ome-xml  5.2.0
LightSource.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_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:
81  class Impl;
83  ome::compat::shared_ptr<Impl> impl;
84 
85  public:
87  LightSource();
88 
94  LightSource (const LightSource& copy);
95 
97  virtual
98  ~LightSource ();
99 
100 
101  // Documented in superclass.
102  bool
103  validElementName(const std::string& name) const;
104 
105 
106  // -- OMEModelObject API methods --
107 
109  virtual void
110  update(const common::xml::dom::Element& element,
112 
113  public:
114  // -- LightSource API methods --
115 
117  bool
118  link (ome::compat::shared_ptr<Reference>& reference,
119  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
120 
126  const std::string&
127  getID () const;
128 
134  void
135  setID (const std::string& id);
136 
142  ome::compat::shared_ptr<double>
143  getPower ();
144 
150  const ome::compat::shared_ptr<double>
151  getPower () const;
152 
158  void
159  setPower (ome::compat::shared_ptr<double>& power);
160 
161 
162 
163 
164 
170  ome::compat::weak_ptr<ome::xml::model::Instrument>
171  getInstrument ();
172 
178  const ome::compat::weak_ptr<ome::xml::model::Instrument>
179  getInstrument () const;
180 
186  void
187  setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
188 
194  virtual const std::string&
195  getLightSourceType() const = 0;
196 
197 
198  protected:
199  // Documented in base class.
202  common::xml::dom::Element& element) const;
203 
204  public:
205  // Documented in superclass.
206  const std::string&
207  getXMLNamespace() const;
208  };
209 
210  }
211  }
212 }
213 
214 #endif // OME_XML_MODEL_LIGHTSOURCE_H
215 
216 /*
217  * Local Variables:
218  * mode:C++
219  * End:
220  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
virtual const std::string & getLightSourceType() const =0
Get the LightSource type.
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: LightSource.cpp:368
void setID(const std::string &id)
Set the ID property.
Definition: LightSource.cpp:271
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: LightSource.cpp:303
virtual ~LightSource()
Destructor.
Definition: LightSource.cpp:158
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:249
ome::compat::shared_ptr< double > getPower()
Get the Power property.
Definition: LightSource.cpp:278
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: LightSource.cpp:317
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: LightSource.cpp:164
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:173
const std::string & getID() const
Get the ID property.
Definition: LightSource.cpp:264
Open Microscopy Environment C++ implementation.
Private implementation details of LightSource model object.
Definition: LightSource.cpp:81
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:77
LightSource()
Default constructor.
Definition: LightSource.cpp:139
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:324
LightSource model object.
Definition: LightSource.h:78
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: LightSource.h:81
void setPower(ome::compat::shared_ptr< double > &power)
Set the Power property.
Definition: LightSource.cpp:292