bioformats  5.1.8
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/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:
84  class Impl;
86  ome::compat::shared_ptr<Impl> impl;
87 
88  public:
90  Laser();
91 
97  Laser (const Laser& copy);
98 
100  virtual
101  ~Laser ();
102 
117  static ome::compat::shared_ptr< Laser>
118  create(const common::xml::dom::Element& element,
120 
121  // Documented in superclass.
122  const std::string&
123  elementName() const;
124 
125  // Documented in superclass.
126  bool
127  validElementName(const std::string& name) const;
128 
129 
130  // -- OMEModelObject API methods --
131 
133  virtual void
134  update(const common::xml::dom::Element& element,
136 
137  public:
138  // -- Laser API methods --
139 
141  bool
142  link (ome::compat::shared_ptr<Reference>& reference,
143  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
144 
150  ome::compat::shared_ptr<bool>
151  getPockelCell ();
152 
158  const ome::compat::shared_ptr<bool>
159  getPockelCell () const;
160 
166  void
167  setPockelCell (ome::compat::shared_ptr<bool>& pockelCell);
168 
174  ome::compat::shared_ptr<ome::xml::model::enums::Pulse>
175  getPulse ();
176 
182  const ome::compat::shared_ptr<ome::xml::model::enums::Pulse>
183  getPulse () const;
184 
190  void
191  setPulse (ome::compat::shared_ptr<ome::xml::model::enums::Pulse>& pulse);
192 
198  ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium>
199  getLaserMedium ();
200 
206  const ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium>
207  getLaserMedium () const;
208 
214  void
215  setLaserMedium (ome::compat::shared_ptr<ome::xml::model::enums::LaserMedium>& laserMedium);
216 
222  ome::compat::shared_ptr<bool>
223  getTuneable ();
224 
230  const ome::compat::shared_ptr<bool>
231  getTuneable () const;
232 
238  void
239  setTuneable (ome::compat::shared_ptr<bool>& tuneable);
240 
246  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
247  getWavelength ();
248 
254  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
255  getWavelength () const;
256 
262  void
263  setWavelength (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& wavelength);
264 
270  ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
272 
278  const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
280 
286  void
287  setFrequencyMultiplication (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& frequencyMultiplication);
288 
294  ome::compat::shared_ptr<ome::xml::model::enums::LaserType>
295  getType ();
296 
302  const ome::compat::shared_ptr<ome::xml::model::enums::LaserType>
303  getType () const;
304 
310  void
311  setType (ome::compat::shared_ptr<ome::xml::model::enums::LaserType>& type);
312 
318  ome::compat::shared_ptr<double>
320 
326  const ome::compat::shared_ptr<double>
327  getRepetitionRate () const;
328 
334  void
335  setRepetitionRate (ome::compat::shared_ptr<double>& repetitionRate);
336 
343  ome::compat::weak_ptr<ome::xml::model::LightSource>
344  getLinkedPump ();
345 
352  const ome::compat::weak_ptr<ome::xml::model::LightSource>
353  getLinkedPump () const;
354 
360  void
361  linkPump (ome::compat::shared_ptr<ome::xml::model::LightSource>& pump);
362 
372  void
373  unlinkPump (ome::compat::shared_ptr<ome::xml::model::LightSource>& pump);
374 
375  const std::string&
376  getLightSourceType() const;
377 
380  asXMLElement (common::xml::dom::Document& document) const;
381 
382 
383  protected:
384  // Documented in base class.
387  common::xml::dom::Element& element) const;
388 
389  public:
390  // Documented in superclass.
391  const std::string&
392  getXMLNamespace() const;
393  };
394 
395  }
396  }
397 }
398 
399 #endif // OME_XML_MODEL_LASER_H
400 
401 /*
402  * Local Variables:
403  * mode:C++
404  * End:
405  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
virtual ~Laser()
Destructor.
Definition: Laser.cpp:190
ome::compat::weak_ptr< ome::xml::model::LightSource > getLinkedPump()
Get linked Pump.
Definition: Laser.cpp:504
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:311
ome::compat::shared_ptr< double > getRepetitionRate()
Get the RepetitionRate property.
Definition: Laser.cpp:483
void unlinkPump(ome::compat::shared_ptr< ome::xml::model::LightSource > &pump)
Unlink Pump.
Definition: Laser.cpp:523
void setType(ome::compat::shared_ptr< ome::xml::model::enums::LaserType > &type)
Set the Type property.
Definition: Laser.cpp:476
const std::string & getLightSourceType() const
Get the LightSource type.
Definition: Laser.cpp:532
void setPockelCell(ome::compat::shared_ptr< bool > &pockelCell)
Set the PockelCell property.
Definition: Laser.cpp:350
DOM Document wrapper.
Definition: Document.h:83
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:195
DOM Element wrapper.
Definition: Element.h:66
void linkPump(ome::compat::shared_ptr< ome::xml::model::LightSource > &pump)
Link Pump.
Definition: Laser.cpp:517
void setFrequencyMultiplication(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &frequencyMultiplication)
Set the FrequencyMultiplication property.
Definition: Laser.cpp:455
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:539
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getFrequencyMultiplication()
Get the FrequencyMultiplication property.
Definition: Laser.cpp:441
void setWavelength(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &wavelength)
Set the Wavelength property.
Definition: Laser.cpp:434
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:220
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getWavelength()
Get the Wavelength property.
Definition: Laser.cpp:420
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Laser.cpp:211
ome::compat::shared_ptr< bool > getPockelCell()
Get the PockelCell property.
Definition: Laser.cpp:336
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
Laser()
Default constructor.
Definition: Laser.cpp:171
const std::string & elementName() const
Get the element name of this model object.
Definition: Laser.cpp:204
Laser model object.
Definition: Laser.h:81
ome::compat::shared_ptr< ome::xml::model::enums::Pulse > getPulse()
Get the Pulse property.
Definition: Laser.cpp:357
void setRepetitionRate(ome::compat::shared_ptr< double > &repetitionRate)
Set the RepetitionRate property.
Definition: Laser.cpp:497
Private implementation details of Laser model object.
Definition: Laser.cpp:75
ome::compat::shared_ptr< bool > getTuneable()
Get the Tuneable property.
Definition: Laser.cpp:399
LightSource model object.
Definition: LightSource.h:78
ome::compat::shared_ptr< ome::xml::model::enums::LaserType > getType()
Get the Type property.
Definition: Laser.cpp:462
void setLaserMedium(ome::compat::shared_ptr< ome::xml::model::enums::LaserMedium > &laserMedium)
Set the LaserMedium property.
Definition: Laser.cpp:392
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Laser.h:84
Boost.Log compatibility.
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Laser.cpp:673
ome::compat::shared_ptr< ome::xml::model::enums::LaserMedium > getLaserMedium()
Get the LaserMedium property.
Definition: Laser.cpp:378
void setTuneable(ome::compat::shared_ptr< bool > &tuneable)
Set the Tuneable property.
Definition: Laser.cpp:413
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:546
void setPulse(ome::compat::shared_ptr< ome::xml::model::enums::Pulse > &pulse)
Set the Pulse property.
Definition: Laser.cpp:371
Xerces-C modern C++ wrapper.
Definition: Base.h:53