ome-xml 5.2.3

ObjectiveSettings.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_OBJECTIVESETTINGS_H
47 #define OME_XML_MODEL_OBJECTIVESETTINGS_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/Objective.h>
65 #include <ome/xml/model/Settings.h>
66 #include <ome/xml/model/enums/Medium.h>
67
68 namespace ome
69 {
70 namespace xml
71 {
72 namespace model
73 {
74
75 // Forward declarations.
76 class OMEModel;
77
81 class ObjectiveSettings : public Settings
82 {
83 private:
84 class Impl;
86 ome::compat::shared_ptr<Impl> impl;
87
88 public:
90 ObjectiveSettings();
91
97 ObjectiveSettings (const ObjectiveSettings& copy);
98
100 virtual
101 ~ObjectiveSettings ();
102
117 static ome::compat::shared_ptr< ObjectiveSettings>
118 create(const common::xml::dom::Element& element,
119 ome::xml::model::OMEModel& model);
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 private:
131 ObjectiveSettings&
132 operator= (const ObjectiveSettings&);
133
134 public:
135 // -- OMEModelObject API methods --
136
138 virtual void
139 update(const common::xml::dom::Element& element,
140 ome::xml::model::OMEModel& model);
141
142 public:
143 // -- ObjectiveSettings API methods --
144
146 bool
147 link (ome::compat::shared_ptr<Reference>& reference,
148 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
149
155 ome::compat::shared_ptr<double>
156 getRefractiveIndex ();
157
163 const ome::compat::shared_ptr<double>
164 getRefractiveIndex () const;
165
171 void
172 setRefractiveIndex (ome::compat::shared_ptr<double>& refractiveIndex);
173
179 ome::compat::shared_ptr<double>
180 getCorrectionCollar ();
181
187 const ome::compat::shared_ptr<double>
188 getCorrectionCollar () const;
189
195 void
196 setCorrectionCollar (ome::compat::shared_ptr<double>& correctionCollar);
197
203 const std::string&
204 getID () const;
205
211 void
212 setID (const std::string& id);
213
219 ome::compat::shared_ptr<ome::xml::model::enums::Medium>
220 getMedium ();
221
227 const ome::compat::shared_ptr<ome::xml::model::enums::Medium>
228 getMedium () const;
229
235 void
236 setMedium (ome::compat::shared_ptr<ome::xml::model::enums::Medium>& medium);
237
243 ome::compat::weak_ptr<ome::xml::model::Objective>
244 getObjective ();
245
251 const ome::compat::weak_ptr<ome::xml::model::Objective>
252 getObjective () const;
253
259 void
260 setObjective (ome::compat::weak_ptr<ome::xml::model::Objective>& objective);
261
263 virtual common::xml::dom::Element
264 asXMLElement (common::xml::dom::Document& document) const;
265
266
267 protected:
268 // Documented in base class.
269 virtual common::xml::dom::Element
270 asXMLElementInternal (common::xml::dom::Document& document,
271 common::xml::dom::Element& element) const;
272
273 public:
274 // Documented in superclass.
275 const std::string&
276 getXMLNamespace() const;
277 };
278
279 }
280 }
281 }
282
283 #endif // OME_XML_MODEL_OBJECTIVESETTINGS_H
284
285 /*
286 * Local Variables:
287 * mode:C++
288 * End:
289 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::ObjectiveSettings::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ObjectiveSettings.cpp:417
ome::xml::model::Settings
Settings model object.
Definition: Settings.h:79
ome::xml::model::ObjectiveSettings::setMedium
void setMedium(ome::compat::shared_ptr< ome::xml::model::enums::Medium > &medium)
Set the Medium property.
Definition: ObjectiveSettings.cpp:321
ome::xml::model::ObjectiveSettings::getID
const std::string & getID() const
Get the ID property.
Definition: ObjectiveSettings.cpp:293
ome::xml::model::ObjectiveSettings::getObjective
ome::compat::weak_ptr< ome::xml::model::Objective > getObjective()
Get the Objective property.
Definition: ObjectiveSettings.cpp:328
ome::xml::model::ObjectiveSettings::setID
void setID(const std::string &id)
Set the ID property.
Definition: ObjectiveSettings.cpp:300
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::ObjectiveSettings::operator=
ObjectiveSettings & operator=(const ObjectiveSettings &)
Assignment operator (deleted).
ome::xml::model::ObjectiveSettings::setCorrectionCollar
void setCorrectionCollar(ome::compat::shared_ptr< double > &correctionCollar)
Set the CorrectionCollar property.
Definition: ObjectiveSettings.cpp:286
ome::xml::model::ObjectiveSettings::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: ObjectiveSettings.cpp:168
ome::xml::model::ObjectiveSettings::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: ObjectiveSettings.cpp:348
ome::xml::model::ObjectiveSettings::setRefractiveIndex
void setRefractiveIndex(ome::compat::shared_ptr< double > &refractiveIndex)
Set the RefractiveIndex property.
Definition: ObjectiveSettings.cpp:265
ome::xml::model::ObjectiveSettings::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: ObjectiveSettings.cpp:175
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::ObjectiveSettings::getMedium
ome::compat::shared_ptr< ome::xml::model::enums::Medium > getMedium()
Get the Medium property.
Definition: ObjectiveSettings.cpp:307
ome::xml::model::ObjectiveSettings::ObjectiveSettings
ObjectiveSettings()
Default constructor.
Definition: ObjectiveSettings.cpp:139
ome::xml::model::ObjectiveSettings
ObjectiveSettings model object.
Definition: ObjectiveSettings.h:81
ome::xml::model::ObjectiveSettings::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: ObjectiveSettings.cpp:236
ome::xml::model::ObjectiveSettings::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: ObjectiveSettings.cpp:183
ome::xml::model::ObjectiveSettings::Impl
Private implementation details of ObjectiveSettings model object.
Definition: ObjectiveSettings.cpp:72
ome::xml::model::ObjectiveSettings::setObjective
void setObjective(ome::compat::weak_ptr< ome::xml::model::Objective > &objective)
Set the Objective property.
Definition: ObjectiveSettings.cpp:342
ome::xml::model::ObjectiveSettings::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: ObjectiveSettings.cpp:355
ome::xml::model::ObjectiveSettings::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: ObjectiveSettings.h:84
ome::xml::model::ObjectiveSettings::~ObjectiveSettings
virtual ~ObjectiveSettings()
Destructor.
Definition: ObjectiveSettings.cpp:154
ome::xml::model::ObjectiveSettings::getCorrectionCollar
ome::compat::shared_ptr< double > getCorrectionCollar()
Get the CorrectionCollar property.
Definition: ObjectiveSettings.cpp:272
ome::xml::model::ObjectiveSettings::getRefractiveIndex
ome::compat::shared_ptr< double > getRefractiveIndex()
Get the RefractiveIndex property.
Definition: ObjectiveSettings.cpp:251
log.h
ome::xml::model::ObjectiveSettings::create
static ome::compat::shared_ptr< ObjectiveSettings > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a ObjectiveSettings model object from DOM element.
Definition: ObjectiveSettings.cpp:159