ome::xml::model::OriginalMetadataAnnotation Class Reference

OriginalMetadataAnnotation model object. More...

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

Inheritance diagram for ome::xml::model::OriginalMetadataAnnotation:

Collaboration diagram for ome::xml::model::OriginalMetadataAnnotation:

Public Types
typedef std::pair< std::string, std::string >	metadata_type
	Type of original annotation.

Public Member Functions
	OriginalMetadataAnnotation ()
	Default constructor.
	OriginalMetadataAnnotation (const OriginalMetadataAnnotation &copy)
	Copy constructor. More...
	OriginalMetadataAnnotation (const metadata_type &map)
	Construct from original metadata key and value. More...
	OriginalMetadataAnnotation (common::xml::dom::Element &element, ::ome::xml::model::OMEModel &model)
	Construct a OriginalMetadataAnnotation recursively from an XML DOM tree. More...
virtual	~OriginalMetadataAnnotation ()
	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 (std::shared_ptr< Reference > &reference, std::shared_ptr<::ome::xml::model::OMEModelObject > &object)
	Link a given OME model object to this model object. More...
metadata_type &	getMetadata ()
	Get the key-value pair mappings. More...
const metadata_type &	getMetadata () const
	Get the key-value pair mappings. More...
void	setMetadata (const metadata_type &map)
	Set the key-value pair mappings. More...
Public Member Functions inherited from ome::xml::model::XMLAnnotation
	XMLAnnotation ()
	Default constructor.
	XMLAnnotation (const XMLAnnotation &copy)
	Copy constructor. More...
virtual	~XMLAnnotation ()
	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 &	getValue () const
	Get the Value property. More...
void	setValue (const std::string &value)
	Set the Value property. More...
std::weak_ptr< ome::xml::model::StructuredAnnotations >	getStructuredAnnotations ()
	Get the StructuredAnnotations property. More...
const std::weak_ptr< ome::xml::model::StructuredAnnotations >	getStructuredAnnotations () const
	Get the StructuredAnnotations property. More...
void	setStructuredAnnotations (std::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
	Set the StructuredAnnotations property. More...
const std::string &	getXMLNamespace () const
	Get the XML namespace for this model object. More...
Public Member Functions inherited from ome::xml::model::TextAnnotation
	TextAnnotation ()
	Default constructor.
	TextAnnotation (const TextAnnotation &copy)
	Copy constructor. More...
virtual	~TextAnnotation ()
	Destructor.
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::Annotation
	Annotation ()
	Default constructor.
	Annotation (const Annotation &copy)
	Copy constructor. More...
virtual	~Annotation ()
	Destructor.
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...
std::shared_ptr< std::string >	getNamespace ()
	Get the Namespace property. More...
const std::shared_ptr< std::string >	getNamespace () const
	Get the Namespace property. More...
void	setNamespace (std::shared_ptr< std::string > &namespace_)
	Set the Namespace property. 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 >	getAnnotator ()
	Get the Annotator property. More...
const std::shared_ptr< std::string >	getAnnotator () const
	Get the Annotator property. More...
void	setAnnotator (std::shared_ptr< std::string > &annotator)
	Set the Annotator property. 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...
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::Image, std::weak_ptr >::type::size_type	sizeOfLinkedImageList () const
	Get size of linked Image list. More...
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type	getLinkedImageList () const
	Get the linked Image list. More...
const std::weak_ptr< ome::xml::model::Image > &	getLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index) const
	Get linked Image. More...
