46 #ifndef OME_XML_MODEL_OBJECTIVE_H 47 #define OME_XML_MODEL_OBJECTIVE_H 57 #include <ome/common/xml/dom/Document.h> 58 #include <ome/common/xml/dom/Element.h> 59 #include <ome/common/xml/dom/Node.h> 61 #include <ome/xml/model/primitives/Quantity.h> 63 #include <ome/xml/model/Instrument.h> 64 #include <ome/xml/model/ManufacturerSpec.h> 65 #include <ome/xml/model/enums/Correction.h> 66 #include <ome/xml/model/enums/Immersion.h> 67 #include <ome/xml/model/enums/UnitsLength.h> 88 std::shared_ptr<Impl>
impl;
119 static std::shared_ptr<Objective>
149 link (std::shared_ptr<Reference>& reference,
150 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
157 std::shared_ptr<bool>
165 const std::shared_ptr<bool>
174 setIris (std::shared_ptr<bool>& iris);
181 std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
189 const std::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
205 std::shared_ptr<ome::xml::model::enums::Immersion>
213 const std::shared_ptr<ome::xml::model::enums::Immersion>
222 setImmersion (std::shared_ptr<ome::xml::model::enums::Immersion>& immersion);
229 std::shared_ptr<ome::xml::model::enums::Correction>
237 const std::shared_ptr<ome::xml::model::enums::Correction>
246 setCorrection (std::shared_ptr<ome::xml::model::enums::Correction>& correction);
253 std::shared_ptr<double>
261 const std::shared_ptr<double>
270 setLensNA (std::shared_ptr<double>& lensNA);
277 std::shared_ptr<double>
285 const std::shared_ptr<double>
301 std::shared_ptr<double>
309 const std::shared_ptr<double>
334 setID (
const std::string&
id);
359 const std::weak_ptr<ome::xml::model::Annotation>&
372 const std::weak_ptr<ome::xml::model::Annotation>&
374 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
387 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
405 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
412 std::weak_ptr<ome::xml::model::Instrument>
420 const std::weak_ptr<ome::xml::model::Instrument>
429 setInstrument (std::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
447 #endif // OME_XML_MODEL_OBJECTIVE_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
const std::string & getID() const
Get the ID property.
Definition: Objective.cpp:501
void setInstrument(std::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Objective.cpp:589
static std::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:198
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getWorkingDistance()
Get the WorkingDistance property.
Definition: Objective.cpp:375
void setImmersion(std::shared_ptr< ome::xml::model::enums::Immersion > &immersion)
Set the Immersion property.
Definition: Objective.cpp:410
std::shared_ptr< double > getCalibratedMagnification()
Get the CalibratedMagnification property.
Definition: Objective.cpp:480
std::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Objective.cpp:575
Private implementation details of Objective model object.
Definition: Objective.cpp:76
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Objective.cpp:708
boost::multi_index_container< Ptr< T >, boost::multi_index::indexed_by< boost::multi_index::random_access<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Ptr< T > >, std::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:93
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Objective.cpp:543
void setWorkingDistance(const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &workingDistance)
Set the WorkingDistance property.
Definition: Objective.cpp:389
void setIris(std::shared_ptr< bool > &iris)
Set the Iris property.
Definition: Objective.cpp:368
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Objective.cpp:323
void setNominalMagnification(std::shared_ptr< double > &nominalMagnification)
Set the NominalMagnification property.
Definition: Objective.cpp:473
std::shared_ptr< ome::xml::model::enums::Correction > getCorrection()
Get the Correction property.
Definition: Objective.cpp:417
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
std::shared_ptr< ome::xml::model::enums::Immersion > getImmersion()
Get the Immersion property.
Definition: Objective.cpp:396
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Objective.cpp:557
Open Microscopy Environment C++ implementation.
void setCalibratedMagnification(std::shared_ptr< double > &calibratedMagnification)
Set the CalibratedMagnification property.
Definition: Objective.cpp:494
std::shared_ptr< double > getNominalMagnification()
Get the NominalMagnification property.
Definition: Objective.cpp:459
Objective model object.
Definition: Objective.h:83
std::shared_ptr< bool > getIris()
Get the Iris property.
Definition: Objective.cpp:354
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Objective.cpp:515
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Objective.cpp:214
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:220
virtual void 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:595
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Objective.cpp:521
virtual ~Objective()
Destructor.
Definition: Objective.cpp:193
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:78
void setLensNA(std::shared_ptr< double > &lensNA)
Set the LensNA property.
Definition: Objective.cpp:452
const std::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Objective.cpp:533
A quantity of a defined unit.
Definition: Quantity.h:57
Objective & operator=(const Objective &)
Assignment operator (deleted).
Objective()
Default constructor.
Definition: Objective.cpp:178
void setCorrection(std::shared_ptr< ome::xml::model::enums::Correction > &correction)
Set the Correction property.
Definition: Objective.cpp:431
const std::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Objective.cpp:527
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Objective.h:86
std::shared_ptr< double > getLensNA()
Get the LensNA property.
Definition: Objective.cpp:438
const std::string & elementName() const
Get the element name of this model object.
Definition: Objective.cpp:207
void setID(const std::string &id)
Set the ID property.
Definition: Objective.cpp:508