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

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

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

Classes
class	Impl
	Private implementation details of Objective model object. More...

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 SKIP 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 (std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
	Link a given OME model object to this model object. More...

std::shared_ptr< bool >	getIris ()
	Get the Iris property. More...

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

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

std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &	getWorkingDistance ()
	Get the WorkingDistance property. More...

const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &	getWorkingDistance () const
	Get the WorkingDistance property. More...

void	setWorkingDistance (const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &workingDistance)
	Set the WorkingDistance property. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	setCalibratedMagnification (std::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...

OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type	sizeOfLinkedAnnotationList () const
	Get size of linked Annotation list. More...

OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type	getLinkedAnnotationList () const
	Get the linked Annotation list. More...

const std::weak_ptr< ome::xml::model::Annotation > &	getLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
	Get linked Annotation. More...

const std::weak_ptr< ome::xml::model::Annotation > &	setLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation)
	Set linked Annotation. More...

bool	linkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation)
	Link Annotation. More...

bool	unlinkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation)
	Unlink Annotation. More...

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

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

void	setInstrument (std::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
	Set the Instrument property. 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 (std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
	Link a given OME model object to this model object. More...

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

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

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

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

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

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

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

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

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

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

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

void	setManufacturer (std::shared_ptr< std::string > &manufacturer)
	Set the Manufacturer property. More...

Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
virtual	~OMEModelObject ()
	Destructor.

virtual common::xml::dom::Element	asXMLElement (common::xml::dom::Document &document) const
	Transform the object hierarchy rooted at this element to XML. More...

virtual void	asXMLElement (common::xml::dom::Document &document, common::xml::dom::Element &element) const
	Transform the object hierarchy rooted at this element to XML. 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...

virtual bool	link (std::shared_ptr< Reference > &reference, std::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 (std::shared_ptr< Reference > &reference, std::shared_ptr< OMEModelObject > &object)=0
	Link a given OME model object to this model object. More...

Static Public Member Functions
static std::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 void	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. More...

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

template<class C , typename T >
bool	contains (const C &container, const std::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
std::shared_ptr< Impl >	impl
	Private implementation details.

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

◆ Objective()

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

Copy constructor.

Parameters

copy	the Objective to copy.

Member Function Documentation

◆ asXMLElementInternal()

void 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.

Concrete model object implementations should override this method.

Parameters

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

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

References ome::common::xml::dom::Node::appendChild(), ome::xml::model::ManufacturerSpec::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().

◆ create()

std::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:

◆ elementName()

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.

◆ getCalibratedMagnification() [1/2]

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

Get the CalibratedMagnification property.

Returns: the CalibratedMagnification property.

References impl.

◆ getCalibratedMagnification() [2/2]

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

Get the CalibratedMagnification property.

Returns: the CalibratedMagnification property.

References impl.

◆ getCorrection() [1/2]

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

Get the Correction property.

Returns: the Correction property.

References impl.

◆ getCorrection() [2/2]

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

Get the Correction property.

Returns: the Correction property.

References impl.

◆ getID()

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

Get the ID property.

Returns: the ID property.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ getImmersion() [1/2]

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

Get the Immersion property.

Returns: the Immersion property.

References impl.

◆ getImmersion() [2/2]

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

Get the Immersion property.

Returns: the Immersion property.

References impl.

◆ getInstrument() [1/2]

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

Get the Instrument property.

Returns: the Instrument property.

References impl.

◆ getInstrument() [2/2]

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

Get the Instrument property.

Returns: the Instrument property.

References impl.

◆ getIris() [1/2]

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

Get the Iris property.

Returns: the Iris property.

References impl.

◆ getIris() [2/2]

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

Get the Iris property.

Returns: the Iris property.

References impl.

◆ getLensNA() [1/2]

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

Get the LensNA property.

Returns: the LensNA property.

References impl.

◆ getLensNA() [2/2]

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

Get the LensNA property.

Returns: the LensNA property.

References impl.

◆ getLinkedAnnotation()

const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Objective::getLinkedAnnotation ( OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index ) const

Get linked Annotation.

Parameters

index the index number of the Annotation.

Returns: a weak pointer to the Annotation.

Exceptions

std::out_of_range if the index is invalid.

References impl.

◆ getLinkedAnnotationList()

OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type ome::xml::model::Objective::getLinkedAnnotationList ( ) const

Get the linked Annotation list.

Returns: a reference to the list.

References impl.

◆ getNominalMagnification() [1/2]

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

Get the NominalMagnification property.

Returns: the NominalMagnification property.

References impl.

◆ getNominalMagnification() [2/2]

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

Get the NominalMagnification property.

Returns: the NominalMagnification property.

References impl.

◆ getWorkingDistance() [1/2]

std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & ome::xml::model::Objective::getWorkingDistance ( )

Get the WorkingDistance property.

Returns: the WorkingDistance property.

References impl.

◆ getWorkingDistance() [2/2]

const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & ome::xml::model::Objective::getWorkingDistance ( ) const

Get the WorkingDistance property.

Returns: the WorkingDistance property.

References impl.

◆ getXMLNamespace()

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.

Referenced by asXMLElementInternal().

Here is the caller graph for this function:

◆ link()

bool ome::xml::model::Objective::link	(	std::shared_ptr< Reference > &	reference,
		std::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.

Todo:: This bit is silly; why do we have two dynamic_casts here.

References impl, ome::xml::model::ManufacturerSpec::link(), ome::xml::model::Annotation::linkObjective(), and ome::xml::model::detail::OMEModelObject::logger.

◆ linkAnnotation()

bool ome::xml::model::Objective::linkAnnotation ( const std::shared_ptr< ome::xml::model::Annotation > & annotation )

Link Annotation.

Parameters

annotation the Annotation to link.

Returns: true if the object was added to the internal annotationLinks list, otherwise false.

Todo:: Why have a return value here; what is it used for? Is this an artifact of the Java API?

References impl.

◆ setCalibratedMagnification()

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

Set the CalibratedMagnification property.

Parameters

calibratedMagnification the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setCorrection()

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

Set the Correction property.

Parameters

correction the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setID()

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

Set the ID property.

Parameters

id	the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setImmersion()

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

Set the Immersion property.

Parameters

immersion the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setInstrument()

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

Set the Instrument property.

Parameters

instrument_BackReference the value to set.

References impl.

◆ setIris()

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

Set the Iris property.

Parameters

iris	the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setLensNA()

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

Set the LensNA property.

Parameters

lensNA the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setLinkedAnnotation()

const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Objective::setLinkedAnnotation	(	OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type	index,
		const std::shared_ptr< ome::xml::model::Annotation > &	annotation
	)

Set linked Annotation.

Note: The index must be valid.

Parameters

index	the index number of the Annotation.
annotation	the Annotation to set.

Returns: a weak pointer to the Annotation.

Exceptions

std::out_of_range if the index is invalid.

References impl.

◆ setNominalMagnification()

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

Set the NominalMagnification property.

Parameters

nominalMagnification the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setWorkingDistance()

void ome::xml::model::Objective::setWorkingDistance ( const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & workingDistance )

Set the WorkingDistance property.

Parameters

workingDistance the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ sizeOfLinkedAnnotationList()

OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type ome::xml::model::Objective::sizeOfLinkedAnnotationList ( ) const

Get size of linked Annotation list.

Returns: the size of the list.

References impl.

◆ unlinkAnnotation()

bool ome::xml::model::Objective::unlinkAnnotation ( const std::shared_ptr< ome::xml::model::Annotation > & annotation )

Unlink Annotation.

Parameters

annotation the Annotation to unlink.

Returns: true if the Annotation was unlinked, otherwise false if the Annotation was not linked and could hence not be unlinked.

Todo:

Does the return value serve any useful purpose? Is this also inherited Java API?

Doesn't the removal break the indexing?

Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.

References impl.

◆ update()

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::xml::model::OMEModel::addReference(), ome::common::xml::dom::Element::getAttribute(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), 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::ManufacturerSpec::update(), and validElementName().

◆ validElementName()

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

name	the element name to check.

Returns: true if valid, false if invalid.

Deprecated:: Always returns true since any element name is now regarded as being valid.

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

Referenced by update().

Here is the caller graph for this function:

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

ome/xml/model/Objective.h
ome/xml/model/Objective.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Objective()

Member Function Documentation

◆ asXMLElementInternal()

◆ create()

◆ elementName()

◆ getCalibratedMagnification() [1/2]

◆ getCalibratedMagnification() [2/2]

◆ getCorrection() [1/2]

◆ getCorrection() [2/2]

◆ getID()

◆ getImmersion() [1/2]

◆ getImmersion() [2/2]

◆ getInstrument() [1/2]

◆ getInstrument() [2/2]

◆ getIris() [1/2]

◆ getIris() [2/2]

◆ getLensNA() [1/2]

◆ getLensNA() [2/2]

◆ getLinkedAnnotation()

◆ getLinkedAnnotationList()

◆ getNominalMagnification() [1/2]

◆ getNominalMagnification() [2/2]

◆ getWorkingDistance() [1/2]

◆ getWorkingDistance() [2/2]

◆ getXMLNamespace()

◆ link()

◆ linkAnnotation()

◆ setCalibratedMagnification()

◆ setCorrection()

◆ setID()

◆ setImmersion()

◆ setInstrument()

◆ setIris()

◆ setLensNA()

◆ setLinkedAnnotation()

◆ setNominalMagnification()

◆ setWorkingDistance()

◆ sizeOfLinkedAnnotationList()

◆ unlinkAnnotation()

◆ update()

◆ validElementName()