ome-xml 5.2.0

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

- File List

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/Objective.h>
63 #include <ome/xml/model/Settings.h>
64 #include <ome/xml/model/enums/Medium.h>
65
66 namespace ome
67 {
68 namespace xml
69 {
70 namespace model
71 {
72
73 // Forward declarations.
74 class OMEModel;
75
79 class ObjectiveSettings : public Settings
80 {
81 private:
82 class Impl;
84 ome::compat::shared_ptr<Impl> impl;
85
86 public:
88 ObjectiveSettings();
89
95 ObjectiveSettings (const ObjectiveSettings& copy);
96
98 virtual
99 ~ObjectiveSettings ();
100
115 static ome::compat::shared_ptr< ObjectiveSettings>
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 // -- ObjectiveSettings 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 getRefractiveIndex ();
150
156 const ome::compat::shared_ptr<double>
157 getRefractiveIndex () const;
158
164 void
165 setRefractiveIndex (ome::compat::shared_ptr<double>& refractiveIndex);
166
172 ome::compat::shared_ptr<double>
173 getCorrectionCollar ();
174
180 const ome::compat::shared_ptr<double>
181 getCorrectionCollar () const;
182
188 void
189 setCorrectionCollar (ome::compat::shared_ptr<double>& correctionCollar);
190
196 const std::string&
197 getID () const;
198
204 void
205 setID (const std::string& id);
206
212 ome::compat::shared_ptr<ome::xml::model::enums::Medium>
213 getMedium ();
214
220 const ome::compat::shared_ptr<ome::xml::model::enums::Medium>
221 getMedium () const;
222
228 void
229 setMedium (ome::compat::shared_ptr<ome::xml::model::enums::Medium>& medium);
230
236 ome::compat::weak_ptr<ome::xml::model::Objective>
237 getObjective ();
238
244 const ome::compat::weak_ptr<ome::xml::model::Objective>
245 getObjective () const;
246
252 void
253 setObjective (ome::compat::weak_ptr<ome::xml::model::Objective>& objective);
254
255
257 virtual common::xml::dom::Element
258 asXMLElement (common::xml::dom::Document& document) const;
259
260
261 protected:
262 // Documented in base class.
263 virtual common::xml::dom::Element
264 asXMLElementInternal (common::xml::dom::Document& document,
265 common::xml::dom::Element& element) const;
266
267 public:
268 // Documented in superclass.
269 const std::string&
270 getXMLNamespace() const;
271 };
272
273 }
274 }
275 }
276
277 #endif // OME_XML_MODEL_OBJECTIVESETTINGS_H
278
279 /*
280 * Local Variables:
281 * mode:C++
282 * End:
283 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Settings
Settings model object.
Definition: Settings.h:77
ome::xml::model::ObjectiveSettings::setMedium
void setMedium(ome::compat::shared_ptr< ome::xml::model::enums::Medium > &medium)
Set the Medium property.
Definition: ObjectiveSettings.cpp:326
ome::xml::model::ObjectiveSettings::getObjective
ome::compat::weak_ptr< ome::xml::model::Objective > getObjective()
Get the Objective property.
Definition: ObjectiveSettings.cpp:333
ome::xml::model::ObjectiveSettings::setID
void setID(const std::string &id)
Set the ID property.
Definition: ObjectiveSettings.cpp:305
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::ObjectiveSettings::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ObjectiveSettings.cpp:423
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:180
ome::xml::model::ObjectiveSettings::setCorrectionCollar
void setCorrectionCollar(ome::compat::shared_ptr< double > &correctionCollar)
Set the CorrectionCollar property.
Definition: ObjectiveSettings.cpp:291
ome::xml::model::ObjectiveSettings::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: ObjectiveSettings.cpp:173
ome::xml::model::ObjectiveSettings::setRefractiveIndex
void setRefractiveIndex(ome::compat::shared_ptr< double > &refractiveIndex)
Set the RefractiveIndex property.
Definition: ObjectiveSettings.cpp:270
ome
Open Microscopy Environment C++ implementation.
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:361
ome::xml::model::ObjectiveSettings::getMedium
ome::compat::shared_ptr< ome::xml::model::enums::Medium > getMedium()
Get the Medium property.
Definition: ObjectiveSettings.cpp:312
ome::xml::model::ObjectiveSettings::ObjectiveSettings
ObjectiveSettings()
Default constructor.
Definition: ObjectiveSettings.cpp:140
ome::xml::model::ObjectiveSettings
ObjectiveSettings model object.
Definition: ObjectiveSettings.h:79
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:241
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:189
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:354
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:347
ome::xml::model::ObjectiveSettings::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: ObjectiveSettings.h:82
ome::xml::model::ObjectiveSettings::~ObjectiveSettings
virtual ~ObjectiveSettings()
Destructor.
Definition: ObjectiveSettings.cpp:159
ome::xml::model::ObjectiveSettings::getCorrectionCollar
ome::compat::shared_ptr< double > getCorrectionCollar()
Get the CorrectionCollar property.
Definition: ObjectiveSettings.cpp:277
ome::xml::model::ObjectiveSettings::getRefractiveIndex
ome::compat::shared_ptr< double > getRefractiveIndex()
Get the RefractiveIndex property.
Definition: ObjectiveSettings.cpp:256
log.h
ome::xml::model::ObjectiveSettings::getID
const std::string & getID() const
Get the ID property.
Definition: ObjectiveSettings.cpp:298
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:164