bioformats  5.1.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ome::xml::model::Pixels Class Reference

Pixels model object. More...

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

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

Public Member Functions

 Pixels ()
 Default constructor.
 
 Pixels (const Pixels &copy)
 Copy constructor. More...
 
virtual ~Pixels ()
 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 ome::xml::model::primitives::PositiveIntegergetSizeT () const
 Get the SizeT property. More...
 
void setSizeT (const ome::xml::model::primitives::PositiveInteger &sizeT)
 Set the SizeT property. More...
 
ome::xml::model::enums::DimensionOrdergetDimensionOrder ()
 Get the DimensionOrder property. More...
 
const ome::xml::model::enums::DimensionOrdergetDimensionOrder () const
 Get the DimensionOrder property. More...
 
void setDimensionOrder (const ome::xml::model::enums::DimensionOrder &dimensionOrder)
 Set the DimensionOrder property. More...
 
ome::compat::shared_ptr< double > getTimeIncrement ()
 Get the TimeIncrement property. More...
 
const ome::compat::shared_ptr< double > getTimeIncrement () const
 Get the TimeIncrement property. More...
 
void setTimeIncrement (ome::compat::shared_ptr< double > &timeIncrement)
 Set the TimeIncrement property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloatgetPhysicalSizeY ()
 Get the PhysicalSizeY property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloatgetPhysicalSizeY () const
 Get the PhysicalSizeY property. More...
 
void setPhysicalSizeY (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &physicalSizeY)
 Set the PhysicalSizeY property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloatgetPhysicalSizeX ()
 Get the PhysicalSizeX property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloatgetPhysicalSizeX () const
 Get the PhysicalSizeX property. More...
 
void setPhysicalSizeX (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &physicalSizeX)
 Set the PhysicalSizeX property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloatgetPhysicalSizeZ ()
 Get the PhysicalSizeZ property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloatgetPhysicalSizeZ () const
 Get the PhysicalSizeZ property. More...
 
void setPhysicalSizeZ (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &physicalSizeZ)
 Set the PhysicalSizeZ property. More...
 
const ome::xml::model::primitives::PositiveIntegergetSizeX () const
 Get the SizeX property. More...
 
void setSizeX (const ome::xml::model::primitives::PositiveInteger &sizeX)
 Set the SizeX property. More...
 
const ome::xml::model::primitives::PositiveIntegergetSizeY () const
 Get the SizeY property. More...
 
void setSizeY (const ome::xml::model::primitives::PositiveInteger &sizeY)
 Set the SizeY property. More...
 
const ome::xml::model::primitives::PositiveIntegergetSizeZ () const
 Get the SizeZ property. More...
 
void setSizeZ (const ome::xml::model::primitives::PositiveInteger &sizeZ)
 Set the SizeZ property. More...
 
ome::compat::shared_ptr< bool > getBigEndian ()
 Get the BigEndian property. More...
 
const ome::compat::shared_ptr< bool > getBigEndian () const
 Get the BigEndian property. More...
 
void setBigEndian (ome::compat::shared_ptr< bool > &bigEndian)
 Set the BigEndian property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetSignificantBits ()
 Get the SignificantBits property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetSignificantBits () const
 Get the SignificantBits property. More...
 
void setSignificantBits (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &significantBits)
 Set the SignificantBits property. More...
 
const ome::xml::model::primitives::PositiveIntegergetSizeC () const
 Get the SizeC property. More...
 
void setSizeC (const ome::xml::model::primitives::PositiveInteger &sizeC)
 Set the SizeC property. More...
 
ome::xml::model::enums::PixelTypegetType ()
 Get the Type property. More...
 
const ome::xml::model::enums::PixelTypegetType () const
 Get the Type property. More...
 
void setType (const ome::xml::model::enums::PixelType &type)
 Set the Type 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< bool > getInterleaved ()
 Get the Interleaved property. More...
 
const ome::compat::shared_ptr< bool > getInterleaved () const
 Get the Interleaved property. More...
 
