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

PlateAcquisition model object. More...

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

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

Public Member Functions

 PlateAcquisition ()
 Default constructor.
 
 PlateAcquisition (const PlateAcquisition &copy)
 Copy constructor. More...
 
virtual ~PlateAcquisition ()
 Destructor.
 
const std::string & elementName () const
 Get the element name of this model object. More...
 
bool validElementName (const std::string &name) const
 Check if a given element name is valid for processing by this model object. More...
 
virtual void update (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Update the object hierarchy recursively from an XML DOM tree. More...
 
bool link (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetMaximumFieldCount ()
 Get the MaximumFieldCount property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetMaximumFieldCount () const
 Get the MaximumFieldCount property. More...
 
void setMaximumFieldCount (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &maximumFieldCount)
 Set the MaximumFieldCount property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::TimestampgetEndTime ()
 Get the EndTime property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::TimestampgetEndTime () const
 Get the EndTime property. More...
 
void setEndTime (ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &endTime)
 Set the EndTime 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::TimestampgetStartTime ()
 Get the StartTime property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::TimestampgetStartTime () const
 Get the StartTime property. More...
 
void setStartTime (ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &startTime)
 Set the StartTime 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...
 
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type sizeOfLinkedWellSampleList () const
 Get size of linked WellSample list. More...
 
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type getLinkedWellSampleList () const
 Get the linked WellSample list. More...
 
const ome::compat::weak_ptr< ome::xml::model::WellSample > & getLinkedWellSample (OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index) const
 Get linked WellSample. More...
 
const ome::compat::weak_ptr< ome::xml::model::WellSample > & setLinkedWellSample (OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
 Set linked WellSample. More...
 
bool linkWellSample (const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
 Link WellSample. More...
 
bool unlinkWellSample (const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
 Unlink WellSample. 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::PlategetPlate ()
 Get the Plate property. More...
 
const ome::compat::weak_ptr< ome::xml::model::PlategetPlate () const
 Get the Plate property. More...
 
void setPlate (ome::compat::weak_ptr< ome::xml::model::Plate > &plate_BackReference)
 Set the Plate 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< PlateAcquisitioncreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a PlateAcquisition 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< ome::xml::model::primitives::PositiveIntegermaximumFieldCount
 MaximumFieldCount property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::TimestampendTime
 EndTime property.
 
std::string id
 ID property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::TimestampstartTime
 StartTime property.
 
ome::compat::shared_ptr< std::string > name
 Name property.
 
ome::compat::shared_ptr< std::string > description
 Description property.
 
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type wellSamples
 WellSampleRef reference (occurs more than once)
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
 AnnotationRef reference (occurs more than once)
 
ome::compat::weak_ptr< ome::xml::model::Plateplate
 Plate_BackReference back reference.
 

Additional Inherited Members

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

Detailed Description

PlateAcquisition model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters
copythe PlateAcquisition to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::PlateAcquisition::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::PlateAcquisition::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(), ome::common::xml::dom::Document::createElementNS(), description, endTime, id, maximumFieldCount, name, ome::common::xml::dom::Element::setAttribute(), startTime, and wellSamples.

Referenced by asXMLElement().

+ Here is the caller graph for this function:

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

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

+ Here is the caller graph for this function:

const std::string & ome::xml::model::PlateAcquisition::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< std::string > ome::xml::model::PlateAcquisition::getDescription ( )

Get the Description property.

Returns
the Description property.

References description.

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

Get the Description property.

Returns
the Description property.

References description.

ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > ome::xml::model::PlateAcquisition::getEndTime ( )

Get the EndTime property.

Returns
the EndTime property.

References endTime.

const ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > ome::xml::model::PlateAcquisition::getEndTime ( ) const

Get the EndTime property.

Returns
the EndTime property.

References endTime.

const std::string & ome::xml::model::PlateAcquisition::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::PlateAcquisition::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::PlateAcquisition::getLinkedAnnotationList ( ) const

Get the linked Annotation list.

Returns
a reference to the list.

References annotationLinks.

const ome::compat::weak_ptr< ome::xml::model::WellSample > & ome::xml::model::PlateAcquisition::getLinkedWellSample ( OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type  index) const

Get linked WellSample.

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

References wellSamples.

OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type ome::xml::model::PlateAcquisition::getLinkedWellSampleList ( ) const

Get the linked WellSample list.

Returns
a reference to the list.

References wellSamples.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::PlateAcquisition::getMaximumFieldCount ( )

Get the MaximumFieldCount property.

Returns
the MaximumFieldCount property.

References maximumFieldCount.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::PlateAcquisition::getMaximumFieldCount ( ) const

Get the MaximumFieldCount property.

Returns
the MaximumFieldCount property.

References maximumFieldCount.

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

Get the Name property.

Returns
the Name property.

References name.

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

Get the Name property.

Returns
the Name property.

References name.

ome::compat::weak_ptr< ome::xml::model::Plate > ome::xml::model::PlateAcquisition::getPlate ( )

Get the Plate property.

Returns
the Plate property.

References plate.

const ome::compat::weak_ptr< ome::xml::model::Plate > ome::xml::model::PlateAcquisition::getPlate ( ) const

Get the Plate property.

Returns
the Plate property.

References plate.

ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > ome::xml::model::PlateAcquisition::getStartTime ( )

Get the StartTime property.

Returns
the StartTime property.

References startTime.

const ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > ome::xml::model::PlateAcquisition::getStartTime ( ) const

Get the StartTime property.

Returns
the StartTime property.

References startTime.

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

Get the XML namespace for this model object.

Returns
the XML namespace.

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

bool ome::xml::model::PlateAcquisition::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.
Todo:
This bit is silly; why do we have two dynamic_casts here.

References annotationLinks, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::WellSample::linkPlateAcquisition(), ome::xml::model::Annotation::linkPlateAcquisition(), ome::xml::model::detail::OMEModelObject::logger, name, and wellSamples.

bool ome::xml::model::PlateAcquisition::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::PlateAcquisition::linkWellSample ( const ome::compat::shared_ptr< ome::xml::model::WellSample > &  wellSample)

Link WellSample.

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

References wellSamples.

void ome::xml::model::PlateAcquisition::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::PlateAcquisition::setEndTime ( ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &  endTime)

Set the EndTime property.

Parameters
endTimethe value to set.

References endTime.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::PlateAcquisition::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::PlateAcquisition::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::WellSample > & ome::xml::model::PlateAcquisition::setLinkedWellSample ( OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type  index,
const ome::compat::shared_ptr< ome::xml::model::WellSample > &  wellSample 
)

Set linked WellSample.

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

References wellSamples.

void ome::xml::model::PlateAcquisition::setMaximumFieldCount ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &  maximumFieldCount)

Set the MaximumFieldCount property.

Parameters
maximumFieldCountthe value to set.

References maximumFieldCount.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::PlateAcquisition::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::PlateAcquisition::setPlate ( ome::compat::weak_ptr< ome::xml::model::Plate > &  plate_BackReference)

Set the Plate property.

Parameters
plate_BackReferencethe value to set.

References plate.

void ome::xml::model::PlateAcquisition::setStartTime ( ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &  startTime)

Set the StartTime property.

Parameters
startTimethe value to set.

References startTime.

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

Get size of linked Annotation list.

Returns
the size of the list.

References annotationLinks.

OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type ome::xml::model::PlateAcquisition::sizeOfLinkedWellSampleList ( ) const

Get size of linked WellSample list.

Returns
the size of the list.

References wellSamples.

bool ome::xml::model::PlateAcquisition::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::PlateAcquisition::unlinkWellSample ( const ome::compat::shared_ptr< ome::xml::model::WellSample > &  wellSample)

Unlink WellSample.

Parameters
wellSamplethe WellSample to unlink.
Returns
true if the WellSample was unlinked, otherwise false if the WellSample 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 wellSamples.

void ome::xml::model::PlateAcquisition::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(), ome::xml::model::OMEModel::addReference(), 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, setDescription(), setEndTime(), setID(), setMaximumFieldCount(), setName(), setStartTime(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().

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