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

Inheritance diagram for ome::xml::model::TiffData:

Collaboration diagram for ome::xml::model::TiffData:

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

Public Member Functions
	TiffData ()
	Default constructor.

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

virtual	~TiffData ()
	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< ome::xml::model::primitives::NonNegativeInteger >	getIFD ()
	Get the IFD property. More...

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

void	setIFD (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &ifd)
	Set the IFD property. More...

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

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

void	setPlaneCount (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &planeCount)
	Set the PlaneCount property. More...

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

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

void	setFirstZ (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &firstZ)
	Set the FirstZ property. More...

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

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

void	setFirstC (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &firstC)
	Set the FirstC property. More...

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

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

void	setFirstT (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &firstT)
	Set the FirstT property. More...

ome::compat::shared_ptr< ome::xml::model::UUID >	getUUID ()
	Get the UUID property. More...

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

void	setUUID (ome::compat::shared_ptr< ome::xml::model::UUID > &uuid)
	Set the UUID property. More...

ome::compat::weak_ptr< ome::xml::model::Pixels >	getPixels ()
	Get the Pixels property. More...

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

void	setPixels (ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
	Set the Pixels property. 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< TiffData >	create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
	Create a TiffData 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

TiffData model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters

copy	the TiffData to copy.

Member Function Documentation

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

static

Create a TiffData 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::Pixels::update().

Here is the caller graph for this function:

const std::string & ome::xml::model::TiffData::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::primitives::NonNegativeInteger > ome::xml::model::TiffData::getFirstC ( )

Get the FirstC property.

Returns: the FirstC property.

References impl.

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::TiffData::getFirstC ( ) const

Get the FirstC property.

Returns: the FirstC property.

References impl.

ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::TiffData::getFirstT ( )

Get the FirstT property.

Returns: the FirstT property.

References impl.

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::TiffData::getFirstT ( ) const

Get the FirstT property.

Returns: the FirstT property.

References impl.

ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::TiffData::getFirstZ ( )

Get the FirstZ property.

Returns: the FirstZ property.

References impl.

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::TiffData::getFirstZ ( ) const

Get the FirstZ property.

Returns: the FirstZ property.

References impl.

ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::TiffData::getIFD ( )

Get the IFD property.

Returns: the IFD property.

References impl.

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::TiffData::getIFD ( ) const

Get the IFD property.

Returns: the IFD property.

References impl.

ome::compat::weak_ptr< ome::xml::model::Pixels > ome::xml::model::TiffData::getPixels ( )

Get the Pixels property.

Returns: the Pixels property.

References impl.

const ome::compat::weak_ptr< ome::xml::model::Pixels > ome::xml::model::TiffData::getPixels ( ) const

Get the Pixels property.

Returns: the Pixels property.

References impl.

ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::TiffData::getPlaneCount ( )

Get the PlaneCount property.

Returns: the PlaneCount property.

References impl.

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::TiffData::getPlaneCount ( ) const

Get the PlaneCount property.

Returns: the PlaneCount property.

References impl.

ome::compat::shared_ptr< ome::xml::model::UUID > ome::xml::model::TiffData::getUUID ( )

Get the UUID property.

Returns: the UUID property.

References impl.

const ome::compat::shared_ptr< ome::xml::model::UUID > ome::xml::model::TiffData::getUUID ( ) const

Get the UUID property.

Returns: the UUID property.

References impl.

const std::string & ome::xml::model::TiffData::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::TiffData::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::detail::OMEModelObject::link(), and ome::xml::model::detail::OMEModelObject::logger.

void ome::xml::model::TiffData::setFirstC ( ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > & firstC )

Set the FirstC property.

Parameters

firstC the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::TiffData::setFirstT ( ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > & firstT )

Set the FirstT property.

Parameters

firstT the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::TiffData::setFirstZ ( ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > & firstZ )

Set the FirstZ property.

Parameters

firstZ the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::TiffData::setIFD ( ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > & ifd )

Set the IFD property.

Parameters

ifd	the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::TiffData::setPixels ( ome::compat::weak_ptr< ome::xml::model::Pixels > & pixels_BackReference )

Set the Pixels property.

Parameters

pixels_BackReference the value to set.

References impl.

void ome::xml::model::TiffData::setPlaneCount ( ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > & planeCount )

Set the PlaneCount property.

Parameters

planeCount the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::TiffData::setUUID ( ome::compat::shared_ptr< ome::xml::model::UUID > & uuid )

Set the UUID property.

Parameters

uuid	the value to set.

References impl.

Referenced by update().

Here is the caller graph for this function:

void ome::xml::model::TiffData::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::UUID::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, setFirstC(), setFirstT(), setFirstZ(), setIFD(), setPlaneCount(), setUUID(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().