const std::weak_ptr< ome::xml::model::Image > &	setLinkedImage (OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
	Set linked Image. More...
bool	linkImage (const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
	Link Image. More...
bool	unlinkImage (const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
	Unlink Image. More...
OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type::size_type	sizeOfLinkedPlaneList () const
	Get size of linked Plane list. More...
OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type	getLinkedPlaneList () const
	Get the linked Plane list. More...
const std::weak_ptr< ome::xml::model::Plane > &	getLinkedPlane (OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type::size_type index) const
	Get linked Plane. More...
const std::weak_ptr< ome::xml::model::Plane > &	setLinkedPlane (OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
	Set linked Plane. More...
bool	linkPlane (const std::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
	Link Plane. More...
bool	unlinkPlane (const std::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
	Unlink Plane. More...
OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type::size_type	sizeOfLinkedChannelList () const
	Get size of linked Channel list. More...
OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type	getLinkedChannelList () const
	Get the linked Channel list. More...
const std::weak_ptr< ome::xml::model::Channel > &	getLinkedChannel (OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type::size_type index) const
	Get linked Channel. More...
const std::weak_ptr< ome::xml::model::Channel > &	setLinkedChannel (OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
	Set linked Channel. More...
bool	linkChannel (const std::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
	Link Channel. More...
bool	unlinkChannel (const std::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
	Unlink Channel. More...
OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type::size_type	sizeOfLinkedInstrumentList () const
	Get size of linked Instrument list. More...
OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type	getLinkedInstrumentList () const
	Get the linked Instrument list. More...
const std::weak_ptr< ome::xml::model::Instrument > &	getLinkedInstrument (OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type::size_type index) const
	Get linked Instrument. More...
const std::weak_ptr< ome::xml::model::Instrument > &	setLinkedInstrument (OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Instrument > &instrument_BackReference)
	Set linked Instrument. More...
bool	linkInstrument (const std::shared_ptr< ome::xml::model::Instrument > &instrument_BackReference)
	Link Instrument. More...
bool	unlinkInstrument (const std::shared_ptr< ome::xml::model::Instrument > &instrument_BackReference)
	Unlink Instrument. More...
OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type::size_type	sizeOfLinkedLightSourceList () const
	Get size of linked LightSource list. More...
OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type	getLinkedLightSourceList () const
	Get the linked LightSource list. More...
const std::weak_ptr< ome::xml::model::LightSource > &	getLinkedLightSource (OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type::size_type index) const
	Get linked LightSource. More...
const std::weak_ptr< ome::xml::model::LightSource > &	setLinkedLightSource (OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::LightSource > &lightSource_BackReference)
	Set linked LightSource. More...
bool	linkLightSource (const std::shared_ptr< ome::xml::model::LightSource > &lightSource_BackReference)
	Link LightSource. More...
bool	unlinkLightSource (const std::shared_ptr< ome::xml::model::LightSource > &lightSource_BackReference)
	Unlink LightSource. More...
OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type	sizeOfLinkedProjectList () const
	Get size of linked Project list. More...
OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type	getLinkedProjectList () const
	Get the linked Project list. More...
const std::weak_ptr< ome::xml::model::Project > &	getLinkedProject (OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type index) const
	Get linked Project. More...
const std::weak_ptr< ome::xml::model::Project > &	setLinkedProject (OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
	Set linked Project. More...
bool	linkProject (const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
	Link Project. More...
bool	unlinkProject (const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
	Unlink Project. More...
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type	sizeOfLinkedExperimenterGroupList () const
	Get size of linked ExperimenterGroup list. More...
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type	getLinkedExperimenterGroupList () const
	Get the linked ExperimenterGroup list. More...
const std::weak_ptr< ome::xml::model::ExperimenterGroup > &	getLinkedExperimenterGroup (OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type index) const
	Get linked ExperimenterGroup. More...
const std::weak_ptr< ome::xml::model::ExperimenterGroup > &	setLinkedExperimenterGroup (OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
	Set linked ExperimenterGroup. More...
bool	linkExperimenterGroup (const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
	Link ExperimenterGroup. More...
bool	unlinkExperimenterGroup (const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
	Unlink ExperimenterGroup. 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::Experimenter, std::weak_ptr >::type::size_type	sizeOfLinkedExperimenterList () const
	Get size of linked Experimenter list. More...
OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type	getLinkedExperimenterList () const
	Get the linked Experimenter list. More...
const std::weak_ptr< ome::xml::model::Experimenter > &	getLinkedExperimenter (OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type::size_type index) const
	Get linked Experimenter. More...
const std::weak_ptr< ome::xml::model::Experimenter > &	setLinkedExperimenter (OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
	Set linked Experimenter. More...
bool	linkExperimenter (const std::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
	Link Experimenter. More...
bool	unlinkExperimenter (const std::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
	Unlink Experimenter. 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::Objective, std::weak_ptr >::type::size_type	sizeOfLinkedObjectiveList () const
	Get size of linked Objective list. More...
OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type	getLinkedObjectiveList () const
	Get the linked Objective list. More...
const std::weak_ptr< ome::xml::model::Objective > &	getLinkedObjective (OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type::size_type index) const
	Get linked Objective. More...
const std::weak_ptr< ome::xml::model::Objective > &	setLinkedObjective (OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Objective > &objective_BackReference)
	Set linked Objective. More...
bool	linkObjective (const std::shared_ptr< ome::xml::model::Objective > &objective_BackReference)
	Link Objective. More...
bool	unlinkObjective (const std::shared_ptr< ome::xml::model::Objective > &objective_BackReference)
	Unlink Objective. More...
OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type::size_type	sizeOfLinkedDetectorList () const
	Get size of linked Detector list. More...
OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type	getLinkedDetectorList () const
	Get the linked Detector list. More...
const std::weak_ptr< ome::xml::model::Detector > &	getLinkedDetector (OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type::size_type index) const
	Get linked Detector. More...
const std::weak_ptr< ome::xml::model::Detector > &	setLinkedDetector (OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Detector > &detector_BackReference)
	Set linked Detector. More...
bool	linkDetector (const std::shared_ptr< ome::xml::model::Detector > &detector_BackReference)
	Link Detector. More...
bool	unlinkDetector (const std::shared_ptr< ome::xml::model::Detector > &detector_BackReference)
	Unlink Detector. More...
OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type	sizeOfLinkedFilterList () const
	Get size of linked Filter list. More...
OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type	getLinkedFilterList () const
	Get the linked Filter list. More...
const std::weak_ptr< ome::xml::model::Filter > &	getLinkedFilter (OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type index) const
	Get linked Filter. More...
const std::weak_ptr< ome::xml::model::Filter > &	setLinkedFilter (OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Filter > &filter_BackReference)
	Set linked Filter. More...
bool	linkFilter (const std::shared_ptr< ome::xml::model::Filter > &filter_BackReference)
	Link Filter. More...
bool	unlinkFilter (const std::shared_ptr< ome::xml::model::Filter > &filter_BackReference)
	Unlink Filter. More...
OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type::size_type	sizeOfLinkedDichroicList () const
	Get size of linked Dichroic list. More...
OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type	getLinkedDichroicList () const
	Get the linked Dichroic list. More...
const std::weak_ptr< ome::xml::model::Dichroic > &	getLinkedDichroic (OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type::size_type index) const
	Get linked Dichroic. More...
const std::weak_ptr< ome::xml::model::Dichroic > &	setLinkedDichroic (OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Dichroic > &dichroic_BackReference)
	Set linked Dichroic. More...
bool	linkDichroic (const std::shared_ptr< ome::xml::model::Dichroic > &dichroic_BackReference)
	Link Dichroic. More...
bool	unlinkDichroic (const std::shared_ptr< ome::xml::model::Dichroic > &dichroic_BackReference)
	Unlink Dichroic. More...
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type	sizeOfLinkedLightPathList () const
	Get size of linked LightPath list. More...
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type	getLinkedLightPathList () const
	Get the linked LightPath list. More...
const std::weak_ptr< ome::xml::model::LightPath > &	getLinkedLightPath (OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index) const
	Get linked LightPath. More...
const std::weak_ptr< ome::xml::model::LightPath > &	setLinkedLightPath (OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
	Set linked LightPath. More...
bool	linkLightPath (const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
	Link LightPath. More...
bool	unlinkLightPath (const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
	Unlink LightPath. 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_BackReference)
	Set linked ROI. More...
bool	linkROI (const std::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
	Link ROI. More...
bool	unlinkROI (const std::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
	Unlink ROI. More...
OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type::size_type	sizeOfLinkedShapeList () const
	Get size of linked Shape list. More...
OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type	getLinkedShapeList () const
	Get the linked Shape list. More...
const std::weak_ptr< ome::xml::model::Shape > &	getLinkedShape (OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type::size_type index) const
	Get linked Shape. More...
const std::weak_ptr< ome::xml::model::Shape > &	setLinkedShape (OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Shape > &shape_BackReference)
	Set linked Shape. More...
bool	linkShape (const std::shared_ptr< ome::xml::model::Shape > &shape_BackReference)
	Link Shape. More...
bool	unlinkShape (const std::shared_ptr< ome::xml::model::Shape > &shape_BackReference)
	Unlink Shape. More...
OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type	sizeOfLinkedPlateList () const
	Get size of linked Plate list. More...
OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type	getLinkedPlateList () const
	Get the linked Plate list. More...
const std::weak_ptr< ome::xml::model::Plate > &	getLinkedPlate (OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type index) const
	Get linked Plate. More...
const std::weak_ptr< ome::xml::model::Plate > &	setLinkedPlate (OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
	Set linked Plate. More...
bool	linkPlate (const std::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
	Link Plate. More...
bool	unlinkPlate (const std::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
	Unlink Plate. More...
OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type::size_type	sizeOfLinkedReagentList () const
	Get size of linked Reagent list. More...
OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type	getLinkedReagentList () const
	Get the linked Reagent list. More...
const std::weak_ptr< ome::xml::model::Reagent > &	getLinkedReagent (OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type::size_type index) const
	Get linked Reagent. More...
const std::weak_ptr< ome::xml::model::Reagent > &	setLinkedReagent (OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
	Set linked Reagent. More...
bool	linkReagent (const std::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
	Link Reagent. More...
bool	unlinkReagent (const std::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
	Unlink Reagent. More...
OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type	sizeOfLinkedScreenList () const
	Get size of linked Screen list. More...
OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type	getLinkedScreenList () const
	Get the linked Screen list. More...
const std::weak_ptr< ome::xml::model::Screen > &	getLinkedScreen (OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type index) const
	Get linked Screen. More...
const std::weak_ptr< ome::xml::model::Screen > &	setLinkedScreen (OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
	Set linked Screen. More...
bool	linkScreen (const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
	Link Screen. More...
bool	unlinkScreen (const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
	Unlink Screen. More...
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type::size_type	sizeOfLinkedPlateAcquisitionList () const
	Get size of linked PlateAcquisition list. More...
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type	getLinkedPlateAcquisitionList () const
	Get the linked PlateAcquisition list. More...
const std::weak_ptr< ome::xml::model::PlateAcquisition > &	getLinkedPlateAcquisition (OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type::size_type index) const
	Get linked PlateAcquisition. More...
const std::weak_ptr< ome::xml::model::PlateAcquisition > &	setLinkedPlateAcquisition (OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
	Set linked PlateAcquisition. More...
bool	linkPlateAcquisition (const std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
	Link PlateAcquisition. More...
bool	unlinkPlateAcquisition (const std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
	Unlink PlateAcquisition. More...
OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type	sizeOfLinkedWellList () const
	Get size of linked Well list. More...
OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type	getLinkedWellList () const
	Get the linked Well list. More...
const std::weak_ptr< ome::xml::model::Well > &	getLinkedWell (OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type index) const
	Get linked Well. More...
const std::weak_ptr< ome::xml::model::Well > &	setLinkedWell (OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
	Set linked Well. More...
bool	linkWell (const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
	Link Well. More...
bool	unlinkWell (const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
	Unlink Well. 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 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...

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
metadata_type	metadata
	Original metadata key-value pair.

Additional Inherited Members
Static Public Member Functions inherited from ome::xml::model::XMLAnnotation
static std::shared_ptr< XMLAnnotation >	create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
	Create a XMLAnnotation model object from DOM element. More...
Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
static std::vector< common::xml::dom::Element >	getChildrenByTagName (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 Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger	logger
	Message logger.

Detailed Description

OriginalMetadataAnnotation model object.

Constructor & Destructor Documentation

OriginalMetadataAnnotation() [1/3]

ome::xml::model::OriginalMetadataAnnotation::OriginalMetadataAnnotation

(

const OriginalMetadataAnnotation &

copy

)

Copy constructor.

Parameters

copy	the object to copy.

OriginalMetadataAnnotation() [2/3]

ome::xml::model::OriginalMetadataAnnotation::OriginalMetadataAnnotation

(

const metadata_type &

map

)

Construct from original metadata key and value.

Parameters

map	the map to copy.

OriginalMetadataAnnotation() [3/3]

ome::xml::model::OriginalMetadataAnnotation::OriginalMetadataAnnotation	(	common::xml::dom::Element &	element,
		::ome::xml::model::OMEModel &	model
	)

Construct a OriginalMetadataAnnotation recursively from an XML DOM tree.

Parameters

element	root of the XML DOM tree to from which to construct the model object graph.
model	handler for the OME model used to track instances and references seen during the update.

Exceptions

EnumerationException

if there is an error instantiating an enumeration during model object creation.

References update().

Member Function Documentation

asXMLElementInternal()

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

document	XML document for element creation.
element	XML element for setting model data.

Reimplemented from ome::xml::model::XMLAnnotation.

References ome::xml::model::XMLAnnotation::asXMLElementInternal().

elementName()

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

getMetadata() [1/2]

OriginalMetadataAnnotation::metadata_type & ome::xml::model::OriginalMetadataAnnotation::getMetadata

(

)

Get the key-value pair mappings.

Returns

the map.

References metadata.

getMetadata() [2/2]

const OriginalMetadataAnnotation::metadata_type & ome::xml::model::OriginalMetadataAnnotation::getMetadata

(

)

const

Get the key-value pair mappings.

Returns

the map.

References metadata.

link()

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

reference	type 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.
object	Model 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.

References ome::xml::model::XMLAnnotation::link(), and ome::xml::model::detail::OMEModelObject::logger.

setMetadata()

void ome::xml::model::OriginalMetadataAnnotation::setMetadata

(

const metadata_type &

map

)

Set the key-value pair mappings.

Parameters

map	the map to set.

References ome::common::xml::dom::Node::appendChild(), ome::common::xml::dom::Document::createElement(), ome::common::xml::dom::createEmptyDocument(), ome::common::xml::dom::Document::getDocumentElement(), metadata, ome::common::xml::dom::Element::setTextContent(), ome::xml::model::XMLAnnotation::setValue(), and ome::common::xml::dom::writeNode().

update()

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

element	root of the XML DOM tree to from which to construct the model object graph.
model	handler for the OME model used to track instances and references seen during the update.

Exceptions

EnumerationException

if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.

Reimplemented from ome::xml::model::detail::OMEModelObject.

References ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), metadata, and ome::xml::model::XMLAnnotation::update().

Referenced by OriginalMetadataAnnotation().

Here is the caller graph for this function:

validElementName()

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

name	the 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.

References ome::xml::model::XMLAnnotation::validElementName().

---

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

• ome/xml/model/OriginalMetadataAnnotation.h
• ome/xml/model/OriginalMetadataAnnotation.cpp