ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

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/Detector.h>
63 #include <ome/xml/model/Settings.h>
64 #include <ome/xml/model/enums/Binning.h>
65 #include <ome/xml/model/primitives/PositiveInteger.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class OMEModel;
76
80 class DetectorSettings : public Settings
81 {
82 private:
83 class Impl;
85 ome::compat::shared_ptr<Impl> impl;
86
87 public:
89 DetectorSettings();
90
96 DetectorSettings (const DetectorSettings& copy);
97
99 virtual
100 ~DetectorSettings ();
101
116 static ome::compat::shared_ptr< DetectorSettings>
117 create(const common::xml::dom::Element& element,
118 ome::xml::model::OMEModel& model);
119
120 // Documented in superclass.
121 const std::string&
122 elementName() const;
123
124 // Documented in superclass.
125 bool
126 validElementName(const std::string& name) const;
127
128
129 // -- OMEModelObject API methods --
130
132 virtual void
133 update(const common::xml::dom::Element& element,
134 ome::xml::model::OMEModel& model);
135
136 public:
137 // -- DetectorSettings API methods --
138
140 bool
141 link (ome::compat::shared_ptr<Reference>& reference,
142 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
143
149 ome::compat::shared_ptr<double>
150 getZoom ();
151
157 const ome::compat::shared_ptr<double>
158 getZoom () const;
159
165 void
166 setZoom (ome::compat::shared_ptr<double>& zoom);
167
173 ome::compat::shared_ptr<ome::xml::model::enums::Binning>
174 getBinning ();
175
181 const ome::compat::shared_ptr<ome::xml::model::enums::Binning>
182 getBinning () const;
183
189 void
190 setBinning (ome::compat::shared_ptr<ome::xml::model::enums::Binning>& binning);
191
197 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
198 getIntegration ();
199
205 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
206 getIntegration () const;
207
213 void
214 setIntegration (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& integration);
215
221 ome::compat::shared_ptr<double>
222 getReadOutRate ();
223
229 const ome::compat::shared_ptr<double>
230 getReadOutRate () const;
231
237 void
238 setReadOutRate (ome::compat::shared_ptr<double>& readOutRate);
239
245 ome::compat::shared_ptr<double>
246 getGain ();
247
253 const ome::compat::shared_ptr<double>
254 getGain () const;
255
261 void
262 setGain (ome::compat::shared_ptr<double>& gain);
263
269 ome::compat::shared_ptr<double>
270 getOffset ();
271
277 const ome::compat::shared_ptr<double>
278 getOffset () const;
279
285 void
286 setOffset (ome::compat::shared_ptr<double>& offset);
287
293 const std::string&
294 getID () const;
295
301 void
302 setID (const std::string& id);
303
309 ome::compat::shared_ptr<double>
310 getVoltage ();
311
317 const ome::compat::shared_ptr<double>
318 getVoltage () const;
319
325 void
326 setVoltage (ome::compat::shared_ptr<double>& voltage);
327
333 ome::compat::weak_ptr<ome::xml::model::Detector>
334 getDetector ();
335
341 const ome::compat::weak_ptr<ome::xml::model::Detector>
342 getDetector () const;
343
349 void
350 setDetector (ome::compat::weak_ptr<ome::xml::model::Detector>& detector);
351
352
354 virtual common::xml::dom::Element
355 asXMLElement (common::xml::dom::Document& document) const;
356
357
358 protected:
359 // Documented in base class.
360 virtual common::xml::dom::Element
361 asXMLElementInternal (common::xml::dom::Document& document,
362 common::xml::dom::Element& element) const;
363
364 public:
365 // Documented in superclass.
366 const std::string&
367 getXMLNamespace() const;
368 };
369
370 }
371 }
372 }
373
374 #endif // OME_XML_MODEL_DETECTORSETTINGS_H
375
376 /*
377 * Local Variables:
378 * mode:C++
379 * End:
380 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::DetectorSettings::setReadOutRate
void setReadOutRate(ome::compat::shared_ptr< double > &readOutRate)
Set the ReadOutRate property.
Definition: DetectorSettings.cpp:397
ome::xml::model::DetectorSettings::setDetector
void setDetector(ome::compat::weak_ptr< ome::xml::model::Detector > &detector)
Set the Detector property.
Definition: DetectorSettings.cpp:495
ome::xml::model::DetectorSettings::getReadOutRate
ome::compat::shared_ptr< double > getReadOutRate()
Get the ReadOutRate property.
Definition: DetectorSettings.cpp:383
ome::xml::model::DetectorSettings::getVoltage
ome::compat::shared_ptr< double > getVoltage()
Get the Voltage property.
Definition: DetectorSettings.cpp:460
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:208
ome::xml::model::DetectorSettings::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: DetectorSettings.h:83
ome::xml::model::Settings
Settings model object.
Definition: Settings.h:77
ome::xml::model::DetectorSettings::getGain
ome::compat::shared_ptr< double > getGain()
Get the Gain property.
Definition: DetectorSettings.cpp:404
ome::xml::model::DetectorSettings::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: DetectorSettings.cpp:201
ome::xml::model::DetectorSettings::setZoom
void setZoom(ome::compat::shared_ptr< double > &zoom)
Set the Zoom property.
Definition: DetectorSettings.cpp:334
ome::xml::model::DetectorSettings::setBinning
void setBinning(ome::compat::shared_ptr< ome::xml::model::enums::Binning > &binning)
Set the Binning property.
Definition: DetectorSettings.cpp:355
ome::xml::model::DetectorSettings::getDetector
ome::compat::weak_ptr< ome::xml::model::Detector > getDetector()
Get the Detector property.
Definition: DetectorSettings.cpp:481
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:418
ome::xml::model::DetectorSettings::getZoom
ome::compat::shared_ptr< double > getZoom()
Get the Zoom property.
Definition: DetectorSettings.cpp:320
ome::xml::model::DetectorSettings::getIntegration
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getIntegration()
Get the Integration property.
Definition: DetectorSettings.cpp:362
ome::xml::model::DetectorSettings::setIntegration
void setIntegration(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &integration)
Set the Integration property.
Definition: DetectorSettings.cpp:376
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:502
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:305
ome::xml::model::DetectorSettings::Impl
Private implementation details of DetectorSettings model object.
Definition: DetectorSettings.cpp:72
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::DetectorSettings::DetectorSettings
DetectorSettings()
Default constructor.
Definition: DetectorSettings.cpp:168
ome::xml::model::DetectorSettings
DetectorSettings model object.
Definition: DetectorSettings.h:80
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:192
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:217
ome::xml::model::DetectorSettings::getBinning
ome::compat::shared_ptr< ome::xml::model::enums::Binning > getBinning()
Get the Binning property.
Definition: DetectorSettings.cpp:341
ome::xml::model::DetectorSettings::setID
void setID(const std::string &id)
Set the ID property.
Definition: DetectorSettings.cpp:453
ome::xml::model::DetectorSettings::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: DetectorSettings.cpp:619
ome::xml::model::DetectorSettings::getOffset
ome::compat::shared_ptr< double > getOffset()
Get the Offset property.
Definition: DetectorSettings.cpp:425
ome::xml::model::DetectorSettings::getID
const std::string & getID() const
Get the ID property.
Definition: DetectorSettings.cpp:446
ome::xml::model::DetectorSettings::setVoltage
void setVoltage(ome::compat::shared_ptr< double > &voltage)
Set the Voltage property.
Definition: DetectorSettings.cpp:474
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:509
log.h
ome::xml::model::DetectorSettings::~DetectorSettings
virtual ~DetectorSettings()
Destructor.
Definition: DetectorSettings.cpp:187
ome::xml::model::DetectorSettings::setOffset
void setOffset(ome::compat::shared_ptr< double > &offset)
Set the Offset property.
Definition: DetectorSettings.cpp:439