ome-xml  5.2.0
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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 (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...
 
metadata_typegetMetadata ()
 Get the key-value pair mappings. More...
 
const metadata_typegetMetadata () const
 Get the key-value pair mappings. More...
 
void setMetadata (const metadata_type &map)
 Set the key-value pair mappings. More...
 
virtual common::xml::dom::Element asXMLElement (common::xml::dom::Document &document) const
 Transform the object hierarchy rooted at this element to XML. 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 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...
 
const std::string & getValue () const
 Get the Value property. More...
 
void setValue (const std::string &value)
 Set the Value property. More...
 
ome::compat::weak_ptr< ome::xml::model::StructuredAnnotationsgetStructuredAnnotations ()
 Get the StructuredAnnotations property. More...
 
const ome::compat::weak_ptr< ome::xml::model::StructuredAnnotationsgetStructuredAnnotations () const
 Get the StructuredAnnotations property. More...
 
void setStructuredAnnotations (ome::compat::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 (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::Annotation
 Annotation ()
 Default constructor.
 
 Annotation (const Annotation &copy)
 Copy constructor. More...
 
virtual ~Annotation ()
 Destructor.
 
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 > getNamespace ()
 Get the Namespace property. More...
 
const ome::compat::shared_ptr< std::string > getNamespace () const
 Get the Namespace property. More...
 
void setNamespace (ome::compat::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...
 
ome::compat::shared_ptr< std::string > getAnnotator ()
 Get the Annotator property. More...
 
const ome::compat::shared_ptr< std::string > getAnnotator () const
 Get the Annotator property. More...
 
void setAnnotator (ome::compat::shared_ptr< std::string > &annotator)
 Set the Annotator 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::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::Pixels, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPixelsList () const
 Get size of linked Pixels list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Pixels, ome::compat::weak_ptr >::type getLinkedPixelsList () const
 Get the linked Pixels list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Pixels > & getLinkedPixels (OMEModelObject::indexed_container< ome::xml::model::Pixels, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Pixels. More...
 
const ome::compat::weak_ptr< ome::xml::model::Pixels > & setLinkedPixels (OMEModelObject::indexed_container< ome::xml::model::Pixels, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels_BackReference)
 Set linked Pixels. More...
 
bool linkPixels (const ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels_BackReference)
 Link Pixels. More...
 
bool unlinkPixels (const ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels_BackReference)
 Unlink Pixels. More...
 
OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPlaneList () const
 Get size of linked Plane list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type getLinkedPlaneList () const
 Get the linked Plane list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Plane > & getLinkedPlane (OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Plane. More...
 
const ome::compat::weak_ptr< ome::xml::model::Plane > & setLinkedPlane (OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
 Set linked Plane. More...
 
bool linkPlane (const ome::compat::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
 Link Plane. More...
 
bool unlinkPlane (const ome::compat::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
 Unlink Plane. More...
 
OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type::size_type sizeOfLinkedChannelList () const
 Get size of linked Channel list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type getLinkedChannelList () const
 Get the linked Channel list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Channel > & getLinkedChannel (OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Channel. More...
 
const ome::compat::weak_ptr< ome::xml::model::Channel > & setLinkedChannel (OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
 Set linked Channel. More...
 
bool linkChannel (const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
 Link Channel. More...
 
bool unlinkChannel (const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
 Unlink Channel. 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::ExperimenterGroup, ome::compat::weak_ptr >::type::size_type sizeOfLinkedExperimenterGroupList () const
 Get size of linked ExperimenterGroup list. More...
 
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type getLinkedExperimenterGroupList () const
 Get the linked ExperimenterGroup list. More...
 
const ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > & getLinkedExperimenterGroup (OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type::size_type index) const
 Get linked ExperimenterGroup. More...
 
const ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > & setLinkedExperimenterGroup (OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
 Set linked ExperimenterGroup. More...
 
bool linkExperimenterGroup (const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
 Link ExperimenterGroup. More...
 
bool unlinkExperimenterGroup (const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
 Unlink ExperimenterGroup. 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...
 
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_BackReference)
 Set linked Experimenter. More...
 
bool linkExperimenter (const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
 Link Experimenter. More...
 
bool unlinkExperimenter (const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
 Unlink Experimenter. More...
 
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type sizeOfLinkedROIList () const
 Get size of linked ROI list. More...
 
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type getLinkedROIList () const
 Get the linked ROI list. More...
 
const ome::compat::weak_ptr< ome::xml::model::ROI > & getLinkedROI (OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index) const
 Get linked ROI. More...
 
const ome::compat::weak_ptr< ome::xml::model::ROI > & setLinkedROI (OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
 Set linked ROI. More...
 
bool linkROI (const ome::compat::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
 Link ROI. More...
 
bool unlinkROI (const ome::compat::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
 Unlink ROI. More...
 
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPlateList () const
 Get size of linked Plate list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type getLinkedPlateList () const
 Get the linked Plate list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Plate > & getLinkedPlate (OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Plate. More...
 
const ome::compat::weak_ptr< ome::xml::model::Plate > & setLinkedPlate (OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
 Set linked Plate. More...
 
bool linkPlate (const ome::compat::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
 Link Plate. More...
 
bool unlinkPlate (const ome::compat::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
 Unlink Plate. More...
 
OMEModelObject::indexed_container< ome::xml::model::Reagent, ome::compat::weak_ptr >::type::size_type sizeOfLinkedReagentList () const
 Get size of linked Reagent list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Reagent, ome::compat::weak_ptr >::type getLinkedReagentList () const
 Get the linked Reagent list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Reagent > & getLinkedReagent (OMEModelObject::indexed_container< ome::xml::model::Reagent, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Reagent. More...
 
const ome::compat::weak_ptr< ome::xml::model::Reagent > & setLinkedReagent (OMEModelObject::indexed_container< ome::xml::model::Reagent, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
 Set linked Reagent. More...
 
bool linkReagent (const ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
 Link Reagent. More...
 
bool unlinkReagent (const ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
 Unlink Reagent. More...
 
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type sizeOfLinkedScreenList () const
 Get size of linked Screen list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type getLinkedScreenList () const
 Get the linked Screen list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Screen > & getLinkedScreen (OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Screen. More...
 
const ome::compat::weak_ptr< ome::xml::model::Screen > & setLinkedScreen (OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
 Set linked Screen. More...
 
bool linkScreen (const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
 Link Screen. More...
 
bool unlinkScreen (const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
 Unlink Screen. More...
 
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPlateAcquisitionList () const
 Get size of linked PlateAcquisition list. More...
 
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type getLinkedPlateAcquisitionList () const
 Get the linked PlateAcquisition list. More...
 
const ome::compat::weak_ptr< ome::xml::model::PlateAcquisition > & getLinkedPlateAcquisition (OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type index) const
 Get linked PlateAcquisition. More...
 
const ome::compat::weak_ptr< ome::xml::model::PlateAcquisition > & setLinkedPlateAcquisition (OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
 Set linked PlateAcquisition. More...
 
bool linkPlateAcquisition (const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
 Link PlateAcquisition. More...
 
bool unlinkPlateAcquisition (const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
 Unlink PlateAcquisition. More...
 
OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type::size_type sizeOfLinkedWellList () const
 Get size of linked Well list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type getLinkedWellList () const
 Get the linked Well list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Well > & getLinkedWell (OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Well. More...
 
const ome::compat::weak_ptr< ome::xml::model::Well > & setLinkedWell (OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
 Set linked Well. More...
 
bool linkWell (const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
 Link Well. More...
 
bool unlinkWell (const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
 Unlink Well. More...
 
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type sizeOfLinkedWellSampleList () const
 Get size of linked WellSample list. More...
 
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type getLinkedWellSampleList () const
 Get the linked WellSample list. More...
 
const ome::compat::weak_ptr< ome::xml::model::WellSample > & getLinkedWellSample (OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index) const
 Get linked WellSample. More...
 
const ome::compat::weak_ptr< ome::xml::model::WellSample > & setLinkedWellSample (OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
 Set linked WellSample. More...
 
bool linkWellSample (const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
 Link WellSample. More...
 
bool unlinkWellSample (const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
 Unlink WellSample. More...
 
- Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
virtual ~OMEModelObject ()
 Destructor.
 
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...
 

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

metadata_type metadata
 Original metadata key-value pair.
 

Additional Inherited Members

- Static Public Member Functions inherited from ome::xml::model::XMLAnnotation
static ome::compat::shared_ptr< XMLAnnotationcreate (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::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 Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger logger
 Message logger.
 

Detailed Description

OriginalMetadataAnnotation model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters
copythe object to copy.
ome::xml::model::OriginalMetadataAnnotation::OriginalMetadataAnnotation ( const metadata_type map)

Construct from original metadata key and value.

Parameters
mapthe map to copy.
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
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.

References update().

Member Function Documentation

common::xml::dom::Element ome::xml::model::OriginalMetadataAnnotation::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.

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

References asXMLElementInternal().

common::xml::dom::Element 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.

Parameters
documentXML document for element creation.
elementXML element for setting model data.
Returns
an XML DOM tree root element for this model object.

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

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

Referenced by asXMLElement().

+ Here is the caller graph for this function:

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.

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

Get the key-value pair mappings.

Returns
the map.

References metadata.

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

Get the key-value pair mappings.

Returns
the map.

References metadata.

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

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

void ome::xml::model::OriginalMetadataAnnotation::setMetadata ( const metadata_type map)
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
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.

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:

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
namethe element name to check.
Returns
true if valid, false if invalid.

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

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


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