bioformats  5.1.3
LightSourceSettings.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_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:
85  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger> wavelength;
87  ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction> attenuation;
89  std::string id;
91  ome::compat::weak_ptr<ome::xml::model::LightSource> lightSource;
93  ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation> microbeamManipulation;
94 
95  public:
98 
105 
107  virtual
109 
110 
111 
126  static ome::compat::shared_ptr< LightSourceSettings>
127  create(const common::xml::dom::Element& element,
129 
130  // Documented in superclass.
131  const std::string&
132  elementName() const;
133 
134  // Documented in superclass.
135  bool
136  validElementName(const std::string& name) const;
137 
138 
139  // -- OMEModelObject API methods --
140 
142  virtual void
143  update(const common::xml::dom::Element& element,
145 
146  public:
147  // -- LightSourceSettings API methods --
148 
150  bool
151  link (ome::compat::shared_ptr<Reference>& reference,
152  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
153 
159  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
160  getWavelength ();
161 
167  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
168  getWavelength () const;
169 
175  void
176  setWavelength (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& wavelength);
177 
183  ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
184  getAttenuation ();
185 
191  const ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>
192  getAttenuation () const;
193 
199  void
200  setAttenuation (ome::compat::shared_ptr<ome::xml::model::primitives::PercentFraction>& attenuation);
201 
207  const std::string&
208  getID () const;
209 
215  void
216  setID (const std::string& id);
217 
223  ome::compat::weak_ptr<ome::xml::model::LightSource>
224  getLightSource ();
225 
231  const ome::compat::weak_ptr<ome::xml::model::LightSource>
232  getLightSource () const;
233 
239  void
240  setLightSource (ome::compat::weak_ptr<ome::xml::model::LightSource>& lightSource);
241 
247  ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>
249 
255  const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>
256  getMicrobeamManipulation () const;
257 
263  void
264  setMicrobeamManipulation (ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
265 
266 
269  asXMLElement (common::xml::dom::Document& document) const;
270 
271 
272  protected:
273  // Documented in base class.
276  common::xml::dom::Element& element) const;
277 
278  public:
279  // Documented in superclass.
280  const std::string&
281  getXMLNamespace() const;
282  };
283 
284  }
285  }
286 }
287 
288 #endif // OME_XML_MODEL_LIGHTSOURCESETTINGS_H
289 
290 /*
291  * Local Variables:
292  * mode:C++
293  * End:
294  */
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:261
ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > getMicrobeamManipulation()
Get the MicrobeamManipulation property.
Definition: LightSourceSettings.cpp:303
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:211
const std::string & getID() const
Get the ID property.
Definition: LightSourceSettings.cpp:268
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:141
ome::compat::weak_ptr< ome::xml::model::LightSource > getLightSource()
Get the LightSource property.
Definition: LightSourceSettings.cpp:282
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:324
const std::string & elementName() const
Get the element name of this model object.
Definition: LightSourceSettings.cpp:150
std::string id
ID property.
Definition: LightSourceSettings.h:89
DOM Document wrapper.
Definition: Document.h:82
DOM Element wrapper.
Definition: Element.h:66
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:166
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: LightSourceSettings.cpp:157
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > getAttenuation()
Get the Attenuation property.
Definition: LightSourceSettings.cpp:247
void setLightSource(ome::compat::weak_ptr< ome::xml::model::LightSource > &lightSource)
Set the LightSource property.
Definition: LightSourceSettings.cpp:296
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > wavelength
Wavelength property.
Definition: LightSourceSettings.h:85
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
ome::compat::weak_ptr< ome::xml::model::LightSource > lightSource
LightSourceRef back reference.
Definition: LightSourceSettings.h:91
void setWavelength(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &wavelength)
Set the Wavelength property.
Definition: LightSourceSettings.cpp:240
void setID(const std::string &id)
Set the ID property.
Definition: LightSourceSettings.cpp:275
void setMicrobeamManipulation(ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
Set the MicrobeamManipulation property.
Definition: LightSourceSettings.cpp:317
virtual ~LightSourceSettings()
Destructor.
Definition: LightSourceSettings.cpp:136
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getWavelength()
Get the Wavelength property.
Definition: LightSourceSettings.cpp:226
LightSourceSettings()
Default constructor.
Definition: LightSourceSettings.cpp:109
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:331
ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > microbeamManipulation
MicrobeamManipulation_BackReference back reference.
Definition: LightSourceSettings.h:93
ome::compat::shared_ptr< ome::xml::model::primitives::PercentFraction > attenuation
Attenuation property.
Definition: LightSourceSettings.h:87
Boost.Log compatibility.
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: LightSourceSettings.cpp:383
Xerces-C modern C++ wrapper.
Definition: Base.h:53