ome-xml 5.2.3

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/primitives/Quantity.h>
63
64 #include <ome/xml/model/detail/OMEModelObject.h>
65 #include <ome/xml/model/enums/UnitsPressure.h>
66 #include <ome/xml/model/enums/UnitsTemperature.h>
67 #include <ome/xml/model/primitives/OrderedMultimap.h>
68 #include <ome/xml/model/primitives/PercentFraction.h>
69
70 namespace ome
71 {
72 namespace xml
73 {
74 namespace model
75 {
76
77 // Forward declarations.
78 class OMEModel;
79
83 class ImagingEnvironment : public detail::OMEModelObject
84 {
85 private:
86 class Impl;
88 ome::compat::shared_ptr<Impl> impl;
89
90 public:
92 ImagingEnvironment();
93
99 ImagingEnvironment (const ImagingEnvironment& copy);
100
102 virtual
103 ~ImagingEnvironment ();
104
119 static ome::compat::shared_ptr< ImagingEnvironment>
120 create(const common::xml::dom::Element& element,
121 ome::xml::model::OMEModel& model);
122
123 // Documented in superclass.
124 const std::string&
125 elementName() const;
126
127 // Documented in superclass.
128 bool
129 validElementName(const std::string& name) const;
130
131 private:
133 ImagingEnvironment&
134 operator= (const ImagingEnvironment&);
135
136 public:
137 // -- OMEModelObject API methods --
138
140 virtual void
141 update(const common::xml::dom::Element& element,
142 ome::xml::model::OMEModel& model);
143
144 public:
145 // -- ImagingEnvironment API methods --
146
148 bool
149 link (ome::compat::shared_ptr<Reference>& reference,
150 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
151
157 ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
158 getCO2Percent ();
159
165 const ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
166 getCO2Percent () const;
167
173 void
174 setCO2Percent (ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>& co2Percent);
175
181 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTemperature > >&
182 getTemperature ();
183
189 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTemperature > >&
190 getTemperature () const;
191
197 void
198 setTemperature (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTemperature > >& temperature);
199
205 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsPressure > >&
206 getAirPressure ();
207
213 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsPressure > >&
214 getAirPressure () const;
215
221 void
222 setAirPressure (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsPressure > >& airPressure);
223
229 ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
230 getHumidity ();
231
237 const ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
238 getHumidity () const;
239
245 void
246 setHumidity (ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>& humidity);
247
253 ome::compat::shared_ptr<ome::xml::model::primitives::OrderedMultimap>
254 getMap ();
255
261 const ome::compat::shared_ptr<ome::xml::model::primitives::OrderedMultimap>
262 getMap () const;
263
269 void
270 setMap (ome::compat::shared_ptr<ome::xml::model::primitives::OrderedMultimap>& map);
271
273 virtual common::xml::dom::Element
274 asXMLElement (common::xml::dom::Document& document) const;
275
276
277 protected:
278 // Documented in base class.
279 virtual common::xml::dom::Element
280 asXMLElementInternal (common::xml::dom::Document& document,
281 common::xml::dom::Element& element) const;
282
283 public:
284 // Documented in superclass.
285 const std::string&
286 getXMLNamespace() const;
287 };
288
289 }
290 }
291 }
292
293 #endif // OME_XML_MODEL_IMAGINGENVIRONMENT_H
294
295 /*
296 * Local Variables:
297 * mode:C++
298 * End:
299 */
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:154
ome::xml::model::ImagingEnvironment::setTemperature
void setTemperature(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > > &temperature)
Set the Temperature property.
Definition: ImagingEnvironment.cpp:327
ome::xml::model::ImagingEnvironment::getCO2Percent
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > getCO2Percent()
Get the CO2Percent property.
Definition: ImagingEnvironment.cpp:292
ome::xml::model::ImagingEnvironment::getMap
ome::compat::shared_ptr< ome::xml::model::primitives::OrderedMultimap > getMap()
Get the Map property.
Definition: ImagingEnvironment.cpp:376
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:183
ome::common::xml::dom::Document
ome::xml::model::ImagingEnvironment::Impl
Private implementation details of ImagingEnvironment model object.
Definition: ImagingEnvironment.cpp:72
ome::xml::model::ImagingEnvironment::setAirPressure
void setAirPressure(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > > &airPressure)
Set the AirPressure property.
Definition: ImagingEnvironment.cpp:348
ome::common::xml::dom::Element
ome::xml::model::ImagingEnvironment::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ImagingEnvironment.cpp:485
ome::xml::model::ImagingEnvironment::ImagingEnvironment
ImagingEnvironment()
Default constructor.
Definition: ImagingEnvironment.cpp:139
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:277
ome::xml::model::ImagingEnvironment::setHumidity
void setHumidity(ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > &humidity)
Set the Humidity property.
Definition: ImagingEnvironment.cpp:369
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:396
ome
Open Microscopy Environment C++ implementation.
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:175
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:403
ome::xml::model::ImagingEnvironment::getTemperature
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > > & getTemperature()
Get the Temperature property.
Definition: ImagingEnvironment.cpp:313
ome::xml::model::ImagingEnvironment::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: ImagingEnvironment.h:86
ome::xml::model::ImagingEnvironment
ImagingEnvironment model object.
Definition: ImagingEnvironment.h:83
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:159
ome::xml::model::ImagingEnvironment::getHumidity
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > getHumidity()
Get the Humidity property.
Definition: ImagingEnvironment.cpp:355
ome::xml::model::primitives::Quantity
A quantity of a defined unit.
Definition: Quantity.h:57
ome::xml::model::ImagingEnvironment::getAirPressure
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > > & getAirPressure()
Get the AirPressure property.
Definition: ImagingEnvironment.cpp:334
ome::xml::model::ImagingEnvironment::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: ImagingEnvironment.cpp:168
ome::xml::model::ImagingEnvironment::operator=
ImagingEnvironment & operator=(const ImagingEnvironment &)
Assignment operator (deleted).
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:306
ome::xml::model::ImagingEnvironment::setMap
void setMap(ome::compat::shared_ptr< ome::xml::model::primitives::OrderedMultimap > &map)
Set the Map property.
Definition: ImagingEnvironment.cpp:390