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

Inheritance diagram for ome::xml::model::Pump:

Collaboration diagram for ome::xml::model::Pump:

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

Public Member Functions
	Pump ()
	Default constructor.

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

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

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::Laser, ome::compat::weak_ptr >::type::size_type	sizeOfLinkedLaserList () const
	Get size of linked Laser list. More...

OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type	getLinkedLaserList () const
	Get the linked Laser list. More...

const ome::compat::weak_ptr< ome::xml::model::Laser > &	getLinkedLaser (OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type::size_type index) const
	Get linked Laser. More...

const ome::compat::weak_ptr< ome::xml::model::Laser > &	setLinkedLaser (OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
	Set linked Laser. More...

bool	linkLaser (const ome::compat::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
	Link Laser. More...

bool	unlinkLaser (const ome::compat::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
	Unlink Laser. 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::Reference
	Reference ()
	Default constructor.

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

virtual	~Reference ()
	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::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< Pump >	create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
	Create a Pump 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< 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

Pump model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters

copy	the Pump to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::Pump::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::Reference.

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

common::xml::dom::Element ome::xml::model::Pump::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::Reference.

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

Referenced by asXMLElement().

Here is the caller graph for this function:

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

static

Create a Pump 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.

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

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

virtual

Get the ID property.

Returns: the ID property.

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

References impl.

Referenced by update().

Here is the caller graph for this function:

const ome::compat::weak_ptr< ome::xml::model::Laser > & ome::xml::model::Pump::getLinkedLaser ( OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type::size_type index ) const

Get linked Laser.

Parameters

index the index number of the Laser.

Returns: a weak pointer to the Laser.

Exceptions

std::out_of_range if the index is invalid.

References impl.

OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type ome::xml::model::Pump::getLinkedLaserList ( ) const

Get the linked Laser list.

Returns: a reference to the list.

References impl.

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

virtual

Get the XML namespace for this model object.

Returns: the XML namespace.

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

Referenced by asXMLElement(), and asXMLElementInternal().

Here is the caller graph for this function:

bool ome::xml::model::Pump::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::Reference::link(), and ome::xml::model::detail::OMEModelObject::logger.

bool ome::xml::model::Pump::linkLaser ( const ome::compat::shared_ptr< ome::xml::model::Laser > & laser_BackReference )

Link Laser.

Parameters

laser_BackReference the Laser to link.

Returns: true if the object was added to the internal lasers 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.

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

virtual

Set the ID property.

Parameters

id	the value to set.

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

References impl.

Referenced by update().

Here is the caller graph for this function:

const ome::compat::weak_ptr< ome::xml::model::Laser > & ome::xml::model::Pump::setLinkedLaser	(	OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type::size_type	index,
		const ome::compat::shared_ptr< ome::xml::model::Laser > &	laser_BackReference
	)

Set linked Laser.

Note: The index must be valid.

Parameters

index	the index number of the Laser.
laser_BackReference	the Laser to set.

Returns: a weak pointer to the Laser.

Exceptions

std::out_of_range if the index is invalid.

References impl.

OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type::size_type ome::xml::model::Pump::sizeOfLinkedLaserList ( ) const

Get size of linked Laser list.

Returns: the size of the list.

References impl.

bool ome::xml::model::Pump::unlinkLaser ( const ome::compat::shared_ptr< ome::xml::model::Laser > & laser_BackReference )

Unlink Laser.

Parameters

laser_BackReference the Laser to unlink.

Returns: true if the Laser was unlinked, otherwise false if the Laser 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.

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

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, setID(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::Reference::update(), and validElementName().