ome-xml  5.2.0
Objective.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_OBJECTIVE_H
47 #define OME_XML_MODEL_OBJECTIVE_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/Correction.h>
65 #include <ome/xml/model/enums/Immersion.h>
66 
67 namespace ome
68 {
69  namespace xml
70  {
71  namespace model
72  {
73 
74  // Forward declarations.
75  class OMEModel;
76 
80  class Objective : public ManufacturerSpec
81  {
82  private:
83  class Impl;
85  ome::compat::shared_ptr<Impl> impl;
86 
87  public:
89  Objective();
90 
96  Objective (const Objective& copy);
97 
99  virtual
100  ~Objective ();
101 
116  static ome::compat::shared_ptr< Objective>
117  create(const common::xml::dom::Element& element,
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,
135 
136  public:
137  // -- Objective 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<bool>
150  getIris ();
151 
157  const ome::compat::shared_ptr<bool>
158  getIris () const;
159 
165  void
166  setIris (ome::compat::shared_ptr<bool>& iris);
167 
173  ome::compat::shared_ptr<double>
175 
181  const ome::compat::shared_ptr<double>
182  getWorkingDistance () const;
183 
189  void
190  setWorkingDistance (ome::compat::shared_ptr<double>& workingDistance);
191 
197  ome::compat::shared_ptr<ome::xml::model::enums::Immersion>
198  getImmersion ();
199 
205  const ome::compat::shared_ptr<ome::xml::model::enums::Immersion>
206  getImmersion () const;
207 
213  void
214  setImmersion (ome::compat::shared_ptr<ome::xml::model::enums::Immersion>& immersion);
215 
221  ome::compat::shared_ptr<ome::xml::model::enums::Correction>
222  getCorrection ();
223 
229  const ome::compat::shared_ptr<ome::xml::model::enums::Correction>
230  getCorrection () const;
231 
237  void
238  setCorrection (ome::compat::shared_ptr<ome::xml::model::enums::Correction>& correction);
239 
245  ome::compat::shared_ptr<double>
246  getLensNA ();
247 
253  const ome::compat::shared_ptr<double>
254  getLensNA () const;
255 
261  void
262  setLensNA (ome::compat::shared_ptr<double>& lensNA);
263 
269  ome::compat::shared_ptr<double>
271 
277  const ome::compat::shared_ptr<double>
278  getNominalMagnification () const;
279 
285  void
286  setNominalMagnification (ome::compat::shared_ptr<double>& nominalMagnification);
287 
293  ome::compat::shared_ptr<double>
295 
301  const ome::compat::shared_ptr<double>
303 
309  void
310  setCalibratedMagnification (ome::compat::shared_ptr<double>& calibratedMagnification);
311 
317  const std::string&
318  getID () const;
319 
325  void
326  setID (const std::string& id);
327 
333  ome::compat::weak_ptr<ome::xml::model::Instrument>
334  getInstrument ();
335 
341  const ome::compat::weak_ptr<ome::xml::model::Instrument>
342  getInstrument () const;
343 
349  void
350  setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
351 
352 
355  asXMLElement (common::xml::dom::Document& document) const;
356 
357 
358  protected:
359  // Documented in base class.
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_OBJECTIVE_H
375 
376 /*
377  * Local Variables:
378  * mode:C++
379  * End:
380  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
void setImmersion(ome::compat::shared_ptr< ome::xml::model::enums::Immersion > &immersion)
Set the Immersion property.
Definition: Objective.cpp:375
ome::compat::shared_ptr< double > getWorkingDistance()
Get the WorkingDistance property.
Definition: Objective.cpp:340
void setWorkingDistance(ome::compat::shared_ptr< double > &workingDistance)
Set the WorkingDistance property.
Definition: Objective.cpp:354
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Objective.cpp:618
Private implementation details of Objective model object.
Definition: Objective.cpp:73
void setNominalMagnification(ome::compat::shared_ptr< double > &nominalMagnification)
Set the NominalMagnification property.
Definition: Objective.cpp:438
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Objective.cpp:209
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Objective.cpp:480
void setLensNA(ome::compat::shared_ptr< double > &lensNA)
Set the LensNA property.
Definition: Objective.cpp:417
ome::compat::shared_ptr< double > getNominalMagnification()
Get the NominalMagnification property.
Definition: Objective.cpp:424
ome::compat::shared_ptr< double > getLensNA()
Get the LensNA property.
Definition: Objective.cpp:403
static ome::compat::shared_ptr< Objective > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Objective model object from DOM element.
Definition: Objective.cpp:193
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: Objective.cpp:304
Open Microscopy Environment C++ implementation.
ome::compat::shared_ptr< ome::xml::model::enums::Correction > getCorrection()
Get the Correction property.
Definition: Objective.cpp:382
void setCalibratedMagnification(ome::compat::shared_ptr< double > &calibratedMagnification)
Set the CalibratedMagnification property.
Definition: Objective.cpp:459
Objective model object.
Definition: Objective.h:80
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: Objective.cpp:218
void setCorrection(ome::compat::shared_ptr< ome::xml::model::enums::Correction > &correction)
Set the Correction property.
Definition: Objective.cpp:396
const std::string & getID() const
Get the ID property.
Definition: Objective.cpp:466
virtual ~Objective()
Destructor.
Definition: Objective.cpp:188
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:77
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Objective.h:83
ome::compat::shared_ptr< ome::xml::model::enums::Immersion > getImmersion()
Get the Immersion property.
Definition: Objective.cpp:361
void setIris(ome::compat::shared_ptr< bool > &iris)
Set the Iris property.
Definition: Objective.cpp:333
Objective()
Default constructor.
Definition: Objective.cpp:169
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Objective.cpp:494
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: Objective.cpp:508
ome::compat::shared_ptr< double > getCalibratedMagnification()
Get the CalibratedMagnification property.
Definition: Objective.cpp:445
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Objective.cpp:501
ome::compat::shared_ptr< bool > getIris()
Get the Iris property.
Definition: Objective.cpp:319
void setID(const std::string &id)
Set the ID property.
Definition: Objective.cpp:473
const std::string & elementName() const
Get the element name of this model object.
Definition: Objective.cpp:202