ome-xml 5.2.0

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

- File List

StageLabel.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_STAGELABEL_H
47 #define OME_XML_MODEL_STAGELABEL_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
77 class StageLabel : public detail::OMEModelObject
78 {
79 private:
80 class Impl;
82 ome::compat::shared_ptr<Impl> impl;
83
84 public:
86 StageLabel();
87
93 StageLabel (const StageLabel& copy);
94
96 virtual
97 ~StageLabel ();
98
113 static ome::compat::shared_ptr< StageLabel>
114 create(const common::xml::dom::Element& element,
115 ome::xml::model::OMEModel& model);
116
117 // Documented in superclass.
118 const std::string&
119 elementName() const;
120
121 // Documented in superclass.
122 bool
123 validElementName(const std::string& name) const;
124
125
126 // -- OMEModelObject API methods --
127
129 virtual void
130 update(const common::xml::dom::Element& element,
131 ome::xml::model::OMEModel& model);
132
133 public:
134 // -- StageLabel API methods --
135
137 bool
138 link (ome::compat::shared_ptr<Reference>& reference,
139 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
140
146 ome::compat::shared_ptr<double>
147 getY ();
148
154 const ome::compat::shared_ptr<double>
155 getY () const;
156
162 void
163 setY (ome::compat::shared_ptr<double>& y);
164
170 ome::compat::shared_ptr<double>
171 getX ();
172
178 const ome::compat::shared_ptr<double>
179 getX () const;
180
186 void
187 setX (ome::compat::shared_ptr<double>& x);
188
194 ome::compat::shared_ptr<double>
195 getZ ();
196
202 const ome::compat::shared_ptr<double>
203 getZ () const;
204
210 void
211 setZ (ome::compat::shared_ptr<double>& z);
212
218 const std::string&
219 getName () const;
220
226 void
227 setName (const std::string& name);
228
229
231 virtual common::xml::dom::Element
232 asXMLElement (common::xml::dom::Document& document) const;
233
234
235 protected:
236 // Documented in base class.
237 virtual common::xml::dom::Element
238 asXMLElementInternal (common::xml::dom::Document& document,
239 common::xml::dom::Element& element) const;
240
241 public:
242 // Documented in superclass.
243 const std::string&
244 getXMLNamespace() const;
245 };
246
247 }
248 }
249 }
250
251 #endif // OME_XML_MODEL_STAGELABEL_H
252
253 /*
254 * Local Variables:
255 * mode:C++
256 * End:
257 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::StageLabel::getName
const std::string & getName() const
Get the Name property.
Definition: StageLabel.cpp:305
ome::xml::model::StageLabel::getZ
ome::compat::shared_ptr< double > getZ()
Get the Z property.
Definition: StageLabel.cpp:284
ome::xml::model::StageLabel::setName
void setName(const std::string &name)
Set the Name property.
Definition: StageLabel.cpp:312
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::StageLabel::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: StageLabel.cpp:180
ome::xml::model::StageLabel
StageLabel model object.
Definition: StageLabel.h:77
ome::xml::model::StageLabel::StageLabel
StageLabel()
Default constructor.
Definition: StageLabel.cpp:131
ome::xml::model::StageLabel::setX
void setX(ome::compat::shared_ptr< double > &x)
Set the X property.
Definition: StageLabel.cpp:277
ome::xml::model::StageLabel::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: StageLabel.cpp:227
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::StageLabel::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: StageLabel.cpp:171
ome::xml::model::StageLabel::~StageLabel
virtual ~StageLabel()
Destructor.
Definition: StageLabel.cpp:150
ome::xml::model::StageLabel::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: StageLabel.cpp:326
ome::xml::model::StageLabel::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: StageLabel.cpp:386
ome::xml::model::StageLabel::create
static ome::compat::shared_ptr< StageLabel > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a StageLabel model object from DOM element.
Definition: StageLabel.cpp:155
ome::xml::model::StageLabel::getY
ome::compat::shared_ptr< double > getY()
Get the Y property.
Definition: StageLabel.cpp:242
ome::xml::model::StageLabel::setY
void setY(ome::compat::shared_ptr< double > &y)
Set the Y property.
Definition: StageLabel.cpp:256
ome::xml::model::StageLabel::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: StageLabel.cpp:164
ome::xml::model::StageLabel::getX
ome::compat::shared_ptr< double > getX()
Get the X property.
Definition: StageLabel.cpp:263
ome::xml::model::StageLabel::setZ
void setZ(ome::compat::shared_ptr< double > &z)
Set the Z property.
Definition: StageLabel.cpp:298
log.h
ome::xml::model::StageLabel::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: StageLabel.h:80
ome::xml::model::StageLabel::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: StageLabel.cpp:319
ome::xml::model::StageLabel::Impl
Private implementation details of StageLabel model object.
Definition: StageLabel.cpp:70