ome-xml  5.2.0
LightSourceSettings.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_LIGHTSOURCESETTINGS_H
47 #define OME_XML_MODEL_LIGHTSOURCESETTINGS_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/LightSource.h>
63 #include <ome/xml/model/MicrobeamManipulation.h>
64 #include <ome/xml/model/Settings.h>
65 #include <ome/xml/model/primitives/PercentFraction.h>
66 #include <ome/xml/model/primitives/PositiveInteger.h>
67 
68 namespace ome
69 {
70  namespace xml
71  {
72  namespace model
73  {
74 
75  // Forward declarations.
76  class OMEModel;
77 
82  {
83  private:
84  class Impl;
86  ome::compat::shared_ptr<Impl> impl;
87 
88  public:
91 
98 
100  virtual
102 
117  static ome::compat::shared_ptr< LightSourceSettings>
118  create(const common::xml::dom::Element& element,
120 
121  // Documented in superclass.
122  const std::string&
123  elementName() const;
124 
125  // Documented in superclass.
126  bool
127  validElementName(const std::string& name) const;
128 
129 
130  // -- OMEModelObject API methods --
131 
133  virtual void
134  update(const common::xml::dom::Element& element,
136 
137  public:
138  // -- LightSourceSettings API methods --
139 
141  bool
142  link (ome::compat::shared_ptr<Reference>& reference,
143  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
144 
150  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
151  getWavelength ();
152 
158  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
159  getWavelength () const;
160 
166  void
167  setWavelength (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& wavelength);
168 
174  ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
175  getAttenuation ();
176 
182  const ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
183  getAttenuation () const;
184 
190  void
191  setAttenuation (ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>& attenuation);
192 
198  const std::string&
199  getID () const;
200 
206  void
207  setID (const std::string& id);
208 
214  ome::compat::weak_ptr<ome::xml::model::LightSource>
215  getLightSource ();
216 
222  const ome::compat::weak_ptr<ome::xml::model::LightSource>
223  getLightSource () const;
224 
230  void
231  setLightSource (ome::compat::weak_ptr<ome::xml::model::LightSource>& lightSource);
232 
238  ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>
240 
246  const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>
247  getMicrobeamManipulation () const;
248 
254  void
255  setMicrobeamManipulation (ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
256 
257 
260  asXMLElement (common::xml::dom::Document& document) const;
261 
262 
263  protected:
264  // Documented in base class.
267  common::xml::dom::Element& element) const;
268 
269  public:
270  // Documented in superclass.
271  const std::string&
272  getXMLNamespace() const;
273  };
274 
275  }
276  }
277 }
278 
279 #endif // OME_XML_MODEL_LIGHTSOURCESETTINGS_H
280 
281 /*
282  * Local Variables:
283  * mode:C++
284  * End:
285  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
Settings model object.
Definition: Settings.h:77
void setAttenuation(ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > &attenuation)
Set the Attenuation property.
Definition: LightSourceSettings.cpp:284
ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > getMicrobeamManipulation()
Get the MicrobeamManipulation property.
Definition: LightSourceSettings.cpp:326
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: LightSourceSettings.cpp:234
const std::string & getID() const
Get the ID property.
Definition: LightSourceSettings.cpp:291
static ome::compat::shared_ptr< LightSourceSettings > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a LightSourceSettings model object from DOM element.
Definition: LightSourceSettings.cpp:164
ome::compat::weak_ptr< ome::xml::model::LightSource > getLightSource()
Get the LightSource property.
Definition: LightSourceSettings.cpp:305
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: LightSourceSettings.cpp:347
const std::string & elementName() const
Get the element name of this model object.
Definition: LightSourceSettings.cpp:173
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: LightSourceSettings.cpp:189
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: LightSourceSettings.cpp:180
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > getAttenuation()
Get the Attenuation property.
Definition: LightSourceSettings.cpp:270
void setLightSource(ome::compat::weak_ptr< ome::xml::model::LightSource > &lightSource)
Set the LightSource property.
Definition: LightSourceSettings.cpp:319
Open Microscopy Environment C++ implementation.
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: LightSourceSettings.h:84
void setWavelength(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &wavelength)
Set the Wavelength property.
Definition: LightSourceSettings.cpp:263
Private implementation details of LightSourceSettings model object.
Definition: LightSourceSettings.cpp:72
void setID(const std::string &id)
Set the ID property.
Definition: LightSourceSettings.cpp:298
void setMicrobeamManipulation(ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
Set the MicrobeamManipulation property.
Definition: LightSourceSettings.cpp:340
virtual ~LightSourceSettings()
Destructor.
Definition: LightSourceSettings.cpp:159
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getWavelength()
Get the Wavelength property.
Definition: LightSourceSettings.cpp:249
LightSourceSettings()
Default constructor.
Definition: LightSourceSettings.cpp:140
LightSourceSettings model object.
Definition: LightSourceSettings.h:81
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: LightSourceSettings.cpp:354
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: LightSourceSettings.cpp:406