ome-xml  5.6.0
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ome::xml::model::Image Class Reference

Image model object. More...

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

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

Classes

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

Public Member Functions

 Image ()
 Default constructor.
 
 Image (const Image &copy)
 Copy constructor. More...
 
virtual ~Image ()
 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 SKIP 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 (std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
const std::string & getID () const
 Get the ID property. More...
 
void setID (const std::string &id)
 Set the ID property. More...
 
std::shared_ptr< std::string > getName ()
 Get the Name property. More...
 
const std::shared_ptr< std::string > getName () const
 Get the Name property. More...
 
void setName (std::shared_ptr< std::string > &name)
 Set the Name property. More...
 
std::shared_ptr< ome::xml::model::primitives::TimestampgetAcquisitionDate ()
 Get the AcquisitionDate property. More...
 
const std::shared_ptr< ome::xml::model::primitives::TimestampgetAcquisitionDate () const
 Get the AcquisitionDate property. More...
 
void setAcquisitionDate (std::shared_ptr< ome::xml::model::primitives::Timestamp > &acquisitionDate)
 Set the AcquisitionDate property. More...
 
std::weak_ptr< ome::xml::model::ExperimentergetLinkedExperimenter ()
 Get linked Experimenter. More...
 
const std::weak_ptr< ome::xml::model::ExperimentergetLinkedExperimenter () const
 Get linked Experimenter. More...
 
void linkExperimenter (std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
 Link Experimenter. More...
 
void unlinkExperimenter (std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
 Unlink Experimenter. More...
 
std::shared_ptr< std::string > getDescription ()
 Get the Description property. More...
 
const std::shared_ptr< std::string > getDescription () const
 Get the Description property. More...
 
void setDescription (std::shared_ptr< std::string > &description)
 Set the Description property. More...
 
std::weak_ptr< ome::xml::model::ExperimentgetLinkedExperiment ()
 Get linked Experiment. More...
 
const std::weak_ptr< ome::xml::model::ExperimentgetLinkedExperiment () const
 Get linked Experiment. More...
 
void linkExperiment (std::shared_ptr< ome::xml::model::Experiment > &experiment)
 Link Experiment. More...
 
void unlinkExperiment (std::shared_ptr< ome::xml::model::Experiment > &experiment)
 Unlink Experiment. More...
 
std::weak_ptr< ome::xml::model::ExperimenterGroupgetLinkedExperimenterGroup ()
 Get linked ExperimenterGroup. More...
 
const std::weak_ptr< ome::xml::model::ExperimenterGroupgetLinkedExperimenterGroup () const
 Get linked ExperimenterGroup. More...
 
void linkExperimenterGroup (std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
 Link ExperimenterGroup. More...
 
void unlinkExperimenterGroup (std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
 Unlink ExperimenterGroup. More...
 
std::weak_ptr< ome::xml::model::InstrumentgetLinkedInstrument ()
 Get linked Instrument. More...
 
const std::weak_ptr< ome::xml::model::InstrumentgetLinkedInstrument () const
 Get linked Instrument. More...
 
void linkInstrument (std::shared_ptr< ome::xml::model::Instrument > &instrument)
 Link Instrument. More...
 
void unlinkInstrument (std::shared_ptr< ome::xml::model::Instrument > &instrument)
 Unlink Instrument. More...
 
std::shared_ptr< ome::xml::model::ObjectiveSettingsgetObjectiveSettings ()
 Get the ObjectiveSettings property. More...
 
const std::shared_ptr< ome::xml::model::ObjectiveSettingsgetObjectiveSettings () const
 Get the ObjectiveSettings property. More...
 
void setObjectiveSettings (std::shared_ptr< ome::xml::model::ObjectiveSettings > &objectiveSettings)
 Set the ObjectiveSettings property. More...
 
std::shared_ptr< ome::xml::model::ImagingEnvironmentgetImagingEnvironment ()
 Get the ImagingEnvironment property. More...
 
const std::shared_ptr< ome::xml::model::ImagingEnvironmentgetImagingEnvironment () const
 Get the ImagingEnvironment property. More...
 
void setImagingEnvironment (std::shared_ptr< ome::xml::model::ImagingEnvironment > &imagingEnvironment)
 Set the ImagingEnvironment property. More...
 
std::shared_ptr< ome::xml::model::StageLabelgetStageLabel ()
 Get the StageLabel property. More...
 
const std::shared_ptr< ome::xml::model::StageLabelgetStageLabel () const
 Get the StageLabel property. More...
 
void setStageLabel (std::shared_ptr< ome::xml::model::StageLabel > &stageLabel)
 Set the StageLabel property. More...
 
std::shared_ptr< ome::xml::model::PixelsgetPixels ()
 Get the Pixels property. More...
 
const std::shared_ptr< ome::xml::model::PixelsgetPixels () const
 Get the Pixels property. More...
 
void setPixels (std::shared_ptr< ome::xml::model::Pixels > &pixels)
 Set the Pixels property. More...
 
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type sizeOfLinkedROIList () const
 Get size of linked ROI list. More...
 
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type getLinkedROIList () const
 Get the linked ROI list. More...
 
const std::weak_ptr< ome::xml::model::ROI > & getLinkedROI (OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index) const
 Get linked ROI. More...
 
const std::weak_ptr< ome::xml::model::ROI > & setLinkedROI (OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::ROI > &roi)
 Set linked ROI. More...
 
bool linkROI (const std::shared_ptr< ome::xml::model::ROI > &roi)
 Link ROI. More...
 
bool unlinkROI (const std::shared_ptr< ome::xml::model::ROI > &roi)
 Unlink ROI. More...
 
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type sizeOfLinkedMicrobeamManipulationList () const
 Get size of linked MicrobeamManipulation list. More...
 
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type getLinkedMicrobeamManipulationList () const
 Get the linked MicrobeamManipulation list. More...
 
const std::weak_ptr< ome::xml::model::MicrobeamManipulation > & getLinkedMicrobeamManipulation (OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type index) const
 Get linked MicrobeamManipulation. More...
 
const std::weak_ptr< ome::xml::model::MicrobeamManipulation > & setLinkedMicrobeamManipulation (OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
 Set linked MicrobeamManipulation. More...
 
bool linkMicrobeamManipulation (const std::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
 Link MicrobeamManipulation. More...
 
bool unlinkMicrobeamManipulation (const std::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
 Unlink MicrobeamManipulation. More...
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList () const
 Get size of linked Annotation list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList () const
 Get the linked Annotation list. More...
 
const std::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
 Get linked Annotation. More...
 
const std::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation)
 Set linked Annotation. More...
 
bool linkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation)
 Link Annotation. More...
 
bool unlinkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation)
 Unlink Annotation. More...
 
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type sizeOfLinkedDatasetList () const
 Get size of linked Dataset list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type getLinkedDatasetList () const
 Get the linked Dataset list. More...
 
const std::weak_ptr< ome::xml::model::Dataset > & getLinkedDataset (OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index) const
 Get linked Dataset. More...
 
const std::weak_ptr< ome::xml::model::Dataset > & setLinkedDataset (OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
 Set linked Dataset. More...
 
bool linkDataset (const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
 Link Dataset. More...
 
bool unlinkDataset (const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
 Unlink Dataset. More...
 
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type sizeOfLinkedFolderList () const
 Get size of linked Folder list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type getLinkedFolderList () const
 Get the linked Folder list. More...
 
const std::weak_ptr< ome::xml::model::Folder > & getLinkedFolder (OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type index) const
 Get linked Folder. More...
 
const std::weak_ptr< ome::xml::model::Folder > & setLinkedFolder (OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
 Set linked Folder. More...
 
bool linkFolder (const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
 Link Folder. More...
 
bool unlinkFolder (const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
 Unlink Folder. More...
 
OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type::size_type sizeOfLinkedWellSampleList () const
 Get size of linked WellSample list. More...
 
OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type getLinkedWellSampleList () const
 Get the linked WellSample list. More...
 
const std::weak_ptr< ome::xml::model::WellSample > & getLinkedWellSample (OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type::size_type index) const
 Get linked WellSample. More...
 
const std::weak_ptr< ome::xml::model::WellSample > & setLinkedWellSample (OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
 Set linked WellSample. More...
 
bool linkWellSample (const std::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
 Link WellSample. More...
 
bool unlinkWellSample (const std::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
 Unlink WellSample. 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 common::xml::dom::Element asXMLElement (common::xml::dom::Document &document) const
 Transform the object hierarchy rooted at this element to XML. More...
 
virtual void asXMLElement (common::xml::dom::Document &document, common::xml::dom::Element &element) const
 Transform the object hierarchy rooted at this element to XML. 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...
 
virtual bool link (std::shared_ptr< Reference > &reference, std::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 (std::shared_ptr< Reference > &reference, std::shared_ptr< OMEModelObject > &object)=0
 Link a given OME model object to this model object. More...
 

Static Public Member Functions

static std::shared_ptr< Imagecreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a Image 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 void 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. More...
 
 OMEModelObject (const OMEModelObject &copy)
 Copy constructor. More...
 
template<class C , typename T >
bool contains (const C &container, const std::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

std::shared_ptr< Implimpl
 Private implementation details.
 

Additional Inherited Members

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

Detailed Description

Image model object.

Constructor & Destructor Documentation

◆ Image()

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

Copy constructor.

Parameters
copythe Image to copy.

Member Function Documentation

◆ asXMLElementInternal()

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

Concrete model object implementations should override this method.

Parameters
documentXML document for element creation.
elementXML element for setting model data.

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

References ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().

◆ create()

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

Create a Image 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:

◆ elementName()

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

◆ getAcquisitionDate() [1/2]

std::shared_ptr< ome::xml::model::primitives::Timestamp > ome::xml::model::Image::getAcquisitionDate ( )

Get the AcquisitionDate property.

Returns
the AcquisitionDate property.

References impl.

◆ getAcquisitionDate() [2/2]

const std::shared_ptr< ome::xml::model::primitives::Timestamp > ome::xml::model::Image::getAcquisitionDate ( ) const

Get the AcquisitionDate property.

Returns
the AcquisitionDate property.

References impl.

◆ getDescription() [1/2]

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

Get the Description property.

Returns
the Description property.

References impl.

◆ getDescription() [2/2]

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

Get the Description property.

Returns
the Description property.

References impl.

◆ getID()

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

Get the ID property.

Returns
the ID property.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ getImagingEnvironment() [1/2]

std::shared_ptr< ome::xml::model::ImagingEnvironment > ome::xml::model::Image::getImagingEnvironment ( )

Get the ImagingEnvironment property.

Returns
the ImagingEnvironment property.

References impl.

◆ getImagingEnvironment() [2/2]

const std::shared_ptr< ome::xml::model::ImagingEnvironment > ome::xml::model::Image::getImagingEnvironment ( ) const

Get the ImagingEnvironment property.

Returns
the ImagingEnvironment property.

References impl.

◆ getLinkedAnnotation()

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

Get linked Annotation.

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

References impl.

◆ getLinkedAnnotationList()

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

Get the linked Annotation list.

Returns
a reference to the list.

References impl.

◆ getLinkedDataset()

const std::weak_ptr< ome::xml::model::Dataset > & ome::xml::model::Image::getLinkedDataset ( OMEModelObject::indexed_container< ome::xml::model::Dataset, std::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 impl.

◆ getLinkedDatasetList()

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

Get the linked Dataset list.

Returns
a reference to the list.

References impl.

◆ getLinkedExperiment() [1/2]

std::weak_ptr< ome::xml::model::Experiment > ome::xml::model::Image::getLinkedExperiment ( )

Get linked Experiment.

Returns
the linked Experiment. The pointer may be null.

References impl.

◆ getLinkedExperiment() [2/2]

const std::weak_ptr< ome::xml::model::Experiment > ome::xml::model::Image::getLinkedExperiment ( ) const

Get linked Experiment.

Returns
the linked Experiment. The pointer may be null.

References impl.

◆ getLinkedExperimenter() [1/2]

std::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::Image::getLinkedExperimenter ( )

Get linked Experimenter.

Returns
the linked Experimenter. The pointer may be null.

References impl.

◆ getLinkedExperimenter() [2/2]

const std::weak_ptr< ome::xml::model::Experimenter > ome::xml::model::Image::getLinkedExperimenter ( ) const

Get linked Experimenter.

Returns
the linked Experimenter. The pointer may be null.

References impl.

◆ getLinkedExperimenterGroup() [1/2]

std::weak_ptr< ome::xml::model::ExperimenterGroup > ome::xml::model::Image::getLinkedExperimenterGroup ( )

Get linked ExperimenterGroup.

Returns
the linked ExperimenterGroup. The pointer may be null.

References impl.

◆ getLinkedExperimenterGroup() [2/2]

const std::weak_ptr< ome::xml::model::ExperimenterGroup > ome::xml::model::Image::getLinkedExperimenterGroup ( ) const

Get linked ExperimenterGroup.

Returns
the linked ExperimenterGroup. The pointer may be null.

References impl.

◆ getLinkedFolder()

const std::weak_ptr< ome::xml::model::Folder > & ome::xml::model::Image::getLinkedFolder ( OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type  index) const

Get linked Folder.

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

References impl.

◆ getLinkedFolderList()

OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type ome::xml::model::Image::getLinkedFolderList ( ) const

Get the linked Folder list.

Returns
a reference to the list.

References impl.

◆ getLinkedInstrument() [1/2]

std::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Image::getLinkedInstrument ( )

Get linked Instrument.

Returns
the linked Instrument. The pointer may be null.

References impl.

◆ getLinkedInstrument() [2/2]

const std::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Image::getLinkedInstrument ( ) const

Get linked Instrument.

Returns
the linked Instrument. The pointer may be null.

References impl.

◆ getLinkedMicrobeamManipulation()

const std::weak_ptr< ome::xml::model::MicrobeamManipulation > & ome::xml::model::Image::getLinkedMicrobeamManipulation ( OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type  index) const

Get linked MicrobeamManipulation.

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

References impl.

◆ getLinkedMicrobeamManipulationList()

OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type ome::xml::model::Image::getLinkedMicrobeamManipulationList ( ) const

Get the linked MicrobeamManipulation list.

Returns
a reference to the list.

References impl.

◆ getLinkedROI()

const std::weak_ptr< ome::xml::model::ROI > & ome::xml::model::Image::getLinkedROI ( OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type  index) const

Get linked ROI.

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

References impl.

◆ getLinkedROIList()

OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type ome::xml::model::Image::getLinkedROIList ( ) const

Get the linked ROI list.

Returns
a reference to the list.

References impl.

◆ getLinkedWellSample()

const std::weak_ptr< ome::xml::model::WellSample > & ome::xml::model::Image::getLinkedWellSample ( OMEModelObject::indexed_container< ome::xml::model::WellSample, std::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 impl.

◆ getLinkedWellSampleList()

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

Get the linked WellSample list.

Returns
a reference to the list.

References impl.

◆ getName() [1/2]

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

Get the Name property.

Returns
the Name property.

References impl.

◆ getName() [2/2]

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

Get the Name property.

Returns
the Name property.

References impl.

◆ getObjectiveSettings() [1/2]

std::shared_ptr< ome::xml::model::ObjectiveSettings > ome::xml::model::Image::getObjectiveSettings ( )

Get the ObjectiveSettings property.

Returns
the ObjectiveSettings property.

References impl.

◆ getObjectiveSettings() [2/2]

const std::shared_ptr< ome::xml::model::ObjectiveSettings > ome::xml::model::Image::getObjectiveSettings ( ) const

Get the ObjectiveSettings property.

Returns
the ObjectiveSettings property.

References impl.

◆ getPixels() [1/2]

std::shared_ptr< ome::xml::model::Pixels > ome::xml::model::Image::getPixels ( )

Get the Pixels property.

Returns
the Pixels property.

References impl.

◆ getPixels() [2/2]

const std::shared_ptr< ome::xml::model::Pixels > ome::xml::model::Image::getPixels ( ) const

Get the Pixels property.

Returns
the Pixels property.

References impl.

◆ getStageLabel() [1/2]

std::shared_ptr< ome::xml::model::StageLabel > ome::xml::model::Image::getStageLabel ( )

Get the StageLabel property.

Returns
the StageLabel property.

References impl.

◆ getStageLabel() [2/2]

const std::shared_ptr< ome::xml::model::StageLabel > ome::xml::model::Image::getStageLabel ( ) const

Get the StageLabel property.

Returns
the StageLabel property.

References impl.

◆ getXMLNamespace()

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

Get the XML namespace for this model object.

Returns
the XML namespace.

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

Referenced by asXMLElementInternal().

+ Here is the caller graph for this function:

◆ link()

bool ome::xml::model::Image::link ( std::shared_ptr< Reference > &  reference,
std::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.
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.
Todo:
This bit is silly; why do we have two dynamic_casts here.

References impl, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::Annotation::linkImage(), ome::xml::model::ROI::linkImage(), ome::xml::model::Experiment::linkImage(), ome::xml::model::Experimenter::linkImage(), ome::xml::model::MicrobeamManipulation::linkImage(), ome::xml::model::ExperimenterGroup::linkImage(), ome::xml::model::Instrument::linkImage(), and ome::xml::model::detail::OMEModelObject::logger.

◆ linkAnnotation()

bool ome::xml::model::Image::linkAnnotation ( const std::shared_ptr< ome::xml::model::Annotation > &  annotation)

Link Annotation.

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

References impl.

◆ linkDataset()

bool ome::xml::model::Image::linkDataset ( const std::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 datasetLinks list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References impl.

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

+ Here is the caller graph for this function:

◆ linkExperiment()

void ome::xml::model::Image::linkExperiment ( std::shared_ptr< ome::xml::model::Experiment > &  experiment)

Link Experiment.

Parameters
experimentthe Experiment to link.

References impl.

◆ linkExperimenter()

void ome::xml::model::Image::linkExperimenter ( std::shared_ptr< ome::xml::model::Experimenter > &  experimenter)

Link Experimenter.

Parameters
experimenterthe Experimenter to link.

References impl.

◆ linkExperimenterGroup()

void ome::xml::model::Image::linkExperimenterGroup ( std::shared_ptr< ome::xml::model::ExperimenterGroup > &  experimenterGroup)

Link ExperimenterGroup.

Parameters
experimenterGroupthe ExperimenterGroup to link.

References impl.

◆ linkFolder()

bool ome::xml::model::Image::linkFolder ( const std::shared_ptr< ome::xml::model::Folder > &  folder_BackReference)

Link Folder.

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

References impl.

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

+ Here is the caller graph for this function:

◆ linkInstrument()

void ome::xml::model::Image::linkInstrument ( std::shared_ptr< ome::xml::model::Instrument > &  instrument)

Link Instrument.

Parameters
instrumentthe Instrument to link.

References impl.

◆ linkMicrobeamManipulation()

bool ome::xml::model::Image::linkMicrobeamManipulation ( const std::shared_ptr< ome::xml::model::MicrobeamManipulation > &  microbeamManipulation)

Link MicrobeamManipulation.

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

References impl.

◆ linkROI()

bool ome::xml::model::Image::linkROI ( const std::shared_ptr< ome::xml::model::ROI > &  roi)

Link ROI.

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

References impl.

◆ linkWellSample()

bool ome::xml::model::Image::linkWellSample ( const std::shared_ptr< ome::xml::model::WellSample > &  wellSample_BackReference)

Link WellSample.

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

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

+ Here is the caller graph for this function:

◆ setAcquisitionDate()

void ome::xml::model::Image::setAcquisitionDate ( std::shared_ptr< ome::xml::model::primitives::Timestamp > &  acquisitionDate)

Set the AcquisitionDate property.

Parameters
acquisitionDatethe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setDescription()

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

Set the Description property.

Parameters
descriptionthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setID()

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

Set the ID property.

Parameters
idthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setImagingEnvironment()

void ome::xml::model::Image::setImagingEnvironment ( std::shared_ptr< ome::xml::model::ImagingEnvironment > &  imagingEnvironment)

Set the ImagingEnvironment property.

Parameters
imagingEnvironmentthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setLinkedAnnotation()

const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Image::setLinkedAnnotation ( OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::Annotation > &  annotation 
)

Set linked Annotation.

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

References impl.

◆ setLinkedDataset()

const std::weak_ptr< ome::xml::model::Dataset > & ome::xml::model::Image::setLinkedDataset ( OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type  index,
const std::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 impl.

◆ setLinkedFolder()

const std::weak_ptr< ome::xml::model::Folder > & ome::xml::model::Image::setLinkedFolder ( OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::Folder > &  folder_BackReference 
)

Set linked Folder.

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

References impl.

◆ setLinkedMicrobeamManipulation()

const std::weak_ptr< ome::xml::model::MicrobeamManipulation > & ome::xml::model::Image::setLinkedMicrobeamManipulation ( OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::MicrobeamManipulation > &  microbeamManipulation 
)

Set linked MicrobeamManipulation.

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

References impl.

◆ setLinkedROI()

const std::weak_ptr< ome::xml::model::ROI > & ome::xml::model::Image::setLinkedROI ( OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::ROI > &  roi 
)

Set linked ROI.

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

References impl.

◆ setLinkedWellSample()

const std::weak_ptr< ome::xml::model::WellSample > & ome::xml::model::Image::setLinkedWellSample ( OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::WellSample > &  wellSample_BackReference 
)

Set linked WellSample.

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

References impl.

◆ setName()

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

Set the Name property.

Parameters
namethe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setObjectiveSettings()

void ome::xml::model::Image::setObjectiveSettings ( std::shared_ptr< ome::xml::model::ObjectiveSettings > &  objectiveSettings)

Set the ObjectiveSettings property.

Parameters
objectiveSettingsthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setPixels()

void ome::xml::model::Image::setPixels ( std::shared_ptr< ome::xml::model::Pixels > &  pixels)

Set the Pixels property.

Parameters
pixelsthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setStageLabel()

void ome::xml::model::Image::setStageLabel ( std::shared_ptr< ome::xml::model::StageLabel > &  stageLabel)

Set the StageLabel property.

Parameters
stageLabelthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ sizeOfLinkedAnnotationList()

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

Get size of linked Annotation list.

Returns
the size of the list.

References impl.

◆ sizeOfLinkedDatasetList()

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

Get size of linked Dataset list.

Returns
the size of the list.

References impl.

◆ sizeOfLinkedFolderList()

OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type ome::xml::model::Image::sizeOfLinkedFolderList ( ) const

Get size of linked Folder list.

Returns
the size of the list.

References impl.

◆ sizeOfLinkedMicrobeamManipulationList()

OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type ome::xml::model::Image::sizeOfLinkedMicrobeamManipulationList ( ) const

Get size of linked MicrobeamManipulation list.

Returns
the size of the list.

References impl.

◆ sizeOfLinkedROIList()

OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type ome::xml::model::Image::sizeOfLinkedROIList ( ) const

Get size of linked ROI list.

Returns
the size of the list.

References impl.

◆ sizeOfLinkedWellSampleList()

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

Get size of linked WellSample list.

Returns
the size of the list.

References impl.

◆ unlinkAnnotation()

bool ome::xml::model::Image::unlinkAnnotation ( const std::shared_ptr< ome::xml::model::Annotation > &  annotation)

Unlink Annotation.

Parameters
annotationthe Annotation to unlink.
Returns
true if the Annotation was unlinked, otherwise false if the Annotation was not linked and could hence not be unlinked.
Todo:

Does the return value serve any useful purpose? Is this also inherited Java API?

Doesn't the removal break the indexing?

Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.

References impl.

◆ unlinkDataset()

bool ome::xml::model::Image::unlinkDataset ( const std::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 impl.

◆ unlinkExperiment()

void ome::xml::model::Image::unlinkExperiment ( std::shared_ptr< ome::xml::model::Experiment > &  experiment)

Unlink Experiment.

Parameters
experimentthe Experiment to unlink.
Todo:
This method is fairly pointless since it's equivalent to linking a null pointer. It could call link(0) internally.

References impl.

◆ unlinkExperimenter()

void ome::xml::model::Image::unlinkExperimenter ( std::shared_ptr< ome::xml::model::Experimenter > &  experimenter)

Unlink Experimenter.

Parameters
experimenterthe Experimenter to unlink.
Todo:
This method is fairly pointless since it's equivalent to linking a null pointer. It could call link(0) internally.

References impl.

◆ unlinkExperimenterGroup()

void ome::xml::model::Image::unlinkExperimenterGroup ( std::shared_ptr< ome::xml::model::ExperimenterGroup > &  experimenterGroup)

Unlink ExperimenterGroup.

Parameters
experimenterGroupthe ExperimenterGroup to unlink.
Todo:
This method is fairly pointless since it's equivalent to linking a null pointer. It could call link(0) internally.

References impl.

◆ unlinkFolder()

bool ome::xml::model::Image::unlinkFolder ( const std::shared_ptr< ome::xml::model::Folder > &  folder_BackReference)

Unlink Folder.

Parameters
folder_BackReferencethe Folder to unlink.
Returns
true if the Folder was unlinked, otherwise false if the Folder was not linked and could hence not be unlinked.
Todo:

Does the return value serve any useful purpose? Is this also inherited Java API?

Doesn't the removal break the indexing?

Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.

References impl.

◆ unlinkInstrument()

void ome::xml::model::Image::unlinkInstrument ( std::shared_ptr< ome::xml::model::Instrument > &  instrument)

Unlink Instrument.

Parameters
instrumentthe Instrument to unlink.
Todo:
This method is fairly pointless since it's equivalent to linking a null pointer. It could call link(0) internally.

References impl.

◆ unlinkMicrobeamManipulation()

bool ome::xml::model::Image::unlinkMicrobeamManipulation ( const std::shared_ptr< ome::xml::model::MicrobeamManipulation > &  microbeamManipulation)

Unlink MicrobeamManipulation.

Parameters
microbeamManipulationthe MicrobeamManipulation to unlink.
Returns
true if the MicrobeamManipulation was unlinked, otherwise false if the MicrobeamManipulation was not linked and could hence not be unlinked.
Todo:

Does the return value serve any useful purpose? Is this also inherited Java API?

Doesn't the removal break the indexing?

Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.

References impl.

◆ unlinkROI()

bool ome::xml::model::Image::unlinkROI ( const std::shared_ptr< ome::xml::model::ROI > &  roi)

Unlink ROI.

Parameters
roithe ROI to unlink.
Returns
true if the ROI was unlinked, otherwise false if the ROI was not linked and could hence not be unlinked.
Todo:

Does the return value serve any useful purpose? Is this also inherited Java API?

Doesn't the removal break the indexing?

Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.

References impl.

◆ unlinkWellSample()

bool ome::xml::model::Image::unlinkWellSample ( const std::shared_ptr< ome::xml::model::WellSample > &  wellSample_BackReference)

Unlink WellSample.

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

◆ update()

void ome::xml::model::Image::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::xml::model::StageLabel::create(), ome::xml::model::ObjectiveSettings::create(), ome::xml::model::ImagingEnvironment::create(), ome::xml::model::Pixels::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, setAcquisitionDate(), setDescription(), setID(), setImagingEnvironment(), setName(), setObjectiveSettings(), setPixels(), setStageLabel(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().

◆ validElementName()

bool ome::xml::model::Image::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.
Deprecated:
Always returns true since any element name is now regarded as being valid.

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

Referenced by update().

+ Here is the caller graph for this function:

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