ROI model object. More...

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

Inheritance diagram for ome::xml::model::ROI:

Collaboration diagram for ome::xml::model::ROI:

Public Member Functions
	ROI ()
	Default constructor.

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

virtual	~ROI ()
	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< std::string >	getNamespace ()
	Get the Namespace property. More...

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

void	setNamespace (ome::compat::shared_ptr< std::string > &namespace_)
	Set the Namespace 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< std::string >	getName ()
	Get the Name property. More...

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

void	setName (ome::compat::shared_ptr< std::string > &name)
	Set the Name property. More...

ome::compat::shared_ptr< ome::xml::model::Union >	getUnion ()
	Get the Union property. More...

const ome::compat::shared_ptr< ome::xml::model::Union >	getUnion () const
	Get the Union property. More...

void	setUnion (ome::compat::shared_ptr< ome::xml::model::Union > &union_)
	Set the Union property. More...

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

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

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

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

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

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

ome::compat::shared_ptr< std::string >	getDescription ()
	Get the Description property. More...

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

void	setDescription (ome::compat::shared_ptr< std::string > &description)
	Set the Description property. More...

OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type	sizeOfLinkedImageList () const
	Get size of linked Image list. More...

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

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

const ome::compat::weak_ptr< ome::xml::model::Image > &	setLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
	Set linked Image. More...

