ome-xml 5.2.3

FileAnnotation.h
1 /*
2 * #%L
3 * OME-XML C++ library for working with OME-XML metadata structures.
4 * %%
5 * Copyright © 2006 - 2016 Open Microscopy Environment:
6 * - Massachusetts Institute of Technology
7 * - National Institutes of Health
8 * - University of Dundee
9 * - Board of Regents of the University of Wisconsin-Madison
10 * - Glencoe Software, Inc.
11 * %%
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are
34 * those of the authors and should not be interpreted as representing official
35 * policies, either expressed or implied, of any organization.
36 * #L%
37 */
38
39 /*─────────────────────────────────────────────────────────────────────────────
40 *
41 * THIS IS AUTOMATICALLY GENERATED CODE. DO NOT MODIFY.
42 *
43 *─────────────────────────────────────────────────────────────────────────────
44 */
45
46 #ifndef OME_XML_MODEL_FILEANNOTATION_H
47 #define OME_XML_MODEL_FILEANNOTATION_H
48
49 #include <algorithm>
50 #include <list>
51 #include <stdexcept>
52 #include <string>
53 #include <vector>
54
55 #include <ome/common/log.h>
56
57 #include <ome/common/xml/dom/Document.h>
58 #include <ome/common/xml/dom/Element.h>
59 #include <ome/common/xml/dom/Node.h>
60 #include <ome/common/xml/dom/NodeList.h>
61
62 #include <ome/xml/model/primitives/Quantity.h>
63
64 #include <ome/xml/model/BinaryFile.h>
65 #include <ome/xml/model/StructuredAnnotations.h>
66 #include <ome/xml/model/TypeAnnotation.h>
67
68 namespace ome
69 {
70 namespace xml
71 {
72 namespace model
73 {
74
75 // Forward declarations.
76 class OMEModel;
77
81 class FileAnnotation : public TypeAnnotation
82 {
83 private:
84 class Impl;
86 ome::compat::shared_ptr<Impl> impl;
87
88 public:
90 FileAnnotation();
91
97 FileAnnotation (const FileAnnotation& copy);
98
100 virtual
101 ~FileAnnotation ();
102
117 static ome::compat::shared_ptr< FileAnnotation>
118 create(const common::xml::dom::Element& element,
119 ome::xml::model::OMEModel& model);
120
121 // Documented in superclass.
122 const std::string&
123 elementName() const;
124
125 // Documented in superclass.
126 bool
127 validElementName(const std::string& name) const;
128
129 private:
131 FileAnnotation&
132 operator= (const FileAnnotation&);
133
134 public:
135 // -- OMEModelObject API methods --
136
138 virtual void
139 update(const common::xml::dom::Element& element,
140 ome::xml::model::OMEModel& model);
141
142 public:
143 // -- FileAnnotation API methods --
144
146 bool
147 link (ome::compat::shared_ptr<Reference>& reference,
148 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
149
155 ome::compat::shared_ptr<ome::xml::model::BinaryFile>
156 getBinaryFile ();
157
163 const ome::compat::shared_ptr<ome::xml::model::BinaryFile>
164 getBinaryFile () const;
165
171 void
172 setBinaryFile (ome::compat::shared_ptr<ome::xml::model::BinaryFile>& binaryFile);
173
179 ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
180 getStructuredAnnotations ();
181
187 const ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
188 getStructuredAnnotations () const;
189
195 void
196 setStructuredAnnotations (ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations_BackReference);
197
199 virtual common::xml::dom::Element
200 asXMLElement (common::xml::dom::Document& document) const;
201
202
203 protected:
204 // Documented in base class.
205 virtual common::xml::dom::Element
206 asXMLElementInternal (common::xml::dom::Document& document,
207 common::xml::dom::Element& element) const;
208
209 public:
210 // Documented in superclass.
211 const std::string&
212 getXMLNamespace() const;
213 };
214
215 }
216 }
217 }
218
219 #endif // OME_XML_MODEL_FILEANNOTATION_H
220
221 /*
222 * Local Variables:
223 * mode:C++
224 * End:
225 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::FileAnnotation::getBinaryFile
ome::compat::shared_ptr< ome::xml::model::BinaryFile > getBinaryFile()
Get the BinaryFile property.
Definition: FileAnnotation.cpp:211
ome::xml::model::FileAnnotation::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: FileAnnotation.cpp:252
ome::xml::model::FileAnnotation::FileAnnotation
FileAnnotation()
Default constructor.
Definition: FileAnnotation.cpp:122
ome::xml::model::FileAnnotation::setBinaryFile
void setBinaryFile(ome::compat::shared_ptr< ome::xml::model::BinaryFile > &binaryFile)
Set the BinaryFile property.
Definition: FileAnnotation.cpp:225
ome::xml::model::FileAnnotation::getStructuredAnnotations
ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: FileAnnotation.cpp:232
ome::xml::model::FileAnnotation::setStructuredAnnotations
void setStructuredAnnotations(ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
Set the StructuredAnnotations property.
Definition: FileAnnotation.cpp:246
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::FileAnnotation::operator=
FileAnnotation & operator=(const FileAnnotation &)
Assignment operator (deleted).
ome::xml::model::FileAnnotation
FileAnnotation model object.
Definition: FileAnnotation.h:81
ome::xml::model::FileAnnotation::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: FileAnnotation.cpp:287
ome::xml::model::FileAnnotation::link
bool link(ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: FileAnnotation.cpp:196
ome::xml::model::FileAnnotation::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: FileAnnotation.h:84
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::FileAnnotation::create
static ome::compat::shared_ptr< FileAnnotation > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a FileAnnotation model object from DOM element.
Definition: FileAnnotation.cpp:142
ome::xml::model::FileAnnotation::Impl
Private implementation details of FileAnnotation model object.
Definition: FileAnnotation.cpp:76
ome::xml::model::FileAnnotation::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: FileAnnotation.cpp:151
ome::xml::model::TypeAnnotation
TypeAnnotation model object.
Definition: TypeAnnotation.h:79
ome::xml::model::FileAnnotation::update
virtual void update(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: FileAnnotation.cpp:166
ome::xml::model::FileAnnotation::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: FileAnnotation.cpp:158
ome::xml::model::FileAnnotation::asXMLElementInternal
virtual common::xml::dom::Element asXMLElementInternal(common::xml::dom::Document &document, common::xml::dom::Element &element) const
Transform the object hierarchy rooted at this element to XML.
Definition: FileAnnotation.cpp:259
ome::xml::model::FileAnnotation::~FileAnnotation
virtual ~FileAnnotation()
Destructor.
Definition: FileAnnotation.cpp:137
log.h