ome-xml 5.2.0

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

- File List

Detector.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_DETECTOR_H
47 #define OME_XML_MODEL_DETECTOR_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/Instrument.h>
63 #include <ome/xml/model/ManufacturerSpec.h>
64 #include <ome/xml/model/enums/DetectorType.h>
65
66 namespace ome
67 {
68 namespace xml
69 {
70 namespace model
71 {
72
73 // Forward declarations.
74 class OMEModel;
75
79 class Detector : public ManufacturerSpec
80 {
81 private:
82 class Impl;
84 ome::compat::shared_ptr<Impl> impl;
85
86 public:
88 Detector();
89
95 Detector (const Detector& copy);
96
98 virtual
99 ~Detector ();
100
115 static ome::compat::shared_ptr< Detector>
116 create(const common::xml::dom::Element& element,
117 ome::xml::model::OMEModel& model);
118
119 // Documented in superclass.
120 const std::string&
121 elementName() const;
122
123 // Documented in superclass.
124 bool
125 validElementName(const std::string& name) const;
126
127
128 // -- OMEModelObject API methods --
129
131 virtual void
132 update(const common::xml::dom::Element& element,
133 ome::xml::model::OMEModel& model);
134
135 public:
136 // -- Detector API methods --
137
139 bool
140 link (ome::compat::shared_ptr<Reference>& reference,
141 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
142
148 ome::compat::shared_ptr<double>
149 getZoom ();
150
156 const ome::compat::shared_ptr<double>
157 getZoom () const;
158
164 void
165 setZoom (ome::compat::shared_ptr<double>& zoom);
166
172 ome::compat::shared_ptr<double>
173 getAmplificationGain ();
174
180 const ome::compat::shared_ptr<double>
181 getAmplificationGain () const;
182
188 void
189 setAmplificationGain (ome::compat::shared_ptr<double>& amplificationGain);
190
196 ome::compat::shared_ptr<double>
197 getGain ();
198
204 const ome::compat::shared_ptr<double>
205 getGain () const;
206
212 void
213 setGain (ome::compat::shared_ptr<double>& gain);
214
220 ome::compat::shared_ptr<double>
221 getOffset ();
222
228 const ome::compat::shared_ptr<double>
229 getOffset () const;
230
236 void
237 setOffset (ome::compat::shared_ptr<double>& offset);
238
244 ome::compat::shared_ptr<ome::xml::model::enums::DetectorType>
245 getType ();
246
252 const ome::compat::shared_ptr<ome::xml::model::enums::DetectorType>
253 getType () const;
254
260 void
261 setType (ome::compat::shared_ptr<ome::xml::model::enums::DetectorType>& type);
262
268 const std::string&
269 getID () const;
270
276 void
277 setID (const std::string& id);
278
284 ome::compat::shared_ptr<double>
285 getVoltage ();
286
292 const ome::compat::shared_ptr<double>
293 getVoltage () const;
294
300 void
301 setVoltage (ome::compat::shared_ptr<double>& voltage);
302
308 ome::compat::weak_ptr<ome::xml::model::Instrument>
309 getInstrument ();
310
316 const ome::compat::weak_ptr<ome::xml::model::Instrument>
317 getInstrument () const;
318
324 void
325 setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
326
327
329 virtual common::xml::dom::Element
330 asXMLElement (common::xml::dom::Document& document) const;
331
332
333 protected:
334 // Documented in base class.
335 virtual common::xml::dom::Element
336 asXMLElementInternal (common::xml::dom::Document& document,
337 common::xml::dom::Element& element) const;
338
339 public:
340 // Documented in superclass.
341 const std::string&
342 getXMLNamespace() const;
343 };
344
345 }
346 }
347 }
348
349 #endif // OME_XML_MODEL_DETECTOR_H
350
351 /*
352 * Local Variables:
353 * mode:C++
354 * End:
355 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Detector::setInstrument
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Detector.cpp:458
ome::xml::model::Detector::getID
const std::string & getID() const
Get the ID property.
Definition: Detector.cpp:409
ome::xml::model::Detector::setVoltage
void setVoltage(ome::compat::shared_ptr< double > &voltage)
Set the Voltage property.
Definition: Detector.cpp:437
ome::xml::model::Detector::setAmplificationGain
void setAmplificationGain(ome::compat::shared_ptr< double > &amplificationGain)
Set the AmplificationGain property.
Definition: Detector.cpp:339
ome::xml::model::Detector::getVoltage
ome::compat::shared_ptr< double > getVoltage()
Get the Voltage property.
Definition: Detector.cpp:423
ome::xml::model::Detector::getOffset
ome::compat::shared_ptr< double > getOffset()
Get the Offset property.
Definition: Detector.cpp:367
ome::xml::model::Detector::setOffset
void setOffset(ome::compat::shared_ptr< double > &offset)
Set the Offset property.
Definition: Detector.cpp:381
ome::xml::model::Detector::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Detector.cpp:465
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Detector::setID
void setID(const std::string &id)
Set the ID property.
Definition: Detector.cpp:416
ome::xml::model::Detector::setZoom
void setZoom(ome::compat::shared_ptr< double > &zoom)
Set the Zoom property.
Definition: Detector.cpp:318
ome::xml::model::Detector::Impl
Private implementation details of Detector model object.
Definition: Detector.cpp:72
ome::xml::model::Detector::setType
void setType(ome::compat::shared_ptr< ome::xml::model::enums::DetectorType > &type)
Set the Type property.
Definition: Detector.cpp:402
ome::xml::model::Detector::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: Detector.cpp:289
ome::xml::model::Detector::create
static ome::compat::shared_ptr< Detector > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Detector model object from DOM element.
Definition: Detector.cpp:185
ome::xml::model::Detector::getType
ome::compat::shared_ptr< ome::xml::model::enums::DetectorType > getType()
Get the Type property.
Definition: Detector.cpp:388
ome::xml::model::Detector
Detector model object.
Definition: Detector.h:79
ome::xml::model::Detector::getInstrument
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Detector.cpp:444
ome::xml::model::Detector::getZoom
ome::compat::shared_ptr< double > getZoom()
Get the Zoom property.
Definition: Detector.cpp:304
ome::xml::model::Detector::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Detector.h:82
ome::xml::model::Detector::setGain
void setGain(ome::compat::shared_ptr< double > &gain)
Set the Gain property.
Definition: Detector.cpp:360
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Detector::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Detector.cpp:570
ome::xml::model::Detector::Detector
Detector()
Default constructor.
Definition: Detector.cpp:161
ome::xml::model::Detector::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: Detector.cpp:472
ome::xml::model::Detector::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Detector.cpp:201
ome::xml::model::Detector::getGain
ome::compat::shared_ptr< double > getGain()
Get the Gain property.
Definition: Detector.cpp:346
ome::xml::model::Detector::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Detector.cpp:194
ome::xml::model::ManufacturerSpec
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:77
ome::xml::model::Detector::~Detector
virtual ~Detector()
Destructor.
Definition: Detector.cpp:180
ome::xml::model::Detector::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: Detector.cpp:210
ome::xml::model::Detector::getAmplificationGain
ome::compat::shared_ptr< double > getAmplificationGain()
Get the AmplificationGain property.
Definition: Detector.cpp:325
log.h