ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

AnnotationRef.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_ANNOTATIONREF_H
47 #define OME_XML_MODEL_ANNOTATIONREF_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/Reference.h>
63
64 namespace ome
65 {
66 namespace xml
67 {
68 namespace model
69 {
70
71 // Forward declarations.
72 class OMEModel;
73
77 class AnnotationRef : public Reference
78 {
79 private:
80 class Impl;
82 ome::compat::shared_ptr<Impl> impl;
83
84 public:
86 AnnotationRef();
87
93 AnnotationRef (const AnnotationRef& copy);
94
96 virtual
97 ~AnnotationRef ();
98
113 static ome::compat::shared_ptr< AnnotationRef>
114 create(const common::xml::dom::Element& element,
115 ome::xml::model::OMEModel& model);
116
117 // Documented in superclass.
118 const std::string&
119 elementName() const;
120
121 // Documented in superclass.
122 bool
123 validElementName(const std::string& name) const;
124
125
126 // -- OMEModelObject API methods --
127
129 virtual void
130 update(const common::xml::dom::Element& element,
131 ome::xml::model::OMEModel& model);
132
133 public:
134 // -- AnnotationRef API methods --
135
137 bool
138 link (ome::compat::shared_ptr<Reference>& reference,
139 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
140
146 const std::string&
147 getID () const;
148
154 void
155 setID (const std::string& id);
156
157
159 virtual common::xml::dom::Element
160 asXMLElement (common::xml::dom::Document& document) const;
161
162
163 protected:
164 // Documented in base class.
165 virtual common::xml::dom::Element
166 asXMLElementInternal (common::xml::dom::Document& document,
167 common::xml::dom::Element& element) const;
168
169 public:
170 // Documented in superclass.
171 const std::string&
172 getXMLNamespace() const;
173 };
174
175 }
176 }
177 }
178
179 #endif // OME_XML_MODEL_ANNOTATIONREF_H
180
181 /*
182 * Local Variables:
183 * mode:C++
184 * End:
185 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::AnnotationRef::create
static ome::compat::shared_ptr< AnnotationRef > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a AnnotationRef model object from DOM element.
Definition: AnnotationRef.cpp:134
ome::xml::model::AnnotationRef::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: AnnotationRef.cpp:222
ome::xml::model::AnnotationRef::Impl
Private implementation details of AnnotationRef model object.
Definition: AnnotationRef.cpp:70
ome::common::xml::dom::Document
ome::xml::model::AnnotationRef::~AnnotationRef
virtual ~AnnotationRef()
Destructor.
Definition: AnnotationRef.cpp:129
ome::common::xml::dom::Element
ome::xml::model::AnnotationRef::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: AnnotationRef.cpp:159
ome::xml::model::AnnotationRef::AnnotationRef
AnnotationRef()
Default constructor.
Definition: AnnotationRef.cpp:110
ome::xml::model::AnnotationRef::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: AnnotationRef.cpp:215
ome::xml::model::AnnotationRef
AnnotationRef model object.
Definition: AnnotationRef.h:77
ome::xml::model::AnnotationRef::getID
const std::string & getID() const
Get the ID property.
Definition: AnnotationRef.cpp:201
ome::xml::model::AnnotationRef::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: AnnotationRef.h:80
ome::xml::model::AnnotationRef::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: AnnotationRef.cpp:150
ome::xml::model::AnnotationRef::setID
void setID(const std::string &id)
Set the ID property.
Definition: AnnotationRef.cpp:208
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::AnnotationRef::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: AnnotationRef.cpp:143
ome::xml::model::AnnotationRef::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: AnnotationRef.cpp:186
ome::xml::model::Reference
Reference model object.
Definition: Reference.h:77
log.h
ome::xml::model::AnnotationRef::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: AnnotationRef.cpp:246