ome-xml 5.2.3

Laser.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_LASER_H
47 #define OME_XML_MODEL_LASER_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/LightSource.h>
65 #include <ome/xml/model/enums/LaserMedium.h>
66 #include <ome/xml/model/enums/LaserType.h>
67 #include <ome/xml/model/enums/Pulse.h>
68 #include <ome/xml/model/enums/UnitsFrequency.h>
69 #include <ome/xml/model/enums/UnitsLength.h>
70 #include <ome/xml/model/primitives/PositiveFloat.h>
71 #include <ome/xml/model/primitives/PositiveInteger.h>
72
73 namespace ome
74 {
75 namespace xml
76 {
77 namespace model
78 {
79
80 // Forward declarations.
81 class OMEModel;
82
86 class Laser : public LightSource
87 {
88 private:
89 class Impl;
91 ome::compat::shared_ptr<Impl> impl;
92
93 public:
95 Laser();
96
102 Laser (const Laser& copy);
103
105 virtual
106 ~Laser ();
107
122 static ome::compat::shared_ptr< Laser>
123 create(const common::xml::dom::Element& element,
124 ome::xml::model::OMEModel& model);
125
126 // Documented in superclass.
127 const std::string&
128 elementName() const;
129
130 // Documented in superclass.
131 bool
132 validElementName(const std::string& name) const;
133
134 private:
136 Laser&
137 operator= (const Laser&);
138
139 public:
140 // -- OMEModelObject API methods --
141
143 virtual void
144 update(const common::xml::dom::Element& element,
145 ome::xml::model::OMEModel& model);
146
147 public:
148 // -- Laser API methods --
149
151 bool
152 link (ome::compat::shared_ptr<Reference>& reference,
153 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
154
160 ome::compat::shared_ptr<bool>
161 getPockelCell ();
162
168 const ome::compat::shared_ptr<bool>
169 getPockelCell () const;
170
176 void
177 setPockelCell (ome::compat::shared_ptr<bool>& pockelCell);
178
184 ome::compat::shared_ptr<bool>
185 getTuneable ();
186
192 const ome::compat::shared_ptr<bool>
193 getTuneable () const;
194
200 void
201 setTuneable (ome::compat::shared_ptr<bool>& tuneable);
202
208 ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium>
209 getLaserMedium ();
210
216 const ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium>
217 getLaserMedium () const;
218
224 void
225 setLaserMedium (ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium>& laserMedium);
226
232 ome::compat::shared_ptr<ome::xml::model::enums::Pulse>
233 getPulse ();
234
240 const ome::compat::shared_ptr<ome::xml::model::enums::Pulse>
241 getPulse () const;
242
248 void
249 setPulse (ome::compat::shared_ptr<ome::xml::model::enums::Pulse>& pulse);
250
256 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
257 getWavelength ();
258
264 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >&
265 getWavelength () const;
266
272 void
273 setWavelength (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > >& wavelength);
274
280 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
281 getFrequencyMultiplication ();
282
288 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
289 getFrequencyMultiplication () const;
290
296 void
297 setFrequencyMultiplication (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& frequencyMultiplication);
298
304 ome::compat::shared_ptr<ome::xml::model::enums::LaserType>
305 getType ();
306
312 const ome::compat::shared_ptr<ome::xml::model::enums::LaserType>
313 getType () const;
314
320 void
321 setType (ome::compat::shared_ptr<ome::xml::model::enums::LaserType>& type);
322
328 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsFrequency > >&
329 getRepetitionRate ();
330
336 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsFrequency > >&
337 getRepetitionRate () const;
338
344 void
345 setRepetitionRate (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsFrequency > >& repetitionRate);
346
353 ome::compat::weak_ptr<ome::xml::model::LightSource>
354 getLinkedPump ();
355
362 const ome::compat::weak_ptr<ome::xml::model::LightSource>
363 getLinkedPump () const;
364
370 void
371 linkPump (ome::compat::shared_ptr<ome::xml::model::LightSource>& pump);
372
382 void
383 unlinkPump (ome::compat::shared_ptr<ome::xml::model::LightSource>& pump);
384
385 const std::string&
386 getLightSourceType() const;
387
389 virtual common::xml::dom::Element
390 asXMLElement (common::xml::dom::Document& document) const;
391
392
393 protected:
394 // Documented in base class.
395 virtual common::xml::dom::Element
396 asXMLElementInternal (common::xml::dom::Document& document,
397 common::xml::dom::Element& element) const;
398
399 public:
400 // Documented in superclass.
401 const std::string&
402 getXMLNamespace() const;
403 };
404
405 }
406 }
407 }
408
409 #endif // OME_XML_MODEL_LASER_H
410
411 /*
412 * Local Variables:
413 * mode:C++
414 * End:
415 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Laser::getRepetitionRate
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > > & getRepetitionRate()
Get the RepetitionRate property.
Definition: Laser.cpp:492
ome::xml::model::Laser::~Laser
virtual ~Laser()
Destructor.
Definition: Laser.cpp:187
ome::xml::model::Laser::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Laser.cpp:548
ome::xml::model::Laser::getLinkedPump
ome::compat::weak_ptr< ome::xml::model::LightSource > getLinkedPump()
Get linked Pump.
Definition: Laser.cpp:513
ome::xml::model::Laser::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: Laser.cpp:320
ome::xml::model::Laser::setWavelength
void setWavelength(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > &wavelength)
Set the Wavelength property.
Definition: Laser.cpp:443
ome::xml::model::Laser::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Laser.cpp:682
ome::xml::model::Laser::unlinkPump
void unlinkPump(ome::compat::shared_ptr< ome::xml::model::LightSource > &pump)
Unlink Pump.
Definition: Laser.cpp:532
ome::xml::model::Laser::setType
void setType(ome::compat::shared_ptr< ome::xml::model::enums::LaserType > &type)
Set the Type property.
Definition: Laser.cpp:485
ome::xml::model::Laser::setPockelCell
void setPockelCell(ome::compat::shared_ptr< bool > &pockelCell)
Set the PockelCell property.
Definition: Laser.cpp:359
ome::xml::model::Laser::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Laser.cpp:208
ome::common::xml::dom::Document
ome::xml::model::Laser::create
static ome::compat::shared_ptr< Laser > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Laser model object from DOM element.
Definition: Laser.cpp:192
ome::common::xml::dom::Element
ome::xml::model::Laser::operator=
Laser & operator=(const Laser &)
Assignment operator (deleted).
ome::xml::model::Laser::linkPump
void linkPump(ome::compat::shared_ptr< ome::xml::model::LightSource > &pump)
Link Pump.
Definition: Laser.cpp:526
ome::xml::model::Laser::setFrequencyMultiplication
void setFrequencyMultiplication(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &frequencyMultiplication)
Set the FrequencyMultiplication property.
Definition: Laser.cpp:464
ome::xml::model::Laser::getFrequencyMultiplication
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getFrequencyMultiplication()
Get the FrequencyMultiplication property.
Definition: Laser.cpp:450
ome::xml::model::Laser::setRepetitionRate
void setRepetitionRate(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > > &repetitionRate)
Set the RepetitionRate property.
Definition: Laser.cpp:506
ome::xml::model::Laser::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: Laser.cpp:216
ome::xml::model::Laser::getLightSourceType
const std::string & getLightSourceType() const
Get the LightSource type.
Definition: Laser.cpp:541
ome::xml::model::Laser::getPockelCell
ome::compat::shared_ptr< bool > getPockelCell()
Get the PockelCell property.
Definition: Laser.cpp:345
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Laser::Laser
Laser()
Default constructor.
Definition: Laser.cpp:172
ome::xml::model::Laser::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: Laser.cpp:555
ome::xml::model::Laser
Laser model object.
Definition: Laser.h:86
ome::xml::model::Laser::getPulse
ome::compat::shared_ptr< ome::xml::model::enums::Pulse > getPulse()
Get the Pulse property.
Definition: Laser.cpp:408
ome::xml::model::primitives::Quantity
A quantity of a defined unit.
Definition: Quantity.h:57
ome::xml::model::Laser::Impl
Private implementation details of Laser model object.
Definition: Laser.cpp:77
ome::xml::model::Laser::getTuneable
ome::compat::shared_ptr< bool > getTuneable()
Get the Tuneable property.
Definition: Laser.cpp:366
ome::xml::model::LightSource
LightSource model object.
Definition: LightSource.h:82
ome::xml::model::Laser::getType
ome::compat::shared_ptr< ome::xml::model::enums::LaserType > getType()
Get the Type property.
Definition: Laser.cpp:471
ome::xml::model::Laser::getWavelength
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & getWavelength()
Get the Wavelength property.
Definition: Laser.cpp:429
ome::xml::model::Laser::setLaserMedium
void setLaserMedium(ome::compat::shared_ptr< ome::xml::model::enums::LaserMedium > &laserMedium)
Set the LaserMedium property.
Definition: Laser.cpp:401
ome::xml::model::Laser::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Laser.h:89
log.h
ome::xml::model::Laser::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Laser.cpp:201
ome::xml::model::Laser::getLaserMedium
ome::compat::shared_ptr< ome::xml::model::enums::LaserMedium > getLaserMedium()
Get the LaserMedium property.
Definition: Laser.cpp:387
ome::xml::model::Laser::setTuneable
void setTuneable(ome::compat::shared_ptr< bool > &tuneable)
Set the Tuneable property.
Definition: Laser.cpp:380
ome::xml::model::Laser::setPulse
void setPulse(ome::compat::shared_ptr< ome::xml::model::enums::Pulse > &pulse)
Set the Pulse property.
Definition: Laser.cpp:422