void setInterleaved (ome::compat::shared_ptr< bool > &interleaved)
 Set the Interleaved property. More...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type sizeOfChannelList () const
 Get size of linked Channel list. More...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > & getChannelList ()
 Get the Channel list. More...
 
const std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > & getChannelList () const
 Get the Channel list. More...
 
ome::compat::shared_ptr< ome::xml::model::Channel > & getChannel (std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type index)
 Get Channel. More...
 
const ome::compat::shared_ptr< ome::xml::model::Channel > & getChannel (std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type index) const
 Get Channel. More...
 
void setChannel (std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
 Set Channel. More...
 
void addChannel (ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
 Add Channel. More...
 
void removeChannel (ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
 Remove Channel. 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...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type sizeOfTiffDataList () const
 Get size of linked TiffData list. More...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > & getTiffDataList ()
 Get the TiffData list. More...
 
const std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > & getTiffDataList () const
 Get the TiffData list. More...
 
ome::compat::shared_ptr< ome::xml::model::TiffData > & getTiffData (std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type index)
 Get TiffData. More...
 
const ome::compat::shared_ptr< ome::xml::model::TiffData > & getTiffData (std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type index) const
 Get TiffData. More...
 
void setTiffData (std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type index, ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
 Set TiffData. More...
 
void addTiffData (ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
 Add TiffData. More...
 
void removeTiffData (ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
 Remove TiffData. More...
 
ome::compat::shared_ptr< ome::xml::model::MetadataOnlygetMetadataOnly ()
 Get the MetadataOnly property. More...
 
const ome::compat::shared_ptr< ome::xml::model::MetadataOnlygetMetadataOnly () const
 Get the MetadataOnly property. More...
 
void setMetadataOnly (ome::compat::shared_ptr< ome::xml::model::MetadataOnly > &metadataOnly)
 Set the MetadataOnly property. More...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type sizeOfPlaneList () const
 Get size of linked Plane list. More...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > > & getPlaneList ()
 Get the Plane list. More...
 
const std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > > & getPlaneList () const
 Get the Plane list. More...
 
ome::compat::shared_ptr< ome::xml::model::Plane > & getPlane (std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type index)
 Get Plane. More...
 
const ome::compat::shared_ptr< ome::xml::model::Plane > & getPlane (std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type index) const
 Get Plane. More...
 
void setPlane (std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
 Set Plane. More...
 
void addPlane (ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
 Add Plane. More...
 
void removePlane (ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
 Remove Plane. 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...
 
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< Pixelscreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a Pixels 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::xml::model::primitives::PositiveInteger sizeT
 SizeT property.
 
ome::xml::model::enums::DimensionOrder dimensionOrder
 DimensionOrder property.
 
ome::compat::shared_ptr< double > timeIncrement
 TimeIncrement property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloatphysicalSizeY
 PhysicalSizeY property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloatphysicalSizeX
 PhysicalSizeX property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloatphysicalSizeZ
 PhysicalSizeZ property.
 
ome::xml::model::primitives::PositiveInteger sizeX
 SizeX property.
 
ome::xml::model::primitives::PositiveInteger sizeY
 SizeY property.
 
ome::xml::model::primitives::PositiveInteger sizeZ
 SizeZ property.
 
ome::compat::shared_ptr< bool > bigEndian
 BigEndian property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegersignificantBits
 SignificantBits property.
 
ome::xml::model::primitives::PositiveInteger sizeC
 SizeC property.
 
ome::xml::model::enums::PixelType type
 Type property.
 
std::string id
 ID property.
 
ome::compat::shared_ptr< bool > interleaved
 Interleaved property.
 
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > channels
 Channel property (occurs more than once)
 
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > binDataBlocks
 BinData property (occurs more than once)
 
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > tiffDataBlocks
 TiffData property (occurs more than once)
 
ome::compat::shared_ptr< ome::xml::model::MetadataOnlymetadataOnly
 MetadataOnly property.
 
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > > planes
 Plane property (occurs more than once)
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
 AnnotationRef 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

Pixels model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters
copythe Pixels to copy.

Member Function Documentation

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

Add BinData.

Parameters
binDatathe BinData to add.
Todo:

Return list position?

Detect and handle duplicates?

References binDataBlocks.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::addChannel ( ome::compat::shared_ptr< ome::xml::model::Channel > &  channel)

Add Channel.

Parameters
channelthe Channel to add.
Todo:

Return list position?

Detect and handle duplicates?

References channels.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::addPlane ( ome::compat::shared_ptr< ome::xml::model::Plane > &  plane)

Add Plane.

Parameters
planethe Plane to add.
Todo:

Return list position?

Detect and handle duplicates?

References planes.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::addTiffData ( ome::compat::shared_ptr< ome::xml::model::TiffData > &  tiffData)

Add TiffData.

Parameters
tiffDatathe TiffData to add.
Todo:

Return list position?

Detect and handle duplicates?

References tiffDataBlocks.

Referenced by update().

+ Here is the caller graph for this function:

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

common::xml::dom::Element ome::xml::model::Pixels::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 annotationLinks, ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), bigEndian, binDataBlocks, channels, ome::common::xml::dom::Document::createElementNS(), dimensionOrder, id, interleaved, metadataOnly, physicalSizeX, physicalSizeY, physicalSizeZ, planes, ome::common::xml::dom::Element::setAttribute(), significantBits, sizeC, sizeT, sizeX, sizeY, sizeZ, tiffDataBlocks, timeIncrement, and type.

Referenced by asXMLElement().

+ Here is the caller graph for this function:

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

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

+ Here is the caller graph for this function:

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

References type.

ome::compat::shared_ptr< bool > ome::xml::model::Pixels::getBigEndian ( )

Get the BigEndian property.

Returns
the BigEndian property.

References bigEndian.

const ome::compat::shared_ptr< bool > ome::xml::model::Pixels::getBigEndian ( ) const

Get the BigEndian property.

Returns
the BigEndian property.

References bigEndian.

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

Get BinData.

Parameters
indexthe index number of the BinData.
Returns
the BinData.
Exceptions
std::out_of_rangeif the index is invalid.

References binDataBlocks.

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

Get BinData.

Parameters
indexthe index number of the BinData.
Returns
the BinData.
Exceptions
std::out_of_rangeif the index is invalid.

References binDataBlocks.

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

Get the BinData list.

Returns
a reference to the list.

References binDataBlocks.

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

Get the BinData list.

Returns
a reference to the list.

References binDataBlocks.

ome::compat::shared_ptr< ome::xml::model::Channel > & ome::xml::model::Pixels::getChannel ( std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type  index)

Get Channel.

Parameters
indexthe index number of the Channel.
Returns
the Channel.
Exceptions
std::out_of_rangeif the index is invalid.

References channels.

const ome::compat::shared_ptr< ome::xml::model::Channel > & ome::xml::model::Pixels::getChannel ( std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type  index) const

Get Channel.

Parameters
indexthe index number of the Channel.
Returns
the Channel.
Exceptions
std::out_of_rangeif the index is invalid.

References channels.

std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > & ome::xml::model::Pixels::getChannelList ( )

Get the Channel list.

Returns
a reference to the list.

References channels.

const std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > & ome::xml::model::Pixels::getChannelList ( ) const

Get the Channel list.

Returns
a reference to the list.

References channels.

ome::xml::model::enums::DimensionOrder & ome::xml::model::Pixels::getDimensionOrder ( )

Get the DimensionOrder property.

Returns
the DimensionOrder property.

References dimensionOrder.

const ome::xml::model::enums::DimensionOrder & ome::xml::model::Pixels::getDimensionOrder ( ) const

Get the DimensionOrder property.

Returns
the DimensionOrder property.

References dimensionOrder.

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

Get the ID property.

Returns
the ID property.

References id.

Referenced by update().

+ Here is the caller graph for this function:

ome::compat::shared_ptr< bool > ome::xml::model::Pixels::getInterleaved ( )

Get the Interleaved property.

Returns
the Interleaved property.

References interleaved.

const ome::compat::shared_ptr< bool > ome::xml::model::Pixels::getInterleaved ( ) const

Get the Interleaved property.

Returns
the Interleaved property.

References interleaved.

const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Pixels::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 annotationLinks.

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

Get the linked Annotation list.

Returns
a reference to the list.

References annotationLinks.

ome::compat::shared_ptr< ome::xml::model::MetadataOnly > ome::xml::model::Pixels::getMetadataOnly ( )

Get the MetadataOnly property.

Returns
the MetadataOnly property.

References metadataOnly.

const ome::compat::shared_ptr< ome::xml::model::MetadataOnly > ome::xml::model::Pixels::getMetadataOnly ( ) const

Get the MetadataOnly property.

Returns
the MetadataOnly property.

References metadataOnly.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > ome::xml::model::Pixels::getPhysicalSizeX ( )

Get the PhysicalSizeX property.

Returns
the PhysicalSizeX property.

References physicalSizeX.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > ome::xml::model::Pixels::getPhysicalSizeX ( ) const

Get the PhysicalSizeX property.

Returns
the PhysicalSizeX property.

References physicalSizeX.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > ome::xml::model::Pixels::getPhysicalSizeY ( )

Get the PhysicalSizeY property.

Returns
the PhysicalSizeY property.

References physicalSizeY.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > ome::xml::model::Pixels::getPhysicalSizeY ( ) const

Get the PhysicalSizeY property.

Returns
the PhysicalSizeY property.

References physicalSizeY.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > ome::xml::model::Pixels::getPhysicalSizeZ ( )

Get the PhysicalSizeZ property.

Returns
the PhysicalSizeZ property.

References physicalSizeZ.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > ome::xml::model::Pixels::getPhysicalSizeZ ( ) const

Get the PhysicalSizeZ property.

Returns
the PhysicalSizeZ property.

References physicalSizeZ.

ome::compat::shared_ptr< ome::xml::model::Plane > & ome::xml::model::Pixels::getPlane ( std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type  index)

Get Plane.

Parameters
indexthe index number of the Plane.
Returns
the Plane.
Exceptions
std::out_of_rangeif the index is invalid.

References planes.

const ome::compat::shared_ptr< ome::xml::model::Plane > & ome::xml::model::Pixels::getPlane ( std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type  index) const

Get Plane.

Parameters
indexthe index number of the Plane.
Returns
the Plane.
Exceptions
std::out_of_rangeif the index is invalid.

References planes.

std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > > & ome::xml::model::Pixels::getPlaneList ( )

Get the Plane list.

Returns
a reference to the list.

References planes.

const std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > > & ome::xml::model::Pixels::getPlaneList ( ) const

Get the Plane list.

Returns
a reference to the list.

References planes.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Pixels::getSignificantBits ( )

Get the SignificantBits property.

Returns
the SignificantBits property.

References significantBits.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Pixels::getSignificantBits ( ) const

Get the SignificantBits property.

Returns
the SignificantBits property.

References significantBits.

const ome::xml::model::primitives::PositiveInteger & ome::xml::model::Pixels::getSizeC ( ) const

Get the SizeC property.

Returns
the SizeC property.

References sizeC.

const ome::xml::model::primitives::PositiveInteger & ome::xml::model::Pixels::getSizeT ( ) const

Get the SizeT property.

Returns
the SizeT property.

References sizeT.

const ome::xml::model::primitives::PositiveInteger & ome::xml::model::Pixels::getSizeX ( ) const

Get the SizeX property.

Returns
the SizeX property.

References sizeX.

const ome::xml::model::primitives::PositiveInteger & ome::xml::model::Pixels::getSizeY ( ) const

Get the SizeY property.

Returns
the SizeY property.

References sizeY.

const ome::xml::model::primitives::PositiveInteger & ome::xml::model::Pixels::getSizeZ ( ) const

Get the SizeZ property.

Returns
the SizeZ property.

References sizeZ.

ome::compat::shared_ptr< ome::xml::model::TiffData > & ome::xml::model::Pixels::getTiffData ( std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type  index)

Get TiffData.

Parameters
indexthe index number of the TiffData.
Returns
the TiffData.
Exceptions
std::out_of_rangeif the index is invalid.

References tiffDataBlocks.

const ome::compat::shared_ptr< ome::xml::model::TiffData > & ome::xml::model::Pixels::getTiffData ( std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type  index) const

Get TiffData.

Parameters
indexthe index number of the TiffData.
Returns
the TiffData.
Exceptions
std::out_of_rangeif the index is invalid.

References tiffDataBlocks.

std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > & ome::xml::model::Pixels::getTiffDataList ( )

Get the TiffData list.

Returns
a reference to the list.

References tiffDataBlocks.

const std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > & ome::xml::model::Pixels::getTiffDataList ( ) const

Get the TiffData list.

Returns
a reference to the list.

References tiffDataBlocks.

ome::compat::shared_ptr< double > ome::xml::model::Pixels::getTimeIncrement ( )

Get the TimeIncrement property.

Returns
the TimeIncrement property.

References timeIncrement.

const ome::compat::shared_ptr< double > ome::xml::model::Pixels::getTimeIncrement ( ) const

Get the TimeIncrement property.

Returns
the TimeIncrement property.

References timeIncrement.

ome::xml::model::enums::PixelType & ome::xml::model::Pixels::getType ( )

Get the Type property.

Returns
the Type property.

References type.

const ome::xml::model::enums::PixelType & ome::xml::model::Pixels::getType ( ) const

Get the Type property.

Returns
the Type property.

References type.

const std::string & ome::xml::model::Pixels::getXMLNamespace ( ) const
virtual

Get the XML namespace for this model object.

Returns
the XML namespace.

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

bool ome::xml::model::Pixels::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 annotationLinks, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::Annotation::linkPixels(), ome::xml::model::detail::OMEModelObject::logger, and type.

bool ome::xml::model::Pixels::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 annotationLinks, and type.

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

Remove BinData.

Parameters
binDatathe 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 binDataBlocks.

void ome::xml::model::Pixels::removeChannel ( ome::compat::shared_ptr< ome::xml::model::Channel > &  channel)

Remove Channel.

Parameters
channelthe Channel 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 channels.

void ome::xml::model::Pixels::removePlane ( ome::compat::shared_ptr< ome::xml::model::Plane > &  plane)

Remove Plane.

Parameters
planethe Plane 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 planes.

void ome::xml::model::Pixels::removeTiffData ( ome::compat::shared_ptr< ome::xml::model::TiffData > &  tiffData)

Remove TiffData.

Parameters
tiffDatathe TiffData 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 tiffDataBlocks.

void ome::xml::model::Pixels::setBigEndian ( ome::compat::shared_ptr< bool > &  bigEndian)

Set the BigEndian property.

Parameters
bigEndianthe value to set.

References bigEndian.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::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
indexthe index number of the BinData.
binDatathe BinData to set.
Exceptions
std::out_of_rangeif the index is invalid.

References binDataBlocks.

void ome::xml::model::Pixels::setChannel ( std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type  index,
ome::compat::shared_ptr< ome::xml::model::Channel > &  channel 
)

Set Channel.

Parameters
indexthe index number of the Channel.
channelthe Channel to set.
Exceptions
std::out_of_rangeif the index is invalid.

References channels.

void ome::xml::model::Pixels::setDimensionOrder ( const ome::xml::model::enums::DimensionOrder dimensionOrder)

Set the DimensionOrder property.

Parameters
dimensionOrderthe value to set.

References dimensionOrder.

Referenced by update().

+ Here is the caller graph for this function:

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

Set the ID property.

Parameters
idthe value to set.

References id.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setInterleaved ( ome::compat::shared_ptr< bool > &  interleaved)

Set the Interleaved property.

Parameters
interleavedthe value to set.

References interleaved.

Referenced by update().

+ Here is the caller graph for this function:

const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Pixels::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 annotationLinks.

void ome::xml::model::Pixels::setMetadataOnly ( ome::compat::shared_ptr< ome::xml::model::MetadataOnly > &  metadataOnly)

Set the MetadataOnly property.

Parameters
metadataOnlythe value to set.

References metadataOnly.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setPhysicalSizeX ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &  physicalSizeX)

Set the PhysicalSizeX property.

Parameters
physicalSizeXthe value to set.

References physicalSizeX.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setPhysicalSizeY ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &  physicalSizeY)

Set the PhysicalSizeY property.

Parameters
physicalSizeYthe value to set.

References physicalSizeY.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setPhysicalSizeZ ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &  physicalSizeZ)

Set the PhysicalSizeZ property.

Parameters
physicalSizeZthe value to set.

References physicalSizeZ.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setPlane ( std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type  index,
ome::compat::shared_ptr< ome::xml::model::Plane > &  plane 
)

Set Plane.

Parameters
indexthe index number of the Plane.
planethe Plane to set.
Exceptions
std::out_of_rangeif the index is invalid.

References planes.

void ome::xml::model::Pixels::setSignificantBits ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &  significantBits)

Set the SignificantBits property.

Parameters
significantBitsthe value to set.

References significantBits.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setSizeC ( const ome::xml::model::primitives::PositiveInteger sizeC)

Set the SizeC property.

Parameters
sizeCthe value to set.

References sizeC.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setSizeT ( const ome::xml::model::primitives::PositiveInteger sizeT)

Set the SizeT property.

Parameters
sizeTthe value to set.

References sizeT.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setSizeX ( const ome::xml::model::primitives::PositiveInteger sizeX)

Set the SizeX property.

Parameters
sizeXthe value to set.

References sizeX.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setSizeY ( const ome::xml::model::primitives::PositiveInteger sizeY)

Set the SizeY property.

Parameters
sizeYthe value to set.

References sizeY.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setSizeZ ( const ome::xml::model::primitives::PositiveInteger sizeZ)

Set the SizeZ property.

Parameters
sizeZthe value to set.

References sizeZ.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setTiffData ( std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type  index,
ome::compat::shared_ptr< ome::xml::model::TiffData > &  tiffData 
)

Set TiffData.

Parameters
indexthe index number of the TiffData.
tiffDatathe TiffData to set.
Exceptions
std::out_of_rangeif the index is invalid.

References tiffDataBlocks.

void ome::xml::model::Pixels::setTimeIncrement ( ome::compat::shared_ptr< double > &  timeIncrement)

Set the TimeIncrement property.

Parameters
timeIncrementthe value to set.

References timeIncrement.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Pixels::setType ( const ome::xml::model::enums::PixelType type)

Set the Type property.

Parameters
typethe value to set.

References type.

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::Pixels::sizeOfBinDataList ( ) const

Get size of linked BinData list.

Returns
the size of the list.

References binDataBlocks.

std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type ome::xml::model::Pixels::sizeOfChannelList ( ) const

Get size of linked Channel list.

Returns
the size of the list.

References channels.

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

Get size of linked Annotation list.

Returns
the size of the list.

References annotationLinks.

std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type ome::xml::model::Pixels::sizeOfPlaneList ( ) const

Get size of linked Plane list.

Returns
the size of the list.

References planes.

std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type ome::xml::model::Pixels::sizeOfTiffDataList ( ) const

Get size of linked TiffData list.

Returns
the size of the list.

References tiffDataBlocks.

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

void ome::xml::model::Pixels::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 addBinData(), addChannel(), ome::xml::model::OMEModel::addModelObject(), addPlane(), ome::xml::model::OMEModel::addReference(), addTiffData(), ome::xml::model::MetadataOnly::create(), ome::xml::model::BinData::create(), ome::xml::model::TiffData::create(), ome::xml::model::Plane::create(), ome::xml::model::Channel::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, setBigEndian(), setDimensionOrder(), setID(), setInterleaved(), setMetadataOnly(), setPhysicalSizeX(), setPhysicalSizeY(), setPhysicalSizeZ(), setSignificantBits(), setSizeC(), setSizeT(), setSizeX(), setSizeY(), setSizeZ(), setTimeIncrement(), setType(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().

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