bioformats  5.1.3
TransmittanceRange.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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_TRANSMITTANCERANGE_H
47 #define OME_XML_MODEL_TRANSMITTANCERANGE_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/NonNegativeInteger.h>
64 #include <ome/xml/model/primitives/PercentFraction.h>
65 #include <ome/xml/model/primitives/PositiveInteger.h>
66 
67 namespace ome
68 {
69  namespace xml
70  {
71  namespace model
72  {
73 
74  // Forward declarations.
75  class OMEModel;
76 
81  {
82  private:
84  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger> cutIn;
86  ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction> transmittance;
88  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger> cutOut;
90  ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger> cutInTolerance;
92  ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger> cutOutTolerance;
93 
94  public:
97 
104 
106  virtual
108 
109 
110 
125  static ome::compat::shared_ptr< TransmittanceRange>
126  create(const common::xml::dom::Element& element,
128 
129  // Documented in superclass.
130  const std::string&
131  elementName() const;
132 
133  // Documented in superclass.
134  bool
135  validElementName(const std::string& name) const;
136 
137 
138  // -- OMEModelObject API methods --
139 
141  virtual void
142  update(const common::xml::dom::Element& element,
144 
145  public:
146  // -- TransmittanceRange API methods --
147 
149  bool
150  link (ome::compat::shared_ptr<Reference>& reference,
151  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
152 
158  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
159  getCutIn ();
160 
166  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
167  getCutIn () const;
168 
174  void
175  setCutIn (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& cutIn);
176 
182  ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
183  getTransmittance ();
184 
190  const ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
191  getTransmittance () const;
192 
198  void
199  setTransmittance (ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>& transmittance);
200 
206  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
207  getCutOut ();
208 
214  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
215  getCutOut () const;
216 
222  void
223  setCutOut (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& cutOut);
224 
230  ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
232 
238  const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
239  getCutInTolerance () const;
240 
246  void
247  setCutInTolerance (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& cutInTolerance);
248 
254  ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
256 
262  const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
263  getCutOutTolerance () const;
264 
270  void
271  setCutOutTolerance (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& cutOutTolerance);
272 
273 
276  asXMLElement (common::xml::dom::Document& document) const;
277 
278 
279  protected:
280  // Documented in base class.
283  common::xml::dom::Element& element) const;
284 
285  public:
286  // Documented in superclass.
287  const std::string&
288  getXMLNamespace() const;
289  };
290 
291  }
292  }
293 }
294 
295 #endif // OME_XML_MODEL_TRANSMITTANCERANGE_H
296 
297 /*
298  * Local Variables:
299  * mode:C++
300  * End:
301  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getCutIn()
Get the CutIn property.
Definition: TransmittanceRange.cpp:237
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > transmittance
Transmittance property.
Definition: TransmittanceRange.h:86
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > getTransmittance()
Get the Transmittance property.
Definition: TransmittanceRange.cpp:258
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getCutInTolerance()
Get the CutInTolerance property.
Definition: TransmittanceRange.cpp:300
void setCutOut(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &cutOut)
Set the CutOut property.
Definition: TransmittanceRange.cpp:293
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getCutOutTolerance()
Get the CutOutTolerance property.
Definition: TransmittanceRange.cpp:321
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > cutIn
CutIn property.
Definition: TransmittanceRange.h:84
DOM Document wrapper.
Definition: Document.h:82
DOM Element wrapper.
Definition: Element.h:66
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: TransmittanceRange.cpp:155
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
void setCutOutTolerance(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &cutOutTolerance)
Set the CutOutTolerance property.
Definition: TransmittanceRange.cpp:335
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > cutInTolerance
CutInTolerance property.
Definition: TransmittanceRange.h:90
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > cutOut
CutOut property.
Definition: TransmittanceRange.h:88
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: TransmittanceRange.cpp:342
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
TransmittanceRange()
Default constructor.
Definition: TransmittanceRange.cpp:107
virtual ~TransmittanceRange()
Destructor.
Definition: TransmittanceRange.cpp:134
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: TransmittanceRange.cpp:424
const std::string & elementName() const
Get the element name of this model object.
Definition: TransmittanceRange.cpp:148
void setCutIn(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &cutIn)
Set the CutIn property.
Definition: TransmittanceRange.cpp:251
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: TransmittanceRange.cpp:349
void setTransmittance(ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > &transmittance)
Set the Transmittance property.
Definition: TransmittanceRange.cpp:272
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > cutOutTolerance
CutOutTolerance property.
Definition: TransmittanceRange.h:92
void setCutInTolerance(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &cutInTolerance)
Set the CutInTolerance property.
Definition: TransmittanceRange.cpp:314
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: TransmittanceRange.cpp:164
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getCutOut()
Get the CutOut property.
Definition: TransmittanceRange.cpp:279
Boost.Log compatibility.
static ome::compat::shared_ptr< TransmittanceRange > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a TransmittanceRange model object from DOM element.
Definition: TransmittanceRange.cpp:139
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: TransmittanceRange.cpp:222
Xerces-C modern C++ wrapper.
Definition: Base.h:53
TransmittanceRange model object.
Definition: TransmittanceRange.h:80