ome-xml 5.2.0

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

- File List

Union.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_UNION_H
47 #define OME_XML_MODEL_UNION_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/detail/OMEModelObject.h>
63
64 namespace ome
65 {
66 namespace xml
67 {
68 namespace model
69 {
70
71 // Forward declarations.
72 class OMEModel;
73 class Shape;
74
78 class Union : public detail::OMEModelObject
79 {
80 private:
81 class Impl;
83 ome::compat::shared_ptr<Impl> impl;
84
85 public:
87 Union();
88
94 Union (const Union& copy);
95
97 virtual
98 ~Union ();
99
114 static ome::compat::shared_ptr< Union>
115 create(const common::xml::dom::Element& element,
116 ome::xml::model::OMEModel& model);
117
118 // Documented in superclass.
119 const std::string&
120 elementName() const;
121
122 // Documented in superclass.
123 bool
124 validElementName(const std::string& name) const;
125
126
127 // -- OMEModelObject API methods --
128
130 virtual void
131 update(const common::xml::dom::Element& element,
132 ome::xml::model::OMEModel& model);
133
134 public:
135 // -- Union API methods --
136
138 bool
139 link (ome::compat::shared_ptr<Reference>& reference,
140 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
141
147 std::vector<ome::compat::shared_ptr<ome::xml::model::Shape> >::size_type
148 sizeOfShapeList () const;
149
156 std::vector<ome::compat::shared_ptr<ome::xml::model::Shape> >&
157 getShapeList ();
158
165 const std::vector<ome::compat::shared_ptr<ome::xml::model::Shape> >&
166 getShapeList () const;
167
175 ome::compat::shared_ptr<ome::xml::model::Shape>&
176 getShape (std::vector<ome::compat::shared_ptr<ome::xml::model::Shape> >::size_type index);
177
185 const ome::compat::shared_ptr<ome::xml::model::Shape>&
186 getShape (std::vector<ome::compat::shared_ptr<ome::xml::model::Shape> >::size_type index) const;
187
195 void
196 setShape (std::vector<ome::compat::shared_ptr<ome::xml::model::Shape> >::size_type index,
197 ome::compat::shared_ptr<ome::xml::model::Shape>& shape);
198
207 void
208 addShape (ome::compat::shared_ptr<ome::xml::model::Shape>& shape);
209
219 void
220 removeShape (ome::compat::shared_ptr<ome::xml::model::Shape>& shape);
221
222
224 virtual common::xml::dom::Element
225 asXMLElement (common::xml::dom::Document& document) const;
226
227
228 protected:
229 // Documented in base class.
230 virtual common::xml::dom::Element
231 asXMLElementInternal (common::xml::dom::Document& document,
232 common::xml::dom::Element& element) const;
233
234 public:
235 // Documented in superclass.
236 const std::string&
237 getXMLNamespace() const;
238 };
239
240 }
241 }
242 }
243
244 #endif // OME_XML_MODEL_UNION_H
245
246 /*
247 * Local Variables:
248 * mode:C++
249 * End:
250 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Union::~Union
virtual ~Union()
Destructor.
Definition: Union.cpp:147
ome::xml::model::Union::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Union.cpp:407
ome::xml::model::Union::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Union.h:81
ome::xml::model::Union::getShapeList
std::vector< ome::compat::shared_ptr< ome::xml::model::Shape > > & getShapeList()
Get the Shape list.
Definition: Union.cpp:317
ome::common::xml::dom::Document
ome::xml::model::Union::setShape
void setShape(std::vector< ome::compat::shared_ptr< ome::xml::model::Shape > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Shape > &shape)
Set Shape.
Definition: Union.cpp:341
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Union::Impl
Private implementation details of Union model object.
Definition: Union.cpp:88
ome::xml::model::Union::Union
Union()
Default constructor.
Definition: Union.cpp:128
ome::xml::model::Union::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Union.cpp:369
ome::xml::model::Union::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Union.cpp:161
ome::xml::model::Union::create
static ome::compat::shared_ptr< Union > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Union model object from DOM element.
Definition: Union.cpp:152
ome::xml::model::Union::removeShape
void removeShape(ome::compat::shared_ptr< ome::xml::model::Shape > &shape)
Remove Shape.
Definition: Union.cpp:358
ome::xml::model::Union::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: Union.cpp:296
ome::xml::model::Union::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: Union.cpp:376
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Union::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Union.cpp:168
ome::xml::model::Union::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: Union.cpp:177
ome::xml::model::Union
Union model object.
Definition: Union.h:78
ome::xml::model::Union::sizeOfShapeList
std::vector< ome::compat::shared_ptr< ome::xml::model::Shape > >::size_type sizeOfShapeList() const
Get size of linked Shape list.
Definition: Union.cpp:311
ome::xml::model::Union::addShape
void addShape(ome::compat::shared_ptr< ome::xml::model::Shape > &shape)
Add Shape.
Definition: Union.cpp:350
log.h
ome::xml::model::Union::getShape
ome::compat::shared_ptr< ome::xml::model::Shape > & getShape(std::vector< ome::compat::shared_ptr< ome::xml::model::Shape > >::size_type index)
Get Shape.
Definition: Union.cpp:329