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

Plate model object. More...

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

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

Public Member Functions

 Plate ()
 Default constructor.
 
 Plate (const Plate &copy)
 Copy constructor. More...
 
virtual ~Plate ()
 Destructor.
 
const std::string & elementName () const
 Get the element name of this model object. More...
 
bool validElementName (const std::string &name) const
 Check if a given element name is valid for processing by this model object. More...
 
virtual void update (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Update the object hierarchy recursively from an XML DOM tree. More...
 
bool link (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
ome::compat::shared_ptr< std::string > getStatus ()
 Get the Status property. More...
 
const ome::compat::shared_ptr< std::string > getStatus () const
 Get the Status property. More...
 
void setStatus (ome::compat::shared_ptr< std::string > &status)
 Set the Status property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetRows ()
 Get the Rows property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetRows () const
 Get the Rows property. More...
 
void setRows (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &rows)
 Set the Rows property. More...
 
ome::compat::shared_ptr< std::string > getExternalIdentifier ()
 Get the ExternalIdentifier property. More...
 
const ome::compat::shared_ptr< std::string > getExternalIdentifier () const
 Get the ExternalIdentifier property. More...
 
void setExternalIdentifier (ome::compat::shared_ptr< std::string > &externalIdentifier)
 Set the ExternalIdentifier property. More...
 
ome::compat::shared_ptr< ome::xml::model::enums::NamingConventiongetRowNamingConvention ()
 Get the RowNamingConvention property. More...
 
const ome::compat::shared_ptr< ome::xml::model::enums::NamingConventiongetRowNamingConvention () const
 Get the RowNamingConvention property. More...
 
void setRowNamingConvention (ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > &rowNamingConvention)
 Set the RowNamingConvention property. More...
 
ome::compat::shared_ptr< ome::xml::model::enums::NamingConventiongetColumnNamingConvention ()
 Get the ColumnNamingConvention property. More...
 
const ome::compat::shared_ptr< ome::xml::model::enums::NamingConventiongetColumnNamingConvention () const
 Get the ColumnNamingConvention property. More...
 
void setColumnNamingConvention (ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > &columnNamingConvention)
 Set the ColumnNamingConvention property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeIntegergetFieldIndex ()
 Get the FieldIndex property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeIntegergetFieldIndex () const
 Get the FieldIndex property. More...
 
void setFieldIndex (ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &fieldIndex)
 Set the FieldIndex property. More...
 
ome::compat::shared_ptr< double > getWellOriginY ()
 Get the WellOriginY property. More...
 
const ome::compat::shared_ptr< double > getWellOriginY () const
 Get the WellOriginY property. More...
 
void setWellOriginY (ome::compat::shared_ptr< double > &wellOriginY)
 Set the WellOriginY property. More...
 
ome::compat::shared_ptr< double > getWellOriginX ()
 Get the WellOriginX property. More...
 
const ome::compat::shared_ptr< double > getWellOriginX () const
 Get the WellOriginX property. More...
 
void setWellOriginX (ome::compat::shared_ptr< double > &wellOriginX)
 Set the WellOriginX 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::PositiveIntegergetColumns ()
 Get the Columns property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetColumns () const
 Get the Columns property. More...
 
void setColumns (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &columns)
 Set the Columns property. More...
 
ome::compat::shared_ptr< std::string > getName ()
 Get the Name property. More...
 
const ome::compat::shared_ptr< std::string > getName () const
 Get the Name property. More...
 
void setName (ome::compat::shared_ptr< std::string > &name)
 Set the Name property. More...
 
ome::compat::shared_ptr< std::string > getDescription ()
 Get the Description property. More...
 
const ome::compat::shared_ptr< std::string > getDescription () const
 Get the Description property. More...
 
void setDescription (ome::compat::shared_ptr< std::string > &description)
 Set the Description property. More...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type sizeOfWellList () const
 Get size of linked Well list. More...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::Well > > & getWellList ()
 Get the Well list. More...
 
const std::vector< ome::compat::shared_ptr< ome::xml::model::Well > > & getWellList () const
 Get the Well list. More...
 
ome::compat::shared_ptr< ome::xml::model::Well > & getWell (std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type index)
 Get Well. More...
 
const ome::compat::shared_ptr< ome::xml::model::Well > & getWell (std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type index) const
 Get Well. More...
 
void setWell (std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Well > &well)
 Set Well. More...
 
void addWell (ome::compat::shared_ptr< ome::xml::model::Well > &well)
 Add Well. More...
 
void removeWell (ome::compat::shared_ptr< ome::xml::model::Well > &well)
 Remove Well. 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...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type sizeOfPlateAcquisitionList () const
 Get size of linked PlateAcquisition list. More...
 
std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > > & getPlateAcquisitionList ()
 Get the PlateAcquisition list. More...
 
const std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > > & getPlateAcquisitionList () const
 Get the PlateAcquisition list. More...
 
ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > & getPlateAcquisition (std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type index)
 Get PlateAcquisition. More...
 
const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > & getPlateAcquisition (std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type index) const
 Get PlateAcquisition. More...
 
void setPlateAcquisition (std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type index, ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
 Set PlateAcquisition. More...
 
void addPlateAcquisition (ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
 Add PlateAcquisition. More...
 
void removePlateAcquisition (ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition)
 Remove PlateAcquisition. More...
 
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type sizeOfLinkedScreenList () const
 Get size of linked Screen list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type getLinkedScreenList () const
 Get the linked Screen list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Screen > & getLinkedScreen (OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Screen. More...
 
const ome::compat::weak_ptr< ome::xml::model::Screen > & setLinkedScreen (OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
 Set linked Screen. More...
 
bool linkScreen (const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
 Link Screen. More...
 
bool unlinkScreen (const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
 Unlink Screen. 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< Platecreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a Plate 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< std::string > status
 Status property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegerrows
 Rows property.
 
ome::compat::shared_ptr< std::string > externalIdentifier
 ExternalIdentifier property.
 
ome::compat::shared_ptr< ome::xml::model::enums::NamingConventionrowNamingConvention
 RowNamingConvention property.
 
ome::compat::shared_ptr< ome::xml::model::enums::NamingConventioncolumnNamingConvention
 ColumnNamingConvention property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeIntegerfieldIndex
 FieldIndex property.
 
ome::compat::shared_ptr< double > wellOriginY
 WellOriginY property.
 
ome::compat::shared_ptr< double > wellOriginX
 WellOriginX property.
 
std::string id
 ID property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegercolumns
 Columns property.
 
ome::compat::shared_ptr< std::string > name
 Name property.
 
ome::compat::shared_ptr< std::string > description
 Description property.
 
std::vector< ome::compat::shared_ptr< ome::xml::model::Well > > wells
 Well property (occurs more than once)
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
 AnnotationRef reference (occurs more than once)
 
std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > > plateAcquisitions
 PlateAcquisition property (occurs more than once)
 
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type screenLinks
 Screen_BackReference back reference (occurs more than once)
 

Additional Inherited Members

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

Detailed Description

Plate model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters
copythe Plate to copy.

Member Function Documentation

void ome::xml::model::Plate::addPlateAcquisition ( ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &  plateAcquisition)

Add PlateAcquisition.

Parameters
plateAcquisitionthe PlateAcquisition to add.
Todo:

Return list position?

Detect and handle duplicates?

References plateAcquisitions.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plate::addWell ( ome::compat::shared_ptr< ome::xml::model::Well > &  well)

Add Well.

Parameters
wellthe Well to add.
Todo:

Return list position?

Detect and handle duplicates?

References wells.

Referenced by update().

+ Here is the caller graph for this function:

common::xml::dom::Element ome::xml::model::Plate::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::Plate::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(), columnNamingConvention, columns, ome::common::xml::dom::Document::createElementNS(), description, externalIdentifier, fieldIndex, id, name, plateAcquisitions, rowNamingConvention, rows, ome::common::xml::dom::Element::setAttribute(), status, wellOriginX, wellOriginY, and wells.

Referenced by asXMLElement().

+ Here is the caller graph for this function:

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

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

+ Here is the caller graph for this function:

const std::string & ome::xml::model::Plate::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::enums::NamingConvention > ome::xml::model::Plate::getColumnNamingConvention ( )

Get the ColumnNamingConvention property.

Returns
the ColumnNamingConvention property.

References columnNamingConvention.

const ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > ome::xml::model::Plate::getColumnNamingConvention ( ) const

Get the ColumnNamingConvention property.

Returns
the ColumnNamingConvention property.

References columnNamingConvention.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Plate::getColumns ( )

Get the Columns property.

Returns
the Columns property.

References columns.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Plate::getColumns ( ) const

Get the Columns property.

Returns
the Columns property.

References columns.

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

Get the Description property.

Returns
the Description property.

References description.

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

Get the Description property.

Returns
the Description property.

References description.

ome::compat::shared_ptr< std::string > ome::xml::model::Plate::getExternalIdentifier ( )

Get the ExternalIdentifier property.

Returns
the ExternalIdentifier property.

References externalIdentifier.

const ome::compat::shared_ptr< std::string > ome::xml::model::Plate::getExternalIdentifier ( ) const

Get the ExternalIdentifier property.

Returns
the ExternalIdentifier property.

References externalIdentifier.

ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::Plate::getFieldIndex ( )

Get the FieldIndex property.

Returns
the FieldIndex property.

References fieldIndex.

const ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > ome::xml::model::Plate::getFieldIndex ( ) const

Get the FieldIndex property.

Returns
the FieldIndex property.

References fieldIndex.

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

Get the ID property.

Returns
the ID property.

References id.

Referenced by update().

+ Here is the caller graph for this function:

const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Plate::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::Plate::getLinkedAnnotationList ( ) const

Get the linked Annotation list.

Returns
a reference to the list.

References annotationLinks.

const ome::compat::weak_ptr< ome::xml::model::Screen > & ome::xml::model::Plate::getLinkedScreen ( OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type  index) const

Get linked Screen.

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

References screenLinks.

OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type ome::xml::model::Plate::getLinkedScreenList ( ) const

Get the linked Screen list.

Returns
a reference to the list.

References screenLinks.

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

Get the Name property.

Returns
the Name property.

References name.

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

Get the Name property.

Returns
the Name property.

References name.

ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > & ome::xml::model::Plate::getPlateAcquisition ( std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type  index)

Get PlateAcquisition.

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

References plateAcquisitions.

const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > & ome::xml::model::Plate::getPlateAcquisition ( std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type  index) const

Get PlateAcquisition.

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

References plateAcquisitions.

std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > > & ome::xml::model::Plate::getPlateAcquisitionList ( )

Get the PlateAcquisition list.

Returns
a reference to the list.

References plateAcquisitions.

const std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > > & ome::xml::model::Plate::getPlateAcquisitionList ( ) const

Get the PlateAcquisition list.

Returns
a reference to the list.

References plateAcquisitions.

ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > ome::xml::model::Plate::getRowNamingConvention ( )

Get the RowNamingConvention property.

Returns
the RowNamingConvention property.

References rowNamingConvention.

const ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > ome::xml::model::Plate::getRowNamingConvention ( ) const

Get the RowNamingConvention property.

Returns
the RowNamingConvention property.

References rowNamingConvention.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Plate::getRows ( )

Get the Rows property.

Returns
the Rows property.

References rows.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Plate::getRows ( ) const

Get the Rows property.

Returns
the Rows property.

References rows.

ome::compat::shared_ptr< std::string > ome::xml::model::Plate::getStatus ( )

Get the Status property.

Returns
the Status property.

References status.

const ome::compat::shared_ptr< std::string > ome::xml::model::Plate::getStatus ( ) const

Get the Status property.

Returns
the Status property.

References status.

ome::compat::shared_ptr< ome::xml::model::Well > & ome::xml::model::Plate::getWell ( std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type  index)

Get Well.

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

References wells.

const ome::compat::shared_ptr< ome::xml::model::Well > & ome::xml::model::Plate::getWell ( std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type  index) const

Get Well.

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

References wells.

std::vector< ome::compat::shared_ptr< ome::xml::model::Well > > & ome::xml::model::Plate::getWellList ( )

Get the Well list.

Returns
a reference to the list.

References wells.

const std::vector< ome::compat::shared_ptr< ome::xml::model::Well > > & ome::xml::model::Plate::getWellList ( ) const

Get the Well list.

Returns
a reference to the list.

References wells.

ome::compat::shared_ptr< double > ome::xml::model::Plate::getWellOriginX ( )

Get the WellOriginX property.

Returns
the WellOriginX property.

References wellOriginX.

const ome::compat::shared_ptr< double > ome::xml::model::Plate::getWellOriginX ( ) const

Get the WellOriginX property.

Returns
the WellOriginX property.

References wellOriginX.

ome::compat::shared_ptr< double > ome::xml::model::Plate::getWellOriginY ( )

Get the WellOriginY property.

Returns
the WellOriginY property.

References wellOriginY.

const ome::compat::shared_ptr< double > ome::xml::model::Plate::getWellOriginY ( ) const

Get the WellOriginY property.

Returns
the WellOriginY property.

References wellOriginY.

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

Get the XML namespace for this model object.

Returns
the XML namespace.

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

bool ome::xml::model::Plate::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::linkPlate(), ome::xml::model::detail::OMEModelObject::logger, and name.

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

bool ome::xml::model::Plate::linkScreen ( const ome::compat::shared_ptr< ome::xml::model::Screen > &  screen_BackReference)

Link Screen.

Parameters
screen_BackReferencethe Screen to link.
Returns
true if the object was added to the internal screenLinks list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References screenLinks.

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

+ Here is the caller graph for this function:

void ome::xml::model::Plate::removePlateAcquisition ( ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &  plateAcquisition)

Remove PlateAcquisition.

Parameters
plateAcquisitionthe PlateAcquisition 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 plateAcquisitions.

void ome::xml::model::Plate::removeWell ( ome::compat::shared_ptr< ome::xml::model::Well > &  well)

Remove Well.

Parameters
wellthe Well 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 wells.

void ome::xml::model::Plate::setColumnNamingConvention ( ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > &  columnNamingConvention)

Set the ColumnNamingConvention property.

Parameters
columnNamingConventionthe value to set.

References columnNamingConvention.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plate::setColumns ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &  columns)

Set the Columns property.

Parameters
columnsthe value to set.

References columns.

Referenced by update().

+ Here is the caller graph for this function:

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

Set the Description property.

Parameters
descriptionthe value to set.

References description.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plate::setExternalIdentifier ( ome::compat::shared_ptr< std::string > &  externalIdentifier)

Set the ExternalIdentifier property.

Parameters
externalIdentifierthe value to set.

References externalIdentifier.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plate::setFieldIndex ( ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &  fieldIndex)

Set the FieldIndex property.

Parameters
fieldIndexthe value to set.

References fieldIndex.

Referenced by update().

+ Here is the caller graph for this function:

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

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

const ome::compat::weak_ptr< ome::xml::model::Screen > & ome::xml::model::Plate::setLinkedScreen ( OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type  index,
const ome::compat::shared_ptr< ome::xml::model::Screen > &  screen_BackReference 
)

Set linked Screen.

Note
The index must be valid.
Parameters
indexthe index number of the Screen.
screen_BackReferencethe Screen to set.
Returns
a weak pointer to the Screen.
Exceptions
std::out_of_rangeif the index is invalid.

References screenLinks.

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

Set the Name property.

Parameters
namethe value to set.

References name.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plate::setPlateAcquisition ( std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type  index,
ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &  plateAcquisition 
)

Set PlateAcquisition.

Parameters
indexthe index number of the PlateAcquisition.
plateAcquisitionthe PlateAcquisition to set.
Exceptions
std::out_of_rangeif the index is invalid.

References plateAcquisitions.

void ome::xml::model::Plate::setRowNamingConvention ( ome::compat::shared_ptr< ome::xml::model::enums::NamingConvention > &  rowNamingConvention)

Set the RowNamingConvention property.

Parameters
rowNamingConventionthe value to set.

References rowNamingConvention.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plate::setRows ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &  rows)

Set the Rows property.

Parameters
rowsthe value to set.

References rows.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plate::setStatus ( ome::compat::shared_ptr< std::string > &  status)

Set the Status property.

Parameters
statusthe value to set.

References status.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plate::setWell ( std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type  index,
ome::compat::shared_ptr< ome::xml::model::Well > &  well 
)

Set Well.

Parameters
indexthe index number of the Well.
wellthe Well to set.
Exceptions
std::out_of_rangeif the index is invalid.

References wells.

void ome::xml::model::Plate::setWellOriginX ( ome::compat::shared_ptr< double > &  wellOriginX)

Set the WellOriginX property.

Parameters
wellOriginXthe value to set.

References wellOriginX.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Plate::setWellOriginY ( ome::compat::shared_ptr< double > &  wellOriginY)

Set the WellOriginY property.

Parameters
wellOriginYthe value to set.

References wellOriginY.

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

Get size of linked Annotation list.

Returns
the size of the list.

References annotationLinks.

OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type ome::xml::model::Plate::sizeOfLinkedScreenList ( ) const

Get size of linked Screen list.

Returns
the size of the list.

References screenLinks.

std::vector< ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > >::size_type ome::xml::model::Plate::sizeOfPlateAcquisitionList ( ) const

Get size of linked PlateAcquisition list.

Returns
the size of the list.

References plateAcquisitions.

std::vector< ome::compat::shared_ptr< ome::xml::model::Well > >::size_type ome::xml::model::Plate::sizeOfWellList ( ) const

Get size of linked Well list.

Returns
the size of the list.

References wells.

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

bool ome::xml::model::Plate::unlinkScreen ( const ome::compat::shared_ptr< ome::xml::model::Screen > &  screen_BackReference)

Unlink Screen.

Parameters
screen_BackReferencethe Screen to unlink.
Returns
true if the Screen was unlinked, otherwise false if the Screen 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 screenLinks.

void ome::xml::model::Plate::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::addModelObject(), addPlateAcquisition(), ome::xml::model::OMEModel::addReference(), addWell(), ome::xml::model::PlateAcquisition::create(), ome::xml::model::Well::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, setColumnNamingConvention(), setColumns(), setDescription(), setExternalIdentifier(), setFieldIndex(), setID(), setName(), setRowNamingConvention(), setRows(), setStatus(), setWellOriginX(), setWellOriginY(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().

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