ome-xml 5.2.3

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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Instrument.h>
65 #include <ome/xml/model/ManufacturerSpec.h>
66 #include <ome/xml/model/enums/UnitsPower.h>
67
68 namespace ome
69 {
70 namespace xml
71 {
72 namespace model
73 {
74
75 // Forward declarations.
76 class Annotation;
77 class OMEModel;
78
82 class LightSource : public ManufacturerSpec
83 {
84 private:
85 class Impl;
87 ome::compat::shared_ptr<Impl> impl;
88
89 public:
91 LightSource();
92
98 LightSource (const LightSource& copy);
99
101 virtual
102 ~LightSource ();
103
104 // Documented in superclass.
105 bool
106 validElementName(const std::string& name) const;
107
108 private:
110 LightSource&
111 operator= (const LightSource&);
112
113 public:
114 // -- OMEModelObject API methods --
115
117 virtual void
118 update(const common::xml::dom::Element& element,
119 ome::xml::model::OMEModel& model);
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<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsPower > >&
151 getPower ();
152
158 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsPower > >&
159 getPower () const;
160
166 void
167 setPower (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsPower > >& power);
168
174 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
175 sizeOfLinkedAnnotationList () const;
176
182 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
183 getLinkedAnnotationList () const;
184
192 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
193 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
194
205 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
206 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
207 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
208
219 bool
220 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
221
237 bool
238 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
239
245 ome::compat::weak_ptr<ome::xml::model::Instrument>
246 getInstrument ();
247
253 const ome::compat::weak_ptr<ome::xml::model::Instrument>
254 getInstrument () const;
255
261 void
262 setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
263
269 virtual const std::string&
270 getLightSourceType() const = 0;
271
273 virtual common::xml::dom::Element
274 asXMLElement (common::xml::dom::Document& document) const;
275
276
277 protected:
278 // Documented in base class.
279 virtual common::xml::dom::Element
280 asXMLElementInternal (common::xml::dom::Document& document,
281 common::xml::dom::Element& element) const;
282
283 public:
284 // Documented in superclass.
285 const std::string&
286 getXMLNamespace() const;
287 };
288
289 }
290 }
291 }
292
293 #endif // OME_XML_MODEL_LIGHTSOURCE_H
294
295 /*
296 * Local Variables:
297 * mode:C++
298 * End:
299 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::LightSource::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: LightSource.cpp:364
ome::xml::model::LightSource::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: LightSource.cpp:325
ome::xml::model::LightSource::getID
const std::string & getID() const
Get the ID property.
Definition: LightSource.cpp:248
ome::xml::model::LightSource::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: LightSource.cpp:289
ome::xml::model::LightSource::setID
void setID(const std::string &id)
Set the ID property.
Definition: LightSource.cpp:255
ome::xml::model::LightSource::getInstrument
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: LightSource.cpp:343
ome::xml::model::LightSource::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: LightSource.cpp:311
ome::xml::model::LightSource::asXMLElementInternal
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:371
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::LightSource::getLinkedAnnotation
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: LightSource.cpp:295
ome::xml::model::OMEModelObject::indexed_container::type
boost::multi_index_container< Ptr< T >, boost::multi_index::indexed_by< boost::multi_index::random_access<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Ptr< T > >, ome::compat::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:94
ome::xml::model::LightSource::~LightSource
virtual ~LightSource()
Destructor.
Definition: LightSource.cpp:149
ome::xml::model::LightSource::link
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:217
ome::xml::model::LightSource::setInstrument
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: LightSource.cpp:357
ome::xml::model::LightSource::update
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:162
ome::xml::model::LightSource::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: LightSource.cpp:429
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::LightSource::Impl
Private implementation details of LightSource model object.
Definition: LightSource.cpp:74
ome::xml::model::LightSource::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: LightSource.cpp:283
ome::xml::model::LightSource::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: LightSource.cpp:154
ome::xml::model::ManufacturerSpec
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:79
ome::xml::model::LightSource::getLightSourceType
virtual const std::string & getLightSourceType() const =0
Get the LightSource type.
ome::xml::model::LightSource::setLinkedAnnotation
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: LightSource.cpp:301
ome::xml::model::LightSource::LightSource
LightSource()
Default constructor.
Definition: LightSource.cpp:134
ome::xml::model::primitives::Quantity
A quantity of a defined unit.
Definition: Quantity.h:57
ome::xml::model::LightSource::getPower
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > > & getPower()
Get the Power property.
Definition: LightSource.cpp:262
ome::xml::model::LightSource
LightSource model object.
Definition: LightSource.h:82
ome::xml::model::LightSource::operator=
LightSource & operator=(const LightSource &)
Assignment operator (deleted).
log.h
ome::xml::model::LightSource::setPower
void setPower(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > > &power)
Set the Power property.
Definition: LightSource.cpp:276
ome::xml::model::LightSource::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: LightSource.h:85