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

Inheritance diagram for ome::xml::model::Objective:

Collaboration diagram for ome::xml::model::Objective:

Public Member Functions
	Objective ()
	Default constructor.

	Objective (const Objective &copy)
	Copy constructor. More...

virtual	~Objective ()
	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< bool >	getIris ()
	Get the Iris property. More...

const ome::compat::shared_ptr< bool >	getIris () const
	Get the Iris property. More...

void	setIris (ome::compat::shared_ptr< bool > &iris)
	Set the Iris property. More...

ome::compat::shared_ptr< double >	getWorkingDistance ()
	Get the WorkingDistance property. More...

const ome::compat::shared_ptr< double >	getWorkingDistance () const
	Get the WorkingDistance property. More...

void	setWorkingDistance (ome::compat::shared_ptr< double > &workingDistance)
	Set the WorkingDistance property. More...

ome::compat::shared_ptr< ome::xml::model::enums::Immersion >	getImmersion ()
	Get the Immersion property. More...

const ome::compat::shared_ptr< ome::xml::model::enums::Immersion >	getImmersion () const
	Get the Immersion property. More...

void	setImmersion (ome::compat::shared_ptr< ome::xml::model::enums::Immersion > &immersion)
	Set the Immersion property. More...

ome::compat::shared_ptr< ome::xml::model::enums::Correction >	getCorrection ()
	Get the Correction property. More...

const ome::compat::shared_ptr< ome::xml::model::enums::Correction >	getCorrection () const
	Get the Correction property. More...

void	setCorrection (ome::compat::shared_ptr< ome::xml::model::enums::Correction > &correction)
	Set the Correction property. More...

ome::compat::shared_ptr< double >	getLensNA ()
	Get the LensNA property. More...

const ome::compat::shared_ptr< double >	getLensNA () const
	Get the LensNA property. More...

void	setLensNA (ome::compat::shared_ptr< double > &lensNA)
	Set the LensNA property. More...

ome::compat::shared_ptr< double >	getNominalMagnification ()
	Get the NominalMagnification property. More...

const ome::compat::shared_ptr< double >	getNominalMagnification () const
	Get the NominalMagnification property. More...

void	setNominalMagnification (ome::compat::shared_ptr< double > &nominalMagnification)
	Set the NominalMagnification property. More...

ome::compat::shared_ptr< double >	getCalibratedMagnification ()
	Get the CalibratedMagnification property. More...

const ome::compat::shared_ptr< double >	getCalibratedMagnification () const
	Get the CalibratedMagnification property. More...

void	setCalibratedMagnification (ome::compat::shared_ptr< double > &calibratedMagnification)
	Set the CalibratedMagnification 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::weak_ptr< ome::xml::model::Instrument >	getInstrument ()
	Get the Instrument property. More...

const ome::compat::weak_ptr< ome::xml::model::Instrument >	getInstrument () const
	Get the Instrument property. More...

