ome-xml 5.2.3

DetectorSettings.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_DETECTORSETTINGS_H
47 #define OME_XML_MODEL_DETECTORSETTINGS_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/Detector.h>
65 #include <ome/xml/model/Settings.h>
66 #include <ome/xml/model/enums/Binning.h>
67 #include <ome/xml/model/enums/UnitsElectricPotential.h>
68 #include <ome/xml/model/enums/UnitsFrequency.h>
69 #include <ome/xml/model/primitives/PositiveInteger.h>
70
71 namespace ome
72 {
73 namespace xml
74 {
75 namespace model
76 {
77
78 // Forward declarations.
79 class OMEModel;
80
84 class DetectorSettings : public Settings
85 {
86 private:
87 class Impl;
89 ome::compat::shared_ptr<Impl> impl;
90
91 public:
93 DetectorSettings();
94
100 DetectorSettings (const DetectorSettings& copy);
101
103 virtual
104 ~DetectorSettings ();
105
120 static ome::compat::shared_ptr< DetectorSettings>
121 create(const common::xml::dom::Element& element,
122 ome::xml::model::OMEModel& model);
123
124 // Documented in superclass.
125 const std::string&
126 elementName() const;
127
128 // Documented in superclass.
129 bool
130 validElementName(const std::string& name) const;
131
132 private:
134 DetectorSettings&
135 operator= (const DetectorSettings&);
136
137 public:
138 // -- OMEModelObject API methods --
139
141 virtual void
142 update(const common::xml::dom::Element& element,
143 ome::xml::model::OMEModel& model);
144
145 public:
146 // -- DetectorSettings API methods --
147
149 bool
150 link (ome::compat::shared_ptr<Reference>& reference,
151 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
152
158 ome::compat::shared_ptr<double>
159 getZoom ();
160
166 const ome::compat::shared_ptr<double>
167 getZoom () const;
168
174 void
175 setZoom (ome::compat::shared_ptr<double>& zoom);
176
182 ome::compat::shared_ptr<ome::xml::model::enums::Binning>
183 getBinning ();
184
190 const ome::compat::shared_ptr<ome::xml::model::enums::Binning>
191 getBinning () const;
192
198 void
199 setBinning (ome::compat::shared_ptr<ome::xml::model::enums::Binning>& binning);
200
206 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
207 getIntegration ();
208
214 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
215 getIntegration () const;
216
222 void
223 setIntegration (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& integration);
224
230 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsFrequency > >&
231 getReadOutRate ();
232
238 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsFrequency > >&
239 getReadOutRate () const;
240
246 void
247 setReadOutRate (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsFrequency > >& readOutRate);
248
254 ome::compat::shared_ptr<double>
255 getGain ();
256
262 const ome::compat::shared_ptr<double>
263 getGain () const;
264
270 void
271 setGain (ome::compat::shared_ptr<double>& gain);
272
278 ome::compat::shared_ptr<double>
279 getOffset ();
280
286 const ome::compat::shared_ptr<double>
287 getOffset () const;
288
294 void
295 setOffset (ome::compat::shared_ptr<double>& offset);
296
302 const std::string&
303 getID () const;
304
310 void
311 setID (const std::string& id);
312
318 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsElectricPotential > >&
319 getVoltage ();
320
326 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsElectricPotential > >&
327 getVoltage () const;
328
334 void
335 setVoltage (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsElectricPotential > >& voltage);
336
342 ome::compat::weak_ptr<ome::xml::model::Detector>
343 getDetector ();
344
350 const ome::compat::weak_ptr<ome::xml::model::Detector>
351 getDetector () const;
352
358 void
359 setDetector (ome::compat::weak_ptr<ome::xml::model::Detector>& detector);
360
362 virtual common::xml::dom::Element
363 asXMLElement (common::xml::dom::Document& document) const;
364
365
366 protected:
367 // Documented in base class.
368 virtual common::xml::dom::Element
369 asXMLElementInternal (common::xml::dom::Document& document,
370 common::xml::dom::Element& element) const;
371
372 public:
373 // Documented in superclass.
374 const std::string&
375 getXMLNamespace() const;
376 };
377
378 }
379 }
380 }
381
382 #endif // OME_XML_MODEL_DETECTORSETTINGS_H
383
384 /*
385 * Local Variables:
386 * mode:C++
387 * End:
388 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::DetectorSettings::setDetector
void setDetector(ome::compat::weak_ptr< ome::xml::model::Detector > &detector)
Set the Detector property.
Definition: DetectorSettings.cpp:504
ome::xml::model::DetectorSettings::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: DetectorSettings.h:87
ome::xml::model::DetectorSettings::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: DetectorSettings.cpp:198
ome::xml::model::Settings
Settings model object.
Definition: Settings.h:79
ome::xml::model::DetectorSettings::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: DetectorSettings.cpp:517
ome::xml::model::DetectorSettings::getReadOutRate
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > > & getReadOutRate()
Get the ReadOutRate property.
Definition: DetectorSettings.cpp:392
ome::xml::model::DetectorSettings::setVoltage
void setVoltage(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential > > &voltage)
Set the Voltage property.
Definition: DetectorSettings.cpp:483
ome::xml::model::DetectorSettings::getGain
ome::compat::shared_ptr< double > getGain()
Get the Gain property.
Definition: DetectorSettings.cpp:413
ome::xml::model::DetectorSettings::setZoom
void setZoom(ome::compat::shared_ptr< double > &zoom)
Set the Zoom property.
Definition: DetectorSettings.cpp:343
ome::xml::model::DetectorSettings::setBinning
void setBinning(ome::compat::shared_ptr< ome::xml::model::enums::Binning > &binning)
Set the Binning property.
Definition: DetectorSettings.cpp:364
ome::xml::model::DetectorSettings::getDetector
ome::compat::weak_ptr< ome::xml::model::Detector > getDetector()
Get the Detector property.
Definition: DetectorSettings.cpp:490
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::DetectorSettings::setGain
void setGain(ome::compat::shared_ptr< double > &gain)
Set the Gain property.
Definition: DetectorSettings.cpp:427
ome::xml::model::DetectorSettings::getZoom
ome::compat::shared_ptr< double > getZoom()
Get the Zoom property.
Definition: DetectorSettings.cpp:329
ome::xml::model::DetectorSettings::getIntegration
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getIntegration()
Get the Integration property.
Definition: DetectorSettings.cpp:371
ome::xml::model::DetectorSettings::getVoltage
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential > > & getVoltage()
Get the Voltage property.
Definition: DetectorSettings.cpp:469
ome::xml::model::DetectorSettings::setIntegration
void setIntegration(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &integration)
Set the Integration property.
Definition: DetectorSettings.cpp:385
ome::xml::model::DetectorSettings::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: DetectorSettings.cpp:314
ome::xml::model::DetectorSettings::Impl
Private implementation details of DetectorSettings model object.
Definition: DetectorSettings.cpp:74
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::DetectorSettings::DetectorSettings
DetectorSettings()
Default constructor.
Definition: DetectorSettings.cpp:169
ome::xml::model::DetectorSettings::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: DetectorSettings.cpp:510
ome::xml::model::DetectorSettings
DetectorSettings model object.
Definition: DetectorSettings.h:84
ome::xml::model::DetectorSettings::getID
const std::string & getID() const
Get the ID property.
Definition: DetectorSettings.cpp:455
ome::xml::model::DetectorSettings::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: DetectorSettings.cpp:205
ome::xml::model::DetectorSettings::create
static ome::compat::shared_ptr< DetectorSettings > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a DetectorSettings model object from DOM element.
Definition: DetectorSettings.cpp:189
ome::xml::model::DetectorSettings::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: DetectorSettings.cpp:213
ome::xml::model::DetectorSettings::getBinning
ome::compat::shared_ptr< ome::xml::model::enums::Binning > getBinning()
Get the Binning property.
Definition: DetectorSettings.cpp:350
ome::xml::model::DetectorSettings::operator=
DetectorSettings & operator=(const DetectorSettings &)
Assignment operator (deleted).
ome::xml::model::DetectorSettings::setID
void setID(const std::string &id)
Set the ID property.
Definition: DetectorSettings.cpp:462
ome::xml::model::DetectorSettings::getOffset
ome::compat::shared_ptr< double > getOffset()
Get the Offset property.
Definition: DetectorSettings.cpp:434
ome::xml::model::primitives::Quantity
A quantity of a defined unit.
Definition: Quantity.h:57
ome::xml::model::DetectorSettings::setReadOutRate
void setReadOutRate(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > > &readOutRate)
Set the ReadOutRate property.
Definition: DetectorSettings.cpp:406
ome::xml::model::DetectorSettings::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: DetectorSettings.cpp:627
log.h
ome::xml::model::DetectorSettings::~DetectorSettings
virtual ~DetectorSettings()
Destructor.
Definition: DetectorSettings.cpp:184
ome::xml::model::DetectorSettings::setOffset
void setOffset(ome::compat::shared_ptr< double > &offset)
Set the Offset property.
Definition: DetectorSettings.cpp:448