ImagingEnvironment model object. More...

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

Inheritance diagram for ome::xml::model::ImagingEnvironment:

Collaboration diagram for ome::xml::model::ImagingEnvironment:

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

Public Member Functions
	ImagingEnvironment ()
	Default constructor.

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

virtual	~ImagingEnvironment ()
	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< ome::xml::model::primitives::PercentFraction >	getCO2Percent ()
	Get the CO2Percent property. More...

const std::shared_ptr< ome::xml::model::primitives::PercentFraction >	getCO2Percent () const
	Get the CO2Percent property. More...

void	setCO2Percent (std::shared_ptr< ome::xml::model::primitives::PercentFraction > &co2Percent)
	Set the CO2Percent property. More...

std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > > &	getTemperature ()
	Get the Temperature property. More...

const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > > &	getTemperature () const
	Get the Temperature property. More...

void	setTemperature (const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > > &temperature)
	Set the Temperature property. More...

std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > > &	getAirPressure ()
	Get the AirPressure property. More...

const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > > &	getAirPressure () const
	Get the AirPressure property. More...

void	setAirPressure (const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > > &airPressure)
	Set the AirPressure property. More...

std::shared_ptr< ome::xml::model::primitives::PercentFraction >	getHumidity ()
	Get the Humidity property. More...

const std::shared_ptr< ome::xml::model::primitives::PercentFraction >	getHumidity () const
	Get the Humidity property. More...

void	setHumidity (std::shared_ptr< ome::xml::model::primitives::PercentFraction > &humidity)
	Set the Humidity property. More...

std::shared_ptr< ome::xml::model::primitives::OrderedMultimap >	getMap ()
	Get the Map property. More...

const std::shared_ptr< ome::xml::model::primitives::OrderedMultimap >	getMap () const
	Get the Map property. More...

void	setMap (std::shared_ptr< ome::xml::model::primitives::OrderedMultimap > &map)
	Set the Map property. More...

const std::string &	getXMLNamespace () const
	Get the XML namespace for this model object. 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< ImagingEnvironment >	create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
	Create a ImagingEnvironment 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

ImagingEnvironment model object.

Constructor & Destructor Documentation

◆ ImagingEnvironment()

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

Copy constructor.

Parameters

copy	the ImagingEnvironment to copy.

Member Function Documentation

◆ asXMLElementInternal()

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

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

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

◆ create()

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

static

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

Here is the caller graph for this function:

◆ elementName()

const std::string & ome::xml::model::ImagingEnvironment::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.

◆ getAirPressure() [1/2]

std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > > & ome::xml::model::ImagingEnvironment::getAirPressure ( )

Get the AirPressure property.

Returns: the AirPressure property.

References impl.

◆ getAirPressure() [2/2]

const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > > & ome::xml::model::ImagingEnvironment::getAirPressure ( ) const

Get the AirPressure property.

Returns: the AirPressure property.

References impl.

◆ getCO2Percent() [1/2]

std::shared_ptr< ome::xml::model::primitives::PercentFraction > ome::xml::model::ImagingEnvironment::getCO2Percent ( )

Get the CO2Percent property.

Returns: the CO2Percent property.

References impl.

◆ getCO2Percent() [2/2]

const std::shared_ptr< ome::xml::model::primitives::PercentFraction > ome::xml::model::ImagingEnvironment::getCO2Percent ( ) const

Get the CO2Percent property.

Returns: the CO2Percent property.

References impl.

◆ getHumidity() [1/2]

std::shared_ptr< ome::xml::model::primitives::PercentFraction > ome::xml::model::ImagingEnvironment::getHumidity ( )

Get the Humidity property.

Returns: the Humidity property.

References impl.

◆ getHumidity() [2/2]

const std::shared_ptr< ome::xml::model::primitives::PercentFraction > ome::xml::model::ImagingEnvironment::getHumidity ( ) const

Get the Humidity property.

Returns: the Humidity property.

References impl.

◆ getMap() [1/2]

std::shared_ptr< ome::xml::model::primitives::OrderedMultimap > ome::xml::model::ImagingEnvironment::getMap ( )

Get the Map property.

Returns: the Map property.

References impl.

◆ getMap() [2/2]

const std::shared_ptr< ome::xml::model::primitives::OrderedMultimap > ome::xml::model::ImagingEnvironment::getMap ( ) const

Get the Map property.

Returns: the Map property.

References impl.

◆ getTemperature() [1/2]

std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > > & ome::xml::model::ImagingEnvironment::getTemperature ( )

Get the Temperature property.

Returns: the Temperature property.

References impl.

◆ getTemperature() [2/2]

const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > > & ome::xml::model::ImagingEnvironment::getTemperature ( ) const

Get the Temperature property.

Returns: the Temperature property.

References impl.

◆ getXMLNamespace()

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

virtual

Get the XML namespace for this model object.

Returns: the XML namespace.

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

Referenced by asXMLElementInternal().

Here is the caller graph for this function:

◆ link()

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

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

◆ setAirPressure()

void ome::xml::model::ImagingEnvironment::setAirPressure ( const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > > & airPressure )

Set the AirPressure property.

Parameters

airPressure the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setCO2Percent()

void ome::xml::model::ImagingEnvironment::setCO2Percent ( std::shared_ptr< ome::xml::model::primitives::PercentFraction > & co2Percent )

Set the CO2Percent property.

Parameters

co2Percent the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setHumidity()

void ome::xml::model::ImagingEnvironment::setHumidity ( std::shared_ptr< ome::xml::model::primitives::PercentFraction > & humidity )

Set the Humidity property.

Parameters

humidity the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setMap()

void ome::xml::model::ImagingEnvironment::setMap ( std::shared_ptr< ome::xml::model::primitives::OrderedMultimap > & map )

Set the Map property.

Parameters

map	the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ setTemperature()

void ome::xml::model::ImagingEnvironment::setTemperature ( const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > > & temperature )

Set the Temperature property.

Parameters

temperature the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

◆ update()

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

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

References ome::common::xml::dom::Element::getAttribute(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setAirPressure(), setCO2Percent(), setHumidity(), setMap(), setTemperature(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().

◆ validElementName()

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

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

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/ImagingEnvironment.h
ome/xml/model/ImagingEnvironment.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImagingEnvironment()

Member Function Documentation

◆ asXMLElementInternal()

◆ create()

◆ elementName()

◆ getAirPressure() [1/2]

◆ getAirPressure() [2/2]

◆ getCO2Percent() [1/2]

◆ getCO2Percent() [2/2]

◆ getHumidity() [1/2]

◆ getHumidity() [2/2]

◆ getMap() [1/2]

◆ getMap() [2/2]

◆ getTemperature() [1/2]

◆ getTemperature() [2/2]

◆ getXMLNamespace()

◆ link()

◆ setAirPressure()

◆ setCO2Percent()

◆ setHumidity()

◆ setMap()

◆ setTemperature()

◆ update()

◆ validElementName()