void	setInstrument (ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
	Set the Instrument 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::ManufacturerSpec
	ManufacturerSpec ()
	Default constructor.

	ManufacturerSpec (const ManufacturerSpec &copy)
	Copy constructor. More...

virtual	~ManufacturerSpec ()
	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...

ome::compat::shared_ptr< std::string >	getLotNumber ()
	Get the LotNumber property. More...

const ome::compat::shared_ptr< std::string >	getLotNumber () const
	Get the LotNumber property. More...

void	setLotNumber (ome::compat::shared_ptr< std::string > &lotNumber)
	Set the LotNumber property. More...

ome::compat::shared_ptr< std::string >	getModel ()
	Get the Model property. More...

const ome::compat::shared_ptr< std::string >	getModel () const
	Get the Model property. More...

void	setModel (ome::compat::shared_ptr< std::string > &model)
	Set the Model property. More...

ome::compat::shared_ptr< std::string >	getSerialNumber ()
	Get the SerialNumber property. More...

const ome::compat::shared_ptr< std::string >	getSerialNumber () const
	Get the SerialNumber property. More...

void	setSerialNumber (ome::compat::shared_ptr< std::string > &serialNumber)
	Set the SerialNumber property. More...

ome::compat::shared_ptr< std::string >	getManufacturer ()
	Get the Manufacturer property. More...

const ome::compat::shared_ptr< std::string >	getManufacturer () const
	Get the Manufacturer property. More...

void	setManufacturer (ome::compat::shared_ptr< std::string > &manufacturer)
	Set the Manufacturer property. 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< Objective >	create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
	Create a Objective model object from DOM element. More...

Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
static std::vector< common::xml::dom::Element >	getChildrenByTagName (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< bool >	iris
	Iris property.

ome::compat::shared_ptr< double >	workingDistance
	WorkingDistance property.

ome::compat::shared_ptr< ome::xml::model::enums::Immersion >	immersion
	Immersion property.

ome::compat::shared_ptr< ome::xml::model::enums::Correction >	correction
	Correction property.

ome::compat::shared_ptr< double >	lensNA
	LensNA property.

ome::compat::shared_ptr< double >	nominalMagnification
	NominalMagnification property.

ome::compat::shared_ptr< double >	calibratedMagnification
	CalibratedMagnification property.

std::string	id
	ID property.

ome::compat::weak_ptr< ome::xml::model::Instrument >	instrument
	Instrument_BackReference back reference.

Additional Inherited Members
Protected Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger	logger
	Message logger.

Detailed Description

Objective model object.

Constructor & Destructor Documentation

ome::xml::model::Objective::Objective ( const Objective & copy )

Copy constructor.

Parameters

copy	the Objective to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::Objective::asXMLElement ( common::xml::dom::Document & document ) const

virtual

Transform the object hierarchy rooted at this element to XML.

Parameters

document document for element creation

Returns: an XML DOM tree root element for this model object.

Reimplemented from ome::xml::model::ManufacturerSpec.

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

common::xml::dom::Element ome::xml::model::Objective::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

document	XML document for element creation.
element	XML element for setting model data.

Returns: an XML DOM tree root element for this model object.

Reimplemented from ome::xml::model::ManufacturerSpec.

References ome::xml::model::ManufacturerSpec::asXMLElementInternal(), calibratedMagnification, correction, ome::common::xml::dom::Document::createElementNS(), id, immersion, iris, lensNA, nominalMagnification, ome::common::xml::dom::Element::setAttribute(), and workingDistance.

Referenced by asXMLElement().

Here is the caller graph for this function:

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

static

Create a Objective model object from DOM element.

Parameters

element	root of the XML DOM tree to from which to construct the model object graph.
model	handler for the OME model used to track instances and references seen during the update.

Exceptions

EnumerationException if 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::Instrument::update().

Here is the caller graph for this function:

const std::string & ome::xml::model::Objective::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::Objective::getCalibratedMagnification ( )

Get the CalibratedMagnification property.

Returns: the CalibratedMagnification property.

References calibratedMagnification.

const ome::compat::shared_ptr< double > ome::xml::model::Objective::getCalibratedMagnification ( ) const

Get the CalibratedMagnification property.

Returns: the CalibratedMagnification property.

References calibratedMagnification.

ome::compat::shared_ptr< ome::xml::model::enums::Correction > ome::xml::model::Objective::getCorrection ( )

Get the Correction property.

Returns: the Correction property.

References correction.

const ome::compat::shared_ptr< ome::xml::model::enums::Correction > ome::xml::model::Objective::getCorrection ( ) const

Get the Correction property.

Returns: the Correction property.

References correction.

const std::string & ome::xml::model::Objective::getID ( ) const

Get the ID property.

Returns: the ID property.

References id.

Referenced by update().

Here is the caller graph for this function:

ome::compat::shared_ptr< ome::xml::model::enums::Immersion > ome::xml::model::Objective::getImmersion ( )

Get the Immersion property.

Returns: the Immersion property.

References immersion.

const ome::compat::shared_ptr< ome::xml::model::enums::Immersion > ome::xml::model::Objective::getImmersion ( ) const

Get the Immersion property.

Returns: the Immersion property.

References immersion.

ome::compat::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Objective::getInstrument ( )

Get the Instrument property.

Returns: the Instrument property.

References instrument.

const ome::compat::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Objective::getInstrument ( ) const

Get the Instrument property.

Returns: the Instrument property.

References instrument.

ome::compat::shared_ptr< bool > ome::xml::model::Objective::getIris ( )

Get the Iris property.

Returns: the Iris property.

References iris.

const ome::compat::shared_ptr< bool > ome::xml::model::Objective::getIris ( ) const

Get the Iris property.

Returns: the Iris property.

References iris.

ome::compat::shared_ptr< double > ome::xml::model::Objective::getLensNA ( )

Get the LensNA property.

Returns: the LensNA property.

References lensNA.

const ome::compat::shared_ptr< double > ome::xml::model::Objective::getLensNA ( ) const

Get the LensNA property.

Returns: the LensNA property.

References lensNA.

ome::compat::shared_ptr< double > ome::xml::model::Objective::getNominalMagnification ( )

Get the NominalMagnification property.

Returns: the NominalMagnification property.

References nominalMagnification.

const ome::compat::shared_ptr< double > ome::xml::model::Objective::getNominalMagnification ( ) const

Get the NominalMagnification property.

Returns: the NominalMagnification property.

References nominalMagnification.

ome::compat::shared_ptr< double > ome::xml::model::Objective::getWorkingDistance ( )

Get the WorkingDistance property.

Returns: the WorkingDistance property.

References workingDistance.

const ome::compat::shared_ptr< double > ome::xml::model::Objective::getWorkingDistance ( ) const

Get the WorkingDistance property.

Returns: the WorkingDistance property.

References workingDistance.

const std::string & ome::xml::model::Objective::getXMLNamespace ( ) const

virtual

Get the XML namespace for this model object.

Returns: the XML namespace.

Reimplemented from ome::xml::model::ManufacturerSpec.

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

reference	type 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.
object	Model 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::ManufacturerSpec::link(), and ome::xml::model::detail::OMEModelObject::logger.

void ome::xml::model::Objective::setCalibratedMagnification ( ome::compat::shared_ptr< double > & calibratedMagnification )

Set the CalibratedMagnification property.

Parameters

calibratedMagnification the value to set.

References calibratedMagnification.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Objective::setCorrection ( ome::compat::shared_ptr< ome::xml::model::enums::Correction > & correction )

Set the Correction property.

Parameters

correction the value to set.

References correction.

Referenced by update().

Here is the caller graph for this function:

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

Set the ID property.

Parameters

id	the value to set.

References id.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Objective::setImmersion ( ome::compat::shared_ptr< ome::xml::model::enums::Immersion > & immersion )

Set the Immersion property.

Parameters

immersion the value to set.

References immersion.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Objective::setInstrument ( ome::compat::weak_ptr< ome::xml::model::Instrument > & instrument_BackReference )

Set the Instrument property.

Parameters

instrument_BackReference the value to set.

References instrument.

void ome::xml::model::Objective::setIris ( ome::compat::shared_ptr< bool > & iris )

Set the Iris property.

Parameters

iris	the value to set.

References iris.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Objective::setLensNA ( ome::compat::shared_ptr< double > & lensNA )

Set the LensNA property.

Parameters

lensNA the value to set.

References lensNA.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Objective::setNominalMagnification ( ome::compat::shared_ptr< double > & nominalMagnification )

Set the NominalMagnification property.

Parameters

nominalMagnification the value to set.

References nominalMagnification.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Objective::setWorkingDistance ( ome::compat::shared_ptr< double > & workingDistance )

Set the WorkingDistance property.

Parameters

workingDistance the value to set.

References workingDistance.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Objective::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

element	root of the XML DOM tree to from which to construct the model object graph.
model	handler for the OME model used to track instances and references seen during the update.

Exceptions

EnumerationException if 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::ManufacturerSpec.

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, setCalibratedMagnification(), setCorrection(), setID(), setImmersion(), setIris(), setLensNA(), setNominalMagnification(), setWorkingDistance(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::ManufacturerSpec::update(), and validElementName().