ome-xml  5.6.0
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 
61 #include <ome/xml/model/primitives/Quantity.h>
62 
63 #include <ome/xml/model/Annotation.h>
64 #include <ome/xml/model/StructuredAnnotations.h>
65 #include <ome/xml/model/primitives/OrderedMultimap.h>
66 
67 namespace ome
68 {
69  namespace xml
70  {
71  namespace model
72  {
73 
74  // Forward declarations.
75  class OMEModel;
76 
80  class MapAnnotation : public Annotation
81  {
82  private:
83  class Impl;
85  std::shared_ptr<Impl> impl;
86 
87  public:
89  MapAnnotation();
90 
96  MapAnnotation (const MapAnnotation& copy);
97 
99  virtual
100  ~MapAnnotation ();
101 
116  static std::shared_ptr<MapAnnotation>
117  create(const common::xml::dom::Element& element,
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 
130  operator= (const MapAnnotation&) = delete;
132 
133  // -- OMEModelObject API methods --
134 
136  virtual void
137  update(const common::xml::dom::Element& element,
139 
140  public:
141  // -- MapAnnotation API methods --
142 
144  bool
145  link (std::shared_ptr<Reference>& reference,
146  std::shared_ptr<ome::xml::model::OMEModelObject>& object);
147 
154  getValue () const;
155 
161  void
163 
169  std::weak_ptr<ome::xml::model::StructuredAnnotations>
171 
177  const std::weak_ptr<ome::xml::model::StructuredAnnotations>
178  getStructuredAnnotations () const;
179 
185  void
186  setStructuredAnnotations (std::weak_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations_BackReference);
187 
188  protected:
189  // Documented in base class.
190  virtual void
192  common::xml::dom::Element& element) const;
193 
194  public:
195  // Documented in superclass.
196  const std::string&
197  getXMLNamespace() const;
198  };
199 
200  }
201  }
202 }
203 
204 #endif // OME_XML_MODEL_MAPANNOTATION_H
205 
206 /*
207  * Local Variables:
208  * mode:C++
209  * End:
210  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
void setValue(const ome::xml::model::primitives::OrderedMultimap &value)
Set the Value property.
Definition: MapAnnotation.cpp:233
MapAnnotation model object.
Definition: MapAnnotation.h:80
virtual ~MapAnnotation()
Destructor.
Definition: MapAnnotation.cpp:140
void setStructuredAnnotations(std::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
Set the StructuredAnnotations property.
Definition: MapAnnotation.cpp:254
const std::string & elementName() const
Get the element name of this model object.
Definition: MapAnnotation.cpp:154
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: MapAnnotation.cpp:288
std::shared_ptr< Impl > impl
Private implementation details.
Definition: MapAnnotation.h:83
const ome::xml::model::primitives::OrderedMultimap & getValue() const
Get the Value property.
Definition: MapAnnotation.cpp:226
virtual SKIP 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:167
Open Microscopy Environment C++ implementation.
virtual void 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:260
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: MapAnnotation.cpp:211
Annotation model object.
Definition: Annotation.h:100
static std::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:145
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: MapAnnotation.cpp:161
std::weak_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: MapAnnotation.cpp:240
Private implementation details of MapAnnotation model object.
Definition: MapAnnotation.cpp:71
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
MapAnnotation()
Default constructor.
Definition: MapAnnotation.cpp:121