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

Inheritance diagram for ome::xml::model::Mask:

Collaboration diagram for ome::xml::model::Mask:

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

Public Member Functions
	Mask ()
	Default constructor.

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

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

double	getY () const
	Get the Y property. More...

void	setY (double y)
	Set the Y property. More...

double	getX () const
	Get the X property. More...

void	setX (double x)
	Set the X property. More...

double	getHeight () const
	Get the Height property. More...

void	setHeight (double height)
	Set the Height property. More...

double	getWidth () const
	Get the Width property. More...

void	setWidth (double width)
	Set the Width property. More...

std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type	sizeOfBinDataList () const
	Get size of linked BinData list. More...

std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > &	getBinDataList ()
	Get the BinData list. More...

const std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > &	getBinDataList () const
	Get the BinData list. More...

ome::compat::shared_ptr< ome::xml::model::BinData > &	getBinData (std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index)
	Get BinData. More...

const ome::compat::shared_ptr< ome::xml::model::BinData > &	getBinData (std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index) const
	Get BinData. More...

void	setBinData (std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index, ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
	Set BinData. More...

void	addBinData (ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
	Add BinData. More...

void	removeBinData (ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
	Remove BinData. More...

const std::string &	getShapeType () const
	Get the Shape type. 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::Shape
	Shape ()
	Default constructor.

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

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

ome::compat::shared_ptr< std::string >	getStrokeDashArray ()
	Get the StrokeDashArray property. More...

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

void	setStrokeDashArray (ome::compat::shared_ptr< std::string > &strokeDashArray)
	Set the StrokeDashArray property. More...

ome::compat::shared_ptr< double >	getStrokeWidth ()
	Get the StrokeWidth property. More...

const ome::compat::shared_ptr< double >	getStrokeWidth () const
	Get the StrokeWidth property. More...

void	setStrokeWidth (ome::compat::shared_ptr< double > &strokeWidth)
	Set the StrokeWidth property. More...

ome::compat::shared_ptr< bool >	getLocked ()
	Get the Locked property. More...

const ome::compat::shared_ptr< bool >	getLocked () const
	Get the Locked property. More...

void	setLocked (ome::compat::shared_ptr< bool > &locked)
	Set the Locked property. More...

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

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

void	setFillRule (ome::compat::shared_ptr< ome::xml::model::enums::FillRule > &fillRule)
	Set the FillRule property. More...

ome::compat::shared_ptr< bool >	getVisible ()
	Get the Visible property. More...

const ome::compat::shared_ptr< bool >	getVisible () const
	Get the Visible property. More...

void	setVisible (ome::compat::shared_ptr< bool > &visible)
	Set the Visible property. More...

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

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

void	setLineCap (ome::compat::shared_ptr< ome::xml::model::enums::LineCap > &lineCap)
	Set the LineCap property. More...

ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger >	getTheC ()
	Get the TheC property. More...

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger >	getTheC () const
	Get the TheC property. More...

void	setTheC (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &theC)
	Set the TheC property. More...

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

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

void	setFontFamily (ome::compat::shared_ptr< ome::xml::model::enums::FontFamily > &fontFamily)
	Set the FontFamily property. More...

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

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

void	setFontStyle (ome::compat::shared_ptr< ome::xml::model::enums::FontStyle > &fontStyle)
	Set the FontStyle property. More...

ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger >	getFontSize ()
	Get the FontSize property. More...

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger >	getFontSize () const
	Get the FontSize property. More...

void	setFontSize (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &fontSize)
	Set the FontSize property. More...

ome::compat::shared_ptr< ome::xml::model::primitives::Color >	getFillColor ()
	Get the FillColor property. More...

const ome::compat::shared_ptr< ome::xml::model::primitives::Color >	getFillColor () const
	Get the FillColor property. More...

void	setFillColor (ome::compat::shared_ptr< ome::xml::model::primitives::Color > &fillColor)
	Set the FillColor property. More...

ome::compat::shared_ptr< std::string >	getText ()
	Get the Text property. More...

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

void	setText (ome::compat::shared_ptr< std::string > &text)
	Set the Text property. More...

ome::compat::shared_ptr< ome::xml::model::primitives::Color >	getStrokeColor ()
	Get the StrokeColor property. More...

const ome::compat::shared_ptr< ome::xml::model::primitives::Color >	getStrokeColor () const
	Get the StrokeColor property. More...

void	setStrokeColor (ome::compat::shared_ptr< ome::xml::model::primitives::Color > &strokeColor)
	Set the StrokeColor property. More...

ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger >	getTheT ()
	Get the TheT property. More...

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger >	getTheT () const
	Get the TheT property. More...

void	setTheT (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &theT)
	Set the TheT 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< ome::xml::model::primitives::NonNegativeInteger >	getTheZ ()
	Get the TheZ property. More...

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger >	getTheZ () const
	Get the TheZ property. More...

void	setTheZ (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &theZ)
	Set the TheZ property. More...

ome::compat::shared_ptr< ome::xml::model::AffineTransform >	getTransform ()
	Get the Transform property. More...

const ome::compat::shared_ptr< ome::xml::model::AffineTransform >	getTransform () const
	Get the Transform property. More...

void	setTransform (ome::compat::shared_ptr< ome::xml::model::AffineTransform > &transform)
	Set the Transform property. More...

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

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

void	setUnion (ome::compat::weak_ptr< ome::xml::model::Union > &union_BackReference)
	Set the Union 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 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< Mask >	create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
	Create a Mask 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

Mask model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters

copy	the Mask to copy.

Member Function Documentation

void ome::xml::model::Mask::addBinData ( ome::compat::shared_ptr< ome::xml::model::BinData > & binData )

Add BinData.

Parameters

binData the BinData to add.

Todo:

Return list position?

Detect and handle duplicates?

References impl.

Referenced by update().

Here is the caller graph for this function:

common::xml::dom::Element ome::xml::model::Mask::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(), ome::common::xml::dom::Document::createElementNS(), and getXMLNamespace().

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

References ome::common::xml::dom::Node::appendChild(), ome::xml::model::Shape::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< Mask > ome::xml::model::Mask::create	(	const common::xml::dom::Element &	element,
		ome::xml::model::OMEModel &	model
	)

static

Create a Mask 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::Union::update().

Here is the caller graph for this function:

const std::string & ome::xml::model::Mask::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< ome::xml::model::BinData > & ome::xml::model::Mask::getBinData ( std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index )

Get BinData.

Parameters

index the index number of the BinData.

Returns: the BinData.

Exceptions

std::out_of_range if the index is invalid.

References impl.

const ome::compat::shared_ptr< ome::xml::model::BinData > & ome::xml::model::Mask::getBinData ( std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index ) const

Get BinData.

Parameters

index the index number of the BinData.

Returns: the BinData.

Exceptions

std::out_of_range if the index is invalid.

References impl.

std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > & ome::xml::model::Mask::getBinDataList ( )

Get the BinData list.

Returns: a reference to the list.

References impl.

const std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > & ome::xml::model::Mask::getBinDataList ( ) const

Get the BinData list.

Returns: a reference to the list.

References impl.

double ome::xml::model::Mask::getHeight ( ) const

Get the Height property.

Returns: the Height property.

References impl.

Referenced by ome::xml::meta::OMEXMLMetadata::getMaskHeight().

Here is the caller graph for this function:

const std::string & ome::xml::model::Mask::getShapeType ( ) const

virtual

Get the Shape type.

Returns: the concrete type of the Shape.

Implements ome::xml::model::Shape.

double ome::xml::model::Mask::getWidth ( ) const

Get the Width property.

Returns: the Width property.

References impl.

Referenced by ome::xml::meta::OMEXMLMetadata::getMaskWidth().

Here is the caller graph for this function:

double ome::xml::model::Mask::getX ( ) const

Get the X property.

Returns: the X property.

References impl.

Referenced by ome::xml::meta::OMEXMLMetadata::getMaskX().

Here is the caller graph for this function:

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

double ome::xml::model::Mask::getY ( ) const

Get the Y property.

Returns: the Y property.

References impl.

Referenced by ome::xml::meta::OMEXMLMetadata::getMaskY().

Here is the caller graph for this function:

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

void ome::xml::model::Mask::removeBinData ( ome::compat::shared_ptr< ome::xml::model::BinData > & binData )

Remove BinData.

Parameters

binData the BinData to remove.

Todo:

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::Mask::setBinData	(	std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type	index,
		ome::compat::shared_ptr< ome::xml::model::BinData > &	binData
	)

Set BinData.

Parameters

index	the index number of the BinData.
binData	the BinData to set.

Exceptions

std::out_of_range if the index is invalid.

References impl.

void ome::xml::model::Mask::setHeight ( double height )

Set the Height property.

Parameters

height the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Mask::setWidth ( double width )

Set the Width property.

Parameters

width the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Mask::setX ( double x )

Set the X property.

Parameters

x	the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::Mask::setY ( double y )

Set the Y property.

Parameters

y	the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type ome::xml::model::Mask::sizeOfBinDataList ( ) const

Get size of linked BinData list.

Returns: the size of the list.

References impl.

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

References addBinData(), ome::xml::model::BinData::create(), 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, setHeight(), setWidth(), setX(), setY(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::Shape::update(), and validElementName().