bioformats  5.1.8
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ome::xml::model::Plane Class Reference

Plane model object. More...

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

+ Inheritance diagram for ome::xml::model::Plane:
+ Collaboration diagram for ome::xml::model::Plane:

Classes

class  Impl
 Private implementation details of Plane model object. More...
 

Public Member Functions

 Plane ()
 Default constructor.
 
 Plane (const Plane &copy)
 Copy constructor. More...
 
virtual ~Plane ()
 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< double > getExposureTime ()
 Get the ExposureTime property. More...
 
const ome::compat::shared_ptr< double > getExposureTime () const
 Get the ExposureTime property. More...
 
void setExposureTime (ome::compat::shared_ptr< double > &exposureTime)
 Set the ExposureTime property. More...
 
ome::compat::shared_ptr< double > getPositionZ ()
 Get the PositionZ property. More...
 
const ome::compat::shared_ptr< double > getPositionZ () const
 Get the PositionZ property. More...
 
void setPositionZ (ome::compat::shared_ptr< double > &positionZ)
 Set the PositionZ property. More...
 
ome::compat::shared_ptr< double > getPositionX ()
 Get the PositionX property. More...
 
const ome::compat::shared_ptr< double > getPositionX () const
 Get the PositionX property. More...
 
void setPositionX (ome::compat::shared_ptr< double > &positionX)
 Set the PositionX property. More...
 
ome::compat::shared_ptr< double > getPositionY ()
 Get the PositionY property. More...
 
const ome::compat::shared_ptr< double > getPositionY () const
 Get the PositionY property. More...
 
void setPositionY (ome::compat::shared_ptr< double > &positionY)
 Set the PositionY property. More...
 
ome::compat::shared_ptr< double > getDeltaT ()
 Get the DeltaT property. More...
 
const ome::compat::shared_ptr< double > getDeltaT () const
 Get the DeltaT property. More...
 
void setDeltaT (ome::compat::shared_ptr< double > &deltaT)
 Set the DeltaT property. More...
 
const ome::xml::model::primitives::NonNegativeIntegergetTheC () const
 Get the TheC property. More...
 
void setTheC (const ome::xml::model::primitives::NonNegativeInteger &theC)
 Set the TheC property. More...
 
const ome::xml::model::primitives::NonNegativeIntegergetTheZ () const
 Get the TheZ property. More...
 
void setTheZ (const ome::xml::model::primitives::NonNegativeInteger &theZ)
 Set the TheZ property. More...
 
const ome::xml::model::primitives::NonNegativeIntegergetTheT () const
 Get the TheT property. More...
 
void setTheT (const ome::xml::model::primitives::NonNegativeInteger &theT)
 Set the TheT property. More...
 
ome::compat::shared_ptr< std::string > getHashSHA1 ()
 Get the HashSHA1 property. More...
 
const ome::compat::shared_ptr< std::string > getHashSHA1 () const
 Get the HashSHA1 property. More...
 
void setHashSHA1 (ome::compat::shared_ptr< std::string > &hashSHA1)
 Set the HashSHA1 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::weak_ptr< ome::xml::model::PixelsgetPixels ()
 Get the Pixels property. More...
 
const ome::compat::weak_ptr< ome::xml::model::PixelsgetPixels () 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< Planecreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a Plane model object from DOM element. More...
 
- Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
static std::vector< common::xml::dom::ElementgetChildrenByTagName (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< Implimpl
 Private implementation details.
 

Additional Inherited Members

- Protected Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger logger
 Message logger.
 

Detailed Description

Plane model object.

Constructor & Destructor Documentation

ome::xml::model::Plane::Plane ( const Plane copy)

Copy constructor.

Parameters
copythe Plane to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::Plane::asXMLElement ( common::xml::dom::Document document) const
virtual

Transform the object hierarchy rooted at this element to XML.

Parameters
documentdocument 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::Plane::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
documentXML document for element creation.
elementXML 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< Plane > ome::xml::model::Plane::create ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
static

Create a Plane model object from DOM element.

Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif 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::Plane::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< double > ome::xml::model::Plane::getDeltaT ( )

Get the DeltaT property.

Returns
the DeltaT property.

References impl.

const ome::compat::shared_ptr< double > ome::xml::model::Plane::getDeltaT ( ) const

Get the DeltaT property.

Returns
the DeltaT property.

References impl.

ome::compat::shared_ptr< double > ome::xml::model::Plane::getExposureTime ( )

Get the ExposureTime property.

Returns
the ExposureTime property.

References impl.

const ome::compat::shared_ptr< double > ome::xml::model::Plane::getExposureTime ( ) const

Get the ExposureTime property.

Returns
the ExposureTime property.

References impl.

ome::compat::shared_ptr< std::string > ome::xml::model::Plane::getHashSHA1 ( )

Get the HashSHA1 property.

Returns
the HashSHA1 property.

References impl.

const ome::compat::shared_ptr< std::string > ome::xml::model::Plane::getHashSHA1 ( ) const

Get the HashSHA1 property.

Returns
the HashSHA1 property.

References impl.

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

Get linked Annotation.

Parameters
indexthe index number of the Annotation.
Returns
a weak pointer to the Annotation.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

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

Get the linked Annotation list.

Returns
a reference to the list.

References impl.

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

Get the Pixels property.

Returns
the Pixels property.

References impl.

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

Get the Pixels property.

Returns
the Pixels property.

References impl.

ome::compat::shared_ptr< double > ome::xml::model::Plane::getPositionX ( )

Get the PositionX property.

Returns
the PositionX property.

References impl.

const ome::compat::shared_ptr< double > ome::xml::model::Plane::getPositionX ( ) const

Get the PositionX property.

Returns
the PositionX property.

References impl.

ome::compat::shared_ptr< double > ome::xml::model::Plane::getPositionY ( )

Get the PositionY property.

Returns
the PositionY property.

References impl.

const ome::compat::shared_ptr< double > ome::xml::model::Plane::getPositionY ( ) const

Get the PositionY property.

Returns
the PositionY property.

References impl.

ome::compat::shared_ptr< double > ome::xml::model::Plane::getPositionZ ( )

Get the PositionZ property.

Returns
the PositionZ property.

References impl.

const ome::compat::shared_ptr< double > ome::xml::model::Plane::getPositionZ ( ) const

Get the PositionZ property.

Returns
the PositionZ property.

References impl.

const ome::xml::model::primitives::NonNegativeInteger & ome::xml::model::Plane::getTheC ( ) const

Get the TheC property.

Returns
the TheC property.

References impl.

const ome::xml::model::primitives::NonNegativeInteger & ome::xml::model::Plane::getTheT ( ) const

Get the TheT property.

Returns
the TheT property.

References impl.

const ome::xml::model::primitives::NonNegativeInteger & ome::xml::model::Plane::getTheZ ( ) const

Get the TheZ property.

Returns
the TheZ property.

References impl.

const std::string & ome::xml::model::Plane::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::Plane::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
referencetype 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.
objectModel 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 impl, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::Annotation::linkPlane(), and ome::xml::model::detail::OMEModelObject::logger.

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

Link Annotation.

Parameters
annotationthe 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 impl.

void ome::xml::model::Plane::setDeltaT ( ome::compat::shared_ptr< double > &  deltaT)

Set the DeltaT property.

Parameters
deltaTthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plane::setExposureTime ( ome::compat::shared_ptr< double > &  exposureTime)

Set the ExposureTime property.

Parameters
exposureTimethe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plane::setHashSHA1 ( ome::compat::shared_ptr< std::string > &  hashSHA1)

Set the HashSHA1 property.

Parameters
hashSHA1the value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Plane::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
indexthe index number of the Annotation.
annotationthe Annotation to set.
Returns
a weak pointer to the Annotation.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

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

Set the Pixels property.

Parameters
pixels_BackReferencethe value to set.

References impl.

void ome::xml::model::Plane::setPositionX ( ome::compat::shared_ptr< double > &  positionX)

Set the PositionX property.

Parameters
positionXthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plane::setPositionY ( ome::compat::shared_ptr< double > &  positionY)

Set the PositionY property.

Parameters
positionYthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plane::setPositionZ ( ome::compat::shared_ptr< double > &  positionZ)

Set the PositionZ property.

Parameters
positionZthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plane::setTheC ( const ome::xml::model::primitives::NonNegativeInteger theC)

Set the TheC property.

Parameters
theCthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plane::setTheT ( const ome::xml::model::primitives::NonNegativeInteger theT)

Set the TheT property.

Parameters
theTthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plane::setTheZ ( const ome::xml::model::primitives::NonNegativeInteger theZ)

Set the TheZ property.

Parameters
theZthe value to set.

References impl.

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::Plane::sizeOfLinkedAnnotationList ( ) const

Get size of linked Annotation list.

Returns
the size of the list.

References impl.

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

Unlink Annotation.

Parameters
annotationthe 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 impl.

void ome::xml::model::Plane::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
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif 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::addReference(), 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, setDeltaT(), setExposureTime(), setHashSHA1(), setPositionX(), setPositionY(), setPositionZ(), setTheC(), setTheT(), setTheZ(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().

bool ome::xml::model::Plane::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
namethe element name to check.
Returns
true if valid, false if invalid.

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

References ome::xml::model::detail::OMEModelObject::validElementName().

Referenced by update().

+ Here is the caller graph for this function:


The documentation for this class was generated from the following files: