ome-xml 5.2.3

CommentAnnotation.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_COMMENTANNOTATION_H
47 #define OME_XML_MODEL_COMMENTANNOTATION_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/StructuredAnnotations.h>
65 #include <ome/xml/model/TextAnnotation.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class OMEModel;
76
80 class CommentAnnotation : public TextAnnotation
81 {
82 private:
83 class Impl;
85 ome::compat::shared_ptr<Impl> impl;
86
87 public:
89 CommentAnnotation();
90
96 CommentAnnotation (const CommentAnnotation& copy);
97
99 virtual
100 ~CommentAnnotation ();
101
116 static ome::compat::shared_ptr< CommentAnnotation>
117 create(const common::xml::dom::Element& element,
118 ome::xml::model::OMEModel& model);
119
120 // Documented in superclass.
121 const std::string&
122 elementName() const;
123
124 // Documented in superclass.
125 bool
126 validElementName(const std::string& name) const;
127
128 private:
130 CommentAnnotation&
131 operator= (const CommentAnnotation&);
132
133 public:
134 // -- OMEModelObject API methods --
135
137 virtual void
138 update(const common::xml::dom::Element& element,
139 ome::xml::model::OMEModel& model);
140
141 public:
142 // -- CommentAnnotation API methods --
143
145 bool
146 link (ome::compat::shared_ptr<Reference>& reference,
147 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
148
154 const std::string&
155 getValue () const;
156
162 void
163 setValue (const std::string& value);
164
170 ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
171 getStructuredAnnotations ();
172
178 const ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
179 getStructuredAnnotations () const;
180
186 void
187 setStructuredAnnotations (ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations_BackReference);
188
190 virtual common::xml::dom::Element
191 asXMLElement (common::xml::dom::Document& document) const;
192
193
194 protected:
195 // Documented in base class.
196 virtual common::xml::dom::Element
197 asXMLElementInternal (common::xml::dom::Document& document,
198 common::xml::dom::Element& element) const;
199
200 public:
201 // Documented in superclass.
202 const std::string&
203 getXMLNamespace() const;
204 };
205
206 }
207 }
208 }
209
210 #endif // OME_XML_MODEL_COMMENTANNOTATION_H
211
212 /*
213 * Local Variables:
214 * mode:C++
215 * End:
216 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::CommentAnnotation::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: CommentAnnotation.cpp:276
ome::xml::model::CommentAnnotation::CommentAnnotation
CommentAnnotation()
Default constructor.
Definition: CommentAnnotation.cpp:117
ome::xml::model::CommentAnnotation::operator=
CommentAnnotation & operator=(const CommentAnnotation &)
Assignment operator (deleted).
ome::xml::model::TextAnnotation
TextAnnotation model object.
Definition: TextAnnotation.h:79
ome::xml::model::CommentAnnotation::setValue
void setValue(const std::string &value)
Set the Value property.
Definition: CommentAnnotation.cpp:211
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::CommentAnnotation::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: CommentAnnotation.cpp:245
ome::xml::model::CommentAnnotation
CommentAnnotation model object.
Definition: CommentAnnotation.h:80
ome::xml::model::CommentAnnotation::setStructuredAnnotations
void setStructuredAnnotations(ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
Set the StructuredAnnotations property.
Definition: CommentAnnotation.cpp:232
ome::xml::model::CommentAnnotation::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: CommentAnnotation.cpp:161
ome::xml::model::CommentAnnotation::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: CommentAnnotation.cpp:153
ome::xml::model::CommentAnnotation::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: CommentAnnotation.cpp:146
ome::xml::model::CommentAnnotation::create
static ome::compat::shared_ptr< CommentAnnotation > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a CommentAnnotation model object from DOM element.
Definition: CommentAnnotation.cpp:137
ome::xml::model::CommentAnnotation::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: CommentAnnotation.h:83
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::CommentAnnotation::~CommentAnnotation
virtual ~CommentAnnotation()
Destructor.
Definition: CommentAnnotation.cpp:132
ome::xml::model::CommentAnnotation::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: CommentAnnotation.cpp:189
ome::xml::model::CommentAnnotation::Impl
Private implementation details of CommentAnnotation model object.
Definition: CommentAnnotation.cpp:71
ome::xml::model::CommentAnnotation::getValue
const std::string & getValue() const
Get the Value property.
Definition: CommentAnnotation.cpp:204
ome::xml::model::CommentAnnotation::getStructuredAnnotations
ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: CommentAnnotation.cpp:218
log.h
ome::xml::model::CommentAnnotation::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: CommentAnnotation.cpp:238