ome-xml 5.2.3

MapAnnotation.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_MAPANNOTATION_H
47 #define OME_XML_MODEL_MAPANNOTATION_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/Annotation.h>
65 #include <ome/xml/model/StructuredAnnotations.h>
66 #include <ome/xml/model/primitives/OrderedMultimap.h>
67
68 namespace ome
69 {
70 namespace xml
71 {
72 namespace model
73 {
74
75 // Forward declarations.
76 class OMEModel;
77
81 class MapAnnotation : public Annotation
82 {
83 private:
84 class Impl;
86 ome::compat::shared_ptr<Impl> impl;
87
88 public:
90 MapAnnotation();
91
97 MapAnnotation (const MapAnnotation& copy);
98
100 virtual
101 ~MapAnnotation ();
102
117 static ome::compat::shared_ptr< MapAnnotation>
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 MapAnnotation&
132 operator= (const MapAnnotation&);
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 // -- MapAnnotation 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 const ome::xml::model::primitives::OrderedMultimap&
156 getValue () const;
157
163 void
164 setValue (const ome::xml::model::primitives::OrderedMultimap& value);
165
171 ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
172 getStructuredAnnotations ();
173
179 const ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
180 getStructuredAnnotations () const;
181
187 void
188 setStructuredAnnotations (ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations_BackReference);
189
191 virtual common::xml::dom::Element
192 asXMLElement (common::xml::dom::Document& document) const;
193
194
195 protected:
196 // Documented in base class.
197 virtual common::xml::dom::Element
198 asXMLElementInternal (common::xml::dom::Document& document,
199 common::xml::dom::Element& element) const;
200
201 public:
202 // Documented in superclass.
203 const std::string&
204 getXMLNamespace() const;
205 };
206
207 }
208 }
209 }
210
211 #endif // OME_XML_MODEL_MAPANNOTATION_H
212
213 /*
214 * Local Variables:
215 * mode:C++
216 * End:
217 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::MapAnnotation::setValue
void setValue(const ome::xml::model::primitives::OrderedMultimap &value)
Set the Value property.
Definition: MapAnnotation.cpp:227
ome::xml::model::MapAnnotation
MapAnnotation model object.
Definition: MapAnnotation.h:81
ome::xml::model::MapAnnotation::~MapAnnotation
virtual ~MapAnnotation()
Destructor.
Definition: MapAnnotation.cpp:132
ome::xml::model::MapAnnotation::setStructuredAnnotations
void setStructuredAnnotations(ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
Set the StructuredAnnotations property.
Definition: MapAnnotation.cpp:248
ome::xml::model::MapAnnotation::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: MapAnnotation.cpp:146
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::MapAnnotation::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: MapAnnotation.h:84
ome::xml::model::MapAnnotation::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: MapAnnotation.cpp:296
ome::xml::model::MapAnnotation::getValue
const ome::xml::model::primitives::OrderedMultimap & getValue() const
Get the Value property.
Definition: MapAnnotation.cpp:220
ome::xml::model::MapAnnotation::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: MapAnnotation.cpp:161
ome::xml::model::MapAnnotation::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: MapAnnotation.cpp:205
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::MapAnnotation::create
static ome::compat::shared_ptr< MapAnnotation > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a MapAnnotation model object from DOM element.
Definition: MapAnnotation.cpp:137
ome::xml::model::Annotation
Annotation model object.
Definition: Annotation.h:101
ome::xml::model::MapAnnotation::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: MapAnnotation.cpp:153
ome::xml::model::MapAnnotation::operator=
MapAnnotation & operator=(const MapAnnotation &)
Assignment operator (deleted).
ome::xml::model::MapAnnotation::Impl
Private implementation details of MapAnnotation model object.
Definition: MapAnnotation.cpp:71
ome::xml::model::MapAnnotation::getStructuredAnnotations
ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: MapAnnotation.cpp:234
ome::xml::model::primitives::OrderedMultimap
boost::multi_index_container< ordered_map_value, boost::multi_index::indexed_by< boost::multi_index::random_access< boost::multi_index::tag< order_index > >, boost::multi_index::hashed_non_unique< boost::multi_index::tag< key_index >, boost::multi_index::member< ordered_map_value, std::string, &ordered_map_value::first > > > > OrderedMultimap
Map preserving insertion order.
Definition: OrderedMultimap.h:89
ome::xml::model::MapAnnotation::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: MapAnnotation.cpp:261
log.h
ome::xml::model::MapAnnotation::MapAnnotation
MapAnnotation()
Default constructor.
Definition: MapAnnotation.cpp:117
ome::xml::model::MapAnnotation::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: MapAnnotation.cpp:254