ome-xml  5.2.0
TransmittanceRange.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_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:
83  class Impl;
85  ome::compat::shared_ptr<Impl> impl;
86 
87  public:
90 
97 
99  virtual
101 
116  static ome::compat::shared_ptr< TransmittanceRange>
117  create(const common::xml::dom::Element& element,
119 
120  // Documented in superclass.
121  const std::string&
122  elementName() const;
123 
124  // Documented in superclass.
125  bool
126  validElementName(const std::string& name) const;
127 
128 
129  // -- OMEModelObject API methods --
130 
132  virtual void
133  update(const common::xml::dom::Element& element,
135 
136  public:
137  // -- TransmittanceRange API methods --
138 
140  bool
141  link (ome::compat::shared_ptr<Reference>& reference,
142  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
143 
149  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
150  getCutIn ();
151 
157  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
158  getCutIn () const;
159 
165  void
166  setCutIn (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& cutIn);
167 
173  ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
174  getTransmittance ();
175 
181  const ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
182  getTransmittance () const;
183 
189  void
190  setTransmittance (ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>& transmittance);
191 
197  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
198  getCutOut ();
199 
205  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
206  getCutOut () const;
207 
213  void
214  setCutOut (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& cutOut);
215 
221  ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
223 
229  const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
230  getCutInTolerance () const;
231 
237  void
238  setCutInTolerance (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& cutInTolerance);
239 
245  ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
247 
253  const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
254  getCutOutTolerance () const;
255 
261  void
262  setCutOutTolerance (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& cutOutTolerance);
263 
264 
267  asXMLElement (common::xml::dom::Document& document) const;
268 
269 
270  protected:
271  // Documented in base class.
274  common::xml::dom::Element& element) const;
275 
276  public:
277  // Documented in superclass.
278  const std::string&
279  getXMLNamespace() const;
280  };
281 
282  }
283  }
284 }
285 
286 #endif // OME_XML_MODEL_TRANSMITTANCERANGE_H
287 
288 /*
289  * Local Variables:
290  * mode:C++
291  * End:
292  */
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:260
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > getTransmittance()
Get the Transmittance property.
Definition: TransmittanceRange.cpp:281
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getCutInTolerance()
Get the CutInTolerance property.
Definition: TransmittanceRange.cpp:323
void setCutOut(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &cutOut)
Set the CutOut property.
Definition: TransmittanceRange.cpp:316
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getCutOutTolerance()
Get the CutOutTolerance property.
Definition: TransmittanceRange.cpp:344
Private implementation details of TransmittanceRange model object.
Definition: TransmittanceRange.cpp:70
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: TransmittanceRange.cpp:178
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:358
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: TransmittanceRange.h:83
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:365
Open Microscopy Environment C++ implementation.
TransmittanceRange()
Default constructor.
Definition: TransmittanceRange.cpp:138
virtual ~TransmittanceRange()
Destructor.
Definition: TransmittanceRange.cpp:157
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: TransmittanceRange.cpp:447
const std::string & elementName() const
Get the element name of this model object.
Definition: TransmittanceRange.cpp:171
void setCutIn(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &cutIn)
Set the CutIn property.
Definition: TransmittanceRange.cpp:274
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:372
void setTransmittance(ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > &transmittance)
Set the Transmittance property.
Definition: TransmittanceRange.cpp:295
void setCutInTolerance(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &cutInTolerance)
Set the CutInTolerance property.
Definition: TransmittanceRange.cpp:337
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:187
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getCutOut()
Get the CutOut property.
Definition: TransmittanceRange.cpp:302
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:162
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:245
TransmittanceRange model object.
Definition: TransmittanceRange.h:80