bioformats  5.1.2
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ome::xml::model::DetectorSettings Class Reference

DetectorSettings model object. More...

#include <ome/xml/model/DetectorSettings.h>

+ Inheritance diagram for ome::xml::model::DetectorSettings:
+ Collaboration diagram for ome::xml::model::DetectorSettings:

Public Member Functions

 DetectorSettings ()
 Default constructor.
 
 DetectorSettings (const DetectorSettings &copy)
 Copy constructor. More...
 
virtual ~DetectorSettings ()
 Destructor.
 
const std::string & elementName () const
 Get the element name of this model object. More...
 
bool validElementName (const std::string &name) const
 Check if a given element name is valid for processing by this model object. More...
 
virtual void update (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Update the object hierarchy recursively from an XML DOM tree. More...
 
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. More...
 
ome::compat::shared_ptr< double > getZoom ()
 Get the Zoom property. More...
 
const ome::compat::shared_ptr< double > getZoom () const
 Get the Zoom property. More...
 
void setZoom (ome::compat::shared_ptr< double > &zoom)
 Set the Zoom property. More...
 
ome::compat::shared_ptr< ome::xml::model::enums::BinninggetBinning ()
 Get the Binning property. More...
 
const ome::compat::shared_ptr< ome::xml::model::enums::BinninggetBinning () const
 Get the Binning property. More...
 
void setBinning (ome::compat::shared_ptr< ome::xml::model::enums::Binning > &binning)
 Set the Binning property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetIntegration ()
 Get the Integration property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetIntegration () const
 Get the Integration property. More...
 
void setIntegration (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &integration)
 Set the Integration property. More...
 
ome::compat::shared_ptr< double > getReadOutRate ()
 Get the ReadOutRate property. More...
 
const ome::compat::shared_ptr< double > getReadOutRate () const
 Get the ReadOutRate property. More...
 
void setReadOutRate (ome::compat::shared_ptr< double > &readOutRate)
 Set the ReadOutRate property. More...
 
ome::compat::shared_ptr< double > getGain ()
 Get the Gain property. More...
 
const ome::compat::shared_ptr< double > getGain () const
 Get the Gain property. More...
 
void setGain (ome::compat::shared_ptr< double > &gain)
 Set the Gain property. More...
 
ome::compat::shared_ptr< double > getOffset ()
 Get the Offset property. More...
 
const ome::compat::shared_ptr< double > getOffset () const
 Get the Offset property. More...
 
void setOffset (ome::compat::shared_ptr< double > &offset)
 Set the Offset property. More...
 
const std::string & getID () const
 Get the ID property. More...
 
void setID (const std::string &id)
 Set the ID property. More...
 
ome::compat::shared_ptr< double > getVoltage ()
 Get the Voltage property. More...
 
const ome::compat::shared_ptr< double > getVoltage () const
 Get the Voltage property. More...
 
void setVoltage (ome::compat::shared_ptr< double > &voltage)
 Set the Voltage property. More...
 
ome::compat::weak_ptr< ome::xml::model::DetectorgetDetector ()
 Get the Detector property. More...
 
const ome::compat::weak_ptr< ome::xml::model::DetectorgetDetector () const
 Get the Detector property. More...
 
void setDetector (ome::compat::weak_ptr< ome::xml::model::Detector > &detector)
 Set the Detector property. More...
 
virtual common::xml::dom::Element asXMLElement (common::xml::dom::Document &document) const
 Transform the object hierarchy rooted at this element to XML. More...
 
const std::string & getXMLNamespace () const
 Get the XML namespace for this model object. More...
 
- Public Member Functions inherited from ome::xml::model::Settings
 Settings ()
 Default constructor.
 
 Settings (const Settings &copy)
 Copy constructor. More...
 
virtual ~Settings ()
 Destructor.
 
bool validElementName (const std::string &name) const
 Check if a given element name is valid for processing by this model object. More...
 
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. More...
 
const std::string & getXMLNamespace () const
 Get the XML namespace for this model object. More...
 
- Public Member Functions inherited from ome::xml::model::Reference
 Reference ()
 Default constructor.
 
 Reference (const Reference &copy)
 Copy constructor. More...
 
virtual ~Reference ()
 Destructor.
 
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. More...
 
- Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
virtual ~OMEModelObject ()
 Destructor.
 
virtual void update (const common::xml::dom::Element &element,::ome::xml::model::OMEModel &model)
 Update the object hierarchy recursively from an XML DOM tree. More...
 
virtual 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. More...
 
- Public Member Functions inherited from ome::xml::model::OMEModelObject
virtual bool link (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< OMEModelObject > &object)=0
 Link a given OME model object to this model object. More...
 

Static Public Member Functions

static ome::compat::shared_ptr< DetectorSettingscreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a DetectorSettings model object from DOM element. More...
 
- Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
static std::vector< common::xml::dom::ElementgetChildrenByTagName (const common::xml::dom::Element &parent, const std::string &name)
 Retrieve all the children of an element that have a given tag name. More...
 
static std::string stripNamespacePrefix (const std::string &value)
 Strip the namespace prefix from a tag name. More...
 

Protected Member Functions

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. More...
 
- Protected Member Functions inherited from ome::xml::model::detail::OMEModelObject
 OMEModelObject (const std::string &objectType="OMEModelObject")
 Constructor.
 
 OMEModelObject (const OMEModelObject &copy)
 Copy constructor. More...
 
template<class C , typename T >
bool contains (const C &container, const ome::compat::shared_ptr< T > &element)
 Check if a container contains a particular element. More...
 
- Protected Member Functions inherited from ome::xml::model::OMEModelObject
 OMEModelObject ()
 Constructor.
 

Private Attributes

ome::compat::shared_ptr< double > zoom
 Zoom property.
 
ome::compat::shared_ptr< ome::xml::model::enums::Binningbinning
 Binning property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegerintegration
 Integration property.
 
ome::compat::shared_ptr< double > readOutRate
 ReadOutRate property.
 
ome::compat::shared_ptr< double > gain
 Gain property.
 
ome::compat::shared_ptr< double > offset
 Offset property.
 
std::string id
 ID property.
 
ome::compat::shared_ptr< double > voltage
 Voltage property.
 
ome::compat::weak_ptr< ome::xml::model::Detectordetector
 DetectorRef back reference.
 

Additional Inherited Members

- Protected Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger logger
 Message logger.
 

Detailed Description

DetectorSettings model object.

Constructor & Destructor Documentation

ome::xml::model::DetectorSettings::DetectorSettings ( const DetectorSettings copy)

Copy constructor.

Parameters
copythe DetectorSettings to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::DetectorSettings::asXMLElement ( common::xml::dom::Document document) const
virtual

Transform the object hierarchy rooted at this element to XML.

Parameters
documentdocument for element creation
Returns
an XML DOM tree root element for this model object.

Reimplemented from ome::xml::model::Settings.

References asXMLElementInternal(), and ome::common::xml::dom::Document::createElementNS().

common::xml::dom::Element ome::xml::model::DetectorSettings::asXMLElementInternal ( common::xml::dom::Document document,
common::xml::dom::Element element 
) const
protectedvirtual

Transform the object hierarchy rooted at this element to XML.

This internal implementation of asXMLelement also requires an XML element, which must not be null, or may be instantiated and passed from superclasses.

Parameters
documentXML document for element creation.
elementXML element for setting model data.
Returns
an XML DOM tree root element for this model object.

Reimplemented from ome::xml::model::Settings.

References ome::xml::model::Settings::asXMLElementInternal(), binning, ome::common::xml::dom::Document::createElementNS(), gain, id, integration, offset, readOutRate, ome::common::xml::dom::Element::setAttribute(), voltage, and zoom.

Referenced by asXMLElement().

+ Here is the caller graph for this function:

ome::compat::shared_ptr< DetectorSettings > ome::xml::model::DetectorSettings::create ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
static

Create a DetectorSettings model object from DOM element.

Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.
Returns
a new model object.

Referenced by ome::xml::model::Channel::update().

+ Here is the caller graph for this function:

const std::string & ome::xml::model::DetectorSettings::elementName ( ) const
virtual

Get the element name of this model object.

This will be the most-derived class name.

Returns
the element type.

Implements ome::xml::model::OMEModelObject.

ome::compat::shared_ptr< ome::xml::model::enums::Binning > ome::xml::model::DetectorSettings::getBinning ( )

Get the Binning property.

Returns
the Binning property.

References binning.

const ome::compat::shared_ptr< ome::xml::model::enums::Binning > ome::xml::model::DetectorSettings::getBinning ( ) const

Get the Binning property.

Returns
the Binning property.

References binning.

ome::compat::weak_ptr< ome::xml::model::Detector > ome::xml::model::DetectorSettings::getDetector ( )

Get the Detector property.

Returns
the Detector property.

References detector.

const ome::compat::weak_ptr< ome::xml::model::Detector > ome::xml::model::DetectorSettings::getDetector ( ) const

Get the Detector property.

Returns
the Detector property.

References detector.

ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getGain ( )

Get the Gain property.

Returns
the Gain property.

References gain.

const ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getGain ( ) const

Get the Gain property.

Returns
the Gain property.

References gain.

const std::string & ome::xml::model::DetectorSettings::getID ( ) const
virtual

Get the ID property.

Returns
the ID property.

Implements ome::xml::model::Reference.

References id.

Referenced by update().

+ Here is the caller graph for this function:

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::DetectorSettings::getIntegration ( )

Get the Integration property.

Returns
the Integration property.

References integration.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::DetectorSettings::getIntegration ( ) const

Get the Integration property.

Returns
the Integration property.

References integration.

ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getOffset ( )

Get the Offset property.

Returns
the Offset property.

References offset.

const ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getOffset ( ) const

Get the Offset property.

Returns
the Offset property.

References offset.

ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getReadOutRate ( )

Get the ReadOutRate property.

Returns
the ReadOutRate property.

References readOutRate.

const ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getReadOutRate ( ) const

Get the ReadOutRate property.

Returns
the ReadOutRate property.

References readOutRate.

ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getVoltage ( )

Get the Voltage property.

Returns
the Voltage property.

References voltage.

const ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getVoltage ( ) const

Get the Voltage property.

Returns
the Voltage property.

References voltage.

const std::string & ome::xml::model::DetectorSettings::getXMLNamespace ( ) const
virtual

Get the XML namespace for this model object.

Returns
the XML namespace.

Implements ome::xml::model::OMEModelObject.

ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getZoom ( )

Get the Zoom property.

Returns
the Zoom property.

References zoom.

const ome::compat::shared_ptr< double > ome::xml::model::DetectorSettings::getZoom ( ) const

Get the Zoom property.

Returns
the Zoom property.

References zoom.

bool ome::xml::model::DetectorSettings::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.

Parameters
referencetype qualifier for the reference. This should be the corresponding reference type for object. If, for example, object is of type Image, reference must be of type ImageRef.
objectModel object to link to.
Returns
true if this model object was able to handle the reference, otherwise false.
Todo:
the use of reference to provide type information for the type of object is unconventional and quite possibly unnecessary–a simple string or type_info would suffice for what it's being used for, if it's needed at all. Is this true for all cases? The implementation also needs to do strict checking of the object type; it's not currently failing if it's of the wrong type. This applies to all generated model objects implementing this interface.

References ome::xml::model::Settings::link(), and ome::xml::model::detail::OMEModelObject::logger.

void ome::xml::model::DetectorSettings::setBinning ( ome::compat::shared_ptr< ome::xml::model::enums::Binning > &  binning)

Set the Binning property.

Parameters
binningthe value to set.

References binning.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::DetectorSettings::setDetector ( ome::compat::weak_ptr< ome::xml::model::Detector > &  detector)

Set the Detector property.

Parameters
detectorthe value to set.

References detector.

void ome::xml::model::DetectorSettings::setGain ( ome::compat::shared_ptr< double > &  gain)

Set the Gain property.

Parameters
gainthe value to set.

References gain.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::DetectorSettings::setID ( const std::string &  id)
virtual

Set the ID property.

Parameters
idthe value to set.

Implements ome::xml::model::Reference.

References id.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::DetectorSettings::setIntegration ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &  integration)