bool	linkImage (const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
	Link Image. More...

bool	unlinkImage (const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
	Unlink Image. More...

OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type	sizeOfLinkedMicrobeamManipulationList () const
	Get size of linked MicrobeamManipulation list. More...

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

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

const ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > &	setLinkedMicrobeamManipulation (OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
	Set linked MicrobeamManipulation. More...

bool	linkMicrobeamManipulation (const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
	Link MicrobeamManipulation. More...

bool	unlinkMicrobeamManipulation (const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
	Unlink MicrobeamManipulation. 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::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< ROI >	create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
	Create a ROI 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< std::string >	namespace_
	Namespace property.

std::string	id
	ID property.

ome::compat::shared_ptr< std::string >	name
	Name property.

ome::compat::shared_ptr< ome::xml::model::Union >	union_
	Union property.

OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type	annotationLinks
	AnnotationRef reference (occurs more than once)

ome::compat::shared_ptr< std::string >	description
	Description property.

OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type	imageLinks
	Image_BackReference back reference (occurs more than once)

OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type	microbeamManipulationLinks
	MicrobeamManipulation_BackReference back reference (occurs more than once)

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

Detailed Description

ROI model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters

copy	the ROI to copy.

Member Function Documentation

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

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

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

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

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

References annotationLinks, ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), description, id, name, namespace_, ome::common::xml::dom::Element::setAttribute(), and union_.

Referenced by asXMLElement().

Here is the caller graph for this function:

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

static

Create a ROI 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::OME::update().

Here is the caller graph for this function:

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

Get the Description property.

Returns: the Description property.

References description.

const ome::compat::shared_ptr< std::string > ome::xml::model::ROI::getDescription ( ) const

Get the Description property.

Returns: the Description property.

References description.

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

Get the ID property.

Returns: the ID property.

References id.

Referenced by update().

Here is the caller graph for this function:

const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::ROI::getLinkedAnnotation ( OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::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 annotationLinks.

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

Get the linked Annotation list.

Returns: a reference to the list.

References annotationLinks.

const ome::compat::weak_ptr< ome::xml::model::Image > & ome::xml::model::ROI::getLinkedImage ( OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index ) const

Get linked Image.

Parameters

index the index number of the Image.

Returns: a weak pointer to the Image.

Exceptions

std::out_of_range if the index is invalid.

References imageLinks.

OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type ome::xml::model::ROI::getLinkedImageList ( ) const

Get the linked Image list.

Returns: a reference to the list.

References imageLinks.

const ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > & ome::xml::model::ROI::getLinkedMicrobeamManipulation ( OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type index ) const

Get linked MicrobeamManipulation.

Parameters

index the index number of the MicrobeamManipulation.

Returns: a weak pointer to the MicrobeamManipulation.

Exceptions

std::out_of_range if the index is invalid.

References microbeamManipulationLinks.

OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type ome::xml::model::ROI::getLinkedMicrobeamManipulationList ( ) const

Get the linked MicrobeamManipulation list.

Returns: a reference to the list.

References microbeamManipulationLinks.

ome::compat::shared_ptr< std::string > ome::xml::model::ROI::getName ( )

Get the Name property.

Returns: the Name property.

References name.

const ome::compat::shared_ptr< std::string > ome::xml::model::ROI::getName ( ) const

Get the Name property.

Returns: the Name property.

References name.

ome::compat::shared_ptr< std::string > ome::xml::model::ROI::getNamespace ( )

Get the Namespace property.

Returns: the Namespace property.

References namespace_.

const ome::compat::shared_ptr< std::string > ome::xml::model::ROI::getNamespace ( ) const

Get the Namespace property.

Returns: the Namespace property.

References namespace_.

ome::compat::shared_ptr< ome::xml::model::Union > ome::xml::model::ROI::getUnion ( )

Get the Union property.

Returns: the Union property.

References union_.

const ome::compat::shared_ptr< ome::xml::model::Union > ome::xml::model::ROI::getUnion ( ) const

Get the Union property.

Returns: the Union property.

References union_.

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

virtual

Get the XML namespace for this model object.

Returns: the XML namespace.

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

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

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

References annotationLinks, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::Annotation::linkROI(), ome::xml::model::detail::OMEModelObject::logger, and name.

bool ome::xml::model::ROI::linkAnnotation ( const ome::compat::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 annotationLinks.

bool ome::xml::model::ROI::linkImage ( const ome::compat::shared_ptr< ome::xml::model::Image > & image_BackReference )

Link Image.

Parameters

image_BackReference the Image to link.

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

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

References imageLinks.

Referenced by ome::xml::model::Image::link().

Here is the caller graph for this function:

bool ome::xml::model::ROI::linkMicrobeamManipulation ( const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > & microbeamManipulation_BackReference )

Link MicrobeamManipulation.

Parameters

microbeamManipulation_BackReference the MicrobeamManipulation to link.

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

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

References microbeamManipulationLinks.

Referenced by ome::xml::model::MicrobeamManipulation::link().

Here is the caller graph for this function:

void ome::xml::model::ROI::setDescription ( ome::compat::shared_ptr< std::string > & description )

Set the Description property.

Parameters

description the value to set.

References description.

Referenced by update().

Here is the caller graph for this function:

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

const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::ROI::setLinkedAnnotation	(	OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type	index,
		const ome::compat::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 annotationLinks.

const ome::compat::weak_ptr< ome::xml::model::Image > & ome::xml::model::ROI::setLinkedImage	(	OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type	index,
		const ome::compat::shared_ptr< ome::xml::model::Image > &	image_BackReference
	)

Set linked Image.

Note: The index must be valid.

Parameters

index	the index number of the Image.
image_BackReference	the Image to set.

Returns: a weak pointer to the Image.

Exceptions

std::out_of_range if the index is invalid.

References imageLinks.

const ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > & ome::xml::model::ROI::setLinkedMicrobeamManipulation	(	OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type	index,
		const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &	microbeamManipulation_BackReference
	)

Set linked MicrobeamManipulation.

Note: The index must be valid.

Parameters

index	the index number of the MicrobeamManipulation.
microbeamManipulation_BackReference	the MicrobeamManipulation to set.

Returns: a weak pointer to the MicrobeamManipulation.

Exceptions

std::out_of_range if the index is invalid.

References microbeamManipulationLinks.

void ome::xml::model::ROI::setName ( ome::compat::shared_ptr< std::string > & name )

Set the Name property.

Parameters

name	the value to set.

References name.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::ROI::setNamespace ( ome::compat::shared_ptr< std::string > & namespace_ )

Set the Namespace property.

Parameters

namespace_ the value to set.

References namespace_.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::ROI::setUnion ( ome::compat::shared_ptr< ome::xml::model::Union > & union_ )

Set the Union property.

Parameters

union_ the value to set.

References union_.

Referenced by update().

Here is the caller graph for this function:

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

Get size of linked Annotation list.

Returns: the size of the list.

References annotationLinks.

OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type ome::xml::model::ROI::sizeOfLinkedImageList ( ) const

Get size of linked Image list.

Returns: the size of the list.

References imageLinks.

OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type ome::xml::model::ROI::sizeOfLinkedMicrobeamManipulationList ( ) const

Get size of linked MicrobeamManipulation list.

Returns: the size of the list.

References microbeamManipulationLinks.

bool ome::xml::model::ROI::unlinkAnnotation ( const ome::compat::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 annotationLinks.

bool ome::xml::model::ROI::unlinkImage ( const ome::compat::shared_ptr< ome::xml::model::Image > & image_BackReference )

Unlink Image.

Parameters

image_BackReference the Image to unlink.

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

bool ome::xml::model::ROI::unlinkMicrobeamManipulation ( const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > & microbeamManipulation_BackReference )

Unlink MicrobeamManipulation.

Parameters

microbeamManipulation_BackReference the MicrobeamManipulation to unlink.

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

void ome::xml::model::ROI::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::xml::model::OMEModel::addModelObject(), ome::xml::model::OMEModel::addReference(), ome::xml::model::Union::create(), 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, setDescription(), setID(), setName(), setNamespace(), setUnion(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().