46 #ifndef OME_XML_MODEL_DETECTOR_H 47 #define OME_XML_MODEL_DETECTOR_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/DetectorType.h> 67 #include <ome/xml/model/enums/UnitsElectricPotential.h> 88 ome::compat::shared_ptr<Impl>
impl;
119 static ome::compat::shared_ptr< Detector>
149 link (ome::compat::shared_ptr<Reference>& reference,
150 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
157 ome::compat::shared_ptr<double>
165 const ome::compat::shared_ptr<double>
174 setZoom (ome::compat::shared_ptr<double>& zoom);
181 ome::compat::shared_ptr<double>
189 const ome::compat::shared_ptr<double>
205 ome::compat::shared_ptr<double>
213 const ome::compat::shared_ptr<double>
222 setGain (ome::compat::shared_ptr<double>& gain);
229 ome::compat::shared_ptr<double>
237 const ome::compat::shared_ptr<double>
246 setOffset (ome::compat::shared_ptr<double>& offset);
253 ome::compat::shared_ptr<ome::xml::model::enums::DetectorType>
261 const ome::compat::shared_ptr<ome::xml::model::enums::DetectorType>
270 setType (ome::compat::shared_ptr<ome::xml::model::enums::DetectorType>& type);
286 setID (
const std::string&
id);
293 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsElectricPotential > >&
301 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsElectricPotential > >&
335 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
348 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
350 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
363 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
381 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
388 ome::compat::weak_ptr<ome::xml::model::Instrument>
396 const ome::compat::weak_ptr<ome::xml::model::Instrument>
405 setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
428 #endif // OME_XML_MODEL_DETECTOR_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Detector.cpp:557
void setVoltage(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential > > &voltage)
Set the Voltage property.
Definition: Detector.cpp:476
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Detector.cpp:206
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Detector.cpp:483
void setAmplificationGain(ome::compat::shared_ptr< double > &lificationGain)
Set the AmplificationGain property.
Definition: Detector.cpp:378
ome::compat::shared_ptr< double > getOffset()
Get the Offset property.
Definition: Detector.cpp:406
void setOffset(ome::compat::shared_ptr< double > &offset)
Set the Offset property.
Definition: Detector.cpp:420
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Detector.cpp:489
void setID(const std::string &id)
Set the ID property.
Definition: Detector.cpp:455
void setZoom(ome::compat::shared_ptr< double > &zoom)
Set the Zoom property.
Definition: Detector.cpp:357
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
Private implementation details of Detector model object.
Definition: Detector.cpp:75
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential > > & getVoltage()
Get the Voltage property.
Definition: Detector.cpp:462
void setType(ome::compat::shared_ptr< ome::xml::model::enums::DetectorType > &type)
Set the Type property.
Definition: Detector.cpp:441
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: Detector.cpp:312
static ome::compat::shared_ptr< Detector > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Detector model object from DOM element.
Definition: Detector.cpp:190
ome::compat::shared_ptr< ome::xml::model::enums::DetectorType > getType()
Get the Type property.
Definition: Detector.cpp:427
Detector model object.
Definition: Detector.h:83
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Detector.cpp:543
ome::compat::shared_ptr< double > getZoom()
Get the Zoom property.
Definition: Detector.cpp:343
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Detector.h:86
void setGain(ome::compat::shared_ptr< double > &gain)
Set the Gain property.
Definition: Detector.cpp:399
Open Microscopy Environment C++ implementation.
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Detector.cpp:525
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: Detector.cpp:570
const std::string & getID() const
Get the ID property.
Definition: Detector.cpp:448
Detector()
Default constructor.
Definition: Detector.cpp:170
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: Detector.cpp:501
const std::string & elementName() const
Get the element name of this model object.
Definition: Detector.cpp:199
ome::compat::shared_ptr< double > getGain()
Get the Gain property.
Definition: Detector.cpp:385
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:79
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: Detector.cpp:495
A quantity of a defined unit.
Definition: Quantity.h:57
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Detector.cpp:690
virtual ~Detector()
Destructor.
Definition: Detector.cpp:185
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: Detector.cpp:214
ome::compat::shared_ptr< double > getAmplificationGain()
Get the AmplificationGain property.
Definition: Detector.cpp:364
Detector & operator=(const Detector &)
Assignment operator (deleted).
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Detector.cpp:563
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Detector.cpp:511