bioformats  5.1.2
Laser.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_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/LightSource.h>
63 #include <ome/xml/model/enums/LaserMedium.h>
64 #include <ome/xml/model/enums/LaserType.h>
65 #include <ome/xml/model/enums/Pulse.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 
81  class Laser : public LightSource
82  {
83  private:
85  ome::compat::shared_ptr<bool> pockelCell;
87  ome::compat::shared_ptr<ome::xml::model::enums::Pulse> pulse;
89  ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium> laserMedium;
91  ome::compat::shared_ptr<bool> tuneable;
93  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger> wavelength;
95  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger> frequencyMultiplication;
97  ome::compat::shared_ptr<ome::xml::model::enums::LaserType> type;
99  ome::compat::shared_ptr<double> repetitionRate;
101  ome::compat::weak_ptr<ome::xml::model::LightSource> pump;
102 
103  public:
105  Laser ();
106 
112  Laser (const Laser& copy);
113 
115  virtual
116  ~Laser ();
117 
118 
119 
134  static ome::compat::shared_ptr< Laser>
135  create(const common::xml::dom::Element& element,
137 
138  // Documented in superclass.
139  const std::string&
140  elementName() const;
141 
142  // Documented in superclass.
143  bool
144  validElementName(const std::string& name) const;
145 
146 
147  // -- OMEModelObject API methods --
148 
150  virtual void
151  update(const common::xml::dom::Element& element,
153 
154  public:
155  // -- Laser API methods --
156 
158  bool
159  link (ome::compat::shared_ptr<Reference>& reference,
160  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
161 
167  ome::compat::shared_ptr<bool>
168  getPockelCell ();
169 
175  const ome::compat::shared_ptr<bool>
176  getPockelCell () const;
177 
183  void
184  setPockelCell (ome::compat::shared_ptr<bool>& pockelCell);
185 
191  ome::compat::shared_ptr<ome::xml::model::enums::Pulse>
192  getPulse ();
193 
199  const ome::compat::shared_ptr<ome::xml::model::enums::Pulse>
200  getPulse () const;
201 
207  void
208  setPulse (ome::compat::shared_ptr<ome::xml::model::enums::Pulse>& pulse);
209 
215  ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium>
216  getLaserMedium ();
217 
223  const ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium>
224  getLaserMedium () const;
225 
231  void
232  setLaserMedium (ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium>& laserMedium);
233 
239  ome::compat::shared_ptr<bool>
240  getTuneable ();
241 
247  const ome::compat::shared_ptr<bool>
248  getTuneable () const;
249 
255  void
256  setTuneable (ome::compat::shared_ptr<bool>& tuneable);
257 
263  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
264  getWavelength ();
265 
271  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
272  getWavelength () const;
273 
279  void
280  setWavelength (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& wavelength);
281 
287  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
289 
295  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
297 
303  void
304  setFrequencyMultiplication (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& frequencyMultiplication);
305 
311  ome::compat::shared_ptr<ome::xml::model::enums::LaserType>
312  getType ();
313 
319  const ome::compat::shared_ptr<ome::xml::model::enums::LaserType>
320  getType () const;
321 
327  void
328  setType (ome::compat::shared_ptr<ome::xml::model::enums::LaserType>& type);
329 
335  ome::compat::shared_ptr<double>
337 
343  const ome::compat::shared_ptr<double>
344  getRepetitionRate () const;
345 
351  void
352  setRepetitionRate (ome::compat::shared_ptr<double>& repetitionRate);
353 
360  ome::compat::weak_ptr<ome::xml::model::LightSource>
361  getLinkedPump ();
362 
369  const ome::compat::weak_ptr<ome::xml::model::LightSource>
370  getLinkedPump () const;
371 
377  void
378  linkPump (ome::compat::shared_ptr<ome::xml::model::LightSource>& pump);
379 
389  void
390  unlinkPump (ome::compat::shared_ptr<ome::xml::model::LightSource>& pump);
391 
392  const std::string&
393  getLightSourceType() const;
394 
397  asXMLElement (common::xml::dom::Document& document) const;
398 
399 
400  protected:
401  // Documented in base class.
404  common::xml::dom::Element& element) const;
405 
406  public:
407  // Documented in superclass.
408  const std::string&
409  getXMLNamespace() const;
410  };
411 
412  }
413  }
414 }
415 
416 #endif // OME_XML_MODEL_LASER_H
417 
418 /*
419  * Local Variables:
420  * mode:C++
421  * End:
422  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< double > repetitionRate
RepetitionRate property.
Definition: Laser.h:99
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > wavelength
Wavelength property.
Definition: Laser.h:93
virtual ~Laser()
Destructor.
Definition: Laser.cpp:159
ome::compat::weak_ptr< ome::xml::model::LightSource > getLinkedPump()
Get linked Pump.
Definition: Laser.cpp:473
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:280
ome::compat::shared_ptr< double > getRepetitionRate()
Get the RepetitionRate property.
Definition: Laser.cpp:452
ome::compat::weak_ptr< ome::xml::model::LightSource > pump
Pump reference.
Definition: Laser.h:101
ome::compat::shared_ptr< std::string > model
Model property.
Definition: ManufacturerSpec.h:83
void unlinkPump(ome::compat::shared_ptr< ome::xml::model::LightSource > &pump)
Unlink Pump.
Definition: Laser.cpp:492
void setType(ome::compat::shared_ptr< ome::xml::model::enums::LaserType > &type)
Set the Type property.
Definition: Laser.cpp:445
const std::string & getLightSourceType() const
Get the LightSource type.
Definition: Laser.cpp:501
void setPockelCell(ome::compat::shared_ptr< bool > &pockelCell)
Set the PockelCell property.
Definition: Laser.cpp:319
DOM Document wrapper.
Definition: Document.h:82
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:164
DOM Element wrapper.
Definition: Element.h:66
void linkPump(ome::compat::shared_ptr< ome::xml::model::LightSource > &pump)
Link Pump.
Definition: Laser.cpp:486
void setFrequencyMultiplication(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &frequencyMultiplication)
Set the FrequencyMultiplication property.
Definition: Laser.cpp:424
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:508
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getFrequencyMultiplication()
Get the FrequencyMultiplication property.
Definition: Laser.cpp:410
void setWavelength(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &wavelength)
Set the Wavelength property.
Definition: Laser.cpp:403
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:189
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getWavelength()
Get the Wavelength property.
Definition: Laser.cpp:389
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Laser.cpp:180
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > frequencyMultiplication
FrequencyMultiplication property.
Definition: Laser.h:95
ome::compat::shared_ptr< bool > getPockelCell()
Get the PockelCell property.
Definition: Laser.cpp:305
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
Laser()
Default constructor.
Definition: Laser.cpp:124
const std::string & elementName() const
Get the element name of this model object.
Definition: Laser.cpp:173
Laser model object.
Definition: Laser.h:81
ome::compat::shared_ptr< ome::xml::model::enums::Pulse > pulse
Pulse property.
Definition: Laser.h:87
ome::compat::shared_ptr< ome::xml::model::enums::LaserMedium > laserMedium
LaserMedium property.
Definition: Laser.h:89
ome::compat::shared_ptr< ome::xml::model::enums::Pulse > getPulse()
Get the Pulse property.
Definition: Laser.cpp:326
void setRepetitionRate(ome::compat::shared_ptr< double > &repetitionRate)
Set the RepetitionRate property.
Definition: Laser.cpp:466
ome::compat::shared_ptr< bool > getTuneable()
Get the Tuneable property.
Definition: Laser.cpp:368
LightSource model object.
Definition: LightSource.h:78
ome::compat::shared_ptr< ome::xml::model::enums::LaserType > getType()
Get the Type property.
Definition: Laser.cpp:431
void setLaserMedium(ome::compat::shared_ptr< ome::xml::model::enums::LaserMedium > &laserMedium)
Set the LaserMedium property.
Definition: Laser.cpp:361
ome::compat::shared_ptr< bool > pockelCell
PockelCell property.
Definition: Laser.h:85
Boost.Log compatibility.
ome::compat::shared_ptr< ome::xml::model::enums::LaserType > type
Type property.
Definition: Laser.h:97
ome::compat::shared_ptr< bool > tuneable
Tuneable property.
Definition: Laser.h:91
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Laser.cpp:642
ome::compat::shared_ptr< ome::xml::model::enums::LaserMedium > getLaserMedium()
Get the LaserMedium property.
Definition: Laser.cpp:347
void setTuneable(ome::compat::shared_ptr< bool > &tuneable)
Set the Tuneable property.
Definition: Laser.cpp:382
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:515
void setPulse(ome::compat::shared_ptr< ome::xml::model::enums::Pulse > &pulse)
Set the Pulse property.
Definition: Laser.cpp:340
Xerces-C modern C++ wrapper.
Definition: Base.h:53