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

ExperimenterGroup model object. More...

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

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

Public Member Functions

 ExperimenterGroup ()
 Default constructor.
 
 ExperimenterGroup (const ExperimenterGroup &copy)
 Copy constructor. More...
 
virtual ~ExperimenterGroup ()
 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 > 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...
 
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< 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::Experimenter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedExperimenterList () const
 Get size of linked Experimenter list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type getLinkedExperimenterList () const
 Get the linked Experimenter list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Experimenter > & getLinkedExperimenter (OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Experimenter. More...
 
const ome::compat::weak_ptr< ome::xml::model::Experimenter > & setLinkedExperimenter (OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
 Set linked Experimenter. More...
 
bool linkExperimenter (const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
 Link Experimenter. More...
 
bool unlinkExperimenter (const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
 Unlink Experimenter. More...
 
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedLeaderList () const
 Get size of linked Leader list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type getLinkedLeaderList () const
 Get the linked Leader list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Experimenter > & getLinkedLeader (OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Leader. More...
 
const ome::compat::weak_ptr< ome::xml::model::Experimenter > & setLinkedLeader (OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Experimenter > &leader)
 Set linked Leader. More...
 
bool linkLeader (const ome::compat::shared_ptr< ome::xml::model::Experimenter > &leader)
 Link Leader. More...
 
bool unlinkLeader (const ome::compat::shared_ptr< ome::xml::model::Experimenter > &leader)
 Unlink Leader. 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...
 
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList () const
 Get size of linked Image list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList () const
 Get the linked Image list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Image > & getLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Image. More...
 
const ome::compat::weak_ptr< ome::xml::model::Image > & setLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
 Set linked Image. More...
 
bool linkImage (const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
 Link Image. More...
 
bool unlinkImage (const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
 Unlink Image. More...
 
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type sizeOfLinkedProjectList () const
 Get size of linked Project list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type getLinkedProjectList () const
 Get the linked Project list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Project > & getLinkedProject (OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Project. More...
 
const ome::compat::weak_ptr< ome::xml::model::Project > & setLinkedProject (OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
 Set linked Project. More...
 
bool linkProject (const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
 Link Project. More...
 
bool unlinkProject (const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
 Unlink Project. More...
 
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type sizeOfLinkedDatasetList () const
 Get size of linked Dataset list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type getLinkedDatasetList () const
 Get the linked Dataset list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Dataset > & getLinkedDataset (OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Dataset. More...
 
const ome::compat::weak_ptr< ome::xml::model::Dataset > & setLinkedDataset (OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
 Set linked Dataset. More...
 
bool linkDataset (const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
 Link Dataset. More...
 
bool unlinkDataset (const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
 Unlink Dataset. 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< ExperimenterGroupcreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a ExperimenterGroup 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 > name
 Name property.
 
std::string id
 ID property.
 
ome::compat::shared_ptr< std::string > description
 Description property.
 
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type experimenterLinks
 ExperimenterRef reference (occurs more than once)
 
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type leaders
 Leader reference (occurs more than once)
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
 AnnotationRef reference (occurs more than once)
 
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type images
 Image_BackReference back reference (occurs more than once)
 
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type projects
 Project_BackReference back reference (occurs more than once)
 
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type datasets
 Dataset_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

ExperimenterGroup model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters
copythe ExperimenterGroup to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::ExperimenterGroup::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::ExperimenterGroup::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, experimenterLinks, id, leaders, name, and ome::common::xml::dom::Element::setAttribute().

Referenced by asXMLElement().

+ Here is the caller graph for this function:

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

Create a ExperimenterGroup 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::ExperimenterGroup::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::ExperimenterGroup::getDescription ( )

Get the Description property.

Returns
the Description property.

References description.

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

Get the Description property.

Returns
the Description property.

References description.

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

Get the linked Annotation list.

Returns
a reference to the list.

References annotationLinks.

const ome::compat::weak_ptr< ome::xml::model::Dataset > & ome::xml::model::ExperimenterGroup::getLinkedDataset ( OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type  index) const

Get linked Dataset.

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

References datasets.

OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type ome::xml::model::ExperimenterGroup::getLinkedDatasetList ( ) const

Get the linked Dataset list.

Returns
a reference to the list.

References datasets.

const ome::compat::weak_ptr< ome::xml::model::Experimenter > & ome::xml::model::ExperimenterGroup::getLinkedExperimenter ( OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type  index) const

Get linked Experimenter.

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

References experimenterLinks.

OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type ome::xml::model::ExperimenterGroup::getLinkedExperimenterList ( ) const

Get the linked Experimenter list.

Returns
a reference to the list.

References experimenterLinks.

const ome::compat::weak_ptr< ome::xml::model::Image > & ome::xml::model::ExperimenterGroup::getLinkedImage ( OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type  index) const

Get linked Image.

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

References images.

OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type ome::xml::model::ExperimenterGroup::getLinkedImageList ( ) const

Get the linked Image list.

Returns
a reference to the list.

References images.

const ome::compat::weak_ptr< ome::xml::model::Experimenter > & ome::xml::model::ExperimenterGroup::getLinkedLeader ( OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type  index) const

Get linked Leader.

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

References leaders.

OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type ome::xml::model::ExperimenterGroup::getLinkedLeaderList ( ) const

Get the linked Leader list.

Returns
a reference to the list.

References leaders.

const ome::compat::weak_ptr< ome::xml::model::Project > & ome::xml::model::ExperimenterGroup::getLinkedProject ( OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type  index) const

Get linked Project.

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

References projects.

OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type ome::xml::model::ExperimenterGroup::getLinkedProjectList ( ) const

Get the linked Project list.

Returns
a reference to the list.

References projects.

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

Get the Name property.

Returns
the Name property.

References name.

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

Get the Name property.

Returns
the Name property.

References name.

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

Get the XML namespace for this model object.

Returns
the XML namespace.

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

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

References annotationLinks, experimenterLinks, leaders, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::Experimenter::linkExperimenterGroup(), ome::xml::model::Annotation::linkExperimenterGroup(), ome::xml::model::detail::OMEModelObject::logger, and name.

bool ome::xml::model::ExperimenterGroup::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::ExperimenterGroup::linkDataset ( const ome::compat::shared_ptr< ome::xml::model::Dataset > &  dataset_BackReference)

Link Dataset.

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

References datasets.

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

+ Here is the caller graph for this function:

bool ome::xml::model::ExperimenterGroup::linkExperimenter ( const ome::compat::shared_ptr< ome::xml::model::Experimenter > &  experimenter)

Link Experimenter.

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

References experimenterLinks.

bool ome::xml::model::ExperimenterGroup::linkImage ( const ome::compat::shared_ptr< ome::xml::model::Image > &  image_BackReference)

Link Image.

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

References images.

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

+ Here is the caller graph for this function:

bool ome::xml::model::ExperimenterGroup::linkLeader ( const ome::compat::shared_ptr< ome::xml::model::Experimenter > &  leader)

Link Leader.

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

References leaders.

bool ome::xml::model::ExperimenterGroup::linkProject ( const ome::compat::shared_ptr< ome::xml::model::Project > &  project_BackReference)

Link Project.

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

References projects.

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

+ Here is the caller graph for this function:

void ome::xml::model::ExperimenterGroup::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::ExperimenterGroup::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::ExperimenterGroup::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::Dataset > & ome::xml::model::ExperimenterGroup::setLinkedDataset ( OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type  index,
const ome::compat::shared_ptr< ome::xml::model::Dataset > &  dataset_BackReference 
)

Set linked Dataset.

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

References datasets.

const ome::compat::weak_ptr< ome::xml::model::Experimenter > & ome::xml::model::ExperimenterGroup::setLinkedExperimenter ( OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type  index,
const ome::compat::shared_ptr< ome::xml::model::Experimenter > &  experimenter 
)

Set linked Experimenter.

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

References experimenterLinks.

const ome::compat::weak_ptr< ome::xml::model::Image > & ome::xml::model::ExperimenterGroup::setLinkedImage ( OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type  index,
const ome::compat::shared_ptr< ome::xml::model::Image > &  image_BackReference 
)

Set linked Image.

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

References images.

const ome::compat::weak_ptr< ome::xml::model::Experimenter > & ome::xml::model::ExperimenterGroup::setLinkedLeader ( OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type  index,
const ome::compat::shared_ptr< ome::xml::model::Experimenter > &  leader 
)

Set linked Leader.

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

References leaders.

const ome::compat::weak_ptr< ome::xml::model::Project > & ome::xml::model::ExperimenterGroup::setLinkedProject ( OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type  index,
const ome::compat::shared_ptr< ome::xml::model::Project > &  project_BackReference 
)

Set linked Project.

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

References projects.

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

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

Get size of linked Annotation list.

Returns
the size of the list.

References annotationLinks.

OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type ome::xml::model::ExperimenterGroup::sizeOfLinkedDatasetList ( ) const

Get size of linked Dataset list.

Returns
the size of the list.

References datasets.

OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type ome::xml::model::ExperimenterGroup::sizeOfLinkedExperimenterList ( ) const

Get size of linked Experimenter list.

Returns
the size of the list.

References experimenterLinks.

OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type ome::xml::model::ExperimenterGroup::sizeOfLinkedImageList ( ) const

Get size of linked Image list.

Returns
the size of the list.

References images.

OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type ome::xml::model::ExperimenterGroup::sizeOfLinkedLeaderList ( ) const

Get size of linked Leader list.

Returns
the size of the list.

References leaders.

OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type ome::xml::model::ExperimenterGroup::sizeOfLinkedProjectList ( ) const

Get size of linked Project list.

Returns
the size of the list.

References projects.

bool ome::xml::model::ExperimenterGroup::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::ExperimenterGroup::unlinkDataset ( const ome::compat::shared_ptr< ome::xml::model::Dataset > &  dataset_BackReference)

Unlink Dataset.

Parameters
dataset_BackReferencethe Dataset to unlink.
Returns
true if the Dataset was unlinked, otherwise false if the Dataset 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 datasets.

bool ome::xml::model::ExperimenterGroup::unlinkExperimenter ( const ome::compat::shared_ptr< ome::xml::model::Experimenter > &  experimenter)

Unlink Experimenter.

Parameters
experimenterthe Experimenter to unlink.
Returns
true if the Experimenter was unlinked, otherwise false if the Experimenter 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 experimenterLinks.

bool ome::xml::model::ExperimenterGroup::unlinkImage ( const ome::compat::shared_ptr< ome::xml::model::Image > &  image_BackReference)

Unlink Image.

Parameters
image_BackReferencethe Image to unlink.
Returns
true if the Image was unlinked, otherwise false if the Image 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 images.

bool ome::xml::model::ExperimenterGroup::unlinkLeader ( const ome::compat::shared_ptr< ome::xml::model::Experimenter > &  leader)

Unlink Leader.

Parameters
leaderthe Leader to unlink.
Returns
true if the Leader was unlinked, otherwise false if the Leader 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 leaders.

bool ome::xml::model::ExperimenterGroup::unlinkProject ( const ome::compat::shared_ptr< ome::xml::model::Project > &  project_BackReference)

Unlink Project.

Parameters
project_BackReferencethe Project to unlink.
Returns
true if the Project was unlinked, otherwise false if the Project 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 projects.

void ome::xml::model::ExperimenterGroup::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(), setID(), setName(), ome::xml::model::detail::OMEModelObject::stripNamespacePrefix(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().

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