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> 60 #include <ome/common/xml/dom/NodeList.h> 62 #include <ome/xml/model/primitives/Quantity.h> 64 #include <ome/xml/model/Instrument.h> 65 #include <ome/xml/model/ManufacturerSpec.h> 66 #include <ome/xml/model/enums/Correction.h> 67 #include <ome/xml/model/enums/Immersion.h> 68 #include <ome/xml/model/enums/UnitsLength.h> 89 ome::compat::shared_ptr<Impl>
impl;
120 static ome::compat::shared_ptr< Objective>
150 link (ome::compat::shared_ptr<Reference>& reference,
151 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
158 ome::compat::shared_ptr<bool>
166 const ome::compat::shared_ptr<bool>
175 setIris (ome::compat::shared_ptr<bool>& iris);
182 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
190 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
206 ome::compat::shared_ptr<ome::xml::model::enums::Immersion>
214 const ome::compat::shared_ptr<ome::xml::model::enums::Immersion>
223 setImmersion (ome::compat::shared_ptr<ome::xml::model::enums::Immersion>& immersion);
230 ome::compat::shared_ptr<ome::xml::model::enums::Correction>
238 const ome::compat::shared_ptr<ome::xml::model::enums::Correction>
247 setCorrection (ome::compat::shared_ptr<ome::xml::model::enums::Correction>& correction);
254 ome::compat::shared_ptr<double>
262 const ome::compat::shared_ptr<double>
271 setLensNA (ome::compat::shared_ptr<double>& lensNA);
278 ome::compat::shared_ptr<double>
286 const ome::compat::shared_ptr<double>
302 ome::compat::shared_ptr<double>
310 const ome::compat::shared_ptr<double>
335 setID (
const std::string&
id);
360 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
373 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
375 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
388 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
406 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
413 ome::compat::weak_ptr<ome::xml::model::Instrument>
421 const ome::compat::weak_ptr<ome::xml::model::Instrument>
430 setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
453 #endif // OME_XML_MODEL_OBJECTIVE_H 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:414
const std::string & getID() const
Get the ID property.
Definition: Objective.cpp:505
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Objective.cpp:519
Private implementation details of Objective model object.
Definition: Objective.cpp:76
void setNominalMagnification(ome::compat::shared_ptr< double > &nominalMagnification)
Set the NominalMagnification property.
Definition: Objective.cpp:477
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Objective.cpp:738
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Objective.cpp:525
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 > >, ome::compat::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:94
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Objective.cpp:547
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Objective.cpp:579
void setLensNA(ome::compat::shared_ptr< double > &lensNA)
Set the LensNA property.
Definition: Objective.cpp:456
ome::compat::shared_ptr< double > getNominalMagnification()
Get the NominalMagnification property.
Definition: Objective.cpp:463
ome::compat::shared_ptr< double > getLensNA()
Get the LensNA property.
Definition: Objective.cpp:442
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Objective.cpp:537
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:198
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:327
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
Open Microscopy Environment C++ implementation.
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getWorkingDistance()
Get the WorkingDistance property.
Definition: Objective.cpp:379
ome::compat::shared_ptr< ome::xml::model::enums::Correction > getCorrection()
Get the Correction property.
Definition: Objective.cpp:421
void setCalibratedMagnification(ome::compat::shared_ptr< double > &calibratedMagnification)
Set the CalibratedMagnification property.
Definition: Objective.cpp:498
Objective model object.
Definition: Objective.h:84
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:222
void setCorrection(ome::compat::shared_ptr< ome::xml::model::enums::Correction > &correction)
Set the Correction property.
Definition: Objective.cpp:435
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Objective.cpp:561
virtual ~Objective()
Destructor.
Definition: Objective.cpp:193
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:79
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Objective.h:87
ome::compat::shared_ptr< ome::xml::model::enums::Immersion > getImmersion()
Get the Immersion property.
Definition: Objective.cpp:400
void setIris(ome::compat::shared_ptr< bool > &iris)
Set the Iris property.
Definition: Objective.cpp:372
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 setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Objective.cpp:593
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Objective.cpp:531
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:606
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:599
void setWorkingDistance(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &workingDistance)
Set the WorkingDistance property.
Definition: Objective.cpp:393
ome::compat::shared_ptr< double > getCalibratedMagnification()
Get the CalibratedMagnification property.
Definition: Objective.cpp:484
ome::compat::shared_ptr< bool > getIris()
Get the Iris property.
Definition: Objective.cpp:358
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:512