bioformats  5.1.2
LightSource.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_LIGHTSOURCE_H
47 #define OME_XML_MODEL_LIGHTSOURCE_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/Instrument.h>
63 #include <ome/xml/model/ManufacturerSpec.h>
64 
65 namespace ome
66 {
67  namespace xml
68  {
69  namespace model
70  {
71 
72  // Forward declarations.
73  class OMEModel;
74 
79  {
80  private:
82  std::string id;
84  ome::compat::shared_ptr<double> power;
90  ome::compat::weak_ptr<ome::xml::model::Instrument> instrument;
91 
92  public:
94  LightSource ();
95 
101  LightSource (const LightSource& copy);
102 
104  virtual
105  ~LightSource ();
106 
107 
108 
109  // Documented in superclass.
110  bool
111  validElementName(const std::string& name) const;
112 
113 
114  // -- OMEModelObject API methods --
115 
117  virtual void
118  update(const common::xml::dom::Element& element,
120 
121  public:
122  // -- LightSource API methods --
123 
125  bool
126  link (ome::compat::shared_ptr<Reference>& reference,
127  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
128 
134  const std::string&
135  getID () const;
136 
142  void
143  setID (const std::string& id);
144 
150  ome::compat::shared_ptr<double>
151  getPower ();
152 
158  const ome::compat::shared_ptr<double>
159  getPower () const;
160 
166  void
167  setPower (ome::compat::shared_ptr<double>& power);
168 
169 
170 
171 
172 
178  ome::compat::weak_ptr<ome::xml::model::Instrument>
179  getInstrument ();
180 
186  const ome::compat::weak_ptr<ome::xml::model::Instrument>
187  getInstrument () const;
188 
194  void
195  setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
196 
202  virtual const std::string&
203  getLightSourceType() const = 0;
204 
205 
206  protected:
207  // Documented in base class.
210  common::xml::dom::Element& element) const;
211 
212  public:
213  // Documented in superclass.
214  const std::string&
215  getXMLNamespace() const;
216  };
217 
218  }
219  }
220 }
221 
222 #endif // OME_XML_MODEL_LIGHTSOURCE_H
223 
224 /*
225  * Local Variables:
226  * mode:C++
227  * End:
228  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: LightSource.cpp:345
ome::compat::shared_ptr< std::string > model
Model property.
Definition: ManufacturerSpec.h:83
void setID(const std::string &id)
Set the ID property.
Definition: LightSource.cpp:248
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: LightSource.cpp:280
DOM Document wrapper.
Definition: Document.h:82
DOM Element wrapper.
Definition: Element.h:66
virtual ~LightSource()
Destructor.
Definition: LightSource.cpp:135
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: LightSource.cpp:226
ome::compat::shared_ptr< double > getPower()
Get the Power property.
Definition: LightSource.cpp:255
ome::compat::weak_ptr< ome::xml::model::Instrument > instrument
*** WARNING *** Unhandled or skipped property Laser *** WARNING *** Unhandled or skipped property Fil...
Definition: LightSource.h:90
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: LightSource.cpp:294
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: LightSource.cpp:141
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: LightSource.cpp:150
const std::string & getID() const
Get the ID property.
Definition: LightSource.cpp:241
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
std::string id
ID property.
Definition: LightSource.h:82
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:77
virtual const std::string & getLightSourceType() const =0
Get the LightSource type.
LightSource()
Default constructor.
Definition: LightSource.cpp:112
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: LightSource.cpp:301
ome::compat::shared_ptr< double > power
Power property.
Definition: LightSource.h:84
LightSource model object.
Definition: LightSource.h:78
Boost.Log compatibility.
Xerces-C modern C++ wrapper.
Definition: Base.h:53
void setPower(ome::compat::shared_ptr< double > &power)
Set the Power property.
Definition: LightSource.cpp:269