ome-xml 5.2.0

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

- File List

TimestampAnnotation.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_TIMESTAMPANNOTATION_H
47 #define OME_XML_MODEL_TIMESTAMPANNOTATION_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/BasicAnnotation.h>
63 #include <ome/xml/model/StructuredAnnotations.h>
64 #include <ome/xml/model/primitives/Timestamp.h>
65
66 namespace ome
67 {
68 namespace xml
69 {
70 namespace model
71 {
72
73 // Forward declarations.
74 class OMEModel;
75
79 class TimestampAnnotation : public BasicAnnotation
80 {
81 private:
82 class Impl;
84 ome::compat::shared_ptr<Impl> impl;
85
86 public:
88 TimestampAnnotation();
89
95 TimestampAnnotation (const TimestampAnnotation& copy);
96
98 virtual
99 ~TimestampAnnotation ();
100
115 static ome::compat::shared_ptr< TimestampAnnotation>
116 create(const common::xml::dom::Element& element,
117 ome::xml::model::OMEModel& model);
118
119 // Documented in superclass.
120 const std::string&
121 elementName() const;
122
123 // Documented in superclass.
124 bool
125 validElementName(const std::string& name) const;
126
127
128 // -- OMEModelObject API methods --
129
131 virtual void
132 update(const common::xml::dom::Element& element,
133 ome::xml::model::OMEModel& model);
134
135 public:
136 // -- TimestampAnnotation API methods --
137
139 bool
140 link (ome::compat::shared_ptr<Reference>& reference,
141 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
142
148 const ome::xml::model::primitives::Timestamp&
149 getValue () const;
150
156 void
157 setValue (const ome::xml::model::primitives::Timestamp& value);
158
164 ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
165 getStructuredAnnotations ();
166
172 const ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
173 getStructuredAnnotations () const;
174
180 void
181 setStructuredAnnotations (ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations_BackReference);
182
183
185 virtual common::xml::dom::Element
186 asXMLElement (common::xml::dom::Document& document) const;
187
188
189 protected:
190 // Documented in base class.
191 virtual common::xml::dom::Element
192 asXMLElementInternal (common::xml::dom::Document& document,
193 common::xml::dom::Element& element) const;
194
195 public:
196 // Documented in superclass.
197 const std::string&
198 getXMLNamespace() const;
199 };
200
201 }
202 }
203 }
204
205 #endif // OME_XML_MODEL_TIMESTAMPANNOTATION_H
206
207 /*
208 * Local Variables:
209 * mode:C++
210 * End:
211 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::TimestampAnnotation::~TimestampAnnotation
virtual ~TimestampAnnotation()
Destructor.
Definition: TimestampAnnotation.cpp:137
ome::xml::model::primitives::Timestamp
An ISO-8601 timestamp.
Definition: Timestamp.h:66
ome::xml::model::TimestampAnnotation::Impl
Private implementation details of TimestampAnnotation model object.
Definition: TimestampAnnotation.cpp:71
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::TimestampAnnotation::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: TimestampAnnotation.cpp:284
ome::xml::model::TimestampAnnotation::getStructuredAnnotations
ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: TimestampAnnotation.cpp:225
ome::xml::model::BasicAnnotation
BasicAnnotation model object.
Definition: BasicAnnotation.h:77
ome::xml::model::TimestampAnnotation::setStructuredAnnotations
void setStructuredAnnotations(ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
Set the StructuredAnnotations property.
Definition: TimestampAnnotation.cpp:239
ome::xml::model::TimestampAnnotation::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: TimestampAnnotation.h:82
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::TimestampAnnotation::create
static ome::compat::shared_ptr< TimestampAnnotation > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a TimestampAnnotation model object from DOM element.
Definition: TimestampAnnotation.cpp:142
ome::xml::model::TimestampAnnotation::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: TimestampAnnotation.cpp:253
ome::xml::model::TimestampAnnotation::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: TimestampAnnotation.cpp:151
ome::xml::model::TimestampAnnotation::TimestampAnnotation
TimestampAnnotation()
Default constructor.
Definition: TimestampAnnotation.cpp:118
ome::xml::model::TimestampAnnotation::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: TimestampAnnotation.cpp:196
ome::xml::model::TimestampAnnotation::setValue
void setValue(const ome::xml::model::primitives::Timestamp &value)
Set the Value property.
Definition: TimestampAnnotation.cpp:218
ome::xml::model::TimestampAnnotation
TimestampAnnotation model object.
Definition: TimestampAnnotation.h:79
ome::xml::model::TimestampAnnotation::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: TimestampAnnotation.cpp:246
ome::xml::model::TimestampAnnotation::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: TimestampAnnotation.cpp:167
ome::xml::model::TimestampAnnotation::getValue
const ome::xml::model::primitives::Timestamp & getValue() const
Get the Value property.
Definition: TimestampAnnotation.cpp:211
log.h
ome::xml::model::TimestampAnnotation::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: TimestampAnnotation.cpp:158