Set the Integration property.

Parameters
integrationthe value to set.

References integration.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::DetectorSettings::setOffset ( ome::compat::shared_ptr< double > &  offset)

Set the Offset property.

Parameters
offsetthe value to set.

References offset.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::DetectorSettings::setReadOutRate ( ome::compat::shared_ptr< double > &  readOutRate)

Set the ReadOutRate property.

Parameters
readOutRatethe value to set.

References readOutRate.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::DetectorSettings::setVoltage ( ome::compat::shared_ptr< double > &  voltage)

Set the Voltage property.

Parameters
voltagethe value to set.

References voltage.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::DetectorSettings::setZoom ( ome::compat::shared_ptr< double > &  zoom)

Set the Zoom property.

Parameters
zoomthe value to set.

References zoom.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::DetectorSettings::update ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
virtual

Update the object hierarchy recursively from an XML DOM tree.

Note
No properties are removed, only added or updated.
Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.

Reimplemented from ome::xml::model::Settings.

References ome::xml::model::OMEModel::addModelObject(), ome::common::xml::dom::Element::getAttribute(), getID(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setBinning(), setGain(), setID(), setIntegration(), setOffset(), setReadOutRate(), setVoltage(), setZoom(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::Settings::update(), and validElementName().

bool ome::xml::model::DetectorSettings::validElementName ( const std::string &  name) const
virtual

Check if a given element name is valid for processing by this model object.

Used for processing nodes when interitance is involved.

Parameters
namethe element name to check.
Returns
true if valid, false if invalid.

Implements ome::xml::model::detail::OMEModelObject.

References ome::xml::model::Settings::validElementName().

Referenced by update().

+ Here is the caller graph for this function:


The documentation for this class was generated from the following files: