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

ObjectiveSettings model object. More...

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

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

Public Member Functions

 ObjectiveSettings ()
 Default constructor.
 
 ObjectiveSettings (const ObjectiveSettings &copy)
 Copy constructor. More...
 
virtual ~ObjectiveSettings ()
 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 > getRefractiveIndex ()
 Get the RefractiveIndex property. More...
 
const ome::compat::shared_ptr< double > getRefractiveIndex () const
 Get the RefractiveIndex property. More...
 
void setRefractiveIndex (ome::compat::shared_ptr< double > &refractiveIndex)
 Set the RefractiveIndex property. More...
 
ome::compat::shared_ptr< double > getCorrectionCollar ()
 Get the CorrectionCollar property. More...
 
const ome::compat::shared_ptr< double > getCorrectionCollar () const
 Get the CorrectionCollar property. More...
 
void setCorrectionCollar (ome::compat::shared_ptr< double > &correctionCollar)
 Set the CorrectionCollar 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< ome::xml::model::enums::MediumgetMedium ()
 Get the Medium property. More...
 
const ome::compat::shared_ptr< ome::xml::model::enums::MediumgetMedium () const
 Get the Medium property. More...
 
void setMedium (ome::compat::shared_ptr< ome::xml::model::enums::Medium > &medium)
 Set the Medium property. More...
 
ome::compat::weak_ptr< ome::xml::model::ObjectivegetObjective ()
 Get the Objective property. More...
 
const ome::compat::weak_ptr< ome::xml::model::ObjectivegetObjective () const
 Get the Objective property. More...
 
void setObjective (ome::compat::weak_ptr< ome::xml::model::Objective > &objective)
 Set the Objective 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< ObjectiveSettingscreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a ObjectiveSettings 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 > refractiveIndex
 RefractiveIndex property.
 
ome::compat::shared_ptr< double > correctionCollar
 CorrectionCollar property.
 
std::string id
 ID property.
 
ome::compat::shared_ptr< ome::xml::model::enums::Mediummedium
 Medium property.
 
ome::compat::weak_ptr< ome::xml::model::Objectiveobjective
 ObjectiveRef back reference.
 

Additional Inherited Members

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

Detailed Description

ObjectiveSettings model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters
copythe ObjectiveSettings to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::ObjectiveSettings::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::ObjectiveSettings::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(), correctionCollar, ome::common::xml::dom::Document::createElementNS(), id, medium, refractiveIndex, and ome::common::xml::dom::Element::setAttribute().

Referenced by asXMLElement().

+ Here is the caller graph for this function:

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

Create a ObjectiveSettings 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::Image::update().

+ Here is the caller graph for this function:

const std::string & ome::xml::model::ObjectiveSettings::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< double > ome::xml::model::ObjectiveSettings::getCorrectionCollar ( )

Get the CorrectionCollar property.

Returns
the CorrectionCollar property.

References correctionCollar.

const ome::compat::shared_ptr< double > ome::xml::model::ObjectiveSettings::getCorrectionCollar ( ) const

Get the CorrectionCollar property.

Returns
the CorrectionCollar property.

References correctionCollar.

const std::string & ome::xml::model::ObjectiveSettings::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::enums::Medium > ome::xml::model::ObjectiveSettings::getMedium ( )

Get the Medium property.

Returns
the Medium property.

References medium.

const ome::compat::shared_ptr< ome::xml::model::enums::Medium > ome::xml::model::ObjectiveSettings::getMedium ( ) const

Get the Medium property.

Returns
the Medium property.

References medium.

ome::compat::weak_ptr< ome::xml::model::Objective > ome::xml::model::ObjectiveSettings::getObjective ( )

Get the Objective property.

Returns
the Objective property.

References objective.

const ome::compat::weak_ptr< ome::xml::model::Objective > ome::xml::model::ObjectiveSettings::getObjective ( ) const

Get the Objective property.

Returns
the Objective property.

References objective.

ome::compat::shared_ptr< double > ome::xml::model::ObjectiveSettings::getRefractiveIndex ( )

Get the RefractiveIndex property.

Returns
the RefractiveIndex property.

References refractiveIndex.

const ome::compat::shared_ptr< double > ome::xml::model::ObjectiveSettings::getRefractiveIndex ( ) const

Get the RefractiveIndex property.

Returns
the RefractiveIndex property.

References refractiveIndex.

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

Get the XML namespace for this model object.

Returns
the XML namespace.

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

bool ome::xml::model::ObjectiveSettings::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::ObjectiveSettings::setCorrectionCollar ( ome::compat::shared_ptr< double > &  correctionCollar)

Set the CorrectionCollar property.

Parameters
correctionCollarthe value to set.

References correctionCollar.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::ObjectiveSettings::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::ObjectiveSettings::setMedium ( ome::compat::shared_ptr< ome::xml::model::enums::Medium > &  medium)

Set the Medium property.

Parameters
mediumthe value to set.

References medium.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::ObjectiveSettings::setObjective ( ome::compat::weak_ptr< ome::xml::model::Objective > &  objective)

Set the Objective property.

Parameters
objectivethe value to set.

References objective.

void ome::xml::model::ObjectiveSettings::setRefractiveIndex ( ome::compat::shared_ptr< double > &  refractiveIndex)

Set the RefractiveIndex property.

Parameters
refractiveIndexthe value to set.

References refractiveIndex.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::ObjectiveSettings::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, setCorrectionCollar(), setID(), setMedium(), setRefractiveIndex(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::Settings::update(), and validElementName().

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