ome-xml 5.2.0

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

- File List

ImagingEnvironment.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_IMAGINGENVIRONMENT_H
47 #define OME_XML_MODEL_IMAGINGENVIRONMENT_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 #include <ome/xml/model/primitives/PercentFraction.h>
64
65 namespace ome
66 {
67 namespace xml
68 {
69 namespace model
70 {
71
72 // Forward declarations.
73 class OMEModel;
74
78 class ImagingEnvironment : public detail::OMEModelObject
79 {
80 private:
81 class Impl;
83 ome::compat::shared_ptr<Impl> impl;
84
85 public:
87 ImagingEnvironment();
88
94 ImagingEnvironment (const ImagingEnvironment& copy);
95
97 virtual
98 ~ImagingEnvironment ();
99
114 static ome::compat::shared_ptr< ImagingEnvironment>
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 // -- ImagingEnvironment 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 ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
148 getCO2Percent ();
149
155 const ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
156 getCO2Percent () const;
157
163 void
164 setCO2Percent (ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>& co2Percent);
165
171 ome::compat::shared_ptr<double>
172 getTemperature ();
173
179 const ome::compat::shared_ptr<double>
180 getTemperature () const;
181
187 void
188 setTemperature (ome::compat::shared_ptr<double>& temperature);
189
195 ome::compat::shared_ptr<double>
196 getAirPressure ();
197
203 const ome::compat::shared_ptr<double>
204 getAirPressure () const;
205
211 void
212 setAirPressure (ome::compat::shared_ptr<double>& airPressure);
213
219 ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
220 getHumidity ();
221
227 const ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
228 getHumidity () const;
229
235 void
236 setHumidity (ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>& humidity);
237
238
240 virtual common::xml::dom::Element
241 asXMLElement (common::xml::dom::Document& document) const;
242
243
244 protected:
245 // Documented in base class.
246 virtual common::xml::dom::Element
247 asXMLElementInternal (common::xml::dom::Document& document,
248 common::xml::dom::Element& element) const;
249
250 public:
251 // Documented in superclass.
252 const std::string&
253 getXMLNamespace() const;
254 };
255
256 }
257 }
258 }
259
260 #endif // OME_XML_MODEL_IMAGINGENVIRONMENT_H
261
262 /*
263 * Local Variables:
264 * mode:C++
265 * End:
266 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::ImagingEnvironment::~ImagingEnvironment
virtual ~ImagingEnvironment()
Destructor.
Definition: ImagingEnvironment.cpp:150
ome::xml::model::ImagingEnvironment::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: ImagingEnvironment.cpp:164
ome::xml::model::ImagingEnvironment::getCO2Percent
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > getCO2Percent()
Get the CO2Percent property.
Definition: ImagingEnvironment.cpp:244
ome::xml::model::ImagingEnvironment::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: ImagingEnvironment.cpp:180
ome::common::xml::dom::Document
ome::xml::model::ImagingEnvironment::Impl
Private implementation details of ImagingEnvironment model object.
Definition: ImagingEnvironment.cpp:70
ome::common::xml::dom::Element
ome::xml::model::ImagingEnvironment::ImagingEnvironment
ImagingEnvironment()
Default constructor.
Definition: ImagingEnvironment.cpp:131
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::ImagingEnvironment::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: ImagingEnvironment.cpp:229
ome::xml::model::ImagingEnvironment::setTemperature
void setTemperature(ome::compat::shared_ptr< double > &temperature)
Set the Temperature property.
Definition: ImagingEnvironment.cpp:279
ome::xml::model::ImagingEnvironment::setHumidity
void setHumidity(ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > &humidity)
Set the Humidity property.
Definition: ImagingEnvironment.cpp:321
ome::xml::model::ImagingEnvironment::setAirPressure
void setAirPressure(ome::compat::shared_ptr< double > &airPressure)
Set the AirPressure property.
Definition: ImagingEnvironment.cpp:300
ome::xml::model::ImagingEnvironment::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: ImagingEnvironment.cpp:335
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::ImagingEnvironment::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: ImagingEnvironment.h:81
ome::xml::model::ImagingEnvironment::getTemperature
ome::compat::shared_ptr< double > getTemperature()
Get the Temperature property.
Definition: ImagingEnvironment.cpp:265
ome::xml::model::ImagingEnvironment
ImagingEnvironment model object.
Definition: ImagingEnvironment.h:78
ome::xml::model::ImagingEnvironment::create
static ome::compat::shared_ptr< ImagingEnvironment > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a ImagingEnvironment model object from DOM element.
Definition: ImagingEnvironment.cpp:155
ome::xml::model::ImagingEnvironment::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ImagingEnvironment.cpp:398
ome::xml::model::ImagingEnvironment::getAirPressure
ome::compat::shared_ptr< double > getAirPressure()
Get the AirPressure property.
Definition: ImagingEnvironment.cpp:286
ome::xml::model::ImagingEnvironment::getHumidity
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > getHumidity()
Get the Humidity property.
Definition: ImagingEnvironment.cpp:307
ome::xml::model::ImagingEnvironment::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: ImagingEnvironment.cpp:171
log.h
ome::xml::model::ImagingEnvironment::setCO2Percent
void setCO2Percent(ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > &co2Percent)
Set the CO2Percent property.
Definition: ImagingEnvironment.cpp:258
ome::xml::model::ImagingEnvironment::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: ImagingEnvironment.cpp:328