ome-xml  5.6.0
Public Member Functions | Private Attributes | List of all members
ome::xml::meta::OMEXMLMetadata Class Reference

A metadata store implementation for constructing and manipulating OME-XML DOMs for the current version of the OME-XML schema. More...

#include <ome/xml/meta/OMEXMLMetadata.h>

+ Inheritance diagram for ome::xml::meta::OMEXMLMetadata:
+ Collaboration diagram for ome::xml::meta::OMEXMLMetadata:

Public Member Functions

 OMEXMLMetadata ()
 Constructor.
 
virtual ~OMEXMLMetadata ()
 Destructor.
 
void createRoot ()
 Create root node. More...
 
std::shared_ptr< MetadataRootgetRoot ()
 Get the root node of the metadata. More...
 
void setRoot (std::shared_ptr< MetadataRoot > root)
 Set the root node of the metadata. More...
 
std::string dumpXML ()
 Dump metadata as OME-XML string. More...
 
index_type resolveReferences ()
 Resolve all references. More...
 
const std::string & getLightSourceType (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the type of a LightSource. More...
 
const std::string & getShapeType (index_type ROIIndex, index_type shapeIndex) const
 Get the type of a Shape. More...
 
index_type getBooleanAnnotationAnnotationCount (index_type booleanAnnotationIndex) const
 Get the number of links to a BooleanAnnotation. More...
 
index_type getCommentAnnotationAnnotationCount (index_type commentAnnotationIndex) const
 Get the number of links to a CommentAnnotation. More...
 
index_type getDoubleAnnotationAnnotationCount (index_type doubleAnnotationIndex) const
 Get the number of links to a DoubleAnnotation. More...
 
index_type getFileAnnotationAnnotationCount (index_type fileAnnotationIndex) const
 Get the number of links to a FileAnnotation. More...
 
index_type getListAnnotationAnnotationCount (index_type listAnnotationIndex) const
 Get the number of links to a ListAnnotation. More...
 
index_type getLongAnnotationAnnotationCount (index_type longAnnotationIndex) const
 Get the number of links to a LongAnnotation. More...
 
index_type getMapAnnotationAnnotationCount (index_type mapAnnotationIndex) const
 Get the number of links to a MapAnnotation. More...
 
index_type getTagAnnotationAnnotationCount (index_type tagAnnotationIndex) const
 Get the number of links to a TagAnnotation. More...
 
index_type getTermAnnotationAnnotationCount (index_type termAnnotationIndex) const
 Get the number of links to a TermAnnotation. More...
 
index_type getTimestampAnnotationAnnotationCount (index_type timestampAnnotationIndex) const
 Get the number of links to a TimestampAnnotation. More...
 
index_type getXMLAnnotationAnnotationCount (index_type xmlAnnotationIndex) const
 Get the number of links to an XMLAnnotation. More...
 
index_type getLightSourceAnnotationRefCount (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the number of AnnotationRef elements in LightSource. More...
 
index_type getInstrumentAnnotationRefCount (index_type instrumentIndex) const
 Get the number of AnnotationRef elements in Instrument. More...
 
index_type getObjectiveAnnotationRefCount (index_type instrumentIndex, index_type objectiveIndex) const
 Get the number of AnnotationRef elements in Objective. More...
 
index_type getFolderAnnotationRefCount (index_type folderIndex) const
 Get the number of AnnotationRef elements in Folder. More...
 
index_type getDetectorAnnotationRefCount (index_type instrumentIndex, index_type detectorIndex) const
 Get the number of AnnotationRef elements in Detector. More...
 
index_type getChannelAnnotationRefCount (index_type imageIndex, index_type channelIndex) const
 Get the number of AnnotationRef elements in Channel. More...
 
index_type getPlateAnnotationRefCount (index_type plateIndex) const
 Get the number of AnnotationRef elements in Plate. More...
 
index_type getExperimenterGroupAnnotationRefCount (index_type experimenterGroupIndex) const
 Get the number of AnnotationRef elements in ExperimenterGroup. More...
 
index_type getScreenAnnotationRefCount (index_type screenIndex) const
 Get the number of AnnotationRef elements in Screen. More...
 
index_type getReagentAnnotationRefCount (index_type screenIndex, index_type reagentIndex) const
 Get the number of AnnotationRef elements in Reagent. More...
 
index_type getPlaneAnnotationRefCount (index_type imageIndex, index_type planeIndex) const
 Get the number of AnnotationRef elements in Plane. More...
 
index_type getExperimenterAnnotationRefCount (index_type experimenterIndex) const
 Get the number of AnnotationRef elements in Experimenter. More...
 
index_type getDichroicAnnotationRefCount (index_type instrumentIndex, index_type dichroicIndex) const
 Get the number of AnnotationRef elements in Dichroic. More...
 
index_type getWellAnnotationRefCount (index_type plateIndex, index_type wellIndex) const
 Get the number of AnnotationRef elements in Well. More...
 
index_type getFilterAnnotationRefCount (index_type instrumentIndex, index_type filterIndex) const
 Get the number of AnnotationRef elements in Filter. More...
 
index_type getPlateAcquisitionAnnotationRefCount (index_type plateIndex, index_type plateAcquisitionIndex) const
 Get the number of AnnotationRef elements in PlateAcquisition. More...
 
index_type getROIAnnotationRefCount (index_type ROIIndex) const
 Get the number of AnnotationRef elements in ROI. More...
 
index_type getProjectAnnotationRefCount (index_type projectIndex) const
 Get the number of AnnotationRef elements in Project. More...
 
index_type getLightPathAnnotationRefCount (index_type imageIndex, index_type channelIndex) const
 Get the number of AnnotationRef elements in LightPath. More...
 
index_type getImageAnnotationRefCount (index_type imageIndex) const
 Get the number of AnnotationRef elements in Image. More...
 
index_type getDatasetAnnotationRefCount (index_type datasetIndex) const
 Get the number of AnnotationRef elements in Dataset. More...
 
index_type getShapeAnnotationRefCount (index_type ROIIndex, index_type shapeIndex) const
 Get the number of AnnotationRef elements in Shape. More...
 
index_type getPixelsBinDataCount (index_type imageIndex) const
 Get the number of BinData elements in Pixels. More...
 
index_type getBooleanAnnotationCount () const
 Get the number of BooleanAnnotation elements. More...
 
index_type getChannelCount (index_type imageIndex) const
 Get the number of Channel elements. More...
 
index_type getCommentAnnotationCount () const
 Get the number of CommentAnnotation elements. More...
 
index_type getDatasetCount () const
 Get the number of Dataset elements. More...
 
index_type getDatasetRefCount (index_type projectIndex) const
 Get the number of DatasetRef elements. More...
 
index_type getDetectorCount (index_type instrumentIndex) const
 Get the number of Detector elements. More...
 
index_type getDichroicCount (index_type instrumentIndex) const
 Get the number of Dichroic elements. More...
 
index_type getDoubleAnnotationCount () const
 Get the number of DoubleAnnotation elements. More...
 
index_type getLightPathEmissionFilterRefCount (index_type imageIndex, index_type channelIndex) const
 Get the number of EmissionFilterRef elements in LightPath. More...
 
index_type getFilterSetEmissionFilterRefCount (index_type instrumentIndex, index_type filterSetIndex) const
 Get the number of EmissionFilterRef elements in FilterSet. More...
 
index_type getLightPathExcitationFilterRefCount (index_type imageIndex, index_type channelIndex) const
 Get the number of ExcitationFilterRef elements in LightPath. More...
 
index_type getFilterSetExcitationFilterRefCount (index_type instrumentIndex, index_type filterSetIndex) const
 Get the number of ExcitationFilterRef elements in FilterSet. More...
 
index_type getExperimentCount () const
 Get the number of Experiment elements. More...
 
index_type getExperimenterCount () const
 Get the number of Experimenter elements. More...
 
index_type getExperimenterGroupCount () const
 Get the number of ExperimenterGroup elements. More...
 
index_type getExperimenterGroupExperimenterRefCount (index_type experimenterGroupIndex) const
 Get the number of ExperimenterRef elements in ExperimenterGroup. More...
 
index_type getFileAnnotationCount () const
 Get the number of FileAnnotation elements. More...
 
index_type getFilterCount (index_type instrumentIndex) const
 Get the number of Filter elements. More...
 
index_type getFilterSetCount (index_type instrumentIndex) const
 Get the number of FilterSet elements. More...
 
index_type getFolderCount () const
 Get the number of Folder elements. More...
 
index_type getFolderRefCount (index_type folderIndex) const
 Get the number of FolderRef elements. More...
 
index_type getImageCount () const
 Get the number of Image elements. More...
 
index_type getFolderImageRefCount (index_type folderIndex) const
 Get the number of ImageRef elements in Folder. More...
 
index_type getDatasetImageRefCount (index_type datasetIndex) const
 Get the number of ImageRef elements in Dataset. More...
 
index_type getInstrumentCount () const
 Get the number of Instrument elements. More...
 
index_type getLeaderCount (index_type experimenterGroupIndex) const
 Get the number of Leader elements. More...
 
index_type getLightSourceCount (index_type instrumentIndex) const
 Get the number of LightSource elements. More...
 
index_type getMicrobeamManipulationLightSourceSettingsCount (index_type experimentIndex, index_type microbeamManipulationIndex) const
 Get the number of LightSourceSettings elements in MicrobeamManipulation. More...
 
index_type getListAnnotationCount () const
 Get the number of ListAnnotation elements. More...
 
index_type getLongAnnotationCount () const
 Get the number of LongAnnotation elements. More...
 
index_type getMapAnnotationCount () const
 Get the number of MapAnnotation elements. More...
 
index_type getMicrobeamManipulationCount (index_type experimentIndex) const
 Get the number of MicrobeamManipulation elements. More...
 
index_type getMicrobeamManipulationRefCount (index_type imageIndex) const
 Get the number of MicrobeamManipulationRef elements. More...
 
index_type getObjectiveCount (index_type instrumentIndex) const
 Get the number of Objective elements. More...
 
index_type getPlaneCount (index_type imageIndex) const
 Get the number of Plane elements. More...
 
index_type getPlateCount () const
 Get the number of Plate elements. More...
 
index_type getPlateAcquisitionCount (index_type plateIndex) const
 Get the number of PlateAcquisition elements. More...
 
index_type getPlateRefCount (index_type screenIndex) const
 Get the number of PlateRef elements. More...
 
index_type getProjectCount () const
 Get the number of Project elements. More...
 
index_type getROICount () const
 Get the number of ROI elements. More...
 
index_type getImageROIRefCount (index_type imageIndex) const
 Get the number of ROIRef elements in Image. More...
 
index_type getFolderROIRefCount (index_type folderIndex) const
 Get the number of ROIRef elements in Folder. More...
 
index_type getMicrobeamManipulationROIRefCount (index_type experimentIndex, index_type microbeamManipulationIndex) const
 Get the number of ROIRef elements in MicrobeamManipulation. More...
 
index_type getReagentCount (index_type screenIndex) const
 Get the number of Reagent elements. More...
 
index_type getScreenCount () const
 Get the number of Screen elements. More...
 
index_type getShapeCount (index_type ROIIndex) const
 Get the number of Shape elements. More...
 
index_type getTagAnnotationCount () const
 Get the number of TagAnnotation elements. More...
 
index_type getTermAnnotationCount () const
 Get the number of TermAnnotation elements. More...
 
index_type getTiffDataCount (index_type imageIndex) const
 Get the number of TiffData elements. More...
 
index_type getTimestampAnnotationCount () const
 Get the number of TimestampAnnotation elements. More...
 
void setUUIDValue (std::string value, index_type imageIndex, index_type tiffDataIndex)
 Set the text value of UUID. More...
 
std::string getUUIDValue (index_type imageIndex, index_type tiffDataIndex) const
 Get the text value of UUID. More...
 
index_type getWellCount (index_type plateIndex) const
 Get the number of Well elements. More...
 
index_type getWellSampleCount (index_type plateIndex, index_type wellIndex) const
 Get the number of WellSample elements. More...
 
index_type getWellSampleRefCount (index_type plateIndex, index_type plateAcquisitionIndex) const
 Get the number of WellSampleRef elements. More...
 
index_type getXMLAnnotationCount () const
 Get the number of XMLAnnotation elements. More...
 
const std::string & getUUID () const
 Get the UUID associated with this collection of metadata. More...
 
const ome::xml::model::primitives::OrderedMultimapgetMapAnnotationValue (index_type mapAnnotationIndex) const
 Get the map value of MapAnnotation. More...
 
const ome::xml::model::primitives::OrderedMultimapgetGenericExcitationSourceMap (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the map value of GenericExcitationSource. More...
 
const ome::xml::model::primitives::OrderedMultimapgetImagingEnvironmentMap (index_type imageIndex) const
 Get the map value of ImagingEnvironment. More...
 
const std::string & getArcAnnotationRef (index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Arc. More...
 
const std::string & getArcID (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the ID property of Arc. More...
 
const std::string & getArcLotNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the LotNumber property of Arc. More...
 
const std::string & getArcManufacturer (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Manufacturer property of Arc. More...
 
const std::string & getArcModel (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Model property of Arc. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPowergetArcPower (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Power property of Arc. More...
 
const std::string & getArcSerialNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the SerialNumber property of Arc. More...
 
ome::xml::model::enums::ArcType getArcType (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Type property of Arc. More...
 
const std::vector< uint8_t > & getBinaryFileBinData (index_type fileAnnotationIndex) const
 Get the Base64Binary property of BinData. More...
 
const std::vector< uint8_t > & getMaskBinData (index_type ROIIndex, index_type shapeIndex) const
 Get the Base64Binary property of BinData. More...
 
const std::vector< uint8_t > & getPixelsBinData (index_type imageIndex, index_type binDataIndex) const
 Get the Base64Binary property of BinData. More...
 
bool getBinaryFileBinDataBigEndian (index_type fileAnnotationIndex) const
 Get the BigEndian property of BinData. More...
 
bool getMaskBinDataBigEndian (index_type ROIIndex, index_type shapeIndex) const
 Get the BigEndian property of BinData. More...
 
bool getPixelsBinDataBigEndian (index_type imageIndex, index_type binDataIndex) const
 Get the BigEndian property of BinData. More...
 
ome::xml::model::enums::Compression getBinaryFileBinDataCompression (index_type fileAnnotationIndex) const
 Get the Compression property of BinData. More...
 
ome::xml::model::enums::Compression getMaskBinDataCompression (index_type ROIIndex, index_type shapeIndex) const
 Get the Compression property of BinData. More...
 
ome::xml::model::enums::Compression getPixelsBinDataCompression (index_type imageIndex, index_type binDataIndex) const
 Get the Compression property of BinData. More...
 
ome::xml::model::primitives::NonNegativeLong getBinaryFileBinDataLength (index_type fileAnnotationIndex) const
 Get the Length property of BinData. More...
 
ome::xml::model::primitives::NonNegativeLong getMaskBinDataLength (index_type ROIIndex, index_type shapeIndex) const
 Get the Length property of BinData. More...
 
ome::xml::model::primitives::NonNegativeLong getPixelsBinDataLength (index_type imageIndex, index_type binDataIndex) const
 Get the Length property of BinData. More...
 
const std::string & getBinaryFileFileName (index_type fileAnnotationIndex) const
 Get the FileName property of BinaryFile. More...
 
const std::string & getBinaryFileMIMEType (index_type fileAnnotationIndex) const
 Get the MIMEType property of BinaryFile. More...
 
ome::xml::model::primitives::NonNegativeLong getBinaryFileSize (index_type fileAnnotationIndex) const
 Get the Size property of BinaryFile. More...
 
const std::string & getBinaryOnlyMetadataFile () const
 Get the MetadataFile property of BinaryOnly. More...
 
const std::string & getBinaryOnlyUUID () const
 Get the UUID property of BinaryOnly. More...
 
const std::string & getBooleanAnnotationAnnotationRef (index_type booleanAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of BooleanAnnotation. More...
 
const std::string & getBooleanAnnotationAnnotator (index_type booleanAnnotationIndex) const
 Get the Annotator property of BooleanAnnotation. More...
 
const std::string & getBooleanAnnotationDescription (index_type booleanAnnotationIndex) const
 Get the Description property of BooleanAnnotation. More...
 
const std::string & getBooleanAnnotationID (index_type booleanAnnotationIndex) const
 Get the ID property of BooleanAnnotation. More...
 
const std::string & getBooleanAnnotationNamespace (index_type booleanAnnotationIndex) const
 Get the Namespace property of BooleanAnnotation. More...
 
bool getBooleanAnnotationValue (index_type booleanAnnotationIndex) const
 Get the Value property of BooleanAnnotation. More...
 
ome::xml::model::enums::AcquisitionMode getChannelAcquisitionMode (index_type imageIndex, index_type channelIndex) const
 Get the AcquisitionMode property of Channel. More...
 
const std::string & getChannelAnnotationRef (index_type imageIndex, index_type channelIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Channel. More...
 
ome::xml::model::primitives::Color getChannelColor (index_type imageIndex, index_type channelIndex) const
 Get the Color property of Channel. More...
 
ome::xml::model::enums::ContrastMethod getChannelContrastMethod (index_type imageIndex, index_type channelIndex) const
 Get the ContrastMethod property of Channel. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetChannelEmissionWavelength (index_type imageIndex, index_type channelIndex) const
 Get the EmissionWavelength property of Channel. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetChannelExcitationWavelength (index_type imageIndex, index_type channelIndex) const
 Get the ExcitationWavelength property of Channel. More...
 
const std::string & getChannelFilterSetRef (index_type imageIndex, index_type channelIndex) const
 Get the FilterSetRef property of Channel. More...
 
const std::string & getChannelFluor (index_type imageIndex, index_type channelIndex) const
 Get the Fluor property of Channel. More...
 
const std::string & getChannelID (index_type imageIndex, index_type channelIndex) const
 Get the ID property of Channel. More...
 
ome::xml::model::enums::IlluminationType getChannelIlluminationType (index_type imageIndex, index_type channelIndex) const
 Get the IlluminationType property of Channel. More...
 
double getChannelNDFilter (index_type imageIndex, index_type channelIndex) const
 Get the NDFilter property of Channel. More...
 
const std::string & getChannelName (index_type imageIndex, index_type channelIndex) const
 Get the Name property of Channel. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetChannelPinholeSize (index_type imageIndex, index_type channelIndex) const
 Get the PinholeSize property of Channel. More...
 
int32_t getChannelPockelCellSetting (index_type imageIndex, index_type channelIndex) const
 Get the PockelCellSetting property of Channel. More...
 
ome::xml::model::primitives::PositiveInteger getChannelSamplesPerPixel (index_type imageIndex, index_type channelIndex) const
 Get the SamplesPerPixel property of Channel. More...
 
const std::string & getCommentAnnotationAnnotationRef (index_type commentAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of CommentAnnotation. More...
 
const std::string & getCommentAnnotationAnnotator (index_type commentAnnotationIndex) const
 Get the Annotator property of CommentAnnotation. More...
 
const std::string & getCommentAnnotationDescription (index_type commentAnnotationIndex) const
 Get the Description property of CommentAnnotation. More...
 
const std::string & getCommentAnnotationID (index_type commentAnnotationIndex) const
 Get the ID property of CommentAnnotation. More...
 
const std::string & getCommentAnnotationNamespace (index_type commentAnnotationIndex) const
 Get the Namespace property of CommentAnnotation. More...
 
const std::string & getCommentAnnotationValue (index_type commentAnnotationIndex) const
 Get the Value property of CommentAnnotation. More...
 
const std::string & getDatasetAnnotationRef (index_type datasetIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Dataset. More...
 
const std::string & getDatasetDescription (index_type datasetIndex) const
 Get the Description property of Dataset. More...
 
const std::string & getDatasetExperimenterGroupRef (index_type datasetIndex) const
 Get the ExperimenterGroupRef property of Dataset. More...
 
const std::string & getDatasetExperimenterRef (index_type datasetIndex) const
 Get the ExperimenterRef property of Dataset. More...
 
const std::string & getDatasetID (index_type datasetIndex) const
 Get the ID property of Dataset. More...
 
const std::string & getDatasetImageRef (index_type datasetIndex, index_type imageRefIndex) const
 Get the ImageRef property of Dataset. More...
 
const std::string & getDatasetName (index_type datasetIndex) const
 Get the Name property of Dataset. More...
 
double getDetectorAmplificationGain (index_type instrumentIndex, index_type detectorIndex) const
 Get the AmplificationGain property of Detector. More...
 
const std::string & getDetectorAnnotationRef (index_type instrumentIndex, index_type detectorIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Detector. More...
 
double getDetectorGain (index_type instrumentIndex, index_type detectorIndex) const
 Get the Gain property of Detector. More...
 
const std::string & getDetectorID (index_type instrumentIndex, index_type detectorIndex) const
 Get the ID property of Detector. More...
 
const std::string & getDetectorLotNumber (index_type instrumentIndex, index_type detectorIndex) const
 Get the LotNumber property of Detector. More...
 
const std::string & getDetectorManufacturer (index_type instrumentIndex, index_type detectorIndex) const
 Get the Manufacturer property of Detector. More...
 
const std::string & getDetectorModel (index_type instrumentIndex, index_type detectorIndex) const
 Get the Model property of Detector. More...
 
double getDetectorOffset (index_type instrumentIndex, index_type detectorIndex) const
 Get the Offset property of Detector. More...
 
const std::string & getDetectorSerialNumber (index_type instrumentIndex, index_type detectorIndex) const
 Get the SerialNumber property of Detector. More...
 
ome::xml::model::enums::DetectorType getDetectorType (index_type instrumentIndex, index_type detectorIndex) const
 Get the Type property of Detector. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotentialgetDetectorVoltage (index_type instrumentIndex, index_type detectorIndex) const
 Get the Voltage property of Detector. More...
 
double getDetectorZoom (index_type instrumentIndex, index_type detectorIndex) const
 Get the Zoom property of Detector. More...
 
ome::xml::model::enums::Binning getDetectorSettingsBinning (index_type imageIndex, index_type channelIndex) const
 Get the Binning property of DetectorSettings. More...
 
double getDetectorSettingsGain (index_type imageIndex, index_type channelIndex) const
 Get the Gain property of DetectorSettings. More...
 
const std::string & getDetectorSettingsID (index_type imageIndex, index_type channelIndex) const
 Get the ID property of DetectorSettings. More...
 
ome::xml::model::primitives::PositiveInteger getDetectorSettingsIntegration (index_type imageIndex, index_type channelIndex) const
 Get the Integration property of DetectorSettings. More...
 
double getDetectorSettingsOffset (index_type imageIndex, index_type channelIndex) const
 Get the Offset property of DetectorSettings. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequencygetDetectorSettingsReadOutRate (index_type imageIndex, index_type channelIndex) const
 Get the ReadOutRate property of DetectorSettings. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotentialgetDetectorSettingsVoltage (index_type imageIndex, index_type channelIndex) const
 Get the Voltage property of DetectorSettings. More...
 
double getDetectorSettingsZoom (index_type imageIndex, index_type channelIndex) const
 Get the Zoom property of DetectorSettings. More...
 
const std::string & getDichroicAnnotationRef (index_type instrumentIndex, index_type dichroicIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Dichroic. More...
 
const std::string & getDichroicID (index_type instrumentIndex, index_type dichroicIndex) const
 Get the ID property of Dichroic. More...
 
const std::string & getDichroicLotNumber (index_type instrumentIndex, index_type dichroicIndex) const
 Get the LotNumber property of Dichroic. More...
 
const std::string & getDichroicManufacturer (index_type instrumentIndex, index_type dichroicIndex) const
 Get the Manufacturer property of Dichroic. More...
 
const std::string & getDichroicModel (index_type instrumentIndex, index_type dichroicIndex) const
 Get the Model property of Dichroic. More...
 
const std::string & getDichroicSerialNumber (index_type instrumentIndex, index_type dichroicIndex) const
 Get the SerialNumber property of Dichroic. More...
 
const std::string & getDoubleAnnotationAnnotationRef (index_type doubleAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of DoubleAnnotation. More...
 
const std::string & getDoubleAnnotationAnnotator (index_type doubleAnnotationIndex) const
 Get the Annotator property of DoubleAnnotation. More...
 
const std::string & getDoubleAnnotationDescription (index_type doubleAnnotationIndex) const
 Get the Description property of DoubleAnnotation. More...
 
const std::string & getDoubleAnnotationID (index_type doubleAnnotationIndex) const
 Get the ID property of DoubleAnnotation. More...
 
const std::string & getDoubleAnnotationNamespace (index_type doubleAnnotationIndex) const
 Get the Namespace property of DoubleAnnotation. More...
 
double getDoubleAnnotationValue (index_type doubleAnnotationIndex) const
 Get the Value property of DoubleAnnotation. More...
 
const std::string & getEllipseAnnotationRef (index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Ellipse. More...
 
ome::xml::model::primitives::Color getEllipseFillColor (index_type ROIIndex, index_type shapeIndex) const
 Get the FillColor property of Ellipse. More...
 
ome::xml::model::enums::FillRule getEllipseFillRule (index_type ROIIndex, index_type shapeIndex) const
 Get the FillRule property of Ellipse. More...
 
ome::xml::model::enums::FontFamily getEllipseFontFamily (index_type ROIIndex, index_type shapeIndex) const
 Get the FontFamily property of Ellipse. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeIntegergetEllipseFontSize (index_type ROIIndex, index_type shapeIndex) const
 Get the FontSize property of Ellipse. More...
 
ome::xml::model::enums::FontStyle getEllipseFontStyle (index_type ROIIndex, index_type shapeIndex) const
 Get the FontStyle property of Ellipse. More...
 
const std::string & getEllipseID (index_type ROIIndex, index_type shapeIndex) const
 Get the ID property of Ellipse. More...
 
bool getEllipseLocked (index_type ROIIndex, index_type shapeIndex) const
 Get the Locked property of Ellipse. More...
 
double getEllipseRadiusX (index_type ROIIndex, index_type shapeIndex) const
 Get the RadiusX property of Ellipse. More...
 
double getEllipseRadiusY (index_type ROIIndex, index_type shapeIndex) const
 Get the RadiusY property of Ellipse. More...
 
ome::xml::model::primitives::Color getEllipseStrokeColor (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeColor property of Ellipse. More...
 
const std::string & getEllipseStrokeDashArray (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeDashArray property of Ellipse. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetEllipseStrokeWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeWidth property of Ellipse. More...
 
const std::string & getEllipseText (index_type ROIIndex, index_type shapeIndex) const
 Get the Text property of Ellipse. More...
 
ome::xml::model::primitives::NonNegativeInteger getEllipseTheC (index_type ROIIndex, index_type shapeIndex) const
 Get the TheC property of Ellipse. More...
 
ome::xml::model::primitives::NonNegativeInteger getEllipseTheT (index_type ROIIndex, index_type shapeIndex) const
 Get the TheT property of Ellipse. More...
 
ome::xml::model::primitives::NonNegativeInteger getEllipseTheZ (index_type ROIIndex, index_type shapeIndex) const
 Get the TheZ property of Ellipse. More...
 
const ::ome::xml::model::AffineTransformgetEllipseTransform (index_type ROIIndex, index_type shapeIndex) const
 Get the Transform property of Ellipse. More...
 
double getEllipseX (index_type ROIIndex, index_type shapeIndex) const
 Get the X property of Ellipse. More...
 
double getEllipseY (index_type ROIIndex, index_type shapeIndex) const
 Get the Y property of Ellipse. More...
 
const std::string & getExperimentDescription (index_type experimentIndex) const
 Get the Description property of Experiment. More...
 
const std::string & getExperimentExperimenterRef (index_type experimentIndex) const
 Get the ExperimenterRef property of Experiment. More...
 
const std::string & getExperimentID (index_type experimentIndex) const
 Get the ID property of Experiment. More...
 
ome::xml::model::enums::ExperimentType getExperimentType (index_type experimentIndex) const
 Get the Type property of Experiment. More...
 
const std::string & getExperimenterAnnotationRef (index_type experimenterIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Experimenter. More...
 
const std::string & getExperimenterEmail (index_type experimenterIndex) const
 Get the Email property of Experimenter. More...
 
const std::string & getExperimenterFirstName (index_type experimenterIndex) const
 Get the FirstName property of Experimenter. More...
 
const std::string & getExperimenterID (index_type experimenterIndex) const
 Get the ID property of Experimenter. More...
 
const std::string & getExperimenterInstitution (index_type experimenterIndex) const
 Get the Institution property of Experimenter. More...
 
const std::string & getExperimenterLastName (index_type experimenterIndex) const
 Get the LastName property of Experimenter. More...
 
const std::string & getExperimenterMiddleName (index_type experimenterIndex) const
 Get the MiddleName property of Experimenter. More...
 
const std::string & getExperimenterUserName (index_type experimenterIndex) const
 Get the UserName property of Experimenter. More...
 
const std::string & getExperimenterGroupAnnotationRef (index_type experimenterGroupIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of ExperimenterGroup. More...
 
const std::string & getExperimenterGroupDescription (index_type experimenterGroupIndex) const
 Get the Description property of ExperimenterGroup. More...
 
const std::string & getExperimenterGroupExperimenterRef (index_type experimenterGroupIndex, index_type experimenterRefIndex) const
 Get the ExperimenterRef property of ExperimenterGroup. More...
 
const std::string & getExperimenterGroupID (index_type experimenterGroupIndex) const
 Get the ID property of ExperimenterGroup. More...
 
const std::string & getExperimenterGroupLeader (index_type experimenterGroupIndex, index_type leaderIndex) const
 Get the Leader property of ExperimenterGroup. More...
 
const std::string & getExperimenterGroupName (index_type experimenterGroupIndex) const
 Get the Name property of ExperimenterGroup. More...
 
const std::string & getFilamentAnnotationRef (index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Filament. More...
 
const std::string & getFilamentID (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the ID property of Filament. More...
 
const std::string & getFilamentLotNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the LotNumber property of Filament. More...
 
const std::string & getFilamentManufacturer (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Manufacturer property of Filament. More...
 
const std::string & getFilamentModel (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Model property of Filament. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPowergetFilamentPower (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Power property of Filament. More...
 
const std::string & getFilamentSerialNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the SerialNumber property of Filament. More...
 
ome::xml::model::enums::FilamentType getFilamentType (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Type property of Filament. More...
 
const std::string & getFileAnnotationAnnotationRef (index_type fileAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of FileAnnotation. More...
 
const std::string & getFileAnnotationAnnotator (index_type fileAnnotationIndex) const
 Get the Annotator property of FileAnnotation. More...
 
const std::string & getFileAnnotationDescription (index_type fileAnnotationIndex) const
 Get the Description property of FileAnnotation. More...
 
const std::string & getFileAnnotationID (index_type fileAnnotationIndex) const
 Get the ID property of FileAnnotation. More...
 
const std::string & getFileAnnotationNamespace (index_type fileAnnotationIndex) const
 Get the Namespace property of FileAnnotation. More...
 
const std::string & getFilterAnnotationRef (index_type instrumentIndex, index_type filterIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Filter. More...
 
const std::string & getFilterFilterWheel (index_type instrumentIndex, index_type filterIndex) const
 Get the FilterWheel property of Filter. More...
 
const std::string & getFilterID (index_type instrumentIndex, index_type filterIndex) const
 Get the ID property of Filter. More...
 
const std::string & getFilterLotNumber (index_type instrumentIndex, index_type filterIndex) const
 Get the LotNumber property of Filter. More...
 
const std::string & getFilterManufacturer (index_type instrumentIndex, index_type filterIndex) const
 Get the Manufacturer property of Filter. More...
 
const std::string & getFilterModel (index_type instrumentIndex, index_type filterIndex) const
 Get the Model property of Filter. More...
 
const std::string & getFilterSerialNumber (index_type instrumentIndex, index_type filterIndex) const
 Get the SerialNumber property of Filter. More...
 
ome::xml::model::enums::FilterType getFilterType (index_type instrumentIndex, index_type filterIndex) const
 Get the Type property of Filter. More...
 
const std::string & getFilterSetDichroicRef (index_type instrumentIndex, index_type filterSetIndex) const
 Get the DichroicRef property of FilterSet. More...
 
const std::string & getFilterSetEmissionFilterRef (index_type instrumentIndex, index_type filterSetIndex, index_type emissionFilterRefIndex) const
 Get the EmissionFilterRef property of FilterSet. More...
 
const std::string & getFilterSetExcitationFilterRef (index_type instrumentIndex, index_type filterSetIndex, index_type excitationFilterRefIndex) const
 Get the ExcitationFilterRef property of FilterSet. More...
 
const std::string & getFilterSetID (index_type instrumentIndex, index_type filterSetIndex) const
 Get the ID property of FilterSet. More...
 
const std::string & getFilterSetLotNumber (index_type instrumentIndex, index_type filterSetIndex) const
 Get the LotNumber property of FilterSet. More...
 
const std::string & getFilterSetManufacturer (index_type instrumentIndex, index_type filterSetIndex) const
 Get the Manufacturer property of FilterSet. More...
 
const std::string & getFilterSetModel (index_type instrumentIndex, index_type filterSetIndex) const
 Get the Model property of FilterSet. More...
 
const std::string & getFilterSetSerialNumber (index_type instrumentIndex, index_type filterSetIndex) const
 Get the SerialNumber property of FilterSet. More...
 
const std::string & getFolderAnnotationRef (index_type folderIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Folder. More...
 
const std::string & getFolderDescription (index_type folderIndex) const
 Get the Description property of Folder. More...
 
const std::string & getFolderFolderRef (index_type folderIndex, index_type folderRefIndex) const
 Get the FolderRef property of Folder. More...
 
const std::string & getFolderID (index_type folderIndex) const
 Get the ID property of Folder. More...
 
const std::string & getFolderImageRef (index_type folderIndex, index_type imageRefIndex) const
 Get the ImageRef property of Folder. More...
 
const std::string & getFolderName (index_type folderIndex) const
 Get the Name property of Folder. More...
 
const std::string & getFolderROIRef (index_type folderIndex, index_type ROIRefIndex) const
 Get the ROIRef property of Folder. More...
 
const std::string & getGenericExcitationSourceAnnotationRef (index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of GenericExcitationSource. More...
 
const std::string & getGenericExcitationSourceID (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the ID property of GenericExcitationSource. More...
 
const std::string & getGenericExcitationSourceLotNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the LotNumber property of GenericExcitationSource. More...
 
const std::string & getGenericExcitationSourceManufacturer (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Manufacturer property of GenericExcitationSource. More...
 
const std::string & getGenericExcitationSourceModel (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Model property of GenericExcitationSource. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPowergetGenericExcitationSourcePower (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Power property of GenericExcitationSource. More...
 
const std::string & getGenericExcitationSourceSerialNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the SerialNumber property of GenericExcitationSource. More...
 
ome::xml::model::primitives::Timestamp getImageAcquisitionDate (index_type imageIndex) const
 Get the AcquisitionDate property of Image. More...
 
const std::string & getImageAnnotationRef (index_type imageIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Image. More...
 
const std::string & getImageDescription (index_type imageIndex) const
 Get the Description property of Image. More...
 
const std::string & getImageExperimentRef (index_type imageIndex) const
 Get the ExperimentRef property of Image. More...
 
const std::string & getImageExperimenterGroupRef (index_type imageIndex) const
 Get the ExperimenterGroupRef property of Image. More...
 
const std::string & getImageExperimenterRef (index_type imageIndex) const
 Get the ExperimenterRef property of Image. More...
 
const std::string & getImageID (index_type imageIndex) const
 Get the ID property of Image. More...
 
const std::string & getImageInstrumentRef (index_type imageIndex) const
 Get the InstrumentRef property of Image. More...
 
const std::string & getImageMicrobeamManipulationRef (index_type imageIndex, index_type microbeamManipulationRefIndex) const
 Get the MicrobeamManipulationRef property of Image. More...
 
const std::string & getImageName (index_type imageIndex) const
 Get the Name property of Image. More...
 
const std::string & getImageROIRef (index_type imageIndex, index_type ROIRefIndex) const
 Get the ROIRef property of Image. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressuregetImagingEnvironmentAirPressure (index_type imageIndex) const
 Get the AirPressure property of ImagingEnvironment. More...
 
ome::xml::model::primitives::PercentFraction getImagingEnvironmentCO2Percent (index_type imageIndex) const
 Get the CO2Percent property of ImagingEnvironment. More...
 
ome::xml::model::primitives::PercentFraction getImagingEnvironmentHumidity (index_type imageIndex) const
 Get the Humidity property of ImagingEnvironment. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperaturegetImagingEnvironmentTemperature (index_type imageIndex) const
 Get the Temperature property of ImagingEnvironment. More...
 
const std::string & getInstrumentAnnotationRef (index_type instrumentIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Instrument. More...
 
const std::string & getInstrumentID (index_type instrumentIndex) const
 Get the ID property of Instrument. More...
 
const std::string & getLabelAnnotationRef (index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Label. More...
 
ome::xml::model::primitives::Color getLabelFillColor (index_type ROIIndex, index_type shapeIndex) const
 Get the FillColor property of Label. More...
 
ome::xml::model::enums::FillRule getLabelFillRule (index_type ROIIndex, index_type shapeIndex) const
 Get the FillRule property of Label. More...
 
ome::xml::model::enums::FontFamily getLabelFontFamily (index_type ROIIndex, index_type shapeIndex) const
 Get the FontFamily property of Label. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeIntegergetLabelFontSize (index_type ROIIndex, index_type shapeIndex) const
 Get the FontSize property of Label. More...
 
ome::xml::model::enums::FontStyle getLabelFontStyle (index_type ROIIndex, index_type shapeIndex) const
 Get the FontStyle property of Label. More...
 
const std::string & getLabelID (index_type ROIIndex, index_type shapeIndex) const
 Get the ID property of Label. More...
 
bool getLabelLocked (index_type ROIIndex, index_type shapeIndex) const
 Get the Locked property of Label. More...
 
ome::xml::model::primitives::Color getLabelStrokeColor (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeColor property of Label. More...
 
const std::string & getLabelStrokeDashArray (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeDashArray property of Label. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetLabelStrokeWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeWidth property of Label. More...
 
const std::string & getLabelText (index_type ROIIndex, index_type shapeIndex) const
 Get the Text property of Label. More...
 
ome::xml::model::primitives::NonNegativeInteger getLabelTheC (index_type ROIIndex, index_type shapeIndex) const
 Get the TheC property of Label. More...
 
ome::xml::model::primitives::NonNegativeInteger getLabelTheT (index_type ROIIndex, index_type shapeIndex) const
 Get the TheT property of Label. More...
 
ome::xml::model::primitives::NonNegativeInteger getLabelTheZ (index_type ROIIndex, index_type shapeIndex) const
 Get the TheZ property of Label. More...
 
const ::ome::xml::model::AffineTransformgetLabelTransform (index_type ROIIndex, index_type shapeIndex) const
 Get the Transform property of Label. More...
 
double getLabelX (index_type ROIIndex, index_type shapeIndex) const
 Get the X property of Label. More...
 
double getLabelY (index_type ROIIndex, index_type shapeIndex) const
 Get the Y property of Label. More...
 
const std::string & getLaserAnnotationRef (index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Laser. More...
 
ome::xml::model::primitives::PositiveInteger getLaserFrequencyMultiplication (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the FrequencyMultiplication property of Laser. More...
 
const std::string & getLaserID (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the ID property of Laser. More...
 
ome::xml::model::enums::LaserMedium getLaserLaserMedium (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the LaserMedium property of Laser. More...
 
const std::string & getLaserLotNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the LotNumber property of Laser. More...
 
const std::string & getLaserManufacturer (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Manufacturer property of Laser. More...
 
const std::string & getLaserModel (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Model property of Laser. More...
 
bool getLaserPockelCell (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the PockelCell property of Laser. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPowergetLaserPower (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Power property of Laser. More...
 
ome::xml::model::enums::Pulse getLaserPulse (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Pulse property of Laser. More...
 
const std::string & getLaserPump (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Pump property of Laser. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequencygetLaserRepetitionRate (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the RepetitionRate property of Laser. More...
 
const std::string & getLaserSerialNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the SerialNumber property of Laser. More...
 
bool getLaserTuneable (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Tuneable property of Laser. More...
 
ome::xml::model::enums::LaserType getLaserType (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Type property of Laser. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetLaserWavelength (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Wavelength property of Laser. More...
 
const std::string & getLightEmittingDiodeAnnotationRef (index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of LightEmittingDiode. More...
 
const std::string & getLightEmittingDiodeID (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the ID property of LightEmittingDiode. More...
 
const std::string & getLightEmittingDiodeLotNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the LotNumber property of LightEmittingDiode. More...
 
const std::string & getLightEmittingDiodeManufacturer (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Manufacturer property of LightEmittingDiode. More...
 
const std::string & getLightEmittingDiodeModel (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Model property of LightEmittingDiode. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPowergetLightEmittingDiodePower (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the Power property of LightEmittingDiode. More...
 
const std::string & getLightEmittingDiodeSerialNumber (index_type instrumentIndex, index_type lightSourceIndex) const
 Get the SerialNumber property of LightEmittingDiode. More...
 
const std::string & getLightPathAnnotationRef (index_type imageIndex, index_type channelIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of LightPath. More...
 
const std::string & getLightPathDichroicRef (index_type imageIndex, index_type channelIndex) const
 Get the DichroicRef property of LightPath. More...
 
const std::string & getLightPathEmissionFilterRef (index_type imageIndex, index_type channelIndex, index_type emissionFilterRefIndex) const
 Get the EmissionFilterRef property of LightPath. More...
 
const std::string & getLightPathExcitationFilterRef (index_type imageIndex, index_type channelIndex, index_type excitationFilterRefIndex) const
 Get the ExcitationFilterRef property of LightPath. More...
 
ome::xml::model::primitives::PercentFraction getChannelLightSourceSettingsAttenuation (index_type imageIndex, index_type channelIndex) const
 Get the Attenuation property of LightSourceSettings. More...
 
ome::xml::model::primitives::PercentFraction getMicrobeamManipulationLightSourceSettingsAttenuation (index_type experimentIndex, index_type microbeamManipulationIndex, index_type lightSourceSettingsIndex) const
 Get the Attenuation property of LightSourceSettings. More...
 
const std::string & getChannelLightSourceSettingsID (index_type imageIndex, index_type channelIndex) const
 Get the ID property of LightSourceSettings. More...
 
const std::string & getMicrobeamManipulationLightSourceSettingsID (index_type experimentIndex, index_type microbeamManipulationIndex, index_type lightSourceSettingsIndex) const
 Get the ID property of LightSourceSettings. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetChannelLightSourceSettingsWavelength (index_type imageIndex, index_type channelIndex) const
 Get the Wavelength property of LightSourceSettings. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetMicrobeamManipulationLightSourceSettingsWavelength (index_type experimentIndex, index_type microbeamManipulationIndex, index_type lightSourceSettingsIndex) const
 Get the Wavelength property of LightSourceSettings. More...
 
const std::string & getLineAnnotationRef (index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Line. More...
 
ome::xml::model::primitives::Color getLineFillColor (index_type ROIIndex, index_type shapeIndex) const
 Get the FillColor property of Line. More...
 
ome::xml::model::enums::FillRule getLineFillRule (index_type ROIIndex, index_type shapeIndex) const
 Get the FillRule property of Line. More...
 
ome::xml::model::enums::FontFamily getLineFontFamily (index_type ROIIndex, index_type shapeIndex) const
 Get the FontFamily property of Line. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeIntegergetLineFontSize (index_type ROIIndex, index_type shapeIndex) const
 Get the FontSize property of Line. More...
 
ome::xml::model::enums::FontStyle getLineFontStyle (index_type ROIIndex, index_type shapeIndex) const
 Get the FontStyle property of Line. More...
 
const std::string & getLineID (index_type ROIIndex, index_type shapeIndex) const
 Get the ID property of Line. More...
 
bool getLineLocked (index_type ROIIndex, index_type shapeIndex) const
 Get the Locked property of Line. More...
 
ome::xml::model::enums::Marker getLineMarkerEnd (index_type ROIIndex, index_type shapeIndex) const
 Get the MarkerEnd property of Line. More...
 
ome::xml::model::enums::Marker getLineMarkerStart (index_type ROIIndex, index_type shapeIndex) const
 Get the MarkerStart property of Line. More...
 
ome::xml::model::primitives::Color getLineStrokeColor (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeColor property of Line. More...
 
const std::string & getLineStrokeDashArray (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeDashArray property of Line. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetLineStrokeWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeWidth property of Line. More...
 
const std::string & getLineText (index_type ROIIndex, index_type shapeIndex) const
 Get the Text property of Line. More...
 
ome::xml::model::primitives::NonNegativeInteger getLineTheC (index_type ROIIndex, index_type shapeIndex) const
 Get the TheC property of Line. More...
 
ome::xml::model::primitives::NonNegativeInteger getLineTheT (index_type ROIIndex, index_type shapeIndex) const
 Get the TheT property of Line. More...
 
ome::xml::model::primitives::NonNegativeInteger getLineTheZ (index_type ROIIndex, index_type shapeIndex) const
 Get the TheZ property of Line. More...
 
const ::ome::xml::model::AffineTransformgetLineTransform (index_type ROIIndex, index_type shapeIndex) const
 Get the Transform property of Line. More...
 
double getLineX1 (index_type ROIIndex, index_type shapeIndex) const
 Get the X1 property of Line. More...
 
double getLineX2 (index_type ROIIndex, index_type shapeIndex) const
 Get the X2 property of Line. More...
 
double getLineY1 (index_type ROIIndex, index_type shapeIndex) const
 Get the Y1 property of Line. More...
 
double getLineY2 (index_type ROIIndex, index_type shapeIndex) const
 Get the Y2 property of Line. More...
 
const std::string & getListAnnotationAnnotationRef (index_type listAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of ListAnnotation. More...
 
const std::string & getListAnnotationAnnotator (index_type listAnnotationIndex) const
 Get the Annotator property of ListAnnotation. More...
 
const std::string & getListAnnotationDescription (index_type listAnnotationIndex) const
 Get the Description property of ListAnnotation. More...
 
const std::string & getListAnnotationID (index_type listAnnotationIndex) const
 Get the ID property of ListAnnotation. More...
 
const std::string & getListAnnotationNamespace (index_type listAnnotationIndex) const
 Get the Namespace property of ListAnnotation. More...
 
const std::string & getLongAnnotationAnnotationRef (index_type longAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of LongAnnotation. More...
 
const std::string & getLongAnnotationAnnotator (index_type longAnnotationIndex) const
 Get the Annotator property of LongAnnotation. More...
 
const std::string & getLongAnnotationDescription (index_type longAnnotationIndex) const
 Get the Description property of LongAnnotation. More...
 
const std::string & getLongAnnotationID (index_type longAnnotationIndex) const
 Get the ID property of LongAnnotation. More...
 
const std::string & getLongAnnotationNamespace (index_type longAnnotationIndex) const
 Get the Namespace property of LongAnnotation. More...
 
int64_t getLongAnnotationValue (index_type longAnnotationIndex) const
 Get the Value property of LongAnnotation. More...
 
const std::string & getMapAnnotationAnnotationRef (index_type mapAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of MapAnnotation. More...
 
const std::string & getMapAnnotationAnnotator (index_type mapAnnotationIndex) const
 Get the Annotator property of MapAnnotation. More...
 
const std::string & getMapAnnotationDescription (index_type mapAnnotationIndex) const
 Get the Description property of MapAnnotation. More...
 
const std::string & getMapAnnotationID (index_type mapAnnotationIndex) const
 Get the ID property of MapAnnotation. More...
 
const std::string & getMapAnnotationNamespace (index_type mapAnnotationIndex) const
 Get the Namespace property of MapAnnotation. More...
 
const std::string & getMaskAnnotationRef (index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Mask. More...
 
ome::xml::model::primitives::Color getMaskFillColor (index_type ROIIndex, index_type shapeIndex) const
 Get the FillColor property of Mask. More...
 
ome::xml::model::enums::FillRule getMaskFillRule (index_type ROIIndex, index_type shapeIndex) const
 Get the FillRule property of Mask. More...
 
ome::xml::model::enums::FontFamily getMaskFontFamily (index_type ROIIndex, index_type shapeIndex) const
 Get the FontFamily property of Mask. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeIntegergetMaskFontSize (index_type ROIIndex, index_type shapeIndex) const
 Get the FontSize property of Mask. More...
 
ome::xml::model::enums::FontStyle getMaskFontStyle (index_type ROIIndex, index_type shapeIndex) const
 Get the FontStyle property of Mask. More...
 
double getMaskHeight (index_type ROIIndex, index_type shapeIndex) const
 Get the Height property of Mask. More...
 
const std::string & getMaskID (index_type ROIIndex, index_type shapeIndex) const
 Get the ID property of Mask. More...
 
bool getMaskLocked (index_type ROIIndex, index_type shapeIndex) const
 Get the Locked property of Mask. More...
 
ome::xml::model::primitives::Color getMaskStrokeColor (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeColor property of Mask. More...
 
const std::string & getMaskStrokeDashArray (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeDashArray property of Mask. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetMaskStrokeWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeWidth property of Mask. More...
 
const std::string & getMaskText (index_type ROIIndex, index_type shapeIndex) const
 Get the Text property of Mask. More...
 
ome::xml::model::primitives::NonNegativeInteger getMaskTheC (index_type ROIIndex, index_type shapeIndex) const
 Get the TheC property of Mask. More...
 
ome::xml::model::primitives::NonNegativeInteger getMaskTheT (index_type ROIIndex, index_type shapeIndex) const
 Get the TheT property of Mask. More...
 
ome::xml::model::primitives::NonNegativeInteger getMaskTheZ (index_type ROIIndex, index_type shapeIndex) const
 Get the TheZ property of Mask. More...
 
const ::ome::xml::model::AffineTransformgetMaskTransform (index_type ROIIndex, index_type shapeIndex) const
 Get the Transform property of Mask. More...
 
double getMaskWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the Width property of Mask. More...
 
double getMaskX (index_type ROIIndex, index_type shapeIndex) const
 Get the X property of Mask. More...
 
double getMaskY (index_type ROIIndex, index_type shapeIndex) const
 Get the Y property of Mask. More...
 
const std::string & getMicrobeamManipulationDescription (index_type experimentIndex, index_type microbeamManipulationIndex) const
 Get the Description property of MicrobeamManipulation. More...
 
const std::string & getMicrobeamManipulationExperimenterRef (index_type experimentIndex, index_type microbeamManipulationIndex) const
 Get the ExperimenterRef property of MicrobeamManipulation. More...
 
const std::string & getMicrobeamManipulationID (index_type experimentIndex, index_type microbeamManipulationIndex) const
 Get the ID property of MicrobeamManipulation. More...
 
const std::string & getMicrobeamManipulationROIRef (index_type experimentIndex, index_type microbeamManipulationIndex, index_type ROIRefIndex) const
 Get the ROIRef property of MicrobeamManipulation. More...
 
ome::xml::model::enums::MicrobeamManipulationType getMicrobeamManipulationType (index_type experimentIndex, index_type microbeamManipulationIndex) const
 Get the Type property of MicrobeamManipulation. More...
 
const std::string & getMicroscopeLotNumber (index_type instrumentIndex) const
 Get the LotNumber property of Microscope. More...
 
const std::string & getMicroscopeManufacturer (index_type instrumentIndex) const
 Get the Manufacturer property of Microscope. More...
 
const std::string & getMicroscopeModel (index_type instrumentIndex) const
 Get the Model property of Microscope. More...
 
const std::string & getMicroscopeSerialNumber (index_type instrumentIndex) const
 Get the SerialNumber property of Microscope. More...
 
ome::xml::model::enums::MicroscopeType getMicroscopeType (index_type instrumentIndex) const
 Get the Type property of Microscope. More...
 
const std::string & getObjectiveAnnotationRef (index_type instrumentIndex, index_type objectiveIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Objective. More...
 
double getObjectiveCalibratedMagnification (index_type instrumentIndex, index_type objectiveIndex) const
 Get the CalibratedMagnification property of Objective. More...
 
ome::xml::model::enums::Correction getObjectiveCorrection (index_type instrumentIndex, index_type objectiveIndex) const
 Get the Correction property of Objective. More...
 
const std::string & getObjectiveID (index_type instrumentIndex, index_type objectiveIndex) const
 Get the ID property of Objective. More...
 
ome::xml::model::enums::Immersion getObjectiveImmersion (index_type instrumentIndex, index_type objectiveIndex) const
 Get the Immersion property of Objective. More...
 
bool getObjectiveIris (index_type instrumentIndex, index_type objectiveIndex) const
 Get the Iris property of Objective. More...
 
double getObjectiveLensNA (index_type instrumentIndex, index_type objectiveIndex) const
 Get the LensNA property of Objective. More...
 
const std::string & getObjectiveLotNumber (index_type instrumentIndex, index_type objectiveIndex) const
 Get the LotNumber property of Objective. More...
 
const std::string & getObjectiveManufacturer (index_type instrumentIndex, index_type objectiveIndex) const
 Get the Manufacturer property of Objective. More...
 
const std::string & getObjectiveModel (index_type instrumentIndex, index_type objectiveIndex) const
 Get the Model property of Objective. More...
 
double getObjectiveNominalMagnification (index_type instrumentIndex, index_type objectiveIndex) const
 Get the NominalMagnification property of Objective. More...
 
const std::string & getObjectiveSerialNumber (index_type instrumentIndex, index_type objectiveIndex) const
 Get the SerialNumber property of Objective. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetObjectiveWorkingDistance (index_type instrumentIndex, index_type objectiveIndex) const
 Get the WorkingDistance property of Objective. More...
 
double getObjectiveSettingsCorrectionCollar (index_type imageIndex) const
 Get the CorrectionCollar property of ObjectiveSettings. More...
 
const std::string & getObjectiveSettingsID (index_type imageIndex) const
 Get the ID property of ObjectiveSettings. More...
 
ome::xml::model::enums::Medium getObjectiveSettingsMedium (index_type imageIndex) const
 Get the Medium property of ObjectiveSettings. More...
 
double getObjectiveSettingsRefractiveIndex (index_type imageIndex) const
 Get the RefractiveIndex property of ObjectiveSettings. More...
 
bool getPixelsBigEndian (index_type imageIndex) const
 Get the BigEndian property of Pixels. More...
 
ome::xml::model::enums::DimensionOrder getPixelsDimensionOrder (index_type imageIndex) const
 Get the DimensionOrder property of Pixels. More...
 
const std::string & getPixelsID (index_type imageIndex) const
 Get the ID property of Pixels. More...
 
bool getPixelsInterleaved (index_type imageIndex) const
 Get the Interleaved property of Pixels. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetPixelsPhysicalSizeX (index_type imageIndex) const
 Get the PhysicalSizeX property of Pixels. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetPixelsPhysicalSizeY (index_type imageIndex) const
 Get the PhysicalSizeY property of Pixels. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetPixelsPhysicalSizeZ (index_type imageIndex) const
 Get the PhysicalSizeZ property of Pixels. More...
 
ome::xml::model::primitives::PositiveInteger getPixelsSignificantBits (index_type imageIndex) const
 Get the SignificantBits property of Pixels. More...
 
ome::xml::model::primitives::PositiveInteger getPixelsSizeC (index_type imageIndex) const
 Get the SizeC property of Pixels. More...
 
ome::xml::model::primitives::PositiveInteger getPixelsSizeT (index_type imageIndex) const
 Get the SizeT property of Pixels. More...
 
ome::xml::model::primitives::PositiveInteger getPixelsSizeX (index_type imageIndex) const
 Get the SizeX property of Pixels. More...
 
ome::xml::model::primitives::PositiveInteger getPixelsSizeY (index_type imageIndex) const
 Get the SizeY property of Pixels. More...
 
ome::xml::model::primitives::PositiveInteger getPixelsSizeZ (index_type imageIndex) const
 Get the SizeZ property of Pixels. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTimegetPixelsTimeIncrement (index_type imageIndex) const
 Get the TimeIncrement property of Pixels. More...
 
ome::xml::model::enums::PixelType getPixelsType (index_type imageIndex) const
 Get the Type property of Pixels. More...
 
const std::string & getPlaneAnnotationRef (index_type imageIndex, index_type planeIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Plane. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTimegetPlaneDeltaT (index_type imageIndex, index_type planeIndex) const
 Get the DeltaT property of Plane. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTimegetPlaneExposureTime (index_type imageIndex, index_type planeIndex) const
 Get the ExposureTime property of Plane. More...
 
const std::string & getPlaneHashSHA1 (index_type imageIndex, index_type planeIndex) const
 Get the HashSHA1 property of Plane. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetPlanePositionX (index_type imageIndex, index_type planeIndex) const
 Get the PositionX property of Plane. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetPlanePositionY (index_type imageIndex, index_type planeIndex) const
 Get the PositionY property of Plane. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetPlanePositionZ (index_type imageIndex, index_type planeIndex) const
 Get the PositionZ property of Plane. More...
 
ome::xml::model::primitives::NonNegativeInteger getPlaneTheC (index_type imageIndex, index_type planeIndex) const
 Get the TheC property of Plane. More...
 
ome::xml::model::primitives::NonNegativeInteger getPlaneTheT (index_type imageIndex, index_type planeIndex) const
 Get the TheT property of Plane. More...
 
ome::xml::model::primitives::NonNegativeInteger getPlaneTheZ (index_type imageIndex, index_type planeIndex) const
 Get the TheZ property of Plane. More...
 
const std::string & getPlateAnnotationRef (index_type plateIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Plate. More...
 
ome::xml::model::enums::NamingConvention getPlateColumnNamingConvention (index_type plateIndex) const
 Get the ColumnNamingConvention property of Plate. More...
 
ome::xml::model::primitives::PositiveInteger getPlateColumns (index_type plateIndex) const
 Get the Columns property of Plate. More...
 
const std::string & getPlateDescription (index_type plateIndex) const
 Get the Description property of Plate. More...
 
const std::string & getPlateExternalIdentifier (index_type plateIndex) const
 Get the ExternalIdentifier property of Plate. More...
 
ome::xml::model::primitives::NonNegativeInteger getPlateFieldIndex (index_type plateIndex) const
 Get the FieldIndex property of Plate. More...
 
const std::string & getPlateID (index_type plateIndex) const
 Get the ID property of Plate. More...
 
const std::string & getPlateName (index_type plateIndex) const
 Get the Name property of Plate. More...
 
ome::xml::model::enums::NamingConvention getPlateRowNamingConvention (index_type plateIndex) const
 Get the RowNamingConvention property of Plate. More...
 
ome::xml::model::primitives::PositiveInteger getPlateRows (index_type plateIndex) const
 Get the Rows property of Plate. More...
 
const std::string & getPlateStatus (index_type plateIndex) const
 Get the Status property of Plate. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetPlateWellOriginX (index_type plateIndex) const
 Get the WellOriginX property of Plate. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetPlateWellOriginY (index_type plateIndex) const
 Get the WellOriginY property of Plate. More...
 
const std::string & getPlateAcquisitionAnnotationRef (index_type plateIndex, index_type plateAcquisitionIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of PlateAcquisition. More...
 
const std::string & getPlateAcquisitionDescription (index_type plateIndex, index_type plateAcquisitionIndex) const
 Get the Description property of PlateAcquisition. More...
 
ome::xml::model::primitives::Timestamp getPlateAcquisitionEndTime (index_type plateIndex, index_type plateAcquisitionIndex) const
 Get the EndTime property of PlateAcquisition. More...
 
const std::string & getPlateAcquisitionID (index_type plateIndex, index_type plateAcquisitionIndex) const
 Get the ID property of PlateAcquisition. More...
 
ome::xml::model::primitives::PositiveInteger getPlateAcquisitionMaximumFieldCount (index_type plateIndex, index_type plateAcquisitionIndex) const
 Get the MaximumFieldCount property of PlateAcquisition. More...
 
const std::string & getPlateAcquisitionName (index_type plateIndex, index_type plateAcquisitionIndex) const
 Get the Name property of PlateAcquisition. More...
 
ome::xml::model::primitives::Timestamp getPlateAcquisitionStartTime (index_type plateIndex, index_type plateAcquisitionIndex) const
 Get the StartTime property of PlateAcquisition. More...
 
const std::string & getPlateAcquisitionWellSampleRef (index_type plateIndex, index_type plateAcquisitionIndex, index_type wellSampleRefIndex) const
 Get the WellSampleRef property of PlateAcquisition. More...
 
const std::string & getPointAnnotationRef (index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Point. More...
 
ome::xml::model::primitives::Color getPointFillColor (index_type ROIIndex, index_type shapeIndex) const
 Get the FillColor property of Point. More...
 
ome::xml::model::enums::FillRule getPointFillRule (index_type ROIIndex, index_type shapeIndex) const
 Get the FillRule property of Point. More...
 
ome::xml::model::enums::FontFamily getPointFontFamily (index_type ROIIndex, index_type shapeIndex) const
 Get the FontFamily property of Point. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeIntegergetPointFontSize (index_type ROIIndex, index_type shapeIndex) const
 Get the FontSize property of Point. More...
 
ome::xml::model::enums::FontStyle getPointFontStyle (index_type ROIIndex, index_type shapeIndex) const
 Get the FontStyle property of Point. More...
 
const std::string & getPointID (index_type ROIIndex, index_type shapeIndex) const
 Get the ID property of Point. More...
 
bool getPointLocked (index_type ROIIndex, index_type shapeIndex) const
 Get the Locked property of Point. More...
 
ome::xml::model::primitives::Color getPointStrokeColor (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeColor property of Point. More...
 
const std::string & getPointStrokeDashArray (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeDashArray property of Point. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetPointStrokeWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeWidth property of Point. More...
 
const std::string & getPointText (index_type ROIIndex, index_type shapeIndex) const
 Get the Text property of Point. More...
 
ome::xml::model::primitives::NonNegativeInteger getPointTheC (index_type ROIIndex, index_type shapeIndex) const
 Get the TheC property of Point. More...
 
ome::xml::model::primitives::NonNegativeInteger getPointTheT (index_type ROIIndex, index_type shapeIndex) const
 Get the TheT property of Point. More...
 
ome::xml::model::primitives::NonNegativeInteger getPointTheZ (index_type ROIIndex, index_type shapeIndex) const
 Get the TheZ property of Point. More...
 
const ::ome::xml::model::AffineTransformgetPointTransform (index_type ROIIndex, index_type shapeIndex) const
 Get the Transform property of Point. More...
 
double getPointX (index_type ROIIndex, index_type shapeIndex) const
 Get the X property of Point. More...
 
double getPointY (index_type ROIIndex, index_type shapeIndex) const
 Get the Y property of Point. More...
 
const std::string & getPolygonAnnotationRef (index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Polygon. More...
 
ome::xml::model::primitives::Color getPolygonFillColor (index_type ROIIndex, index_type shapeIndex) const
 Get the FillColor property of Polygon. More...
 
ome::xml::model::enums::FillRule getPolygonFillRule (index_type ROIIndex, index_type shapeIndex) const
 Get the FillRule property of Polygon. More...
 
ome::xml::model::enums::FontFamily getPolygonFontFamily (index_type ROIIndex, index_type shapeIndex) const
 Get the FontFamily property of Polygon. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeIntegergetPolygonFontSize (index_type ROIIndex, index_type shapeIndex) const
 Get the FontSize property of Polygon. More...
 
ome::xml::model::enums::FontStyle getPolygonFontStyle (index_type ROIIndex, index_type shapeIndex) const
 Get the FontStyle property of Polygon. More...
 
const std::string & getPolygonID (index_type ROIIndex, index_type shapeIndex) const
 Get the ID property of Polygon. More...
 
bool getPolygonLocked (index_type ROIIndex, index_type shapeIndex) const
 Get the Locked property of Polygon. More...
 
const std::string & getPolygonPoints (index_type ROIIndex, index_type shapeIndex) const
 Get the Points property of Polygon. More...
 
ome::xml::model::primitives::Color getPolygonStrokeColor (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeColor property of Polygon. More...
 
const std::string & getPolygonStrokeDashArray (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeDashArray property of Polygon. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetPolygonStrokeWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeWidth property of Polygon. More...
 
const std::string & getPolygonText (index_type ROIIndex, index_type shapeIndex) const
 Get the Text property of Polygon. More...
 
ome::xml::model::primitives::NonNegativeInteger getPolygonTheC (index_type ROIIndex, index_type shapeIndex) const
 Get the TheC property of Polygon. More...
 
ome::xml::model::primitives::NonNegativeInteger getPolygonTheT (index_type ROIIndex, index_type shapeIndex) const
 Get the TheT property of Polygon. More...
 
ome::xml::model::primitives::NonNegativeInteger getPolygonTheZ (index_type ROIIndex, index_type shapeIndex) const
 Get the TheZ property of Polygon. More...
 
const ::ome::xml::model::AffineTransformgetPolygonTransform (index_type ROIIndex, index_type shapeIndex) const
 Get the Transform property of Polygon. More...
 
const std::string & getPolylineAnnotationRef (index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Polyline. More...
 
ome::xml::model::primitives::Color getPolylineFillColor (index_type ROIIndex, index_type shapeIndex) const
 Get the FillColor property of Polyline. More...
 
ome::xml::model::enums::FillRule getPolylineFillRule (index_type ROIIndex, index_type shapeIndex) const
 Get the FillRule property of Polyline. More...
 
ome::xml::model::enums::FontFamily getPolylineFontFamily (index_type ROIIndex, index_type shapeIndex) const
 Get the FontFamily property of Polyline. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeIntegergetPolylineFontSize (index_type ROIIndex, index_type shapeIndex) const
 Get the FontSize property of Polyline. More...
 
ome::xml::model::enums::FontStyle getPolylineFontStyle (index_type ROIIndex, index_type shapeIndex) const
 Get the FontStyle property of Polyline. More...
 
const std::string & getPolylineID (index_type ROIIndex, index_type shapeIndex) const
 Get the ID property of Polyline. More...
 
bool getPolylineLocked (index_type ROIIndex, index_type shapeIndex) const
 Get the Locked property of Polyline. More...
 
ome::xml::model::enums::Marker getPolylineMarkerEnd (index_type ROIIndex, index_type shapeIndex) const
 Get the MarkerEnd property of Polyline. More...
 
ome::xml::model::enums::Marker getPolylineMarkerStart (index_type ROIIndex, index_type shapeIndex) const
 Get the MarkerStart property of Polyline. More...
 
const std::string & getPolylinePoints (index_type ROIIndex, index_type shapeIndex) const
 Get the Points property of Polyline. More...
 
ome::xml::model::primitives::Color getPolylineStrokeColor (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeColor property of Polyline. More...
 
const std::string & getPolylineStrokeDashArray (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeDashArray property of Polyline. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetPolylineStrokeWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeWidth property of Polyline. More...
 
const std::string & getPolylineText (index_type ROIIndex, index_type shapeIndex) const
 Get the Text property of Polyline. More...
 
ome::xml::model::primitives::NonNegativeInteger getPolylineTheC (index_type ROIIndex, index_type shapeIndex) const
 Get the TheC property of Polyline. More...
 
ome::xml::model::primitives::NonNegativeInteger getPolylineTheT (index_type ROIIndex, index_type shapeIndex) const
 Get the TheT property of Polyline. More...
 
ome::xml::model::primitives::NonNegativeInteger getPolylineTheZ (index_type ROIIndex, index_type shapeIndex) const
 Get the TheZ property of Polyline. More...
 
const ::ome::xml::model::AffineTransformgetPolylineTransform (index_type ROIIndex, index_type shapeIndex) const
 Get the Transform property of Polyline. More...
 
const std::string & getProjectAnnotationRef (index_type projectIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Project. More...
 
const std::string & getProjectDatasetRef (index_type projectIndex, index_type datasetRefIndex) const
 Get the DatasetRef property of Project. More...
 
const std::string & getProjectDescription (index_type projectIndex) const
 Get the Description property of Project. More...
 
const std::string & getProjectExperimenterGroupRef (index_type projectIndex) const
 Get the ExperimenterGroupRef property of Project. More...
 
const std::string & getProjectExperimenterRef (index_type projectIndex) const
 Get the ExperimenterRef property of Project. More...
 
const std::string & getProjectID (index_type projectIndex) const
 Get the ID property of Project. More...
 
const std::string & getProjectName (index_type projectIndex) const
 Get the Name property of Project. More...
 
const std::string & getROIAnnotationRef (index_type ROIIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of ROI. More...
 
const std::string & getROIDescription (index_type ROIIndex) const
 Get the Description property of ROI. More...
 
const std::string & getROIID (index_type ROIIndex) const
 Get the ID property of ROI. More...
 
const std::string & getROIName (index_type ROIIndex) const
 Get the Name property of ROI. More...
 
const std::string & getReagentAnnotationRef (index_type screenIndex, index_type reagentIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Reagent. More...
 
const std::string & getReagentDescription (index_type screenIndex, index_type reagentIndex) const
 Get the Description property of Reagent. More...
 
const std::string & getReagentID (index_type screenIndex, index_type reagentIndex) const
 Get the ID property of Reagent. More...
 
const std::string & getReagentName (index_type screenIndex, index_type reagentIndex) const
 Get the Name property of Reagent. More...
 
const std::string & getReagentReagentIdentifier (index_type screenIndex, index_type reagentIndex) const
 Get the ReagentIdentifier property of Reagent. More...
 
const std::string & getRectangleAnnotationRef (index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Rectangle. More...
 
ome::xml::model::primitives::Color getRectangleFillColor (index_type ROIIndex, index_type shapeIndex) const
 Get the FillColor property of Rectangle. More...
 
ome::xml::model::enums::FillRule getRectangleFillRule (index_type ROIIndex, index_type shapeIndex) const
 Get the FillRule property of Rectangle. More...
 
ome::xml::model::enums::FontFamily getRectangleFontFamily (index_type ROIIndex, index_type shapeIndex) const
 Get the FontFamily property of Rectangle. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeIntegergetRectangleFontSize (index_type ROIIndex, index_type shapeIndex) const
 Get the FontSize property of Rectangle. More...
 
ome::xml::model::enums::FontStyle getRectangleFontStyle (index_type ROIIndex, index_type shapeIndex) const
 Get the FontStyle property of Rectangle. More...
 
double getRectangleHeight (index_type ROIIndex, index_type shapeIndex) const
 Get the Height property of Rectangle. More...
 
const std::string & getRectangleID (index_type ROIIndex, index_type shapeIndex) const
 Get the ID property of Rectangle. More...
 
bool getRectangleLocked (index_type ROIIndex, index_type shapeIndex) const
 Get the Locked property of Rectangle. More...
 
ome::xml::model::primitives::Color getRectangleStrokeColor (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeColor property of Rectangle. More...
 
const std::string & getRectangleStrokeDashArray (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeDashArray property of Rectangle. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetRectangleStrokeWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the StrokeWidth property of Rectangle. More...
 
const std::string & getRectangleText (index_type ROIIndex, index_type shapeIndex) const
 Get the Text property of Rectangle. More...
 
ome::xml::model::primitives::NonNegativeInteger getRectangleTheC (index_type ROIIndex, index_type shapeIndex) const
 Get the TheC property of Rectangle. More...
 
ome::xml::model::primitives::NonNegativeInteger getRectangleTheT (index_type ROIIndex, index_type shapeIndex) const
 Get the TheT property of Rectangle. More...
 
ome::xml::model::primitives::NonNegativeInteger getRectangleTheZ (index_type ROIIndex, index_type shapeIndex) const
 Get the TheZ property of Rectangle. More...
 
const ::ome::xml::model::AffineTransformgetRectangleTransform (index_type ROIIndex, index_type shapeIndex) const
 Get the Transform property of Rectangle. More...
 
double getRectangleWidth (index_type ROIIndex, index_type shapeIndex) const
 Get the Width property of Rectangle. More...
 
double getRectangleX (index_type ROIIndex, index_type shapeIndex) const
 Get the X property of Rectangle. More...
 
double getRectangleY (index_type ROIIndex, index_type shapeIndex) const
 Get the Y property of Rectangle. More...
 
const std::string & getRightsRightsHeld () const
 Get the RightsHeld property of Rights. More...
 
const std::string & getRightsRightsHolder () const
 Get the RightsHolder property of Rights. More...
 
const std::string & getScreenAnnotationRef (index_type screenIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Screen. More...
 
const std::string & getScreenDescription (index_type screenIndex) const
 Get the Description property of Screen. More...
 
const std::string & getScreenID (index_type screenIndex) const
 Get the ID property of Screen. More...
 
const std::string & getScreenName (index_type screenIndex) const
 Get the Name property of Screen. More...
 
const std::string & getScreenPlateRef (index_type screenIndex, index_type plateRefIndex) const
 Get the PlateRef property of Screen. More...
 
const std::string & getScreenProtocolDescription (index_type screenIndex) const
 Get the ProtocolDescription property of Screen. More...
 
const std::string & getScreenProtocolIdentifier (index_type screenIndex) const
 Get the ProtocolIdentifier property of Screen. More...
 
const std::string & getScreenReagentSetDescription (index_type screenIndex) const
 Get the ReagentSetDescription property of Screen. More...
 
const std::string & getScreenReagentSetIdentifier (index_type screenIndex) const
 Get the ReagentSetIdentifier property of Screen. More...
 
const std::string & getScreenType (index_type screenIndex) const
 Get the Type property of Screen. More...
 
const std::string & getStageLabelName (index_type imageIndex) const
 Get the Name property of StageLabel. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetStageLabelX (index_type imageIndex) const
 Get the X property of StageLabel. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetStageLabelY (index_type imageIndex) const
 Get the Y property of StageLabel. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetStageLabelZ (index_type imageIndex) const
 Get the Z property of StageLabel. More...
 
const std::string & getTagAnnotationAnnotationRef (index_type tagAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of TagAnnotation. More...
 
const std::string & getTagAnnotationAnnotator (index_type tagAnnotationIndex) const
 Get the Annotator property of TagAnnotation. More...
 
const std::string & getTagAnnotationDescription (index_type tagAnnotationIndex) const
 Get the Description property of TagAnnotation. More...
 
const std::string & getTagAnnotationID (index_type tagAnnotationIndex) const
 Get the ID property of TagAnnotation. More...
 
const std::string & getTagAnnotationNamespace (index_type tagAnnotationIndex) const
 Get the Namespace property of TagAnnotation. More...
 
const std::string & getTagAnnotationValue (index_type tagAnnotationIndex) const
 Get the Value property of TagAnnotation. More...
 
const std::string & getTermAnnotationAnnotationRef (index_type termAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of TermAnnotation. More...
 
const std::string & getTermAnnotationAnnotator (index_type termAnnotationIndex) const
 Get the Annotator property of TermAnnotation. More...
 
const std::string & getTermAnnotationDescription (index_type termAnnotationIndex) const
 Get the Description property of TermAnnotation. More...
 
const std::string & getTermAnnotationID (index_type termAnnotationIndex) const
 Get the ID property of TermAnnotation. More...
 
const std::string & getTermAnnotationNamespace (index_type termAnnotationIndex) const
 Get the Namespace property of TermAnnotation. More...
 
const std::string & getTermAnnotationValue (index_type termAnnotationIndex) const
 Get the Value property of TermAnnotation. More...
 
ome::xml::model::primitives::NonNegativeInteger getTiffDataFirstC (index_type imageIndex, index_type tiffDataIndex) const
 Get the FirstC property of TiffData. More...
 
ome::xml::model::primitives::NonNegativeInteger getTiffDataFirstT (index_type imageIndex, index_type tiffDataIndex) const
 Get the FirstT property of TiffData. More...
 
ome::xml::model::primitives::NonNegativeInteger getTiffDataFirstZ (index_type imageIndex, index_type tiffDataIndex) const
 Get the FirstZ property of TiffData. More...
 
ome::xml::model::primitives::NonNegativeInteger getTiffDataIFD (index_type imageIndex, index_type tiffDataIndex) const
 Get the IFD property of TiffData. More...
 
ome::xml::model::primitives::NonNegativeInteger getTiffDataPlaneCount (index_type imageIndex, index_type tiffDataIndex) const
 Get the PlaneCount property of TiffData. More...
 
const std::string & getTimestampAnnotationAnnotationRef (index_type timestampAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of TimestampAnnotation. More...
 
const std::string & getTimestampAnnotationAnnotator (index_type timestampAnnotationIndex) const
 Get the Annotator property of TimestampAnnotation. More...
 
const std::string & getTimestampAnnotationDescription (index_type timestampAnnotationIndex) const
 Get the Description property of TimestampAnnotation. More...
 
const std::string & getTimestampAnnotationID (index_type timestampAnnotationIndex) const
 Get the ID property of TimestampAnnotation. More...
 
const std::string & getTimestampAnnotationNamespace (index_type timestampAnnotationIndex) const
 Get the Namespace property of TimestampAnnotation. More...
 
ome::xml::model::primitives::Timestamp getTimestampAnnotationValue (index_type timestampAnnotationIndex) const
 Get the Value property of TimestampAnnotation. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetTransmittanceRangeCutIn (index_type instrumentIndex, index_type filterIndex) const
 Get the CutIn property of TransmittanceRange. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeFloatgetTransmittanceRangeCutInTolerance (index_type instrumentIndex, index_type filterIndex) const
 Get the CutInTolerance property of TransmittanceRange. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloatgetTransmittanceRangeCutOut (index_type instrumentIndex, index_type filterIndex) const
 Get the CutOut property of TransmittanceRange. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeFloatgetTransmittanceRangeCutOutTolerance (index_type instrumentIndex, index_type filterIndex) const
 Get the CutOutTolerance property of TransmittanceRange. More...
 
ome::xml::model::primitives::PercentFraction getTransmittanceRangeTransmittance (index_type instrumentIndex, index_type filterIndex) const
 Get the Transmittance property of TransmittanceRange. More...
 
const std::string & getUUIDFileName (index_type imageIndex, index_type tiffDataIndex) const
 Get the FileName property of UUID. More...
 
const std::string & getWellAnnotationRef (index_type plateIndex, index_type wellIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of Well. More...
 
ome::xml::model::primitives::Color getWellColor (index_type plateIndex, index_type wellIndex) const
 Get the Color property of Well. More...
 
ome::xml::model::primitives::NonNegativeInteger getWellColumn (index_type plateIndex, index_type wellIndex) const
 Get the Column property of Well. More...
 
const std::string & getWellExternalDescription (index_type plateIndex, index_type wellIndex) const
 Get the ExternalDescription property of Well. More...
 
const std::string & getWellExternalIdentifier (index_type plateIndex, index_type wellIndex) const
 Get the ExternalIdentifier property of Well. More...
 
const std::string & getWellID (index_type plateIndex, index_type wellIndex) const
 Get the ID property of Well. More...
 
const std::string & getWellReagentRef (index_type plateIndex, index_type wellIndex) const
 Get the ReagentRef property of Well. More...
 
ome::xml::model::primitives::NonNegativeInteger getWellRow (index_type plateIndex, index_type wellIndex) const
 Get the Row property of Well. More...
 
const std::string & getWellType (index_type plateIndex, index_type wellIndex) const
 Get the Type property of Well. More...
 
const std::string & getWellSampleID (index_type plateIndex, index_type wellIndex, index_type wellSampleIndex) const
 Get the ID property of WellSample. More...
 
const std::string & getWellSampleImageRef (index_type plateIndex, index_type wellIndex, index_type wellSampleIndex) const
 Get the ImageRef property of WellSample. More...
 
ome::xml::model::primitives::NonNegativeInteger getWellSampleIndex (index_type plateIndex, index_type wellIndex, index_type wellSampleIndex) const
 Get the Index property of WellSample. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetWellSamplePositionX (index_type plateIndex, index_type wellIndex, index_type wellSampleIndex) const
 Get the PositionX property of WellSample. More...
 
ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLengthgetWellSamplePositionY (index_type plateIndex, index_type wellIndex, index_type wellSampleIndex) const
 Get the PositionY property of WellSample. More...
 
ome::xml::model::primitives::Timestamp getWellSampleTimepoint (index_type plateIndex, index_type wellIndex, index_type wellSampleIndex) const
 Get the Timepoint property of WellSample. More...
 
const std::string & getXMLAnnotationAnnotationRef (index_type XMLAnnotationIndex, index_type annotationRefIndex) const
 Get the AnnotationRef property of XMLAnnotation. More...
 
const std::string & getXMLAnnotationAnnotator (index_type XMLAnnotationIndex) const
 Get the Annotator property of XMLAnnotation. More...
 
const std::string & getXMLAnnotationDescription (index_type XMLAnnotationIndex) const
 Get the Description property of XMLAnnotation. More...
 
const std::string & getXMLAnnotationID (index_type XMLAnnotationIndex) const
 Get the ID property of XMLAnnotation. More...
 
const std::string & getXMLAnnotationNamespace (index_type XMLAnnotationIndex) const
 Get the Namespace property of XMLAnnotation. More...
 
const std::string & getXMLAnnotationValue (index_type XMLAnnotationIndex) const
 Get the Value property of XMLAnnotation. More...
 
void setUUID (const std::string &uuid)
 Set the UUID associated with this collection of metadata. More...
 
void setMapAnnotationValue (const ome::xml::model::primitives::OrderedMultimap &value, index_type mapAnnotationIndex)
 Set the map value of MapAnnotation. More...
 
void setGenericExcitationSourceMap (const ome::xml::model::primitives::OrderedMultimap &value, index_type instrumentIndex, index_type lightSourceIndex)
 Set the map value of GenericExcitationSource. More...
 
void setImagingEnvironmentMap (const ome::xml::model::primitives::OrderedMultimap &value, index_type imageIndex)
 Set the map value of ImagingEnvironment. More...
 
void setArcAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Arc. More...
 
void setArcID (const std::string &id, index_type instrumentIndex, index_type lightSourceIndex)
 Set the ID property of Arc. More...
 
void setArcLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the LotNumber property of Arc. More...
 
void setArcManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Manufacturer property of Arc. More...
 
void setArcModel (const std::string &model, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Model property of Arc. More...
 
void setArcPower (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > power, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Power property of Arc. More...
 
void setArcSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the SerialNumber property of Arc. More...
 
void setArcType (ome::xml::model::enums::ArcType type, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Type property of Arc. More...
 
void setBinaryFileBinData (const std::vector< uint8_t > &base64Binary, index_type fileAnnotationIndex)
 Set the Base64Binary property of BinData. More...
 
void setMaskBinData (const std::vector< uint8_t > &base64Binary, index_type ROIIndex, index_type shapeIndex)
 Set the Base64Binary property of BinData. More...
 
void setPixelsBinData (const std::vector< uint8_t > &base64Binary, index_type imageIndex, index_type binDataIndex)
 Set the Base64Binary property of BinData. More...
 
void setBinaryFileBinDataBigEndian (bool bigEndian, index_type fileAnnotationIndex)
 Set the BigEndian property of BinData. More...
 
void setMaskBinDataBigEndian (bool bigEndian, index_type ROIIndex, index_type shapeIndex)
 Set the BigEndian property of BinData. More...
 
void setPixelsBinDataBigEndian (bool bigEndian, index_type imageIndex, index_type binDataIndex)
 Set the BigEndian property of BinData. More...
 
void setBinaryFileBinDataCompression (ome::xml::model::enums::Compression compression, index_type fileAnnotationIndex)
 Set the Compression property of BinData. More...
 
void setMaskBinDataCompression (ome::xml::model::enums::Compression compression, index_type ROIIndex, index_type shapeIndex)
 Set the Compression property of BinData. More...
 
void setPixelsBinDataCompression (ome::xml::model::enums::Compression compression, index_type imageIndex, index_type binDataIndex)
 Set the Compression property of BinData. More...
 
void setBinaryFileBinDataLength (ome::xml::model::primitives::NonNegativeLong length, index_type fileAnnotationIndex)
 Set the Length property of BinData. More...
 
void setMaskBinDataLength (ome::xml::model::primitives::NonNegativeLong length, index_type ROIIndex, index_type shapeIndex)
 Set the Length property of BinData. More...
 
void setPixelsBinDataLength (ome::xml::model::primitives::NonNegativeLong length, index_type imageIndex, index_type binDataIndex)
 Set the Length property of BinData. More...
 
void setBinaryFileFileName (const std::string &fileName, index_type fileAnnotationIndex)
 Set the FileName property of BinaryFile. More...
 
void setBinaryFileMIMEType (const std::string &mimeType, index_type fileAnnotationIndex)
 Set the MIMEType property of BinaryFile. More...
 
void setBinaryFileSize (ome::xml::model::primitives::NonNegativeLong size, index_type fileAnnotationIndex)
 Set the Size property of BinaryFile. More...
 
void setBinaryOnlyMetadataFile (const std::string &metadataFile)
 Set the MetadataFile property of BinaryOnly. More...
 
void setBinaryOnlyUUID (const std::string &uuid)
 Set the UUID property of BinaryOnly. More...
 
void setBooleanAnnotationAnnotationRef (const std::string &annotation, index_type booleanAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of BooleanAnnotation. More...
 
void setBooleanAnnotationAnnotator (const std::string &annotator, index_type booleanAnnotationIndex)
 Set the Annotator property of BooleanAnnotation. More...
 
void setBooleanAnnotationDescription (const std::string &description, index_type booleanAnnotationIndex)
 Set the Description property of BooleanAnnotation. More...
 
void setBooleanAnnotationID (const std::string &id, index_type booleanAnnotationIndex)
 Set the ID property of BooleanAnnotation. More...
 
void setBooleanAnnotationNamespace (const std::string &namespace_, index_type booleanAnnotationIndex)
 Set the Namespace property of BooleanAnnotation. More...
 
void setBooleanAnnotationValue (bool value, index_type booleanAnnotationIndex)
 Set the Value property of BooleanAnnotation. More...
 
void setChannelAcquisitionMode (ome::xml::model::enums::AcquisitionMode acquisitionMode, index_type imageIndex, index_type channelIndex)
 Set the AcquisitionMode property of Channel. More...
 
void setChannelAnnotationRef (const std::string &annotation, index_type imageIndex, index_type channelIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Channel. More...
 
void setChannelColor (ome::xml::model::primitives::Color color, index_type imageIndex, index_type channelIndex)
 Set the Color property of Channel. More...
 
void setChannelContrastMethod (ome::xml::model::enums::ContrastMethod contrastMethod, index_type imageIndex, index_type channelIndex)
 Set the ContrastMethod property of Channel. More...
 
void setChannelEmissionWavelength (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > emissionWavelength, index_type imageIndex, index_type channelIndex)
 Set the EmissionWavelength property of Channel. More...
 
void setChannelExcitationWavelength (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > excitationWavelength, index_type imageIndex, index_type channelIndex)
 Set the ExcitationWavelength property of Channel. More...
 
void setChannelFilterSetRef (const std::string &filterSet, index_type imageIndex, index_type channelIndex)
 Set the FilterSetRef property of Channel. More...
 
void setChannelFluor (const std::string &fluor, index_type imageIndex, index_type channelIndex)
 Set the Fluor property of Channel. More...
 
void setChannelID (const std::string &id, index_type imageIndex, index_type channelIndex)
 Set the ID property of Channel. More...
 
void setChannelIlluminationType (ome::xml::model::enums::IlluminationType illuminationType, index_type imageIndex, index_type channelIndex)
 Set the IlluminationType property of Channel. More...
 
void setChannelNDFilter (double ndFilter, index_type imageIndex, index_type channelIndex)
 Set the NDFilter property of Channel. More...
 
void setChannelName (const std::string &name, index_type imageIndex, index_type channelIndex)
 Set the Name property of Channel. More...
 
void setChannelPinholeSize (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > pinholeSize, index_type imageIndex, index_type channelIndex)
 Set the PinholeSize property of Channel. More...
 
void setChannelPockelCellSetting (int32_t pockelCellSetting, index_type imageIndex, index_type channelIndex)
 Set the PockelCellSetting property of Channel. More...
 
void setChannelSamplesPerPixel (ome::xml::model::primitives::PositiveInteger samplesPerPixel, index_type imageIndex, index_type channelIndex)
 Set the SamplesPerPixel property of Channel. More...
 
void setCommentAnnotationAnnotationRef (const std::string &annotation, index_type commentAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of CommentAnnotation. More...
 
void setCommentAnnotationAnnotator (const std::string &annotator, index_type commentAnnotationIndex)
 Set the Annotator property of CommentAnnotation. More...
 
void setCommentAnnotationDescription (const std::string &description, index_type commentAnnotationIndex)
 Set the Description property of CommentAnnotation. More...
 
void setCommentAnnotationID (const std::string &id, index_type commentAnnotationIndex)
 Set the ID property of CommentAnnotation. More...
 
void setCommentAnnotationNamespace (const std::string &namespace_, index_type commentAnnotationIndex)
 Set the Namespace property of CommentAnnotation. More...
 
void setCommentAnnotationValue (const std::string &value, index_type commentAnnotationIndex)
 Set the Value property of CommentAnnotation. More...
 
void setDatasetAnnotationRef (const std::string &annotation, index_type datasetIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Dataset. More...
 
void setDatasetDescription (const std::string &description, index_type datasetIndex)
 Set the Description property of Dataset. More...
 
void setDatasetExperimenterGroupRef (const std::string &experimenterGroup, index_type datasetIndex)
 Set the ExperimenterGroupRef property of Dataset. More...
 
void setDatasetExperimenterRef (const std::string &experimenter, index_type datasetIndex)
 Set the ExperimenterRef property of Dataset. More...
 
void setDatasetID (const std::string &id, index_type datasetIndex)
 Set the ID property of Dataset. More...
 
void setDatasetImageRef (const std::string &image, index_type datasetIndex, index_type imageRefIndex)
 Set the ImageRef property of Dataset. More...
 
void setDatasetName (const std::string &name, index_type datasetIndex)
 Set the Name property of Dataset. More...
 
void setDetectorAmplificationGain (double amplificationGain, index_type instrumentIndex, index_type detectorIndex)
 Set the AmplificationGain property of Detector. More...
 
void setDetectorAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type detectorIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Detector. More...
 
void setDetectorGain (double gain, index_type instrumentIndex, index_type detectorIndex)
 Set the Gain property of Detector. More...
 
void setDetectorID (const std::string &id, index_type instrumentIndex, index_type detectorIndex)
 Set the ID property of Detector. More...
 
void setDetectorLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type detectorIndex)
 Set the LotNumber property of Detector. More...
 
void setDetectorManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type detectorIndex)
 Set the Manufacturer property of Detector. More...
 
void setDetectorModel (const std::string &model, index_type instrumentIndex, index_type detectorIndex)
 Set the Model property of Detector. More...
 
void setDetectorOffset (double offset, index_type instrumentIndex, index_type detectorIndex)
 Set the Offset property of Detector. More...
 
void setDetectorSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type detectorIndex)
 Set the SerialNumber property of Detector. More...
 
void setDetectorType (ome::xml::model::enums::DetectorType type, index_type instrumentIndex, index_type detectorIndex)
 Set the Type property of Detector. More...
 
void setDetectorVoltage (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential > voltage, index_type instrumentIndex, index_type detectorIndex)
 Set the Voltage property of Detector. More...
 
void setDetectorZoom (double zoom, index_type instrumentIndex, index_type detectorIndex)
 Set the Zoom property of Detector. More...
 
void setDetectorSettingsBinning (ome::xml::model::enums::Binning binning, index_type imageIndex, index_type channelIndex)
 Set the Binning property of DetectorSettings. More...
 
void setDetectorSettingsGain (double gain, index_type imageIndex, index_type channelIndex)
 Set the Gain property of DetectorSettings. More...
 
void setDetectorSettingsID (const std::string &id, index_type imageIndex, index_type channelIndex)
 Set the ID property of DetectorSettings. More...
 
void setDetectorSettingsIntegration (ome::xml::model::primitives::PositiveInteger integration, index_type imageIndex, index_type channelIndex)
 Set the Integration property of DetectorSettings. More...
 
void setDetectorSettingsOffset (double offset, index_type imageIndex, index_type channelIndex)
 Set the Offset property of DetectorSettings. More...
 
void setDetectorSettingsReadOutRate (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > readOutRate, index_type imageIndex, index_type channelIndex)
 Set the ReadOutRate property of DetectorSettings. More...
 
void setDetectorSettingsVoltage (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential > voltage, index_type imageIndex, index_type channelIndex)
 Set the Voltage property of DetectorSettings. More...
 
void setDetectorSettingsZoom (double zoom, index_type imageIndex, index_type channelIndex)
 Set the Zoom property of DetectorSettings. More...
 
void setDichroicAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type dichroicIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Dichroic. More...
 
void setDichroicID (const std::string &id, index_type instrumentIndex, index_type dichroicIndex)
 Set the ID property of Dichroic. More...
 
void setDichroicLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type dichroicIndex)
 Set the LotNumber property of Dichroic. More...
 
void setDichroicManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type dichroicIndex)
 Set the Manufacturer property of Dichroic. More...
 
void setDichroicModel (const std::string &model, index_type instrumentIndex, index_type dichroicIndex)
 Set the Model property of Dichroic. More...
 
void setDichroicSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type dichroicIndex)
 Set the SerialNumber property of Dichroic. More...
 
void setDoubleAnnotationAnnotationRef (const std::string &annotation, index_type doubleAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of DoubleAnnotation. More...
 
void setDoubleAnnotationAnnotator (const std::string &annotator, index_type doubleAnnotationIndex)
 Set the Annotator property of DoubleAnnotation. More...
 
void setDoubleAnnotationDescription (const std::string &description, index_type doubleAnnotationIndex)
 Set the Description property of DoubleAnnotation. More...
 
void setDoubleAnnotationID (const std::string &id, index_type doubleAnnotationIndex)
 Set the ID property of DoubleAnnotation. More...
 
void setDoubleAnnotationNamespace (const std::string &namespace_, index_type doubleAnnotationIndex)
 Set the Namespace property of DoubleAnnotation. More...
 
void setDoubleAnnotationValue (double value, index_type doubleAnnotationIndex)
 Set the Value property of DoubleAnnotation. More...
 
void setEllipseAnnotationRef (const std::string &annotation, index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Ellipse. More...
 
void setEllipseFillColor (ome::xml::model::primitives::Color fillColor, index_type ROIIndex, index_type shapeIndex)
 Set the FillColor property of Ellipse. More...
 
void setEllipseFillRule (ome::xml::model::enums::FillRule fillRule, index_type ROIIndex, index_type shapeIndex)
 Set the FillRule property of Ellipse. More...
 
void setEllipseFontFamily (ome::xml::model::enums::FontFamily fontFamily, index_type ROIIndex, index_type shapeIndex)
 Set the FontFamily property of Ellipse. More...
 
void setEllipseFontSize (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > fontSize, index_type ROIIndex, index_type shapeIndex)
 Set the FontSize property of Ellipse. More...
 
void setEllipseFontStyle (ome::xml::model::enums::FontStyle fontStyle, index_type ROIIndex, index_type shapeIndex)
 Set the FontStyle property of Ellipse. More...
 
void setEllipseID (const std::string &id, index_type ROIIndex, index_type shapeIndex)
 Set the ID property of Ellipse. More...
 
void setEllipseLocked (bool locked, index_type ROIIndex, index_type shapeIndex)
 Set the Locked property of Ellipse. More...
 
void setEllipseRadiusX (double radiusX, index_type ROIIndex, index_type shapeIndex)
 Set the RadiusX property of Ellipse. More...
 
void setEllipseRadiusY (double radiusY, index_type ROIIndex, index_type shapeIndex)
 Set the RadiusY property of Ellipse. More...
 
void setEllipseStrokeColor (ome::xml::model::primitives::Color strokeColor, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeColor property of Ellipse. More...
 
void setEllipseStrokeDashArray (const std::string &strokeDashArray, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeDashArray property of Ellipse. More...
 
void setEllipseStrokeWidth (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > strokeWidth, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeWidth property of Ellipse. More...
 
void setEllipseText (const std::string &text, index_type ROIIndex, index_type shapeIndex)
 Set the Text property of Ellipse. More...
 
void setEllipseTheC (ome::xml::model::primitives::NonNegativeInteger theC, index_type ROIIndex, index_type shapeIndex)
 Set the TheC property of Ellipse. More...
 
void setEllipseTheT (ome::xml::model::primitives::NonNegativeInteger theT, index_type ROIIndex, index_type shapeIndex)
 Set the TheT property of Ellipse. More...
 
void setEllipseTheZ (ome::xml::model::primitives::NonNegativeInteger theZ, index_type ROIIndex, index_type shapeIndex)
 Set the TheZ property of Ellipse. More...
 
void setEllipseTransform (const ::ome::xml::model::AffineTransform &transform, index_type ROIIndex, index_type shapeIndex)
 Set the Transform property of Ellipse. More...
 
void setEllipseX (double x, index_type ROIIndex, index_type shapeIndex)
 Set the X property of Ellipse. More...
 
void setEllipseY (double y, index_type ROIIndex, index_type shapeIndex)
 Set the Y property of Ellipse. More...
 
void setExperimentDescription (const std::string &description, index_type experimentIndex)
 Set the Description property of Experiment. More...
 
void setExperimentExperimenterRef (const std::string &experimenter, index_type experimentIndex)
 Set the ExperimenterRef property of Experiment. More...
 
void setExperimentID (const std::string &id, index_type experimentIndex)
 Set the ID property of Experiment. More...
 
void setExperimentType (ome::xml::model::enums::ExperimentType type, index_type experimentIndex)
 Set the Type property of Experiment. More...
 
void setExperimenterAnnotationRef (const std::string &annotation, index_type experimenterIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Experimenter. More...
 
void setExperimenterEmail (const std::string &email, index_type experimenterIndex)
 Set the Email property of Experimenter. More...
 
void setExperimenterFirstName (const std::string &firstName, index_type experimenterIndex)
 Set the FirstName property of Experimenter. More...
 
void setExperimenterID (const std::string &id, index_type experimenterIndex)
 Set the ID property of Experimenter. More...
 
void setExperimenterInstitution (const std::string &institution, index_type experimenterIndex)
 Set the Institution property of Experimenter. More...
 
void setExperimenterLastName (const std::string &lastName, index_type experimenterIndex)
 Set the LastName property of Experimenter. More...
 
void setExperimenterMiddleName (const std::string &middleName, index_type experimenterIndex)
 Set the MiddleName property of Experimenter. More...
 
void setExperimenterUserName (const std::string &userName, index_type experimenterIndex)
 Set the UserName property of Experimenter. More...
 
void setExperimenterGroupAnnotationRef (const std::string &annotation, index_type experimenterGroupIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of ExperimenterGroup. More...
 
void setExperimenterGroupDescription (const std::string &description, index_type experimenterGroupIndex)
 Set the Description property of ExperimenterGroup. More...
 
void setExperimenterGroupExperimenterRef (const std::string &experimenter, index_type experimenterGroupIndex, index_type experimenterRefIndex)
 Set the ExperimenterRef property of ExperimenterGroup. More...
 
void setExperimenterGroupID (const std::string &id, index_type experimenterGroupIndex)
 Set the ID property of ExperimenterGroup. More...
 
void setExperimenterGroupLeader (const std::string &leader, index_type experimenterGroupIndex, index_type leaderIndex)
 Set the Leader property of ExperimenterGroup. More...
 
void setExperimenterGroupName (const std::string &name, index_type experimenterGroupIndex)
 Set the Name property of ExperimenterGroup. More...
 
void setFilamentAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Filament. More...
 
void setFilamentID (const std::string &id, index_type instrumentIndex, index_type lightSourceIndex)
 Set the ID property of Filament. More...
 
void setFilamentLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the LotNumber property of Filament. More...
 
void setFilamentManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Manufacturer property of Filament. More...
 
void setFilamentModel (const std::string &model, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Model property of Filament. More...
 
void setFilamentPower (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > power, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Power property of Filament. More...
 
void setFilamentSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the SerialNumber property of Filament. More...
 
void setFilamentType (ome::xml::model::enums::FilamentType type, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Type property of Filament. More...
 
void setFileAnnotationAnnotationRef (const std::string &annotation, index_type fileAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of FileAnnotation. More...
 
void setFileAnnotationAnnotator (const std::string &annotator, index_type fileAnnotationIndex)
 Set the Annotator property of FileAnnotation. More...
 
void setFileAnnotationDescription (const std::string &description, index_type fileAnnotationIndex)
 Set the Description property of FileAnnotation. More...
 
void setFileAnnotationID (const std::string &id, index_type fileAnnotationIndex)
 Set the ID property of FileAnnotation. More...
 
void setFileAnnotationNamespace (const std::string &namespace_, index_type fileAnnotationIndex)
 Set the Namespace property of FileAnnotation. More...
 
void setFilterAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type filterIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Filter. More...
 
void setFilterFilterWheel (const std::string &filterWheel, index_type instrumentIndex, index_type filterIndex)
 Set the FilterWheel property of Filter. More...
 
void setFilterID (const std::string &id, index_type instrumentIndex, index_type filterIndex)
 Set the ID property of Filter. More...
 
void setFilterLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type filterIndex)
 Set the LotNumber property of Filter. More...
 
void setFilterManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type filterIndex)
 Set the Manufacturer property of Filter. More...
 
void setFilterModel (const std::string &model, index_type instrumentIndex, index_type filterIndex)
 Set the Model property of Filter. More...
 
void setFilterSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type filterIndex)
 Set the SerialNumber property of Filter. More...
 
void setFilterType (ome::xml::model::enums::FilterType type, index_type instrumentIndex, index_type filterIndex)
 Set the Type property of Filter. More...
 
void setFilterSetDichroicRef (const std::string &dichroic, index_type instrumentIndex, index_type filterSetIndex)
 Set the DichroicRef property of FilterSet. More...
 
void setFilterSetEmissionFilterRef (const std::string &emissionFilter, index_type instrumentIndex, index_type filterSetIndex, index_type emissionFilterRefIndex)
 Set the EmissionFilterRef property of FilterSet. More...
 
void setFilterSetExcitationFilterRef (const std::string &excitationFilter, index_type instrumentIndex, index_type filterSetIndex, index_type excitationFilterRefIndex)
 Set the ExcitationFilterRef property of FilterSet. More...
 
void setFilterSetID (const std::string &id, index_type instrumentIndex, index_type filterSetIndex)
 Set the ID property of FilterSet. More...
 
void setFilterSetLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type filterSetIndex)
 Set the LotNumber property of FilterSet. More...
 
void setFilterSetManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type filterSetIndex)
 Set the Manufacturer property of FilterSet. More...
 
void setFilterSetModel (const std::string &model, index_type instrumentIndex, index_type filterSetIndex)
 Set the Model property of FilterSet. More...
 
void setFilterSetSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type filterSetIndex)
 Set the SerialNumber property of FilterSet. More...
 
void setFolderAnnotationRef (const std::string &annotation, index_type folderIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Folder. More...
 
void setFolderDescription (const std::string &description, index_type folderIndex)
 Set the Description property of Folder. More...
 
void setFolderFolderRef (const std::string &folder, index_type folderIndex, index_type folderRefIndex)
 Set the FolderRef property of Folder. More...
 
void setFolderID (const std::string &id, index_type folderIndex)
 Set the ID property of Folder. More...
 
void setFolderImageRef (const std::string &image, index_type folderIndex, index_type imageRefIndex)
 Set the ImageRef property of Folder. More...
 
void setFolderName (const std::string &name, index_type folderIndex)
 Set the Name property of Folder. More...
 
void setFolderROIRef (const std::string &roi, index_type folderIndex, index_type ROIRefIndex)
 Set the ROIRef property of Folder. More...
 
void setGenericExcitationSourceAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of GenericExcitationSource. More...
 
void setGenericExcitationSourceID (const std::string &id, index_type instrumentIndex, index_type lightSourceIndex)
 Set the ID property of GenericExcitationSource. More...
 
void setGenericExcitationSourceLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the LotNumber property of GenericExcitationSource. More...
 
void setGenericExcitationSourceManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Manufacturer property of GenericExcitationSource. More...
 
void setGenericExcitationSourceModel (const std::string &model, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Model property of GenericExcitationSource. More...
 
void setGenericExcitationSourcePower (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > power, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Power property of GenericExcitationSource. More...
 
void setGenericExcitationSourceSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the SerialNumber property of GenericExcitationSource. More...
 
void setImageAcquisitionDate (ome::xml::model::primitives::Timestamp acquisitionDate, index_type imageIndex)
 Set the AcquisitionDate property of Image. More...
 
void setImageAnnotationRef (const std::string &annotation, index_type imageIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Image. More...
 
void setImageDescription (const std::string &description, index_type imageIndex)
 Set the Description property of Image. More...
 
void setImageExperimentRef (const std::string &experiment, index_type imageIndex)
 Set the ExperimentRef property of Image. More...
 
void setImageExperimenterGroupRef (const std::string &experimenterGroup, index_type imageIndex)
 Set the ExperimenterGroupRef property of Image. More...
 
void setImageExperimenterRef (const std::string &experimenter, index_type imageIndex)
 Set the ExperimenterRef property of Image. More...
 
void setImageID (const std::string &id, index_type imageIndex)
 Set the ID property of Image. More...
 
void setImageInstrumentRef (const std::string &instrument, index_type imageIndex)
 Set the InstrumentRef property of Image. More...
 
void setImageMicrobeamManipulationRef (const std::string &microbeamManipulation, index_type imageIndex, index_type microbeamManipulationRefIndex)
 Set the MicrobeamManipulationRef property of Image. More...
 
void setImageName (const std::string &name, index_type imageIndex)
 Set the Name property of Image. More...
 
void setImageROIRef (const std::string &roi, index_type imageIndex, index_type ROIRefIndex)
 Set the ROIRef property of Image. More...
 
void setImagingEnvironmentAirPressure (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > airPressure, index_type imageIndex)
 Set the AirPressure property of ImagingEnvironment. More...
 
void setImagingEnvironmentCO2Percent (ome::xml::model::primitives::PercentFraction co2Percent, index_type imageIndex)
 Set the CO2Percent property of ImagingEnvironment. More...
 
void setImagingEnvironmentHumidity (ome::xml::model::primitives::PercentFraction humidity, index_type imageIndex)
 Set the Humidity property of ImagingEnvironment. More...
 
void setImagingEnvironmentTemperature (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > temperature, index_type imageIndex)
 Set the Temperature property of ImagingEnvironment. More...
 
void setInstrumentAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Instrument. More...
 
void setInstrumentID (const std::string &id, index_type instrumentIndex)
 Set the ID property of Instrument. More...
 
void setLabelAnnotationRef (const std::string &annotation, index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Label. More...
 
void setLabelFillColor (ome::xml::model::primitives::Color fillColor, index_type ROIIndex, index_type shapeIndex)
 Set the FillColor property of Label. More...
 
void setLabelFillRule (ome::xml::model::enums::FillRule fillRule, index_type ROIIndex, index_type shapeIndex)
 Set the FillRule property of Label. More...
 
void setLabelFontFamily (ome::xml::model::enums::FontFamily fontFamily, index_type ROIIndex, index_type shapeIndex)
 Set the FontFamily property of Label. More...
 
void setLabelFontSize (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > fontSize, index_type ROIIndex, index_type shapeIndex)
 Set the FontSize property of Label. More...
 
void setLabelFontStyle (ome::xml::model::enums::FontStyle fontStyle, index_type ROIIndex, index_type shapeIndex)
 Set the FontStyle property of Label. More...
 
void setLabelID (const std::string &id, index_type ROIIndex, index_type shapeIndex)
 Set the ID property of Label. More...
 
void setLabelLocked (bool locked, index_type ROIIndex, index_type shapeIndex)
 Set the Locked property of Label. More...
 
void setLabelStrokeColor (ome::xml::model::primitives::Color strokeColor, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeColor property of Label. More...
 
void setLabelStrokeDashArray (const std::string &strokeDashArray, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeDashArray property of Label. More...
 
void setLabelStrokeWidth (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > strokeWidth, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeWidth property of Label. More...
 
void setLabelText (const std::string &text, index_type ROIIndex, index_type shapeIndex)
 Set the Text property of Label. More...
 
void setLabelTheC (ome::xml::model::primitives::NonNegativeInteger theC, index_type ROIIndex, index_type shapeIndex)
 Set the TheC property of Label. More...
 
void setLabelTheT (ome::xml::model::primitives::NonNegativeInteger theT, index_type ROIIndex, index_type shapeIndex)
 Set the TheT property of Label. More...
 
void setLabelTheZ (ome::xml::model::primitives::NonNegativeInteger theZ, index_type ROIIndex, index_type shapeIndex)
 Set the TheZ property of Label. More...
 
void setLabelTransform (const ::ome::xml::model::AffineTransform &transform, index_type ROIIndex, index_type shapeIndex)
 Set the Transform property of Label. More...
 
void setLabelX (double x, index_type ROIIndex, index_type shapeIndex)
 Set the X property of Label. More...
 
void setLabelY (double y, index_type ROIIndex, index_type shapeIndex)
 Set the Y property of Label. More...
 
void setLaserAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Laser. More...
 
void setLaserFrequencyMultiplication (ome::xml::model::primitives::PositiveInteger frequencyMultiplication, index_type instrumentIndex, index_type lightSourceIndex)
 Set the FrequencyMultiplication property of Laser. More...
 
void setLaserID (const std::string &id, index_type instrumentIndex, index_type lightSourceIndex)
 Set the ID property of Laser. More...
 
void setLaserLaserMedium (ome::xml::model::enums::LaserMedium laserMedium, index_type instrumentIndex, index_type lightSourceIndex)
 Set the LaserMedium property of Laser. More...
 
void setLaserLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the LotNumber property of Laser. More...
 
void setLaserManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Manufacturer property of Laser. More...
 
void setLaserModel (const std::string &model, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Model property of Laser. More...
 
void setLaserPockelCell (bool pockelCell, index_type instrumentIndex, index_type lightSourceIndex)
 Set the PockelCell property of Laser. More...
 
void setLaserPower (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > power, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Power property of Laser. More...
 
void setLaserPulse (ome::xml::model::enums::Pulse pulse, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Pulse property of Laser. More...
 
void setLaserPump (const std::string &pump, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Pump property of Laser. More...
 
void setLaserRepetitionRate (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > repetitionRate, index_type instrumentIndex, index_type lightSourceIndex)
 Set the RepetitionRate property of Laser. More...
 
void setLaserSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the SerialNumber property of Laser. More...
 
void setLaserTuneable (bool tuneable, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Tuneable property of Laser. More...
 
void setLaserType (ome::xml::model::enums::LaserType type, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Type property of Laser. More...
 
void setLaserWavelength (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > wavelength, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Wavelength property of Laser. More...
 
void setLightEmittingDiodeAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type lightSourceIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of LightEmittingDiode. More...
 
void setLightEmittingDiodeID (const std::string &id, index_type instrumentIndex, index_type lightSourceIndex)
 Set the ID property of LightEmittingDiode. More...
 
void setLightEmittingDiodeLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the LotNumber property of LightEmittingDiode. More...
 
void setLightEmittingDiodeManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Manufacturer property of LightEmittingDiode. More...
 
void setLightEmittingDiodeModel (const std::string &model, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Model property of LightEmittingDiode. More...
 
void setLightEmittingDiodePower (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > power, index_type instrumentIndex, index_type lightSourceIndex)
 Set the Power property of LightEmittingDiode. More...
 
void setLightEmittingDiodeSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type lightSourceIndex)
 Set the SerialNumber property of LightEmittingDiode. More...
 
void setLightPathAnnotationRef (const std::string &annotation, index_type imageIndex, index_type channelIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of LightPath. More...
 
void setLightPathDichroicRef (const std::string &dichroic, index_type imageIndex, index_type channelIndex)
 Set the DichroicRef property of LightPath. More...
 
void setLightPathEmissionFilterRef (const std::string &emissionFilter, index_type imageIndex, index_type channelIndex, index_type emissionFilterRefIndex)
 Set the EmissionFilterRef property of LightPath. More...
 
void setLightPathExcitationFilterRef (const std::string &excitationFilter, index_type imageIndex, index_type channelIndex, index_type excitationFilterRefIndex)
 Set the ExcitationFilterRef property of LightPath. More...
 
void setChannelLightSourceSettingsAttenuation (ome::xml::model::primitives::PercentFraction attenuation, index_type imageIndex, index_type channelIndex)
 Set the Attenuation property of LightSourceSettings. More...
 
void setMicrobeamManipulationLightSourceSettingsAttenuation (ome::xml::model::primitives::PercentFraction attenuation, index_type experimentIndex, index_type microbeamManipulationIndex, index_type lightSourceSettingsIndex)
 Set the Attenuation property of LightSourceSettings. More...
 
void setChannelLightSourceSettingsID (const std::string &id, index_type imageIndex, index_type channelIndex)
 Set the ID property of LightSourceSettings. More...
 
void setMicrobeamManipulationLightSourceSettingsID (const std::string &id, index_type experimentIndex, index_type microbeamManipulationIndex, index_type lightSourceSettingsIndex)
 Set the ID property of LightSourceSettings. More...
 
void setChannelLightSourceSettingsWavelength (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > wavelength, index_type imageIndex, index_type channelIndex)
 Set the Wavelength property of LightSourceSettings. More...
 
void setMicrobeamManipulationLightSourceSettingsWavelength (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > wavelength, index_type experimentIndex, index_type microbeamManipulationIndex, index_type lightSourceSettingsIndex)
 Set the Wavelength property of LightSourceSettings. More...
 
void setLineAnnotationRef (const std::string &annotation, index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Line. More...
 
void setLineFillColor (ome::xml::model::primitives::Color fillColor, index_type ROIIndex, index_type shapeIndex)
 Set the FillColor property of Line. More...
 
void setLineFillRule (ome::xml::model::enums::FillRule fillRule, index_type ROIIndex, index_type shapeIndex)
 Set the FillRule property of Line. More...
 
void setLineFontFamily (ome::xml::model::enums::FontFamily fontFamily, index_type ROIIndex, index_type shapeIndex)
 Set the FontFamily property of Line. More...
 
void setLineFontSize (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > fontSize, index_type ROIIndex, index_type shapeIndex)
 Set the FontSize property of Line. More...
 
void setLineFontStyle (ome::xml::model::enums::FontStyle fontStyle, index_type ROIIndex, index_type shapeIndex)
 Set the FontStyle property of Line. More...
 
void setLineID (const std::string &id, index_type ROIIndex, index_type shapeIndex)
 Set the ID property of Line. More...
 
void setLineLocked (bool locked, index_type ROIIndex, index_type shapeIndex)
 Set the Locked property of Line. More...
 
void setLineMarkerEnd (ome::xml::model::enums::Marker markerEnd, index_type ROIIndex, index_type shapeIndex)
 Set the MarkerEnd property of Line. More...
 
void setLineMarkerStart (ome::xml::model::enums::Marker markerStart, index_type ROIIndex, index_type shapeIndex)
 Set the MarkerStart property of Line. More...
 
void setLineStrokeColor (ome::xml::model::primitives::Color strokeColor, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeColor property of Line. More...
 
void setLineStrokeDashArray (const std::string &strokeDashArray, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeDashArray property of Line. More...
 
void setLineStrokeWidth (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > strokeWidth, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeWidth property of Line. More...
 
void setLineText (const std::string &text, index_type ROIIndex, index_type shapeIndex)
 Set the Text property of Line. More...
 
void setLineTheC (ome::xml::model::primitives::NonNegativeInteger theC, index_type ROIIndex, index_type shapeIndex)
 Set the TheC property of Line. More...
 
void setLineTheT (ome::xml::model::primitives::NonNegativeInteger theT, index_type ROIIndex, index_type shapeIndex)
 Set the TheT property of Line. More...
 
void setLineTheZ (ome::xml::model::primitives::NonNegativeInteger theZ, index_type ROIIndex, index_type shapeIndex)
 Set the TheZ property of Line. More...
 
void setLineTransform (const ::ome::xml::model::AffineTransform &transform, index_type ROIIndex, index_type shapeIndex)
 Set the Transform property of Line. More...
 
void setLineX1 (double x1, index_type ROIIndex, index_type shapeIndex)
 Set the X1 property of Line. More...
 
void setLineX2 (double x2, index_type ROIIndex, index_type shapeIndex)
 Set the X2 property of Line. More...
 
void setLineY1 (double y1, index_type ROIIndex, index_type shapeIndex)
 Set the Y1 property of Line. More...
 
void setLineY2 (double y2, index_type ROIIndex, index_type shapeIndex)
 Set the Y2 property of Line. More...
 
void setListAnnotationAnnotationRef (const std::string &annotation, index_type listAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of ListAnnotation. More...
 
void setListAnnotationAnnotator (const std::string &annotator, index_type listAnnotationIndex)
 Set the Annotator property of ListAnnotation. More...
 
void setListAnnotationDescription (const std::string &description, index_type listAnnotationIndex)
 Set the Description property of ListAnnotation. More...
 
void setListAnnotationID (const std::string &id, index_type listAnnotationIndex)
 Set the ID property of ListAnnotation. More...
 
void setListAnnotationNamespace (const std::string &namespace_, index_type listAnnotationIndex)
 Set the Namespace property of ListAnnotation. More...
 
void setLongAnnotationAnnotationRef (const std::string &annotation, index_type longAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of LongAnnotation. More...
 
void setLongAnnotationAnnotator (const std::string &annotator, index_type longAnnotationIndex)
 Set the Annotator property of LongAnnotation. More...
 
void setLongAnnotationDescription (const std::string &description, index_type longAnnotationIndex)
 Set the Description property of LongAnnotation. More...
 
void setLongAnnotationID (const std::string &id, index_type longAnnotationIndex)
 Set the ID property of LongAnnotation. More...
 
void setLongAnnotationNamespace (const std::string &namespace_, index_type longAnnotationIndex)
 Set the Namespace property of LongAnnotation. More...
 
void setLongAnnotationValue (int64_t value, index_type longAnnotationIndex)
 Set the Value property of LongAnnotation. More...
 
void setMapAnnotationAnnotationRef (const std::string &annotation, index_type mapAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of MapAnnotation. More...
 
void setMapAnnotationAnnotator (const std::string &annotator, index_type mapAnnotationIndex)
 Set the Annotator property of MapAnnotation. More...
 
void setMapAnnotationDescription (const std::string &description, index_type mapAnnotationIndex)
 Set the Description property of MapAnnotation. More...
 
void setMapAnnotationID (const std::string &id, index_type mapAnnotationIndex)
 Set the ID property of MapAnnotation. More...
 
void setMapAnnotationNamespace (const std::string &namespace_, index_type mapAnnotationIndex)
 Set the Namespace property of MapAnnotation. More...
 
void setMaskAnnotationRef (const std::string &annotation, index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Mask. More...
 
void setMaskFillColor (ome::xml::model::primitives::Color fillColor, index_type ROIIndex, index_type shapeIndex)
 Set the FillColor property of Mask. More...
 
void setMaskFillRule (ome::xml::model::enums::FillRule fillRule, index_type ROIIndex, index_type shapeIndex)
 Set the FillRule property of Mask. More...
 
void setMaskFontFamily (ome::xml::model::enums::FontFamily fontFamily, index_type ROIIndex, index_type shapeIndex)
 Set the FontFamily property of Mask. More...
 
void setMaskFontSize (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > fontSize, index_type ROIIndex, index_type shapeIndex)
 Set the FontSize property of Mask. More...
 
void setMaskFontStyle (ome::xml::model::enums::FontStyle fontStyle, index_type ROIIndex, index_type shapeIndex)
 Set the FontStyle property of Mask. More...
 
void setMaskHeight (double height, index_type ROIIndex, index_type shapeIndex)
 Set the Height property of Mask. More...
 
void setMaskID (const std::string &id, index_type ROIIndex, index_type shapeIndex)
 Set the ID property of Mask. More...
 
void setMaskLocked (bool locked, index_type ROIIndex, index_type shapeIndex)
 Set the Locked property of Mask. More...
 
void setMaskStrokeColor (ome::xml::model::primitives::Color strokeColor, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeColor property of Mask. More...
 
void setMaskStrokeDashArray (const std::string &strokeDashArray, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeDashArray property of Mask. More...
 
void setMaskStrokeWidth (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > strokeWidth, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeWidth property of Mask. More...
 
void setMaskText (const std::string &text, index_type ROIIndex, index_type shapeIndex)
 Set the Text property of Mask. More...
 
void setMaskTheC (ome::xml::model::primitives::NonNegativeInteger theC, index_type ROIIndex, index_type shapeIndex)
 Set the TheC property of Mask. More...
 
void setMaskTheT (ome::xml::model::primitives::NonNegativeInteger theT, index_type ROIIndex, index_type shapeIndex)
 Set the TheT property of Mask. More...
 
void setMaskTheZ (ome::xml::model::primitives::NonNegativeInteger theZ, index_type ROIIndex, index_type shapeIndex)
 Set the TheZ property of Mask. More...
 
void setMaskTransform (const ::ome::xml::model::AffineTransform &transform, index_type ROIIndex, index_type shapeIndex)
 Set the Transform property of Mask. More...
 
void setMaskWidth (double width, index_type ROIIndex, index_type shapeIndex)
 Set the Width property of Mask. More...
 
void setMaskX (double x, index_type ROIIndex, index_type shapeIndex)
 Set the X property of Mask. More...
 
void setMaskY (double y, index_type ROIIndex, index_type shapeIndex)
 Set the Y property of Mask. More...
 
void setMicrobeamManipulationDescription (const std::string &description, index_type experimentIndex, index_type microbeamManipulationIndex)
 Set the Description property of MicrobeamManipulation. More...
 
void setMicrobeamManipulationExperimenterRef (const std::string &experimenter, index_type experimentIndex, index_type microbeamManipulationIndex)
 Set the ExperimenterRef property of MicrobeamManipulation. More...
 
void setMicrobeamManipulationID (const std::string &id, index_type experimentIndex, index_type microbeamManipulationIndex)
 Set the ID property of MicrobeamManipulation. More...
 
void setMicrobeamManipulationROIRef (const std::string &roi, index_type experimentIndex, index_type microbeamManipulationIndex, index_type ROIRefIndex)
 Set the ROIRef property of MicrobeamManipulation. More...
 
void setMicrobeamManipulationType (ome::xml::model::enums::MicrobeamManipulationType type, index_type experimentIndex, index_type microbeamManipulationIndex)
 Set the Type property of MicrobeamManipulation. More...
 
void setMicroscopeLotNumber (const std::string &lotNumber, index_type instrumentIndex)
 Set the LotNumber property of Microscope. More...
 
void setMicroscopeManufacturer (const std::string &manufacturer, index_type instrumentIndex)
 Set the Manufacturer property of Microscope. More...
 
void setMicroscopeModel (const std::string &model, index_type instrumentIndex)
 Set the Model property of Microscope. More...
 
void setMicroscopeSerialNumber (const std::string &serialNumber, index_type instrumentIndex)
 Set the SerialNumber property of Microscope. More...
 
void setMicroscopeType (ome::xml::model::enums::MicroscopeType type, index_type instrumentIndex)
 Set the Type property of Microscope. More...
 
void setObjectiveAnnotationRef (const std::string &annotation, index_type instrumentIndex, index_type objectiveIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Objective. More...
 
void setObjectiveCalibratedMagnification (double calibratedMagnification, index_type instrumentIndex, index_type objectiveIndex)
 Set the CalibratedMagnification property of Objective. More...
 
void setObjectiveCorrection (ome::xml::model::enums::Correction correction, index_type instrumentIndex, index_type objectiveIndex)
 Set the Correction property of Objective. More...
 
void setObjectiveID (const std::string &id, index_type instrumentIndex, index_type objectiveIndex)
 Set the ID property of Objective. More...
 
void setObjectiveImmersion (ome::xml::model::enums::Immersion immersion, index_type instrumentIndex, index_type objectiveIndex)
 Set the Immersion property of Objective. More...
 
void setObjectiveIris (bool iris, index_type instrumentIndex, index_type objectiveIndex)
 Set the Iris property of Objective. More...
 
void setObjectiveLensNA (double lensNA, index_type instrumentIndex, index_type objectiveIndex)
 Set the LensNA property of Objective. More...
 
void setObjectiveLotNumber (const std::string &lotNumber, index_type instrumentIndex, index_type objectiveIndex)
 Set the LotNumber property of Objective. More...
 
void setObjectiveManufacturer (const std::string &manufacturer, index_type instrumentIndex, index_type objectiveIndex)
 Set the Manufacturer property of Objective. More...
 
void setObjectiveModel (const std::string &model, index_type instrumentIndex, index_type objectiveIndex)
 Set the Model property of Objective. More...
 
void setObjectiveNominalMagnification (double nominalMagnification, index_type instrumentIndex, index_type objectiveIndex)
 Set the NominalMagnification property of Objective. More...
 
void setObjectiveSerialNumber (const std::string &serialNumber, index_type instrumentIndex, index_type objectiveIndex)
 Set the SerialNumber property of Objective. More...
 
void setObjectiveWorkingDistance (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > workingDistance, index_type instrumentIndex, index_type objectiveIndex)
 Set the WorkingDistance property of Objective. More...
 
void setObjectiveSettingsCorrectionCollar (double correctionCollar, index_type imageIndex)
 Set the CorrectionCollar property of ObjectiveSettings. More...
 
void setObjectiveSettingsID (const std::string &id, index_type imageIndex)
 Set the ID property of ObjectiveSettings. More...
 
void setObjectiveSettingsMedium (ome::xml::model::enums::Medium medium, index_type imageIndex)
 Set the Medium property of ObjectiveSettings. More...
 
void setObjectiveSettingsRefractiveIndex (double refractiveIndex, index_type imageIndex)
 Set the RefractiveIndex property of ObjectiveSettings. More...
 
void setPixelsBigEndian (bool bigEndian, index_type imageIndex)
 Set the BigEndian property of Pixels. More...
 
void setPixelsDimensionOrder (ome::xml::model::enums::DimensionOrder dimensionOrder, index_type imageIndex)
 Set the DimensionOrder property of Pixels. More...
 
void setPixelsID (const std::string &id, index_type imageIndex)
 Set the ID property of Pixels. More...
 
void setPixelsInterleaved (bool interleaved, index_type imageIndex)
 Set the Interleaved property of Pixels. More...
 
void setPixelsPhysicalSizeX (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > physicalSizeX, index_type imageIndex)
 Set the PhysicalSizeX property of Pixels. More...
 
void setPixelsPhysicalSizeY (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > physicalSizeY, index_type imageIndex)
 Set the PhysicalSizeY property of Pixels. More...
 
void setPixelsPhysicalSizeZ (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > physicalSizeZ, index_type imageIndex)
 Set the PhysicalSizeZ property of Pixels. More...
 
void setPixelsSignificantBits (ome::xml::model::primitives::PositiveInteger significantBits, index_type imageIndex)
 Set the SignificantBits property of Pixels. More...
 
void setPixelsSizeC (ome::xml::model::primitives::PositiveInteger sizeC, index_type imageIndex)
 Set the SizeC property of Pixels. More...
 
void setPixelsSizeT (ome::xml::model::primitives::PositiveInteger sizeT, index_type imageIndex)
 Set the SizeT property of Pixels. More...
 
void setPixelsSizeX (ome::xml::model::primitives::PositiveInteger sizeX, index_type imageIndex)
 Set the SizeX property of Pixels. More...
 
void setPixelsSizeY (ome::xml::model::primitives::PositiveInteger sizeY, index_type imageIndex)
 Set the SizeY property of Pixels. More...
 
void setPixelsSizeZ (ome::xml::model::primitives::PositiveInteger sizeZ, index_type imageIndex)
 Set the SizeZ property of Pixels. More...
 
void setPixelsTimeIncrement (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > timeIncrement, index_type imageIndex)
 Set the TimeIncrement property of Pixels. More...
 
void setPixelsType (ome::xml::model::enums::PixelType type, index_type imageIndex)
 Set the Type property of Pixels. More...
 
void setPlaneAnnotationRef (const std::string &annotation, index_type imageIndex, index_type planeIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Plane. More...
 
void setPlaneDeltaT (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > deltaT, index_type imageIndex, index_type planeIndex)
 Set the DeltaT property of Plane. More...
 
void setPlaneExposureTime (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > exposureTime, index_type imageIndex, index_type planeIndex)
 Set the ExposureTime property of Plane. More...
 
void setPlaneHashSHA1 (const std::string &hashSHA1, index_type imageIndex, index_type planeIndex)
 Set the HashSHA1 property of Plane. More...
 
void setPlanePositionX (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > positionX, index_type imageIndex, index_type planeIndex)
 Set the PositionX property of Plane. More...
 
void setPlanePositionY (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > positionY, index_type imageIndex, index_type planeIndex)
 Set the PositionY property of Plane. More...
 
void setPlanePositionZ (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > positionZ, index_type imageIndex, index_type planeIndex)
 Set the PositionZ property of Plane. More...
 
void setPlaneTheC (ome::xml::model::primitives::NonNegativeInteger theC, index_type imageIndex, index_type planeIndex)
 Set the TheC property of Plane. More...
 
void setPlaneTheT (ome::xml::model::primitives::NonNegativeInteger theT, index_type imageIndex, index_type planeIndex)
 Set the TheT property of Plane. More...
 
void setPlaneTheZ (ome::xml::model::primitives::NonNegativeInteger theZ, index_type imageIndex, index_type planeIndex)
 Set the TheZ property of Plane. More...
 
void setPlateAnnotationRef (const std::string &annotation, index_type plateIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Plate. More...
 
void setPlateColumnNamingConvention (ome::xml::model::enums::NamingConvention columnNamingConvention, index_type plateIndex)
 Set the ColumnNamingConvention property of Plate. More...
 
void setPlateColumns (ome::xml::model::primitives::PositiveInteger columns, index_type plateIndex)
 Set the Columns property of Plate. More...
 
void setPlateDescription (const std::string &description, index_type plateIndex)
 Set the Description property of Plate. More...
 
void setPlateExternalIdentifier (const std::string &externalIdentifier, index_type plateIndex)
 Set the ExternalIdentifier property of Plate. More...
 
void setPlateFieldIndex (ome::xml::model::primitives::NonNegativeInteger fieldIndex, index_type plateIndex)
 Set the FieldIndex property of Plate. More...
 
void setPlateID (const std::string &id, index_type plateIndex)
 Set the ID property of Plate. More...
 
void setPlateName (const std::string &name, index_type plateIndex)
 Set the Name property of Plate. More...
 
void setPlateRowNamingConvention (ome::xml::model::enums::NamingConvention rowNamingConvention, index_type plateIndex)
 Set the RowNamingConvention property of Plate. More...
 
void setPlateRows (ome::xml::model::primitives::PositiveInteger rows, index_type plateIndex)
 Set the Rows property of Plate. More...
 
void setPlateStatus (const std::string &status, index_type plateIndex)
 Set the Status property of Plate. More...
 
void setPlateWellOriginX (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > wellOriginX, index_type plateIndex)
 Set the WellOriginX property of Plate. More...
 
void setPlateWellOriginY (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > wellOriginY, index_type plateIndex)
 Set the WellOriginY property of Plate. More...
 
void setPlateAcquisitionAnnotationRef (const std::string &annotation, index_type plateIndex, index_type plateAcquisitionIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of PlateAcquisition. More...
 
void setPlateAcquisitionDescription (const std::string &description, index_type plateIndex, index_type plateAcquisitionIndex)
 Set the Description property of PlateAcquisition. More...
 
void setPlateAcquisitionEndTime (ome::xml::model::primitives::Timestamp endTime, index_type plateIndex, index_type plateAcquisitionIndex)
 Set the EndTime property of PlateAcquisition. More...
 
void setPlateAcquisitionID (const std::string &id, index_type plateIndex, index_type plateAcquisitionIndex)
 Set the ID property of PlateAcquisition. More...
 
void setPlateAcquisitionMaximumFieldCount (ome::xml::model::primitives::PositiveInteger maximumFieldCount, index_type plateIndex, index_type plateAcquisitionIndex)
 Set the MaximumFieldCount property of PlateAcquisition. More...
 
void setPlateAcquisitionName (const std::string &name, index_type plateIndex, index_type plateAcquisitionIndex)
 Set the Name property of PlateAcquisition. More...
 
void setPlateAcquisitionStartTime (ome::xml::model::primitives::Timestamp startTime, index_type plateIndex, index_type plateAcquisitionIndex)
 Set the StartTime property of PlateAcquisition. More...
 
void setPlateAcquisitionWellSampleRef (const std::string &wellSample, index_type plateIndex, index_type plateAcquisitionIndex, index_type wellSampleRefIndex)
 Set the WellSampleRef property of PlateAcquisition. More...
 
void setPointAnnotationRef (const std::string &annotation, index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Point. More...
 
void setPointFillColor (ome::xml::model::primitives::Color fillColor, index_type ROIIndex, index_type shapeIndex)
 Set the FillColor property of Point. More...
 
void setPointFillRule (ome::xml::model::enums::FillRule fillRule, index_type ROIIndex, index_type shapeIndex)
 Set the FillRule property of Point. More...
 
void setPointFontFamily (ome::xml::model::enums::FontFamily fontFamily, index_type ROIIndex, index_type shapeIndex)
 Set the FontFamily property of Point. More...
 
void setPointFontSize (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > fontSize, index_type ROIIndex, index_type shapeIndex)
 Set the FontSize property of Point. More...
 
void setPointFontStyle (ome::xml::model::enums::FontStyle fontStyle, index_type ROIIndex, index_type shapeIndex)
 Set the FontStyle property of Point. More...
 
void setPointID (const std::string &id, index_type ROIIndex, index_type shapeIndex)
 Set the ID property of Point. More...
 
void setPointLocked (bool locked, index_type ROIIndex, index_type shapeIndex)
 Set the Locked property of Point. More...
 
void setPointStrokeColor (ome::xml::model::primitives::Color strokeColor, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeColor property of Point. More...
 
void setPointStrokeDashArray (const std::string &strokeDashArray, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeDashArray property of Point. More...
 
void setPointStrokeWidth (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > strokeWidth, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeWidth property of Point. More...
 
void setPointText (const std::string &text, index_type ROIIndex, index_type shapeIndex)
 Set the Text property of Point. More...
 
void setPointTheC (ome::xml::model::primitives::NonNegativeInteger theC, index_type ROIIndex, index_type shapeIndex)
 Set the TheC property of Point. More...
 
void setPointTheT (ome::xml::model::primitives::NonNegativeInteger theT, index_type ROIIndex, index_type shapeIndex)
 Set the TheT property of Point. More...
 
void setPointTheZ (ome::xml::model::primitives::NonNegativeInteger theZ, index_type ROIIndex, index_type shapeIndex)
 Set the TheZ property of Point. More...
 
void setPointTransform (const ::ome::xml::model::AffineTransform &transform, index_type ROIIndex, index_type shapeIndex)
 Set the Transform property of Point. More...
 
void setPointX (double x, index_type ROIIndex, index_type shapeIndex)
 Set the X property of Point. More...
 
void setPointY (double y, index_type ROIIndex, index_type shapeIndex)
 Set the Y property of Point. More...
 
void setPolygonAnnotationRef (const std::string &annotation, index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Polygon. More...
 
void setPolygonFillColor (ome::xml::model::primitives::Color fillColor, index_type ROIIndex, index_type shapeIndex)
 Set the FillColor property of Polygon. More...
 
void setPolygonFillRule (ome::xml::model::enums::FillRule fillRule, index_type ROIIndex, index_type shapeIndex)
 Set the FillRule property of Polygon. More...
 
void setPolygonFontFamily (ome::xml::model::enums::FontFamily fontFamily, index_type ROIIndex, index_type shapeIndex)
 Set the FontFamily property of Polygon. More...
 
void setPolygonFontSize (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > fontSize, index_type ROIIndex, index_type shapeIndex)
 Set the FontSize property of Polygon. More...
 
void setPolygonFontStyle (ome::xml::model::enums::FontStyle fontStyle, index_type ROIIndex, index_type shapeIndex)
 Set the FontStyle property of Polygon. More...
 
void setPolygonID (const std::string &id, index_type ROIIndex, index_type shapeIndex)
 Set the ID property of Polygon. More...
 
void setPolygonLocked (bool locked, index_type ROIIndex, index_type shapeIndex)
 Set the Locked property of Polygon. More...
 
void setPolygonPoints (const std::string &points, index_type ROIIndex, index_type shapeIndex)
 Set the Points property of Polygon. More...
 
void setPolygonStrokeColor (ome::xml::model::primitives::Color strokeColor, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeColor property of Polygon. More...
 
void setPolygonStrokeDashArray (const std::string &strokeDashArray, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeDashArray property of Polygon. More...
 
void setPolygonStrokeWidth (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > strokeWidth, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeWidth property of Polygon. More...
 
void setPolygonText (const std::string &text, index_type ROIIndex, index_type shapeIndex)
 Set the Text property of Polygon. More...
 
void setPolygonTheC (ome::xml::model::primitives::NonNegativeInteger theC, index_type ROIIndex, index_type shapeIndex)
 Set the TheC property of Polygon. More...
 
void setPolygonTheT (ome::xml::model::primitives::NonNegativeInteger theT, index_type ROIIndex, index_type shapeIndex)
 Set the TheT property of Polygon. More...
 
void setPolygonTheZ (ome::xml::model::primitives::NonNegativeInteger theZ, index_type ROIIndex, index_type shapeIndex)
 Set the TheZ property of Polygon. More...
 
void setPolygonTransform (const ::ome::xml::model::AffineTransform &transform, index_type ROIIndex, index_type shapeIndex)
 Set the Transform property of Polygon. More...
 
void setPolylineAnnotationRef (const std::string &annotation, index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Polyline. More...
 
void setPolylineFillColor (ome::xml::model::primitives::Color fillColor, index_type ROIIndex, index_type shapeIndex)
 Set the FillColor property of Polyline. More...
 
void setPolylineFillRule (ome::xml::model::enums::FillRule fillRule, index_type ROIIndex, index_type shapeIndex)
 Set the FillRule property of Polyline. More...
 
void setPolylineFontFamily (ome::xml::model::enums::FontFamily fontFamily, index_type ROIIndex, index_type shapeIndex)
 Set the FontFamily property of Polyline. More...
 
void setPolylineFontSize (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > fontSize, index_type ROIIndex, index_type shapeIndex)
 Set the FontSize property of Polyline. More...
 
void setPolylineFontStyle (ome::xml::model::enums::FontStyle fontStyle, index_type ROIIndex, index_type shapeIndex)
 Set the FontStyle property of Polyline. More...
 
void setPolylineID (const std::string &id, index_type ROIIndex, index_type shapeIndex)
 Set the ID property of Polyline. More...
 
void setPolylineLocked (bool locked, index_type ROIIndex, index_type shapeIndex)
 Set the Locked property of Polyline. More...
 
void setPolylineMarkerEnd (ome::xml::model::enums::Marker markerEnd, index_type ROIIndex, index_type shapeIndex)
 Set the MarkerEnd property of Polyline. More...
 
void setPolylineMarkerStart (ome::xml::model::enums::Marker markerStart, index_type ROIIndex, index_type shapeIndex)
 Set the MarkerStart property of Polyline. More...
 
void setPolylinePoints (const std::string &points, index_type ROIIndex, index_type shapeIndex)
 Set the Points property of Polyline. More...
 
void setPolylineStrokeColor (ome::xml::model::primitives::Color strokeColor, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeColor property of Polyline. More...
 
void setPolylineStrokeDashArray (const std::string &strokeDashArray, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeDashArray property of Polyline. More...
 
void setPolylineStrokeWidth (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > strokeWidth, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeWidth property of Polyline. More...
 
void setPolylineText (const std::string &text, index_type ROIIndex, index_type shapeIndex)
 Set the Text property of Polyline. More...
 
void setPolylineTheC (ome::xml::model::primitives::NonNegativeInteger theC, index_type ROIIndex, index_type shapeIndex)
 Set the TheC property of Polyline. More...
 
void setPolylineTheT (ome::xml::model::primitives::NonNegativeInteger theT, index_type ROIIndex, index_type shapeIndex)
 Set the TheT property of Polyline. More...
 
void setPolylineTheZ (ome::xml::model::primitives::NonNegativeInteger theZ, index_type ROIIndex, index_type shapeIndex)
 Set the TheZ property of Polyline. More...
 
void setPolylineTransform (const ::ome::xml::model::AffineTransform &transform, index_type ROIIndex, index_type shapeIndex)
 Set the Transform property of Polyline. More...
 
void setProjectAnnotationRef (const std::string &annotation, index_type projectIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Project. More...
 
void setProjectDatasetRef (const std::string &dataset, index_type projectIndex, index_type datasetRefIndex)
 Set the DatasetRef property of Project. More...
 
void setProjectDescription (const std::string &description, index_type projectIndex)
 Set the Description property of Project. More...
 
void setProjectExperimenterGroupRef (const std::string &experimenterGroup, index_type projectIndex)
 Set the ExperimenterGroupRef property of Project. More...
 
void setProjectExperimenterRef (const std::string &experimenter, index_type projectIndex)
 Set the ExperimenterRef property of Project. More...
 
void setProjectID (const std::string &id, index_type projectIndex)
 Set the ID property of Project. More...
 
void setProjectName (const std::string &name, index_type projectIndex)
 Set the Name property of Project. More...
 
void setROIAnnotationRef (const std::string &annotation, index_type ROIIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of ROI. More...
 
void setROIDescription (const std::string &description, index_type ROIIndex)
 Set the Description property of ROI. More...
 
void setROIID (const std::string &id, index_type ROIIndex)
 Set the ID property of ROI. More...
 
void setROIName (const std::string &name, index_type ROIIndex)
 Set the Name property of ROI. More...
 
void setReagentAnnotationRef (const std::string &annotation, index_type screenIndex, index_type reagentIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Reagent. More...
 
void setReagentDescription (const std::string &description, index_type screenIndex, index_type reagentIndex)
 Set the Description property of Reagent. More...
 
void setReagentID (const std::string &id, index_type screenIndex, index_type reagentIndex)
 Set the ID property of Reagent. More...
 
void setReagentName (const std::string &name, index_type screenIndex, index_type reagentIndex)
 Set the Name property of Reagent. More...
 
void setReagentReagentIdentifier (const std::string &reagentIdentifier, index_type screenIndex, index_type reagentIndex)
 Set the ReagentIdentifier property of Reagent. More...
 
void setRectangleAnnotationRef (const std::string &annotation, index_type ROIIndex, index_type shapeIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Rectangle. More...
 
void setRectangleFillColor (ome::xml::model::primitives::Color fillColor, index_type ROIIndex, index_type shapeIndex)
 Set the FillColor property of Rectangle. More...
 
void setRectangleFillRule (ome::xml::model::enums::FillRule fillRule, index_type ROIIndex, index_type shapeIndex)
 Set the FillRule property of Rectangle. More...
 
void setRectangleFontFamily (ome::xml::model::enums::FontFamily fontFamily, index_type ROIIndex, index_type shapeIndex)
 Set the FontFamily property of Rectangle. More...
 
void setRectangleFontSize (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > fontSize, index_type ROIIndex, index_type shapeIndex)
 Set the FontSize property of Rectangle. More...
 
void setRectangleFontStyle (ome::xml::model::enums::FontStyle fontStyle, index_type ROIIndex, index_type shapeIndex)
 Set the FontStyle property of Rectangle. More...
 
void setRectangleHeight (double height, index_type ROIIndex, index_type shapeIndex)
 Set the Height property of Rectangle. More...
 
void setRectangleID (const std::string &id, index_type ROIIndex, index_type shapeIndex)
 Set the ID property of Rectangle. More...
 
void setRectangleLocked (bool locked, index_type ROIIndex, index_type shapeIndex)
 Set the Locked property of Rectangle. More...
 
void setRectangleStrokeColor (ome::xml::model::primitives::Color strokeColor, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeColor property of Rectangle. More...
 
void setRectangleStrokeDashArray (const std::string &strokeDashArray, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeDashArray property of Rectangle. More...
 
void setRectangleStrokeWidth (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > strokeWidth, index_type ROIIndex, index_type shapeIndex)
 Set the StrokeWidth property of Rectangle. More...
 
void setRectangleText (const std::string &text, index_type ROIIndex, index_type shapeIndex)
 Set the Text property of Rectangle. More...
 
void setRectangleTheC (ome::xml::model::primitives::NonNegativeInteger theC, index_type ROIIndex, index_type shapeIndex)
 Set the TheC property of Rectangle. More...
 
void setRectangleTheT (ome::xml::model::primitives::NonNegativeInteger theT, index_type ROIIndex, index_type shapeIndex)
 Set the TheT property of Rectangle. More...
 
void setRectangleTheZ (ome::xml::model::primitives::NonNegativeInteger theZ, index_type ROIIndex, index_type shapeIndex)
 Set the TheZ property of Rectangle. More...
 
void setRectangleTransform (const ::ome::xml::model::AffineTransform &transform, index_type ROIIndex, index_type shapeIndex)
 Set the Transform property of Rectangle. More...
 
void setRectangleWidth (double width, index_type ROIIndex, index_type shapeIndex)
 Set the Width property of Rectangle. More...
 
void setRectangleX (double x, index_type ROIIndex, index_type shapeIndex)
 Set the X property of Rectangle. More...
 
void setRectangleY (double y, index_type ROIIndex, index_type shapeIndex)
 Set the Y property of Rectangle. More...
 
void setRightsRightsHeld (const std::string &rightsHeld)
 Set the RightsHeld property of Rights. More...
 
void setRightsRightsHolder (const std::string &rightsHolder)
 Set the RightsHolder property of Rights. More...
 
void setScreenAnnotationRef (const std::string &annotation, index_type screenIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Screen. More...
 
void setScreenDescription (const std::string &description, index_type screenIndex)
 Set the Description property of Screen. More...
 
void setScreenID (const std::string &id, index_type screenIndex)
 Set the ID property of Screen. More...
 
void setScreenName (const std::string &name, index_type screenIndex)
 Set the Name property of Screen. More...
 
void setScreenPlateRef (const std::string &plate, index_type screenIndex, index_type plateRefIndex)
 Set the PlateRef property of Screen. More...
 
void setScreenProtocolDescription (const std::string &protocolDescription, index_type screenIndex)
 Set the ProtocolDescription property of Screen. More...
 
void setScreenProtocolIdentifier (const std::string &protocolIdentifier, index_type screenIndex)
 Set the ProtocolIdentifier property of Screen. More...
 
void setScreenReagentSetDescription (const std::string &reagentSetDescription, index_type screenIndex)
 Set the ReagentSetDescription property of Screen. More...
 
void setScreenReagentSetIdentifier (const std::string &reagentSetIdentifier, index_type screenIndex)
 Set the ReagentSetIdentifier property of Screen. More...
 
void setScreenType (const std::string &type, index_type screenIndex)
 Set the Type property of Screen. More...
 
void setStageLabelName (const std::string &name, index_type imageIndex)
 Set the Name property of StageLabel. More...
 
void setStageLabelX (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > x, index_type imageIndex)
 Set the X property of StageLabel. More...
 
void setStageLabelY (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > y, index_type imageIndex)
 Set the Y property of StageLabel. More...
 
void setStageLabelZ (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > z, index_type imageIndex)
 Set the Z property of StageLabel. More...
 
void setTagAnnotationAnnotationRef (const std::string &annotation, index_type tagAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of TagAnnotation. More...
 
void setTagAnnotationAnnotator (const std::string &annotator, index_type tagAnnotationIndex)
 Set the Annotator property of TagAnnotation. More...
 
void setTagAnnotationDescription (const std::string &description, index_type tagAnnotationIndex)
 Set the Description property of TagAnnotation. More...
 
void setTagAnnotationID (const std::string &id, index_type tagAnnotationIndex)
 Set the ID property of TagAnnotation. More...
 
void setTagAnnotationNamespace (const std::string &namespace_, index_type tagAnnotationIndex)
 Set the Namespace property of TagAnnotation. More...
 
void setTagAnnotationValue (const std::string &value, index_type tagAnnotationIndex)
 Set the Value property of TagAnnotation. More...
 
void setTermAnnotationAnnotationRef (const std::string &annotation, index_type termAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of TermAnnotation. More...
 
void setTermAnnotationAnnotator (const std::string &annotator, index_type termAnnotationIndex)
 Set the Annotator property of TermAnnotation. More...
 
void setTermAnnotationDescription (const std::string &description, index_type termAnnotationIndex)
 Set the Description property of TermAnnotation. More...
 
void setTermAnnotationID (const std::string &id, index_type termAnnotationIndex)
 Set the ID property of TermAnnotation. More...
 
void setTermAnnotationNamespace (const std::string &namespace_, index_type termAnnotationIndex)
 Set the Namespace property of TermAnnotation. More...
 
void setTermAnnotationValue (const std::string &value, index_type termAnnotationIndex)
 Set the Value property of TermAnnotation. More...
 
void setTiffDataFirstC (ome::xml::model::primitives::NonNegativeInteger firstC, index_type imageIndex, index_type tiffDataIndex)
 Set the FirstC property of TiffData. More...
 
void setTiffDataFirstT (ome::xml::model::primitives::NonNegativeInteger firstT, index_type imageIndex, index_type tiffDataIndex)
 Set the FirstT property of TiffData. More...
 
void setTiffDataFirstZ (ome::xml::model::primitives::NonNegativeInteger firstZ, index_type imageIndex, index_type tiffDataIndex)
 Set the FirstZ property of TiffData. More...
 
void setTiffDataIFD (ome::xml::model::primitives::NonNegativeInteger ifd, index_type imageIndex, index_type tiffDataIndex)
 Set the IFD property of TiffData. More...
 
void setTiffDataPlaneCount (ome::xml::model::primitives::NonNegativeInteger planeCount, index_type imageIndex, index_type tiffDataIndex)
 Set the PlaneCount property of TiffData. More...
 
void setTimestampAnnotationAnnotationRef (const std::string &annotation, index_type timestampAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of TimestampAnnotation. More...
 
void setTimestampAnnotationAnnotator (const std::string &annotator, index_type timestampAnnotationIndex)
 Set the Annotator property of TimestampAnnotation. More...
 
void setTimestampAnnotationDescription (const std::string &description, index_type timestampAnnotationIndex)
 Set the Description property of TimestampAnnotation. More...
 
void setTimestampAnnotationID (const std::string &id, index_type timestampAnnotationIndex)
 Set the ID property of TimestampAnnotation. More...
 
void setTimestampAnnotationNamespace (const std::string &namespace_, index_type timestampAnnotationIndex)
 Set the Namespace property of TimestampAnnotation. More...
 
void setTimestampAnnotationValue (ome::xml::model::primitives::Timestamp value, index_type timestampAnnotationIndex)
 Set the Value property of TimestampAnnotation. More...
 
void setTransmittanceRangeCutIn (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > cutIn, index_type instrumentIndex, index_type filterIndex)
 Set the CutIn property of TransmittanceRange. More...
 
void setTransmittanceRangeCutInTolerance (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeFloat > cutInTolerance, index_type instrumentIndex, index_type filterIndex)
 Set the CutInTolerance property of TransmittanceRange. More...
 
void setTransmittanceRangeCutOut (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > cutOut, index_type instrumentIndex, index_type filterIndex)
 Set the CutOut property of TransmittanceRange. More...
 
void setTransmittanceRangeCutOutTolerance (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeFloat > cutOutTolerance, index_type instrumentIndex, index_type filterIndex)
 Set the CutOutTolerance property of TransmittanceRange. More...
 
void setTransmittanceRangeTransmittance (ome::xml::model::primitives::PercentFraction transmittance, index_type instrumentIndex, index_type filterIndex)
 Set the Transmittance property of TransmittanceRange. More...
 
void setUUIDFileName (const std::string &fileName, index_type imageIndex, index_type tiffDataIndex)
 Set the FileName property of UUID. More...
 
void setWellAnnotationRef (const std::string &annotation, index_type plateIndex, index_type wellIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of Well. More...
 
void setWellColor (ome::xml::model::primitives::Color color, index_type plateIndex, index_type wellIndex)
 Set the Color property of Well. More...
 
void setWellColumn (ome::xml::model::primitives::NonNegativeInteger column, index_type plateIndex, index_type wellIndex)
 Set the Column property of Well. More...
 
void setWellExternalDescription (const std::string &externalDescription, index_type plateIndex, index_type wellIndex)
 Set the ExternalDescription property of Well. More...
 
void setWellExternalIdentifier (const std::string &externalIdentifier, index_type plateIndex, index_type wellIndex)
 Set the ExternalIdentifier property of Well. More...
 
void setWellID (const std::string &id, index_type plateIndex, index_type wellIndex)
 Set the ID property of Well. More...
 
void setWellReagentRef (const std::string &reagent, index_type plateIndex, index_type wellIndex)
 Set the ReagentRef property of Well. More...
 
void setWellRow (ome::xml::model::primitives::NonNegativeInteger row, index_type plateIndex, index_type wellIndex)
 Set the Row property of Well. More...
 
void setWellType (const std::string &type, index_type plateIndex, index_type wellIndex)
 Set the Type property of Well. More...
 
void setWellSampleID (const std::string &id, index_type plateIndex, index_type wellIndex, index_type wellSampleIndex)
 Set the ID property of WellSample. More...
 
void setWellSampleImageRef (const std::string &image, index_type plateIndex, index_type wellIndex, index_type wellSampleIndex)
 Set the ImageRef property of WellSample. More...
 
void setWellSampleIndex (ome::xml::model::primitives::NonNegativeInteger index, index_type plateIndex, index_type wellIndex, index_type wellSampleIndex)
 Set the Index property of WellSample. More...
 
void setWellSamplePositionX (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > positionX, index_type plateIndex, index_type wellIndex, index_type wellSampleIndex)
 Set the PositionX property of WellSample. More...
 
void setWellSamplePositionY (ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > positionY, index_type plateIndex, index_type wellIndex, index_type wellSampleIndex)
 Set the PositionY property of WellSample. More...
 
void setWellSampleTimepoint (ome::xml::model::primitives::Timestamp timepoint, index_type plateIndex, index_type wellIndex, index_type wellSampleIndex)
 Set the Timepoint property of WellSample. More...
 
void setXMLAnnotationAnnotationRef (const std::string &annotation, index_type XMLAnnotationIndex, index_type annotationRefIndex)
 Set the AnnotationRef property of XMLAnnotation. More...
 
void setXMLAnnotationAnnotator (const std::string &annotator, index_type XMLAnnotationIndex)
 Set the Annotator property of XMLAnnotation. More...
 
void setXMLAnnotationDescription (const std::string &description, index_type XMLAnnotationIndex)
 Set the Description property of XMLAnnotation. More...
 
void setXMLAnnotationID (const std::string &id, index_type XMLAnnotationIndex)
 Set the ID property of XMLAnnotation. More...
 
void setXMLAnnotationNamespace (const std::string &namespace_, index_type XMLAnnotationIndex)
 Set the Namespace property of XMLAnnotation. More...
 
void setXMLAnnotationValue (const std::string &value, index_type XMLAnnotationIndex)
 Set the Value property of XMLAnnotation. More...
 
- Public Member Functions inherited from ome::xml::meta::MetadataRetrieve
virtual ~MetadataRetrieve ()
 Destructor.
 
- Public Member Functions inherited from ome::xml::meta::MetadataStore
virtual ~MetadataStore ()
 Destructor.
 

Private Attributes

std::shared_ptr< OMEXMLMetadataRootroot
 OME-XML root node.
 
std::shared_ptr< MetadataRootgenericRoot
 Generic root node.
 
std::shared_ptr<::ome::xml::model::OMEModelmodel
 OME-XML model.
 

Additional Inherited Members

- Protected Member Functions inherited from ome::xml::meta::MetadataRetrieve
 MetadataRetrieve ()
 Constructor.
 
- Protected Member Functions inherited from ome::xml::meta::MetadataStore
 MetadataStore ()
 Constructor.
 

Detailed Description

A metadata store implementation for constructing and manipulating OME-XML DOMs for the current version of the OME-XML schema.

Member Function Documentation

◆ createRoot()

void ome::xml::meta::OMEXMLMetadata::createRoot ( )
virtual

Create root node.

The action taken here is specific to the concrete metadata implementation.

Implements ome::xml::meta::MetadataStore.

References setRoot().

Referenced by OMEXMLMetadata().

+ Here is the caller graph for this function:

◆ dumpXML()

std::string ome::xml::meta::OMEXMLMetadata::dumpXML ( )

Dump metadata as OME-XML string.

The OME XML model objects contained within this metadata store are serialised to an XML text representation.

Returns
a string containing OME-XML.

References ome::common::xml::dom::Node::appendChild(), ome::common::xml::dom::Document::createComment(), ome::common::xml::dom::createEmptyDocument(), ome::common::xml::dom::Document::getDocumentElement(), resolveReferences(), root, and ome::common::xml::dom::writeDocument().

◆ getArcAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getArcAnnotationRef ( index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Arc.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getArcID()

const std::string & ome::xml::meta::OMEXMLMetadata::getArcID ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the ID property of Arc.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getArcLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getArcLotNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the LotNumber property of Arc.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getArcManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getArcManufacturer ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Manufacturer property of Arc.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getArcModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getArcModel ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Model property of Arc.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getArcPower()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > ome::xml::meta::OMEXMLMetadata::getArcPower ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Power property of Arc.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Power property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getArcSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getArcSerialNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the SerialNumber property of Arc.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getArcType()

ome::xml::model::enums::ArcType ome::xml::meta::OMEXMLMetadata::getArcType ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Type property of Arc.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBinaryFileBinData()

const std::vector< uint8_t > & ome::xml::meta::OMEXMLMetadata::getBinaryFileBinData ( index_type  fileAnnotationIndex) const
virtual

Get the Base64Binary property of BinData.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the Base64Binary property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBinaryFileBinDataBigEndian()

bool ome::xml::meta::OMEXMLMetadata::getBinaryFileBinDataBigEndian ( index_type  fileAnnotationIndex) const
virtual

Get the BigEndian property of BinData.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the BigEndian property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBinaryFileBinDataCompression()

ome::xml::model::enums::Compression ome::xml::meta::OMEXMLMetadata::getBinaryFileBinDataCompression ( index_type  fileAnnotationIndex) const
virtual

Get the Compression property of BinData.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the Compression property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBinaryFileBinDataLength()

ome::xml::model::primitives::NonNegativeLong ome::xml::meta::OMEXMLMetadata::getBinaryFileBinDataLength ( index_type  fileAnnotationIndex) const
virtual

Get the Length property of BinData.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the Length property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBinaryFileFileName()

const std::string & ome::xml::meta::OMEXMLMetadata::getBinaryFileFileName ( index_type  fileAnnotationIndex) const
virtual

Get the FileName property of BinaryFile.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the FileName property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBinaryFileMIMEType()

const std::string & ome::xml::meta::OMEXMLMetadata::getBinaryFileMIMEType ( index_type  fileAnnotationIndex) const
virtual

Get the MIMEType property of BinaryFile.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the MIMEType property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBinaryFileSize()

ome::xml::model::primitives::NonNegativeLong ome::xml::meta::OMEXMLMetadata::getBinaryFileSize ( index_type  fileAnnotationIndex) const
virtual

Get the Size property of BinaryFile.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the Size property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBinaryOnlyMetadataFile()

const std::string & ome::xml::meta::OMEXMLMetadata::getBinaryOnlyMetadataFile ( ) const
virtual

Get the MetadataFile property of BinaryOnly.

Returns
the MetadataFile property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBinaryOnlyUUID()

const std::string & ome::xml::meta::OMEXMLMetadata::getBinaryOnlyUUID ( ) const
virtual

Get the UUID property of BinaryOnly.

Returns
the UUID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBooleanAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getBooleanAnnotationAnnotationCount ( index_type  booleanAnnotationIndex) const
virtual

Get the number of links to a BooleanAnnotation.

This method returns the number of references to the specified BooleanAnnotation held by all model objects.

Parameters
booleanAnnotationIndexthe BooleanAnnotation index.
Returns
the number of BooleanAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBooleanAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getBooleanAnnotationAnnotationRef ( index_type  booleanAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of BooleanAnnotation.

Parameters
booleanAnnotationIndexthe BooleanAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBooleanAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getBooleanAnnotationAnnotator ( index_type  booleanAnnotationIndex) const
virtual

Get the Annotator property of BooleanAnnotation.

Parameters
booleanAnnotationIndexthe BooleanAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBooleanAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getBooleanAnnotationCount ( ) const
virtual

Get the number of BooleanAnnotation elements.

Returns
the number of BooleanAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBooleanAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getBooleanAnnotationDescription ( index_type  booleanAnnotationIndex) const
virtual

Get the Description property of BooleanAnnotation.

Parameters
booleanAnnotationIndexthe BooleanAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBooleanAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getBooleanAnnotationID ( index_type  booleanAnnotationIndex) const
virtual

Get the ID property of BooleanAnnotation.

Parameters
booleanAnnotationIndexthe BooleanAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBooleanAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getBooleanAnnotationNamespace ( index_type  booleanAnnotationIndex) const
virtual

Get the Namespace property of BooleanAnnotation.

Parameters
booleanAnnotationIndexthe BooleanAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getBooleanAnnotationValue()

bool ome::xml::meta::OMEXMLMetadata::getBooleanAnnotationValue ( index_type  booleanAnnotationIndex) const
virtual

Get the Value property of BooleanAnnotation.

Parameters
booleanAnnotationIndexthe BooleanAnnotation index.
Returns
the Value property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelAcquisitionMode()

ome::xml::model::enums::AcquisitionMode ome::xml::meta::OMEXMLMetadata::getChannelAcquisitionMode ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the AcquisitionMode property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the AcquisitionMode property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getChannelAnnotationRef ( index_type  imageIndex,
index_type  channelIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getChannelAnnotationRefCount ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the number of AnnotationRef elements in Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getChannelColor ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Color property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Color property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelContrastMethod()

ome::xml::model::enums::ContrastMethod ome::xml::meta::OMEXMLMetadata::getChannelContrastMethod ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the ContrastMethod property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the ContrastMethod property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getChannelCount ( index_type  imageIndex) const
virtual

Get the number of Channel elements.

Parameters
imageIndexthe Image index.
Returns
the number of Channel elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelEmissionWavelength()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getChannelEmissionWavelength ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the EmissionWavelength property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the EmissionWavelength property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelExcitationWavelength()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getChannelExcitationWavelength ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the ExcitationWavelength property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the ExcitationWavelength property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelFilterSetRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getChannelFilterSetRef ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the FilterSetRef property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the FilterSetRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelFluor()

const std::string & ome::xml::meta::OMEXMLMetadata::getChannelFluor ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Fluor property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Fluor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelID()

const std::string & ome::xml::meta::OMEXMLMetadata::getChannelID ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the ID property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelIlluminationType()

ome::xml::model::enums::IlluminationType ome::xml::meta::OMEXMLMetadata::getChannelIlluminationType ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the IlluminationType property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the IlluminationType property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelLightSourceSettingsAttenuation()

ome::xml::model::primitives::PercentFraction ome::xml::meta::OMEXMLMetadata::getChannelLightSourceSettingsAttenuation ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Attenuation property of LightSourceSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Attenuation property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelLightSourceSettingsID()

const std::string & ome::xml::meta::OMEXMLMetadata::getChannelLightSourceSettingsID ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the ID property of LightSourceSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelLightSourceSettingsWavelength()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getChannelLightSourceSettingsWavelength ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Wavelength property of LightSourceSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Wavelength property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelName()

const std::string & ome::xml::meta::OMEXMLMetadata::getChannelName ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Name property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelNDFilter()

double ome::xml::meta::OMEXMLMetadata::getChannelNDFilter ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the NDFilter property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the NDFilter property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelPinholeSize()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getChannelPinholeSize ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the PinholeSize property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the PinholeSize property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelPockelCellSetting()

int32_t ome::xml::meta::OMEXMLMetadata::getChannelPockelCellSetting ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the PockelCellSetting property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the PockelCellSetting property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getChannelSamplesPerPixel()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getChannelSamplesPerPixel ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the SamplesPerPixel property of Channel.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the SamplesPerPixel property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getCommentAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getCommentAnnotationAnnotationCount ( index_type  commentAnnotationIndex) const
virtual

Get the number of links to a CommentAnnotation.

This method returns the number of references to the specified CommentAnnotation held by all model objects.

Parameters
commentAnnotationIndexthe CommentAnnotation index.
Returns
the number of CommentAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getCommentAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getCommentAnnotationAnnotationRef ( index_type  commentAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of CommentAnnotation.

Parameters
commentAnnotationIndexthe CommentAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getCommentAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getCommentAnnotationAnnotator ( index_type  commentAnnotationIndex) const
virtual

Get the Annotator property of CommentAnnotation.

Parameters
commentAnnotationIndexthe CommentAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getCommentAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getCommentAnnotationCount ( ) const
virtual

Get the number of CommentAnnotation elements.

Returns
the number of CommentAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getCommentAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getCommentAnnotationDescription ( index_type  commentAnnotationIndex) const
virtual

Get the Description property of CommentAnnotation.

Parameters
commentAnnotationIndexthe CommentAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getCommentAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getCommentAnnotationID ( index_type  commentAnnotationIndex) const
virtual

Get the ID property of CommentAnnotation.

Parameters
commentAnnotationIndexthe CommentAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getCommentAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getCommentAnnotationNamespace ( index_type  commentAnnotationIndex) const
virtual

Get the Namespace property of CommentAnnotation.

Parameters
commentAnnotationIndexthe CommentAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getCommentAnnotationValue()

const std::string & ome::xml::meta::OMEXMLMetadata::getCommentAnnotationValue ( index_type  commentAnnotationIndex) const
virtual

Get the Value property of CommentAnnotation.

Parameters
commentAnnotationIndexthe CommentAnnotation index.
Returns
the Value property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getDatasetAnnotationRef ( index_type  datasetIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Dataset.

Parameters
datasetIndexthe Dataset index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDatasetAnnotationRefCount ( index_type  datasetIndex) const
virtual

Get the number of AnnotationRef elements in Dataset.

Parameters
datasetIndexthe Dataset index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDatasetCount ( ) const
virtual

Get the number of Dataset elements.

Returns
the number of Dataset elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getDatasetDescription ( index_type  datasetIndex) const
virtual

Get the Description property of Dataset.

Parameters
datasetIndexthe Dataset index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetExperimenterGroupRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getDatasetExperimenterGroupRef ( index_type  datasetIndex) const
virtual

Get the ExperimenterGroupRef property of Dataset.

Parameters
datasetIndexthe Dataset index.
Returns
the ExperimenterGroupRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetExperimenterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getDatasetExperimenterRef ( index_type  datasetIndex) const
virtual

Get the ExperimenterRef property of Dataset.

Parameters
datasetIndexthe Dataset index.
Returns
the ExperimenterRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetID()

const std::string & ome::xml::meta::OMEXMLMetadata::getDatasetID ( index_type  datasetIndex) const
virtual

Get the ID property of Dataset.

Parameters
datasetIndexthe Dataset index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetImageRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getDatasetImageRef ( index_type  datasetIndex,
index_type  imageRefIndex 
) const
virtual

Get the ImageRef property of Dataset.

Parameters
datasetIndexthe Dataset index.
imageRefIndexImageRef index.
Returns
the ImageRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetImageRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDatasetImageRefCount ( index_type  datasetIndex) const
virtual

Get the number of ImageRef elements in Dataset.

Parameters
datasetIndexthe Dataset index.
Returns
the number of ImageRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetName()

const std::string & ome::xml::meta::OMEXMLMetadata::getDatasetName ( index_type  datasetIndex) const
virtual

Get the Name property of Dataset.

Parameters
datasetIndexthe Dataset index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDatasetRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDatasetRefCount ( index_type  projectIndex) const
virtual

Get the number of DatasetRef elements.

Parameters
projectIndexthe Project index.
Returns
the number of DatasetRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorAmplificationGain()

double ome::xml::meta::OMEXMLMetadata::getDetectorAmplificationGain ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the AmplificationGain property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the AmplificationGain property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getDetectorAnnotationRef ( index_type  instrumentIndex,
index_type  detectorIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDetectorAnnotationRefCount ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the number of AnnotationRef elements in Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDetectorCount ( index_type  instrumentIndex) const
virtual

Get the number of Detector elements.

Parameters
instrumentIndexthe Instrument index.
Returns
the number of Detector elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorGain()

double ome::xml::meta::OMEXMLMetadata::getDetectorGain ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the Gain property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the Gain property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorID()

const std::string & ome::xml::meta::OMEXMLMetadata::getDetectorID ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the ID property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getDetectorLotNumber ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the LotNumber property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getDetectorManufacturer ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the Manufacturer property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getDetectorModel ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the Model property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorOffset()

double ome::xml::meta::OMEXMLMetadata::getDetectorOffset ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the Offset property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the Offset property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getDetectorSerialNumber ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the SerialNumber property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorSettingsBinning()

ome::xml::model::enums::Binning ome::xml::meta::OMEXMLMetadata::getDetectorSettingsBinning ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Binning property of DetectorSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Binning property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorSettingsGain()

double ome::xml::meta::OMEXMLMetadata::getDetectorSettingsGain ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Gain property of DetectorSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Gain property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorSettingsID()

const std::string & ome::xml::meta::OMEXMLMetadata::getDetectorSettingsID ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the ID property of DetectorSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorSettingsIntegration()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getDetectorSettingsIntegration ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Integration property of DetectorSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Integration property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorSettingsOffset()

double ome::xml::meta::OMEXMLMetadata::getDetectorSettingsOffset ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Offset property of DetectorSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Offset property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorSettingsReadOutRate()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > ome::xml::meta::OMEXMLMetadata::getDetectorSettingsReadOutRate ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the ReadOutRate property of DetectorSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the ReadOutRate property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorSettingsVoltage()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential > ome::xml::meta::OMEXMLMetadata::getDetectorSettingsVoltage ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Voltage property of DetectorSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Voltage property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorSettingsZoom()

double ome::xml::meta::OMEXMLMetadata::getDetectorSettingsZoom ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the Zoom property of DetectorSettings.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the Zoom property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorType()

ome::xml::model::enums::DetectorType ome::xml::meta::OMEXMLMetadata::getDetectorType ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the Type property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorVoltage()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential > ome::xml::meta::OMEXMLMetadata::getDetectorVoltage ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the Voltage property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the Voltage property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDetectorZoom()

double ome::xml::meta::OMEXMLMetadata::getDetectorZoom ( index_type  instrumentIndex,
index_type  detectorIndex 
) const
virtual

Get the Zoom property of Detector.

Parameters
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
Returns
the Zoom property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDichroicAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getDichroicAnnotationRef ( index_type  instrumentIndex,
index_type  dichroicIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Dichroic.

Parameters
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDichroicAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDichroicAnnotationRefCount ( index_type  instrumentIndex,
index_type  dichroicIndex 
) const
virtual

Get the number of AnnotationRef elements in Dichroic.

Parameters
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDichroicCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDichroicCount ( index_type  instrumentIndex) const
virtual

Get the number of Dichroic elements.

Parameters
instrumentIndexthe Instrument index.
Returns
the number of Dichroic elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDichroicID()

const std::string & ome::xml::meta::OMEXMLMetadata::getDichroicID ( index_type  instrumentIndex,
index_type  dichroicIndex 
) const
virtual

Get the ID property of Dichroic.

Parameters
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDichroicLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getDichroicLotNumber ( index_type  instrumentIndex,
index_type  dichroicIndex 
) const
virtual

Get the LotNumber property of Dichroic.

Parameters
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDichroicManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getDichroicManufacturer ( index_type  instrumentIndex,
index_type  dichroicIndex 
) const
virtual

Get the Manufacturer property of Dichroic.

Parameters
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDichroicModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getDichroicModel ( index_type  instrumentIndex,
index_type  dichroicIndex 
) const
virtual

Get the Model property of Dichroic.

Parameters
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDichroicSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getDichroicSerialNumber ( index_type  instrumentIndex,
index_type  dichroicIndex 
) const
virtual

Get the SerialNumber property of Dichroic.

Parameters
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDoubleAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDoubleAnnotationAnnotationCount ( index_type  doubleAnnotationIndex) const
virtual

Get the number of links to a DoubleAnnotation.

This method returns the number of references to the specified DoubleAnnotation held by all model objects.

Parameters
doubleAnnotationIndexthe DoubleAnnotation index.
Returns
the number of DoubleAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDoubleAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getDoubleAnnotationAnnotationRef ( index_type  doubleAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of DoubleAnnotation.

Parameters
doubleAnnotationIndexthe DoubleAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDoubleAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getDoubleAnnotationAnnotator ( index_type  doubleAnnotationIndex) const
virtual

Get the Annotator property of DoubleAnnotation.

Parameters
doubleAnnotationIndexthe DoubleAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDoubleAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getDoubleAnnotationCount ( ) const
virtual

Get the number of DoubleAnnotation elements.

Returns
the number of DoubleAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDoubleAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getDoubleAnnotationDescription ( index_type  doubleAnnotationIndex) const
virtual

Get the Description property of DoubleAnnotation.

Parameters
doubleAnnotationIndexthe DoubleAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDoubleAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getDoubleAnnotationID ( index_type  doubleAnnotationIndex) const
virtual

Get the ID property of DoubleAnnotation.

Parameters
doubleAnnotationIndexthe DoubleAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDoubleAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getDoubleAnnotationNamespace ( index_type  doubleAnnotationIndex) const
virtual

Get the Namespace property of DoubleAnnotation.

Parameters
doubleAnnotationIndexthe DoubleAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getDoubleAnnotationValue()

double ome::xml::meta::OMEXMLMetadata::getDoubleAnnotationValue ( index_type  doubleAnnotationIndex) const
virtual

Get the Value property of DoubleAnnotation.

Parameters
doubleAnnotationIndexthe DoubleAnnotation index.
Returns
the Value property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getEllipseAnnotationRef ( index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseFillColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getEllipseFillColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillColor property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseFillRule()

ome::xml::model::enums::FillRule ome::xml::meta::OMEXMLMetadata::getEllipseFillRule ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillRule property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillRule property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseFontFamily()

ome::xml::model::enums::FontFamily ome::xml::meta::OMEXMLMetadata::getEllipseFontFamily ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontFamily property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontFamily property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseFontSize()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > ome::xml::meta::OMEXMLMetadata::getEllipseFontSize ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontSize property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontSize property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseFontStyle()

ome::xml::model::enums::FontStyle ome::xml::meta::OMEXMLMetadata::getEllipseFontStyle ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontStyle property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontStyle property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseID()

const std::string & ome::xml::meta::OMEXMLMetadata::getEllipseID ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the ID property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseLocked()

bool ome::xml::meta::OMEXMLMetadata::getEllipseLocked ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Locked property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Locked property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseRadiusX()

double ome::xml::meta::OMEXMLMetadata::getEllipseRadiusX ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the RadiusX property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the RadiusX property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseRadiusY()

double ome::xml::meta::OMEXMLMetadata::getEllipseRadiusY ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the RadiusY property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the RadiusY property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseStrokeColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getEllipseStrokeColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeColor property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseStrokeDashArray()

const std::string & ome::xml::meta::OMEXMLMetadata::getEllipseStrokeDashArray ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeDashArray property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeDashArray property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseStrokeWidth()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getEllipseStrokeWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeWidth property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeWidth property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseText()

const std::string & ome::xml::meta::OMEXMLMetadata::getEllipseText ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Text property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Text property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseTheC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getEllipseTheC ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheC property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseTheT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getEllipseTheT ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheT property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseTheZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getEllipseTheZ ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheZ property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseTransform()

const ::ome::xml::model::AffineTransform & ome::xml::meta::OMEXMLMetadata::getEllipseTransform ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Transform property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Transform property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseX()

double ome::xml::meta::OMEXMLMetadata::getEllipseX ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the X property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the X property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getEllipseY()

double ome::xml::meta::OMEXMLMetadata::getEllipseY ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Y property of Ellipse.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Y property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimentCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getExperimentCount ( ) const
virtual

Get the number of Experiment elements.

Returns
the number of Experiment elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimentDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimentDescription ( index_type  experimentIndex) const
virtual

Get the Description property of Experiment.

Parameters
experimentIndexthe Experiment index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterAnnotationRef ( index_type  experimenterIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Experimenter.

Parameters
experimenterIndexthe Experimenter index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getExperimenterAnnotationRefCount ( index_type  experimenterIndex) const
virtual

Get the number of AnnotationRef elements in Experimenter.

Parameters
experimenterIndexthe Experimenter index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getExperimenterCount ( ) const
virtual

Get the number of Experimenter elements.

Returns
the number of Experimenter elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterEmail()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterEmail ( index_type  experimenterIndex) const
virtual

Get the Email property of Experimenter.

Parameters
experimenterIndexthe Experimenter index.
Returns
the Email property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterFirstName()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterFirstName ( index_type  experimenterIndex) const
virtual

Get the FirstName property of Experimenter.

Parameters
experimenterIndexthe Experimenter index.
Returns
the FirstName property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterGroupAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterGroupAnnotationRef ( index_type  experimenterGroupIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of ExperimenterGroup.

Parameters
experimenterGroupIndexthe ExperimenterGroup index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterGroupAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getExperimenterGroupAnnotationRefCount ( index_type  experimenterGroupIndex) const
virtual

Get the number of AnnotationRef elements in ExperimenterGroup.

Parameters
experimenterGroupIndexthe ExperimenterGroup index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterGroupCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getExperimenterGroupCount ( ) const
virtual

Get the number of ExperimenterGroup elements.

Returns
the number of ExperimenterGroup elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterGroupDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterGroupDescription ( index_type  experimenterGroupIndex) const
virtual

Get the Description property of ExperimenterGroup.

Parameters
experimenterGroupIndexthe ExperimenterGroup index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterGroupExperimenterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterGroupExperimenterRef ( index_type  experimenterGroupIndex,
index_type  experimenterRefIndex 
) const
virtual

Get the ExperimenterRef property of ExperimenterGroup.

Parameters
experimenterGroupIndexthe ExperimenterGroup index.
experimenterRefIndexExperimenterRef index.
Returns
the ExperimenterRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterGroupExperimenterRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getExperimenterGroupExperimenterRefCount ( index_type  experimenterGroupIndex) const
virtual

Get the number of ExperimenterRef elements in ExperimenterGroup.

Parameters
experimenterGroupIndexthe ExperimenterGroup index.
Returns
the number of ExperimenterRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterGroupID()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterGroupID ( index_type  experimenterGroupIndex) const
virtual

Get the ID property of ExperimenterGroup.

Parameters
experimenterGroupIndexthe ExperimenterGroup index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterGroupLeader()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterGroupLeader ( index_type  experimenterGroupIndex,
index_type  leaderIndex 
) const
virtual

Get the Leader property of ExperimenterGroup.

Parameters
experimenterGroupIndexthe ExperimenterGroup index.
leaderIndexLeader index.
Returns
the Leader property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterGroupName()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterGroupName ( index_type  experimenterGroupIndex) const
virtual

Get the Name property of ExperimenterGroup.

Parameters
experimenterGroupIndexthe ExperimenterGroup index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterID()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterID ( index_type  experimenterIndex) const
virtual

Get the ID property of Experimenter.

Parameters
experimenterIndexthe Experimenter index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterInstitution()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterInstitution ( index_type  experimenterIndex) const
virtual

Get the Institution property of Experimenter.

Parameters
experimenterIndexthe Experimenter index.
Returns
the Institution property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterLastName()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterLastName ( index_type  experimenterIndex) const
virtual

Get the LastName property of Experimenter.

Parameters
experimenterIndexthe Experimenter index.
Returns
the LastName property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterMiddleName()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterMiddleName ( index_type  experimenterIndex) const
virtual

Get the MiddleName property of Experimenter.

Parameters
experimenterIndexthe Experimenter index.
Returns
the MiddleName property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimenterUserName()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimenterUserName ( index_type  experimenterIndex) const
virtual

Get the UserName property of Experimenter.

Parameters
experimenterIndexthe Experimenter index.
Returns
the UserName property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimentExperimenterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimentExperimenterRef ( index_type  experimentIndex) const
virtual

Get the ExperimenterRef property of Experiment.

Parameters
experimentIndexthe Experiment index.
Returns
the ExperimenterRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimentID()

const std::string & ome::xml::meta::OMEXMLMetadata::getExperimentID ( index_type  experimentIndex) const
virtual

Get the ID property of Experiment.

Parameters
experimentIndexthe Experiment index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getExperimentType()

ome::xml::model::enums::ExperimentType ome::xml::meta::OMEXMLMetadata::getExperimentType ( index_type  experimentIndex) const
virtual

Get the Type property of Experiment.

Parameters
experimentIndexthe Experiment index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilamentAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilamentAnnotationRef ( index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Filament.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilamentID()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilamentID ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the ID property of Filament.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilamentLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilamentLotNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the LotNumber property of Filament.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilamentManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilamentManufacturer ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Manufacturer property of Filament.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilamentModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilamentModel ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Model property of Filament.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilamentPower()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > ome::xml::meta::OMEXMLMetadata::getFilamentPower ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Power property of Filament.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Power property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilamentSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilamentSerialNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the SerialNumber property of Filament.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilamentType()

ome::xml::model::enums::FilamentType ome::xml::meta::OMEXMLMetadata::getFilamentType ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Type property of Filament.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFileAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFileAnnotationAnnotationCount ( index_type  fileAnnotationIndex) const
virtual

Get the number of links to a FileAnnotation.

This method returns the number of references to the specified FileAnnotation held by all model objects.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the number of FileAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFileAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFileAnnotationAnnotationRef ( index_type  fileAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of FileAnnotation.

Parameters
fileAnnotationIndexthe FileAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFileAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getFileAnnotationAnnotator ( index_type  fileAnnotationIndex) const
virtual

Get the Annotator property of FileAnnotation.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFileAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFileAnnotationCount ( ) const
virtual

Get the number of FileAnnotation elements.

Returns
the number of FileAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFileAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getFileAnnotationDescription ( index_type  fileAnnotationIndex) const
virtual

Get the Description property of FileAnnotation.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFileAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getFileAnnotationID ( index_type  fileAnnotationIndex) const
virtual

Get the ID property of FileAnnotation.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFileAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getFileAnnotationNamespace ( index_type  fileAnnotationIndex) const
virtual

Get the Namespace property of FileAnnotation.

Parameters
fileAnnotationIndexthe FileAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterAnnotationRef ( index_type  instrumentIndex,
index_type  filterIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Filter.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFilterAnnotationRefCount ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the number of AnnotationRef elements in Filter.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFilterCount ( index_type  instrumentIndex) const
virtual

Get the number of Filter elements.

Parameters
instrumentIndexthe Instrument index.
Returns
the number of Filter elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterFilterWheel()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterFilterWheel ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the FilterWheel property of Filter.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the FilterWheel property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterID()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterID ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the ID property of Filter.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterLotNumber ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the LotNumber property of Filter.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterManufacturer ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the Manufacturer property of Filter.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterModel ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the Model property of Filter.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterSerialNumber ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the SerialNumber property of Filter.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFilterSetCount ( index_type  instrumentIndex) const
virtual

Get the number of FilterSet elements.

Parameters
instrumentIndexthe Instrument index.
Returns
the number of FilterSet elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetDichroicRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterSetDichroicRef ( index_type  instrumentIndex,
index_type  filterSetIndex 
) const
virtual

Get the DichroicRef property of FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
Returns
the DichroicRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetEmissionFilterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterSetEmissionFilterRef ( index_type  instrumentIndex,
index_type  filterSetIndex,
index_type  emissionFilterRefIndex 
) const
virtual

Get the EmissionFilterRef property of FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
emissionFilterRefIndexEmissionFilterRef index.
Returns
the EmissionFilterRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetEmissionFilterRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFilterSetEmissionFilterRefCount ( index_type  instrumentIndex,
index_type  filterSetIndex 
) const
virtual

Get the number of EmissionFilterRef elements in FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
Returns
the number of EmissionFilterRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetExcitationFilterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterSetExcitationFilterRef ( index_type  instrumentIndex,
index_type  filterSetIndex,
index_type  excitationFilterRefIndex 
) const
virtual

Get the ExcitationFilterRef property of FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
excitationFilterRefIndexExcitationFilterRef index.
Returns
the ExcitationFilterRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetExcitationFilterRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFilterSetExcitationFilterRefCount ( index_type  instrumentIndex,
index_type  filterSetIndex 
) const
virtual

Get the number of ExcitationFilterRef elements in FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
Returns
the number of ExcitationFilterRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetID()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterSetID ( index_type  instrumentIndex,
index_type  filterSetIndex 
) const
virtual

Get the ID property of FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterSetLotNumber ( index_type  instrumentIndex,
index_type  filterSetIndex 
) const
virtual

Get the LotNumber property of FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterSetManufacturer ( index_type  instrumentIndex,
index_type  filterSetIndex 
) const
virtual

Get the Manufacturer property of FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterSetModel ( index_type  instrumentIndex,
index_type  filterSetIndex 
) const
virtual

Get the Model property of FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterSetSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getFilterSetSerialNumber ( index_type  instrumentIndex,
index_type  filterSetIndex 
) const
virtual

Get the SerialNumber property of FilterSet.

Parameters
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFilterType()

ome::xml::model::enums::FilterType ome::xml::meta::OMEXMLMetadata::getFilterType ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the Type property of Filter.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFolderAnnotationRef ( index_type  folderIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Folder.

Parameters
folderIndexthe Folder index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFolderAnnotationRefCount ( index_type  folderIndex) const
virtual

Get the number of AnnotationRef elements in Folder.

Parameters
folderIndexthe Folder index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFolderCount ( ) const
virtual

Get the number of Folder elements.

Returns
the number of Folder elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getFolderDescription ( index_type  folderIndex) const
virtual

Get the Description property of Folder.

Parameters
folderIndexthe Folder index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderFolderRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFolderFolderRef ( index_type  folderIndex,
index_type  folderRefIndex 
) const
virtual

Get the FolderRef property of Folder.

Parameters
folderIndexthe Folder index.
folderRefIndexFolderRef index.
Returns
the FolderRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderID()

const std::string & ome::xml::meta::OMEXMLMetadata::getFolderID ( index_type  folderIndex) const
virtual

Get the ID property of Folder.

Parameters
folderIndexthe Folder index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderImageRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFolderImageRef ( index_type  folderIndex,
index_type  imageRefIndex 
) const
virtual

Get the ImageRef property of Folder.

Parameters
folderIndexthe Folder index.
imageRefIndexImageRef index.
Returns
the ImageRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderImageRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFolderImageRefCount ( index_type  folderIndex) const
virtual

Get the number of ImageRef elements in Folder.

Parameters
folderIndexthe Folder index.
Returns
the number of ImageRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderName()

const std::string & ome::xml::meta::OMEXMLMetadata::getFolderName ( index_type  folderIndex) const
virtual

Get the Name property of Folder.

Parameters
folderIndexthe Folder index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFolderRefCount ( index_type  folderIndex) const
virtual

Get the number of FolderRef elements.

Parameters
folderIndexthe Folder index.
Returns
the number of FolderRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderROIRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getFolderROIRef ( index_type  folderIndex,
index_type  ROIRefIndex 
) const
virtual

Get the ROIRef property of Folder.

Parameters
folderIndexthe Folder index.
ROIRefIndexROIRef index.
Returns
the ROIRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getFolderROIRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getFolderROIRefCount ( index_type  folderIndex) const
virtual

Get the number of ROIRef elements in Folder.

Parameters
folderIndexthe Folder index.
Returns
the number of ROIRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getGenericExcitationSourceAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getGenericExcitationSourceAnnotationRef ( index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of GenericExcitationSource.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getGenericExcitationSourceID()

const std::string & ome::xml::meta::OMEXMLMetadata::getGenericExcitationSourceID ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the ID property of GenericExcitationSource.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getGenericExcitationSourceLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getGenericExcitationSourceLotNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the LotNumber property of GenericExcitationSource.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getGenericExcitationSourceManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getGenericExcitationSourceManufacturer ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Manufacturer property of GenericExcitationSource.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getGenericExcitationSourceMap()

const ome::xml::model::primitives::OrderedMultimap & ome::xml::meta::OMEXMLMetadata::getGenericExcitationSourceMap ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the map value of GenericExcitationSource.

Parameters
instrumentIndexthe LightSource index.
lightSourceIndexthe LightSource index.
Returns
the map value.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getGenericExcitationSourceModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getGenericExcitationSourceModel ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Model property of GenericExcitationSource.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getGenericExcitationSourcePower()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > ome::xml::meta::OMEXMLMetadata::getGenericExcitationSourcePower ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Power property of GenericExcitationSource.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Power property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getGenericExcitationSourceSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getGenericExcitationSourceSerialNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the SerialNumber property of GenericExcitationSource.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageAcquisitionDate()

ome::xml::model::primitives::Timestamp ome::xml::meta::OMEXMLMetadata::getImageAcquisitionDate ( index_type  imageIndex) const
virtual

Get the AcquisitionDate property of Image.

Parameters
imageIndexthe Image index.
Returns
the AcquisitionDate property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageAnnotationRef ( index_type  imageIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Image.

Parameters
imageIndexthe Image index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getImageAnnotationRefCount ( index_type  imageIndex) const
virtual

Get the number of AnnotationRef elements in Image.

Parameters
imageIndexthe Image index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getImageCount ( ) const
virtual

Get the number of Image elements.

Returns
the number of Image elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageDescription ( index_type  imageIndex) const
virtual

Get the Description property of Image.

Parameters
imageIndexthe Image index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageExperimenterGroupRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageExperimenterGroupRef ( index_type  imageIndex) const
virtual

Get the ExperimenterGroupRef property of Image.

Parameters
imageIndexthe Image index.
Returns
the ExperimenterGroupRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageExperimenterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageExperimenterRef ( index_type  imageIndex) const
virtual

Get the ExperimenterRef property of Image.

Parameters
imageIndexthe Image index.
Returns
the ExperimenterRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageExperimentRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageExperimentRef ( index_type  imageIndex) const
virtual

Get the ExperimentRef property of Image.

Parameters
imageIndexthe Image index.
Returns
the ExperimentRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageID()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageID ( index_type  imageIndex) const
virtual

Get the ID property of Image.

Parameters
imageIndexthe Image index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageInstrumentRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageInstrumentRef ( index_type  imageIndex) const
virtual

Get the InstrumentRef property of Image.

Parameters
imageIndexthe Image index.
Returns
the InstrumentRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageMicrobeamManipulationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageMicrobeamManipulationRef ( index_type  imageIndex,
index_type  microbeamManipulationRefIndex 
) const
virtual

Get the MicrobeamManipulationRef property of Image.

Parameters
imageIndexthe Image index.
microbeamManipulationRefIndexMicrobeamManipulationRef index.
Returns
the MicrobeamManipulationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageName()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageName ( index_type  imageIndex) const
virtual

Get the Name property of Image.

Parameters
imageIndexthe Image index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageROIRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getImageROIRef ( index_type  imageIndex,
index_type  ROIRefIndex 
) const
virtual

Get the ROIRef property of Image.

Parameters
imageIndexthe Image index.
ROIRefIndexROIRef index.
Returns
the ROIRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImageROIRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getImageROIRefCount ( index_type  imageIndex) const
virtual

Get the number of ROIRef elements in Image.

Parameters
imageIndexthe Image index.
Returns
the number of ROIRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImagingEnvironmentAirPressure()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure > ome::xml::meta::OMEXMLMetadata::getImagingEnvironmentAirPressure ( index_type  imageIndex) const
virtual

Get the AirPressure property of ImagingEnvironment.

Parameters
imageIndexthe Image index.
Returns
the AirPressure property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImagingEnvironmentCO2Percent()

ome::xml::model::primitives::PercentFraction ome::xml::meta::OMEXMLMetadata::getImagingEnvironmentCO2Percent ( index_type  imageIndex) const
virtual

Get the CO2Percent property of ImagingEnvironment.

Parameters
imageIndexthe Image index.
Returns
the CO2Percent property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImagingEnvironmentHumidity()

ome::xml::model::primitives::PercentFraction ome::xml::meta::OMEXMLMetadata::getImagingEnvironmentHumidity ( index_type  imageIndex) const
virtual

Get the Humidity property of ImagingEnvironment.

Parameters
imageIndexthe Image index.
Returns
the Humidity property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImagingEnvironmentMap()

const ome::xml::model::primitives::OrderedMultimap & ome::xml::meta::OMEXMLMetadata::getImagingEnvironmentMap ( index_type  imageIndex) const
virtual

Get the map value of ImagingEnvironment.

Parameters
imageIndexthe Image index.
Returns
the map value.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getImagingEnvironmentTemperature()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature > ome::xml::meta::OMEXMLMetadata::getImagingEnvironmentTemperature ( index_type  imageIndex) const
virtual

Get the Temperature property of ImagingEnvironment.

Parameters
imageIndexthe Image index.
Returns
the Temperature property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getInstrumentAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getInstrumentAnnotationRef ( index_type  instrumentIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Instrument.

Parameters
instrumentIndexthe Instrument index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getInstrumentAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getInstrumentAnnotationRefCount ( index_type  instrumentIndex) const
virtual

Get the number of AnnotationRef elements in Instrument.

Parameters
instrumentIndexthe Instrument index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getInstrumentCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getInstrumentCount ( ) const
virtual

Get the number of Instrument elements.

Returns
the number of Instrument elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getInstrumentID()

const std::string & ome::xml::meta::OMEXMLMetadata::getInstrumentID ( index_type  instrumentIndex) const
virtual

Get the ID property of Instrument.

Parameters
instrumentIndexthe Instrument index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getLabelAnnotationRef ( index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelFillColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getLabelFillColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillColor property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelFillRule()

ome::xml::model::enums::FillRule ome::xml::meta::OMEXMLMetadata::getLabelFillRule ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillRule property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillRule property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelFontFamily()

ome::xml::model::enums::FontFamily ome::xml::meta::OMEXMLMetadata::getLabelFontFamily ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontFamily property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontFamily property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelFontSize()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > ome::xml::meta::OMEXMLMetadata::getLabelFontSize ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontSize property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontSize property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelFontStyle()

ome::xml::model::enums::FontStyle ome::xml::meta::OMEXMLMetadata::getLabelFontStyle ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontStyle property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontStyle property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelID()

const std::string & ome::xml::meta::OMEXMLMetadata::getLabelID ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the ID property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelLocked()

bool ome::xml::meta::OMEXMLMetadata::getLabelLocked ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Locked property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Locked property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelStrokeColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getLabelStrokeColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeColor property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelStrokeDashArray()

const std::string & ome::xml::meta::OMEXMLMetadata::getLabelStrokeDashArray ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeDashArray property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeDashArray property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelStrokeWidth()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getLabelStrokeWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeWidth property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeWidth property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelText()

const std::string & ome::xml::meta::OMEXMLMetadata::getLabelText ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Text property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Text property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelTheC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getLabelTheC ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheC property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelTheT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getLabelTheT ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheT property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelTheZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getLabelTheZ ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheZ property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelTransform()

const ::ome::xml::model::AffineTransform & ome::xml::meta::OMEXMLMetadata::getLabelTransform ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Transform property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Transform property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelX()

double ome::xml::meta::OMEXMLMetadata::getLabelX ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the X property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the X property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLabelY()

double ome::xml::meta::OMEXMLMetadata::getLabelY ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Y property of Label.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Y property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getLaserAnnotationRef ( index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserFrequencyMultiplication()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getLaserFrequencyMultiplication ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the FrequencyMultiplication property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the FrequencyMultiplication property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserID()

const std::string & ome::xml::meta::OMEXMLMetadata::getLaserID ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the ID property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserLaserMedium()

ome::xml::model::enums::LaserMedium ome::xml::meta::OMEXMLMetadata::getLaserLaserMedium ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the LaserMedium property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the LaserMedium property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getLaserLotNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the LotNumber property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getLaserManufacturer ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Manufacturer property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getLaserModel ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Model property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserPockelCell()

bool ome::xml::meta::OMEXMLMetadata::getLaserPockelCell ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the PockelCell property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the PockelCell property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserPower()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > ome::xml::meta::OMEXMLMetadata::getLaserPower ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Power property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Power property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserPulse()

ome::xml::model::enums::Pulse ome::xml::meta::OMEXMLMetadata::getLaserPulse ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Pulse property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Pulse property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserPump()

const std::string & ome::xml::meta::OMEXMLMetadata::getLaserPump ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Pump property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Pump property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserRepetitionRate()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > ome::xml::meta::OMEXMLMetadata::getLaserRepetitionRate ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the RepetitionRate property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the RepetitionRate property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getLaserSerialNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the SerialNumber property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserTuneable()

bool ome::xml::meta::OMEXMLMetadata::getLaserTuneable ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Tuneable property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Tuneable property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserType()

ome::xml::model::enums::LaserType ome::xml::meta::OMEXMLMetadata::getLaserType ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Type property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLaserWavelength()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getLaserWavelength ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Wavelength property of Laser.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Wavelength property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLeaderCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getLeaderCount ( index_type  experimenterGroupIndex) const
virtual

Get the number of Leader elements.

Parameters
experimenterGroupIndexthe ExperimenterGroup index.
Returns
the number of Leader elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightEmittingDiodeAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightEmittingDiodeAnnotationRef ( index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of LightEmittingDiode.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightEmittingDiodeID()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightEmittingDiodeID ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the ID property of LightEmittingDiode.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightEmittingDiodeLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightEmittingDiodeLotNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the LotNumber property of LightEmittingDiode.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightEmittingDiodeManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightEmittingDiodeManufacturer ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Manufacturer property of LightEmittingDiode.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightEmittingDiodeModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightEmittingDiodeModel ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Model property of LightEmittingDiode.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightEmittingDiodePower()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > ome::xml::meta::OMEXMLMetadata::getLightEmittingDiodePower ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the Power property of LightEmittingDiode.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the Power property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightEmittingDiodeSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightEmittingDiodeSerialNumber ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the SerialNumber property of LightEmittingDiode.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightPathAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightPathAnnotationRef ( index_type  imageIndex,
index_type  channelIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of LightPath.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightPathAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getLightPathAnnotationRefCount ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the number of AnnotationRef elements in LightPath.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightPathDichroicRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightPathDichroicRef ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the DichroicRef property of LightPath.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the DichroicRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightPathEmissionFilterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightPathEmissionFilterRef ( index_type  imageIndex,
index_type  channelIndex,
index_type  emissionFilterRefIndex 
) const
virtual

Get the EmissionFilterRef property of LightPath.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
emissionFilterRefIndexEmissionFilterRef index.
Returns
the EmissionFilterRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightPathEmissionFilterRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getLightPathEmissionFilterRefCount ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the number of EmissionFilterRef elements in LightPath.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the number of EmissionFilterRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightPathExcitationFilterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightPathExcitationFilterRef ( index_type  imageIndex,
index_type  channelIndex,
index_type  excitationFilterRefIndex 
) const
virtual

Get the ExcitationFilterRef property of LightPath.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
excitationFilterRefIndexExcitationFilterRef index.
Returns
the ExcitationFilterRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightPathExcitationFilterRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getLightPathExcitationFilterRefCount ( index_type  imageIndex,
index_type  channelIndex 
) const
virtual

Get the number of ExcitationFilterRef elements in LightPath.

Parameters
imageIndexthe Image index.
channelIndexthe Channel index.
Returns
the number of ExcitationFilterRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightSourceAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getLightSourceAnnotationRefCount ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the number of AnnotationRef elements in LightSource.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightSourceCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getLightSourceCount ( index_type  instrumentIndex) const
virtual

Get the number of LightSource elements.

Parameters
instrumentIndexthe Instrument index.
Returns
the number of LightSource elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLightSourceType()

const std::string & ome::xml::meta::OMEXMLMetadata::getLightSourceType ( index_type  instrumentIndex,
index_type  lightSourceIndex 
) const
virtual

Get the type of a LightSource.

Parameters
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
Returns
the LightSource type.
Todo:
Can this be a const reference?

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getLineAnnotationRef ( index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineFillColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getLineFillColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillColor property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineFillRule()

ome::xml::model::enums::FillRule ome::xml::meta::OMEXMLMetadata::getLineFillRule ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillRule property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillRule property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineFontFamily()

ome::xml::model::enums::FontFamily ome::xml::meta::OMEXMLMetadata::getLineFontFamily ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontFamily property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontFamily property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineFontSize()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > ome::xml::meta::OMEXMLMetadata::getLineFontSize ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontSize property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontSize property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineFontStyle()

ome::xml::model::enums::FontStyle ome::xml::meta::OMEXMLMetadata::getLineFontStyle ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontStyle property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontStyle property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineID()

const std::string & ome::xml::meta::OMEXMLMetadata::getLineID ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the ID property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineLocked()

bool ome::xml::meta::OMEXMLMetadata::getLineLocked ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Locked property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Locked property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineMarkerEnd()

ome::xml::model::enums::Marker ome::xml::meta::OMEXMLMetadata::getLineMarkerEnd ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the MarkerEnd property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the MarkerEnd property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineMarkerStart()

ome::xml::model::enums::Marker ome::xml::meta::OMEXMLMetadata::getLineMarkerStart ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the MarkerStart property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the MarkerStart property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineStrokeColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getLineStrokeColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeColor property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineStrokeDashArray()

const std::string & ome::xml::meta::OMEXMLMetadata::getLineStrokeDashArray ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeDashArray property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeDashArray property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineStrokeWidth()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getLineStrokeWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeWidth property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeWidth property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineText()

const std::string & ome::xml::meta::OMEXMLMetadata::getLineText ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Text property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Text property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineTheC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getLineTheC ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheC property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineTheT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getLineTheT ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheT property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineTheZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getLineTheZ ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheZ property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineTransform()

const ::ome::xml::model::AffineTransform & ome::xml::meta::OMEXMLMetadata::getLineTransform ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Transform property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Transform property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineX1()

double ome::xml::meta::OMEXMLMetadata::getLineX1 ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the X1 property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the X1 property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineX2()

double ome::xml::meta::OMEXMLMetadata::getLineX2 ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the X2 property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the X2 property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineY1()

double ome::xml::meta::OMEXMLMetadata::getLineY1 ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Y1 property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Y1 property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLineY2()

double ome::xml::meta::OMEXMLMetadata::getLineY2 ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Y2 property of Line.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Y2 property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getListAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getListAnnotationAnnotationCount ( index_type  listAnnotationIndex) const
virtual

Get the number of links to a ListAnnotation.

This method returns the number of references to the specified ListAnnotation held by all model objects.

Parameters
listAnnotationIndexthe ListAnnotation index.
Returns
the number of ListAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getListAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getListAnnotationAnnotationRef ( index_type  listAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of ListAnnotation.

Parameters
listAnnotationIndexthe ListAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getListAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getListAnnotationAnnotator ( index_type  listAnnotationIndex) const
virtual

Get the Annotator property of ListAnnotation.

Parameters
listAnnotationIndexthe ListAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getListAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getListAnnotationCount ( ) const
virtual

Get the number of ListAnnotation elements.

Returns
the number of ListAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getListAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getListAnnotationDescription ( index_type  listAnnotationIndex) const
virtual

Get the Description property of ListAnnotation.

Parameters
listAnnotationIndexthe ListAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getListAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getListAnnotationID ( index_type  listAnnotationIndex) const
virtual

Get the ID property of ListAnnotation.

Parameters
listAnnotationIndexthe ListAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getListAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getListAnnotationNamespace ( index_type  listAnnotationIndex) const
virtual

Get the Namespace property of ListAnnotation.

Parameters
listAnnotationIndexthe ListAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLongAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getLongAnnotationAnnotationCount ( index_type  longAnnotationIndex) const
virtual

Get the number of links to a LongAnnotation.

This method returns the number of references to the specified LongAnnotation held by all model objects.

Parameters
longAnnotationIndexthe LongAnnotation index.
Returns
the number of LongAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLongAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getLongAnnotationAnnotationRef ( index_type  longAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of LongAnnotation.

Parameters
longAnnotationIndexthe LongAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLongAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getLongAnnotationAnnotator ( index_type  longAnnotationIndex) const
virtual

Get the Annotator property of LongAnnotation.

Parameters
longAnnotationIndexthe LongAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLongAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getLongAnnotationCount ( ) const
virtual

Get the number of LongAnnotation elements.

Returns
the number of LongAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLongAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getLongAnnotationDescription ( index_type  longAnnotationIndex) const
virtual

Get the Description property of LongAnnotation.

Parameters
longAnnotationIndexthe LongAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLongAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getLongAnnotationID ( index_type  longAnnotationIndex) const
virtual

Get the ID property of LongAnnotation.

Parameters
longAnnotationIndexthe LongAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLongAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getLongAnnotationNamespace ( index_type  longAnnotationIndex) const
virtual

Get the Namespace property of LongAnnotation.

Parameters
longAnnotationIndexthe LongAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getLongAnnotationValue()

int64_t ome::xml::meta::OMEXMLMetadata::getLongAnnotationValue ( index_type  longAnnotationIndex) const
virtual

Get the Value property of LongAnnotation.

Parameters
longAnnotationIndexthe LongAnnotation index.
Returns
the Value property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMapAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getMapAnnotationAnnotationCount ( index_type  mapAnnotationIndex) const
virtual

Get the number of links to a MapAnnotation.

This method returns the number of references to the specified MapAnnotation held by all model objects.

Parameters
mapAnnotationIndexthe MapAnnotation index.
Returns
the number of MapAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMapAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getMapAnnotationAnnotationRef ( index_type  mapAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of MapAnnotation.

Parameters
mapAnnotationIndexthe MapAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMapAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getMapAnnotationAnnotator ( index_type  mapAnnotationIndex) const
virtual

Get the Annotator property of MapAnnotation.

Parameters
mapAnnotationIndexthe MapAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMapAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getMapAnnotationCount ( ) const
virtual

Get the number of MapAnnotation elements.

Returns
the number of MapAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMapAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getMapAnnotationDescription ( index_type  mapAnnotationIndex) const
virtual

Get the Description property of MapAnnotation.

Parameters
mapAnnotationIndexthe MapAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMapAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getMapAnnotationID ( index_type  mapAnnotationIndex) const
virtual

Get the ID property of MapAnnotation.

Parameters
mapAnnotationIndexthe MapAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMapAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getMapAnnotationNamespace ( index_type  mapAnnotationIndex) const
virtual

Get the Namespace property of MapAnnotation.

Parameters
mapAnnotationIndexthe MapAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMapAnnotationValue()

const ome::xml::model::primitives::OrderedMultimap & ome::xml::meta::OMEXMLMetadata::getMapAnnotationValue ( index_type  mapAnnotationIndex) const
virtual

Get the map value of MapAnnotation.

Parameters
mapAnnotationIndexthe MapAnnotation index.
Returns
the map value.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getMaskAnnotationRef ( index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskBinData()

const std::vector< uint8_t > & ome::xml::meta::OMEXMLMetadata::getMaskBinData ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Base64Binary property of BinData.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Base64Binary property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskBinDataBigEndian()

bool ome::xml::meta::OMEXMLMetadata::getMaskBinDataBigEndian ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the BigEndian property of BinData.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the BigEndian property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskBinDataCompression()

ome::xml::model::enums::Compression ome::xml::meta::OMEXMLMetadata::getMaskBinDataCompression ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Compression property of BinData.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Compression property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskBinDataLength()

ome::xml::model::primitives::NonNegativeLong ome::xml::meta::OMEXMLMetadata::getMaskBinDataLength ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Length property of BinData.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Length property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskFillColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getMaskFillColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillColor property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskFillRule()

ome::xml::model::enums::FillRule ome::xml::meta::OMEXMLMetadata::getMaskFillRule ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillRule property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillRule property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskFontFamily()

ome::xml::model::enums::FontFamily ome::xml::meta::OMEXMLMetadata::getMaskFontFamily ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontFamily property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontFamily property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskFontSize()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > ome::xml::meta::OMEXMLMetadata::getMaskFontSize ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontSize property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontSize property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskFontStyle()

ome::xml::model::enums::FontStyle ome::xml::meta::OMEXMLMetadata::getMaskFontStyle ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontStyle property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontStyle property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskHeight()

double ome::xml::meta::OMEXMLMetadata::getMaskHeight ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Height property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Height property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskID()

const std::string & ome::xml::meta::OMEXMLMetadata::getMaskID ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the ID property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskLocked()

bool ome::xml::meta::OMEXMLMetadata::getMaskLocked ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Locked property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Locked property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskStrokeColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getMaskStrokeColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeColor property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskStrokeDashArray()

const std::string & ome::xml::meta::OMEXMLMetadata::getMaskStrokeDashArray ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeDashArray property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeDashArray property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskStrokeWidth()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getMaskStrokeWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeWidth property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeWidth property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskText()

const std::string & ome::xml::meta::OMEXMLMetadata::getMaskText ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Text property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Text property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskTheC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getMaskTheC ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheC property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskTheT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getMaskTheT ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheT property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskTheZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getMaskTheZ ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheZ property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskTransform()

const ::ome::xml::model::AffineTransform & ome::xml::meta::OMEXMLMetadata::getMaskTransform ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Transform property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Transform property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskWidth()

double ome::xml::meta::OMEXMLMetadata::getMaskWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Width property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Width property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskX()

double ome::xml::meta::OMEXMLMetadata::getMaskX ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the X property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the X property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMaskY()

double ome::xml::meta::OMEXMLMetadata::getMaskY ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Y property of Mask.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Y property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationCount ( index_type  experimentIndex) const
virtual

Get the number of MicrobeamManipulation elements.

Parameters
experimentIndexthe Experiment index.
Returns
the number of MicrobeamManipulation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationDescription ( index_type  experimentIndex,
index_type  microbeamManipulationIndex 
) const
virtual

Get the Description property of MicrobeamManipulation.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationExperimenterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationExperimenterRef ( index_type  experimentIndex,
index_type  microbeamManipulationIndex 
) const
virtual

Get the ExperimenterRef property of MicrobeamManipulation.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
Returns
the ExperimenterRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationID ( index_type  experimentIndex,
index_type  microbeamManipulationIndex 
) const
virtual

Get the ID property of MicrobeamManipulation.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationLightSourceSettingsAttenuation()

ome::xml::model::primitives::PercentFraction ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationLightSourceSettingsAttenuation ( index_type  experimentIndex,
index_type  microbeamManipulationIndex,
index_type  lightSourceSettingsIndex 
) const
virtual

Get the Attenuation property of LightSourceSettings.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
lightSourceSettingsIndexthe LightSourceSettings index.
Returns
the Attenuation property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationLightSourceSettingsCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationLightSourceSettingsCount ( index_type  experimentIndex,
index_type  microbeamManipulationIndex 
) const
virtual

Get the number of LightSourceSettings elements in MicrobeamManipulation.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
Returns
the number of LightSourceSettings elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationLightSourceSettingsID()

const std::string & ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationLightSourceSettingsID ( index_type  experimentIndex,
index_type  microbeamManipulationIndex,
index_type  lightSourceSettingsIndex 
) const
virtual

Get the ID property of LightSourceSettings.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
lightSourceSettingsIndexthe LightSourceSettings index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationLightSourceSettingsWavelength()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationLightSourceSettingsWavelength ( index_type  experimentIndex,
index_type  microbeamManipulationIndex,
index_type  lightSourceSettingsIndex 
) const
virtual

Get the Wavelength property of LightSourceSettings.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
lightSourceSettingsIndexthe LightSourceSettings index.
Returns
the Wavelength property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationRefCount ( index_type  imageIndex) const
virtual

Get the number of MicrobeamManipulationRef elements.

Parameters
imageIndexthe Image index.
Returns
the number of MicrobeamManipulationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationROIRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationROIRef ( index_type  experimentIndex,
index_type  microbeamManipulationIndex,
index_type  ROIRefIndex 
) const
virtual

Get the ROIRef property of MicrobeamManipulation.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
ROIRefIndexROIRef index.
Returns
the ROIRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationROIRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationROIRefCount ( index_type  experimentIndex,
index_type  microbeamManipulationIndex 
) const
virtual

Get the number of ROIRef elements in MicrobeamManipulation.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
Returns
the number of ROIRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicrobeamManipulationType()

ome::xml::model::enums::MicrobeamManipulationType ome::xml::meta::OMEXMLMetadata::getMicrobeamManipulationType ( index_type  experimentIndex,
index_type  microbeamManipulationIndex 
) const
virtual

Get the Type property of MicrobeamManipulation.

Parameters
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicroscopeLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getMicroscopeLotNumber ( index_type  instrumentIndex) const
virtual

Get the LotNumber property of Microscope.

Parameters
instrumentIndexthe Instrument index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicroscopeManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getMicroscopeManufacturer ( index_type  instrumentIndex) const
virtual

Get the Manufacturer property of Microscope.

Parameters
instrumentIndexthe Instrument index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicroscopeModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getMicroscopeModel ( index_type  instrumentIndex) const
virtual

Get the Model property of Microscope.

Parameters
instrumentIndexthe Instrument index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicroscopeSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getMicroscopeSerialNumber ( index_type  instrumentIndex) const
virtual

Get the SerialNumber property of Microscope.

Parameters
instrumentIndexthe Instrument index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getMicroscopeType()

ome::xml::model::enums::MicroscopeType ome::xml::meta::OMEXMLMetadata::getMicroscopeType ( index_type  instrumentIndex) const
virtual

Get the Type property of Microscope.

Parameters
instrumentIndexthe Instrument index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getObjectiveAnnotationRef ( index_type  instrumentIndex,
index_type  objectiveIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getObjectiveAnnotationRefCount ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the number of AnnotationRef elements in Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveCalibratedMagnification()

double ome::xml::meta::OMEXMLMetadata::getObjectiveCalibratedMagnification ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the CalibratedMagnification property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the CalibratedMagnification property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveCorrection()

ome::xml::model::enums::Correction ome::xml::meta::OMEXMLMetadata::getObjectiveCorrection ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the Correction property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the Correction property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getObjectiveCount ( index_type  instrumentIndex) const
virtual

Get the number of Objective elements.

Parameters
instrumentIndexthe Instrument index.
Returns
the number of Objective elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveID()

const std::string & ome::xml::meta::OMEXMLMetadata::getObjectiveID ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the ID property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveImmersion()

ome::xml::model::enums::Immersion ome::xml::meta::OMEXMLMetadata::getObjectiveImmersion ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the Immersion property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the Immersion property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveIris()

bool ome::xml::meta::OMEXMLMetadata::getObjectiveIris ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the Iris property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the Iris property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveLensNA()

double ome::xml::meta::OMEXMLMetadata::getObjectiveLensNA ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the LensNA property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the LensNA property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveLotNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getObjectiveLotNumber ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the LotNumber property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the LotNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveManufacturer()

const std::string & ome::xml::meta::OMEXMLMetadata::getObjectiveManufacturer ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the Manufacturer property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the Manufacturer property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveModel()

const std::string & ome::xml::meta::OMEXMLMetadata::getObjectiveModel ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the Model property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the Model property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveNominalMagnification()

double ome::xml::meta::OMEXMLMetadata::getObjectiveNominalMagnification ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the NominalMagnification property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the NominalMagnification property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveSerialNumber()

const std::string & ome::xml::meta::OMEXMLMetadata::getObjectiveSerialNumber ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the SerialNumber property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the SerialNumber property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveSettingsCorrectionCollar()

double ome::xml::meta::OMEXMLMetadata::getObjectiveSettingsCorrectionCollar ( index_type  imageIndex) const
virtual

Get the CorrectionCollar property of ObjectiveSettings.

Parameters
imageIndexthe Image index.
Returns
the CorrectionCollar property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveSettingsID()

const std::string & ome::xml::meta::OMEXMLMetadata::getObjectiveSettingsID ( index_type  imageIndex) const
virtual

Get the ID property of ObjectiveSettings.

Parameters
imageIndexthe Image index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveSettingsMedium()

ome::xml::model::enums::Medium ome::xml::meta::OMEXMLMetadata::getObjectiveSettingsMedium ( index_type  imageIndex) const
virtual

Get the Medium property of ObjectiveSettings.

Parameters
imageIndexthe Image index.
Returns
the Medium property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveSettingsRefractiveIndex()

double ome::xml::meta::OMEXMLMetadata::getObjectiveSettingsRefractiveIndex ( index_type  imageIndex) const
virtual

Get the RefractiveIndex property of ObjectiveSettings.

Parameters
imageIndexthe Image index.
Returns
the RefractiveIndex property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getObjectiveWorkingDistance()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getObjectiveWorkingDistance ( index_type  instrumentIndex,
index_type  objectiveIndex 
) const
virtual

Get the WorkingDistance property of Objective.

Parameters
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
Returns
the WorkingDistance property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsBigEndian()

bool ome::xml::meta::OMEXMLMetadata::getPixelsBigEndian ( index_type  imageIndex) const
virtual

Get the BigEndian property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the BigEndian property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsBinData()

const std::vector< uint8_t > & ome::xml::meta::OMEXMLMetadata::getPixelsBinData ( index_type  imageIndex,
index_type  binDataIndex 
) const
virtual

Get the Base64Binary property of BinData.

Parameters
imageIndexthe Image index.
binDataIndexthe BinData index.
Returns
the Base64Binary property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsBinDataBigEndian()

bool ome::xml::meta::OMEXMLMetadata::getPixelsBinDataBigEndian ( index_type  imageIndex,
index_type  binDataIndex 
) const
virtual

Get the BigEndian property of BinData.

Parameters
imageIndexthe Image index.
binDataIndexthe BinData index.
Returns
the BigEndian property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsBinDataCompression()

ome::xml::model::enums::Compression ome::xml::meta::OMEXMLMetadata::getPixelsBinDataCompression ( index_type  imageIndex,
index_type  binDataIndex 
) const
virtual

Get the Compression property of BinData.

Parameters
imageIndexthe Image index.
binDataIndexthe BinData index.
Returns
the Compression property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsBinDataCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getPixelsBinDataCount ( index_type  imageIndex) const
virtual

Get the number of BinData elements in Pixels.

Parameters
imageIndexthe Image index.
Returns
the number of BinData elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsBinDataLength()

ome::xml::model::primitives::NonNegativeLong ome::xml::meta::OMEXMLMetadata::getPixelsBinDataLength ( index_type  imageIndex,
index_type  binDataIndex 
) const
virtual

Get the Length property of BinData.

Parameters
imageIndexthe Image index.
binDataIndexthe BinData index.
Returns
the Length property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsDimensionOrder()

ome::xml::model::enums::DimensionOrder ome::xml::meta::OMEXMLMetadata::getPixelsDimensionOrder ( index_type  imageIndex) const
virtual

Get the DimensionOrder property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the DimensionOrder property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsID()

const std::string & ome::xml::meta::OMEXMLMetadata::getPixelsID ( index_type  imageIndex) const
virtual

Get the ID property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsInterleaved()

bool ome::xml::meta::OMEXMLMetadata::getPixelsInterleaved ( index_type  imageIndex) const
virtual

Get the Interleaved property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the Interleaved property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsPhysicalSizeX()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getPixelsPhysicalSizeX ( index_type  imageIndex) const
virtual

Get the PhysicalSizeX property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the PhysicalSizeX property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsPhysicalSizeY()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getPixelsPhysicalSizeY ( index_type  imageIndex) const
virtual

Get the PhysicalSizeY property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the PhysicalSizeY property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsPhysicalSizeZ()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getPixelsPhysicalSizeZ ( index_type  imageIndex) const
virtual

Get the PhysicalSizeZ property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the PhysicalSizeZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsSignificantBits()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getPixelsSignificantBits ( index_type  imageIndex) const
virtual

Get the SignificantBits property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the SignificantBits property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsSizeC()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getPixelsSizeC ( index_type  imageIndex) const
virtual

Get the SizeC property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the SizeC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsSizeT()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getPixelsSizeT ( index_type  imageIndex) const
virtual

Get the SizeT property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the SizeT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsSizeX()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getPixelsSizeX ( index_type  imageIndex) const
virtual

Get the SizeX property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the SizeX property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsSizeY()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getPixelsSizeY ( index_type  imageIndex) const
virtual

Get the SizeY property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the SizeY property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsSizeZ()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getPixelsSizeZ ( index_type  imageIndex) const
virtual

Get the SizeZ property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the SizeZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsTimeIncrement()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > ome::xml::meta::OMEXMLMetadata::getPixelsTimeIncrement ( index_type  imageIndex) const
virtual

Get the TimeIncrement property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the TimeIncrement property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPixelsType()

ome::xml::model::enums::PixelType ome::xml::meta::OMEXMLMetadata::getPixelsType ( index_type  imageIndex) const
virtual

Get the Type property of Pixels.

Parameters
imageIndexthe Image index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlaneAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlaneAnnotationRef ( index_type  imageIndex,
index_type  planeIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlaneAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getPlaneAnnotationRefCount ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the number of AnnotationRef elements in Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlaneCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getPlaneCount ( index_type  imageIndex) const
virtual

Get the number of Plane elements.

Parameters
imageIndexthe Image index.
Returns
the number of Plane elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlaneDeltaT()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > ome::xml::meta::OMEXMLMetadata::getPlaneDeltaT ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the DeltaT property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the DeltaT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlaneExposureTime()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > ome::xml::meta::OMEXMLMetadata::getPlaneExposureTime ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the ExposureTime property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the ExposureTime property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlaneHashSHA1()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlaneHashSHA1 ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the HashSHA1 property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the HashSHA1 property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlanePositionX()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getPlanePositionX ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the PositionX property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the PositionX property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlanePositionY()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getPlanePositionY ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the PositionY property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the PositionY property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlanePositionZ()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getPlanePositionZ ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the PositionZ property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the PositionZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlaneTheC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPlaneTheC ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the TheC property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the TheC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlaneTheT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPlaneTheT ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the TheT property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the TheT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlaneTheZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPlaneTheZ ( index_type  imageIndex,
index_type  planeIndex 
) const
virtual

Get the TheZ property of Plane.

Parameters
imageIndexthe Image index.
planeIndexthe Plane index.
Returns
the TheZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionAnnotationRef ( index_type  plateIndex,
index_type  plateAcquisitionIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of PlateAcquisition.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionAnnotationRefCount ( index_type  plateIndex,
index_type  plateAcquisitionIndex 
) const
virtual

Get the number of AnnotationRef elements in PlateAcquisition.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionCount ( index_type  plateIndex) const
virtual

Get the number of PlateAcquisition elements.

Parameters
plateIndexthe Plate index.
Returns
the number of PlateAcquisition elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionDescription ( index_type  plateIndex,
index_type  plateAcquisitionIndex 
) const
virtual

Get the Description property of PlateAcquisition.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionEndTime()

ome::xml::model::primitives::Timestamp ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionEndTime ( index_type  plateIndex,
index_type  plateAcquisitionIndex 
) const
virtual

Get the EndTime property of PlateAcquisition.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
Returns
the EndTime property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionID()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionID ( index_type  plateIndex,
index_type  plateAcquisitionIndex 
) const
virtual

Get the ID property of PlateAcquisition.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionMaximumFieldCount()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionMaximumFieldCount ( index_type  plateIndex,
index_type  plateAcquisitionIndex 
) const
virtual

Get the MaximumFieldCount property of PlateAcquisition.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
Returns
the MaximumFieldCount property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionName()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionName ( index_type  plateIndex,
index_type  plateAcquisitionIndex 
) const
virtual

Get the Name property of PlateAcquisition.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionStartTime()

ome::xml::model::primitives::Timestamp ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionStartTime ( index_type  plateIndex,
index_type  plateAcquisitionIndex 
) const
virtual

Get the StartTime property of PlateAcquisition.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
Returns
the StartTime property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAcquisitionWellSampleRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateAcquisitionWellSampleRef ( index_type  plateIndex,
index_type  plateAcquisitionIndex,
index_type  wellSampleRefIndex 
) const
virtual

Get the WellSampleRef property of PlateAcquisition.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
wellSampleRefIndexWellSampleRef index.
Returns
the WellSampleRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateAnnotationRef ( index_type  plateIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Plate.

Parameters
plateIndexthe Plate index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getPlateAnnotationRefCount ( index_type  plateIndex) const
virtual

Get the number of AnnotationRef elements in Plate.

Parameters
plateIndexthe Plate index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateColumnNamingConvention()

ome::xml::model::enums::NamingConvention ome::xml::meta::OMEXMLMetadata::getPlateColumnNamingConvention ( index_type  plateIndex) const
virtual

Get the ColumnNamingConvention property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the ColumnNamingConvention property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateColumns()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getPlateColumns ( index_type  plateIndex) const
virtual

Get the Columns property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the Columns property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getPlateCount ( ) const
virtual

Get the number of Plate elements.

Returns
the number of Plate elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateDescription ( index_type  plateIndex) const
virtual

Get the Description property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateExternalIdentifier()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateExternalIdentifier ( index_type  plateIndex) const
virtual

Get the ExternalIdentifier property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the ExternalIdentifier property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateFieldIndex()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPlateFieldIndex ( index_type  plateIndex) const
virtual

Get the FieldIndex property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the FieldIndex property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateID()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateID ( index_type  plateIndex) const
virtual

Get the ID property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateName()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateName ( index_type  plateIndex) const
virtual

Get the Name property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getPlateRefCount ( index_type  screenIndex) const
virtual

Get the number of PlateRef elements.

Parameters
screenIndexthe Screen index.
Returns
the number of PlateRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateRowNamingConvention()

ome::xml::model::enums::NamingConvention ome::xml::meta::OMEXMLMetadata::getPlateRowNamingConvention ( index_type  plateIndex) const
virtual

Get the RowNamingConvention property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the RowNamingConvention property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateRows()

ome::xml::model::primitives::PositiveInteger ome::xml::meta::OMEXMLMetadata::getPlateRows ( index_type  plateIndex) const
virtual

Get the Rows property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the Rows property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateStatus()

const std::string & ome::xml::meta::OMEXMLMetadata::getPlateStatus ( index_type  plateIndex) const
virtual

Get the Status property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the Status property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateWellOriginX()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getPlateWellOriginX ( index_type  plateIndex) const
virtual

Get the WellOriginX property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the WellOriginX property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPlateWellOriginY()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getPlateWellOriginY ( index_type  plateIndex) const
virtual

Get the WellOriginY property of Plate.

Parameters
plateIndexthe Plate index.
Returns
the WellOriginY property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getPointAnnotationRef ( index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointFillColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getPointFillColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillColor property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointFillRule()

ome::xml::model::enums::FillRule ome::xml::meta::OMEXMLMetadata::getPointFillRule ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillRule property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillRule property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointFontFamily()

ome::xml::model::enums::FontFamily ome::xml::meta::OMEXMLMetadata::getPointFontFamily ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontFamily property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontFamily property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointFontSize()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > ome::xml::meta::OMEXMLMetadata::getPointFontSize ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontSize property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontSize property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointFontStyle()

ome::xml::model::enums::FontStyle ome::xml::meta::OMEXMLMetadata::getPointFontStyle ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontStyle property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontStyle property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointID()

const std::string & ome::xml::meta::OMEXMLMetadata::getPointID ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the ID property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointLocked()

bool ome::xml::meta::OMEXMLMetadata::getPointLocked ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Locked property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Locked property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointStrokeColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getPointStrokeColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeColor property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointStrokeDashArray()

const std::string & ome::xml::meta::OMEXMLMetadata::getPointStrokeDashArray ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeDashArray property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeDashArray property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointStrokeWidth()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getPointStrokeWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeWidth property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeWidth property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointText()

const std::string & ome::xml::meta::OMEXMLMetadata::getPointText ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Text property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Text property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointTheC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPointTheC ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheC property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointTheT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPointTheT ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheT property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointTheZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPointTheZ ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheZ property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointTransform()

const ::ome::xml::model::AffineTransform & ome::xml::meta::OMEXMLMetadata::getPointTransform ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Transform property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Transform property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointX()

double ome::xml::meta::OMEXMLMetadata::getPointX ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the X property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the X property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPointY()

double ome::xml::meta::OMEXMLMetadata::getPointY ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Y property of Point.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Y property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolygonAnnotationRef ( index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonFillColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getPolygonFillColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillColor property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonFillRule()

ome::xml::model::enums::FillRule ome::xml::meta::OMEXMLMetadata::getPolygonFillRule ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillRule property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillRule property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonFontFamily()

ome::xml::model::enums::FontFamily ome::xml::meta::OMEXMLMetadata::getPolygonFontFamily ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontFamily property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontFamily property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonFontSize()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > ome::xml::meta::OMEXMLMetadata::getPolygonFontSize ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontSize property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontSize property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonFontStyle()

ome::xml::model::enums::FontStyle ome::xml::meta::OMEXMLMetadata::getPolygonFontStyle ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontStyle property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontStyle property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonID()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolygonID ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the ID property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonLocked()

bool ome::xml::meta::OMEXMLMetadata::getPolygonLocked ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Locked property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Locked property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonPoints()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolygonPoints ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Points property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Points property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonStrokeColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getPolygonStrokeColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeColor property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonStrokeDashArray()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolygonStrokeDashArray ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeDashArray property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeDashArray property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonStrokeWidth()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getPolygonStrokeWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeWidth property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeWidth property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonText()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolygonText ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Text property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Text property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonTheC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPolygonTheC ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheC property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonTheT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPolygonTheT ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheT property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonTheZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPolygonTheZ ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheZ property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolygonTransform()

const ::ome::xml::model::AffineTransform & ome::xml::meta::OMEXMLMetadata::getPolygonTransform ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Transform property of Polygon.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Transform property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolylineAnnotationRef ( index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineFillColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getPolylineFillColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillColor property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineFillRule()

ome::xml::model::enums::FillRule ome::xml::meta::OMEXMLMetadata::getPolylineFillRule ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillRule property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillRule property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineFontFamily()

ome::xml::model::enums::FontFamily ome::xml::meta::OMEXMLMetadata::getPolylineFontFamily ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontFamily property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontFamily property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineFontSize()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > ome::xml::meta::OMEXMLMetadata::getPolylineFontSize ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontSize property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontSize property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineFontStyle()

ome::xml::model::enums::FontStyle ome::xml::meta::OMEXMLMetadata::getPolylineFontStyle ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontStyle property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontStyle property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineID()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolylineID ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the ID property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineLocked()

bool ome::xml::meta::OMEXMLMetadata::getPolylineLocked ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Locked property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Locked property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineMarkerEnd()

ome::xml::model::enums::Marker ome::xml::meta::OMEXMLMetadata::getPolylineMarkerEnd ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the MarkerEnd property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the MarkerEnd property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineMarkerStart()

ome::xml::model::enums::Marker ome::xml::meta::OMEXMLMetadata::getPolylineMarkerStart ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the MarkerStart property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the MarkerStart property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylinePoints()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolylinePoints ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Points property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Points property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineStrokeColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getPolylineStrokeColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeColor property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineStrokeDashArray()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolylineStrokeDashArray ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeDashArray property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeDashArray property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineStrokeWidth()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getPolylineStrokeWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeWidth property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeWidth property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineText()

const std::string & ome::xml::meta::OMEXMLMetadata::getPolylineText ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Text property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Text property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineTheC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPolylineTheC ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheC property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineTheT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPolylineTheT ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheT property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineTheZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getPolylineTheZ ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheZ property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getPolylineTransform()

const ::ome::xml::model::AffineTransform & ome::xml::meta::OMEXMLMetadata::getPolylineTransform ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Transform property of Polyline.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Transform property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getProjectAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getProjectAnnotationRef ( index_type  projectIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Project.

Parameters
projectIndexthe Project index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getProjectAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getProjectAnnotationRefCount ( index_type  projectIndex) const
virtual

Get the number of AnnotationRef elements in Project.

Parameters
projectIndexthe Project index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getProjectCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getProjectCount ( ) const
virtual

Get the number of Project elements.

Returns
the number of Project elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getProjectDatasetRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getProjectDatasetRef ( index_type  projectIndex,
index_type  datasetRefIndex 
) const
virtual

Get the DatasetRef property of Project.

Parameters
projectIndexthe Project index.
datasetRefIndexDatasetRef index.
Returns
the DatasetRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getProjectDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getProjectDescription ( index_type  projectIndex) const
virtual

Get the Description property of Project.

Parameters
projectIndexthe Project index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getProjectExperimenterGroupRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getProjectExperimenterGroupRef ( index_type  projectIndex) const
virtual

Get the ExperimenterGroupRef property of Project.

Parameters
projectIndexthe Project index.
Returns
the ExperimenterGroupRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getProjectExperimenterRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getProjectExperimenterRef ( index_type  projectIndex) const
virtual

Get the ExperimenterRef property of Project.

Parameters
projectIndexthe Project index.
Returns
the ExperimenterRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getProjectID()

const std::string & ome::xml::meta::OMEXMLMetadata::getProjectID ( index_type  projectIndex) const
virtual

Get the ID property of Project.

Parameters
projectIndexthe Project index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getProjectName()

const std::string & ome::xml::meta::OMEXMLMetadata::getProjectName ( index_type  projectIndex) const
virtual

Get the Name property of Project.

Parameters
projectIndexthe Project index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getReagentAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getReagentAnnotationRef ( index_type  screenIndex,
index_type  reagentIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Reagent.

Parameters
screenIndexthe Screen index.
reagentIndexthe Reagent index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getReagentAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getReagentAnnotationRefCount ( index_type  screenIndex,
index_type  reagentIndex 
) const
virtual

Get the number of AnnotationRef elements in Reagent.

Parameters
screenIndexthe Screen index.
reagentIndexthe Reagent index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getReagentCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getReagentCount ( index_type  screenIndex) const
virtual

Get the number of Reagent elements.

Parameters
screenIndexthe Screen index.
Returns
the number of Reagent elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getReagentDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getReagentDescription ( index_type  screenIndex,
index_type  reagentIndex 
) const
virtual

Get the Description property of Reagent.

Parameters
screenIndexthe Screen index.
reagentIndexthe Reagent index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getReagentID()

const std::string & ome::xml::meta::OMEXMLMetadata::getReagentID ( index_type  screenIndex,
index_type  reagentIndex 
) const
virtual

Get the ID property of Reagent.

Parameters
screenIndexthe Screen index.
reagentIndexthe Reagent index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getReagentName()

const std::string & ome::xml::meta::OMEXMLMetadata::getReagentName ( index_type  screenIndex,
index_type  reagentIndex 
) const
virtual

Get the Name property of Reagent.

Parameters
screenIndexthe Screen index.
reagentIndexthe Reagent index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getReagentReagentIdentifier()

const std::string & ome::xml::meta::OMEXMLMetadata::getReagentReagentIdentifier ( index_type  screenIndex,
index_type  reagentIndex 
) const
virtual

Get the ReagentIdentifier property of Reagent.

Parameters
screenIndexthe Screen index.
reagentIndexthe Reagent index.
Returns
the ReagentIdentifier property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getRectangleAnnotationRef ( index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleFillColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getRectangleFillColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillColor property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleFillRule()

ome::xml::model::enums::FillRule ome::xml::meta::OMEXMLMetadata::getRectangleFillRule ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FillRule property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FillRule property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleFontFamily()

ome::xml::model::enums::FontFamily ome::xml::meta::OMEXMLMetadata::getRectangleFontFamily ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontFamily property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontFamily property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleFontSize()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > ome::xml::meta::OMEXMLMetadata::getRectangleFontSize ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontSize property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontSize property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleFontStyle()

ome::xml::model::enums::FontStyle ome::xml::meta::OMEXMLMetadata::getRectangleFontStyle ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the FontStyle property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the FontStyle property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleHeight()

double ome::xml::meta::OMEXMLMetadata::getRectangleHeight ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Height property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Height property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleID()

const std::string & ome::xml::meta::OMEXMLMetadata::getRectangleID ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the ID property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleLocked()

bool ome::xml::meta::OMEXMLMetadata::getRectangleLocked ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Locked property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Locked property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleStrokeColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getRectangleStrokeColor ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeColor property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeColor property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleStrokeDashArray()

const std::string & ome::xml::meta::OMEXMLMetadata::getRectangleStrokeDashArray ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeDashArray property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeDashArray property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleStrokeWidth()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getRectangleStrokeWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the StrokeWidth property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the StrokeWidth property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleText()

const std::string & ome::xml::meta::OMEXMLMetadata::getRectangleText ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Text property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Text property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleTheC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getRectangleTheC ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheC property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleTheT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getRectangleTheT ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheT property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleTheZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getRectangleTheZ ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the TheZ property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the TheZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleTransform()

const ::ome::xml::model::AffineTransform & ome::xml::meta::OMEXMLMetadata::getRectangleTransform ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Transform property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Transform property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleWidth()

double ome::xml::meta::OMEXMLMetadata::getRectangleWidth ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Width property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Width property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleX()

double ome::xml::meta::OMEXMLMetadata::getRectangleX ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the X property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the X property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRectangleY()

double ome::xml::meta::OMEXMLMetadata::getRectangleY ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the Y property of Rectangle.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Y property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRightsRightsHeld()

const std::string & ome::xml::meta::OMEXMLMetadata::getRightsRightsHeld ( ) const
virtual

Get the RightsHeld property of Rights.

Returns
the RightsHeld property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRightsRightsHolder()

const std::string & ome::xml::meta::OMEXMLMetadata::getRightsRightsHolder ( ) const
virtual

Get the RightsHolder property of Rights.

Returns
the RightsHolder property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getROIAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getROIAnnotationRef ( index_type  ROIIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of ROI.

Parameters
ROIIndexthe ROI index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getROIAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getROIAnnotationRefCount ( index_type  ROIIndex) const
virtual

Get the number of AnnotationRef elements in ROI.

Parameters
ROIIndexthe ROI index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getROICount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getROICount ( ) const
virtual

Get the number of ROI elements.

Returns
the number of ROI elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getROIDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getROIDescription ( index_type  ROIIndex) const
virtual

Get the Description property of ROI.

Parameters
ROIIndexthe ROI index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getROIID()

const std::string & ome::xml::meta::OMEXMLMetadata::getROIID ( index_type  ROIIndex) const
virtual

Get the ID property of ROI.

Parameters
ROIIndexthe ROI index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getROIName()

const std::string & ome::xml::meta::OMEXMLMetadata::getROIName ( index_type  ROIIndex) const
virtual

Get the Name property of ROI.

Parameters
ROIIndexthe ROI index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getRoot()

std::shared_ptr< MetadataRoot > ome::xml::meta::OMEXMLMetadata::getRoot ( )
virtual

Get the root node of the metadata.

Note that the root node type will be specific to the concrete metadata implementation.

Returns
a pointer to the root node.
Todo:
should this be a reference or shared_ptr?

Implements ome::xml::meta::MetadataStore.

References root.

◆ getScreenAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenAnnotationRef ( index_type  screenIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Screen.

Parameters
screenIndexthe Screen index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getScreenAnnotationRefCount ( index_type  screenIndex) const
virtual

Get the number of AnnotationRef elements in Screen.

Parameters
screenIndexthe Screen index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getScreenCount ( ) const
virtual

Get the number of Screen elements.

Returns
the number of Screen elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenDescription ( index_type  screenIndex) const
virtual

Get the Description property of Screen.

Parameters
screenIndexthe Screen index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenID()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenID ( index_type  screenIndex) const
virtual

Get the ID property of Screen.

Parameters
screenIndexthe Screen index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenName()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenName ( index_type  screenIndex) const
virtual

Get the Name property of Screen.

Parameters
screenIndexthe Screen index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenPlateRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenPlateRef ( index_type  screenIndex,
index_type  plateRefIndex 
) const
virtual

Get the PlateRef property of Screen.

Parameters
screenIndexthe Screen index.
plateRefIndexPlateRef index.
Returns
the PlateRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenProtocolDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenProtocolDescription ( index_type  screenIndex) const
virtual

Get the ProtocolDescription property of Screen.

Parameters
screenIndexthe Screen index.
Returns
the ProtocolDescription property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenProtocolIdentifier()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenProtocolIdentifier ( index_type  screenIndex) const
virtual

Get the ProtocolIdentifier property of Screen.

Parameters
screenIndexthe Screen index.
Returns
the ProtocolIdentifier property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenReagentSetDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenReagentSetDescription ( index_type  screenIndex) const
virtual

Get the ReagentSetDescription property of Screen.

Parameters
screenIndexthe Screen index.
Returns
the ReagentSetDescription property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenReagentSetIdentifier()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenReagentSetIdentifier ( index_type  screenIndex) const
virtual

Get the ReagentSetIdentifier property of Screen.

Parameters
screenIndexthe Screen index.
Returns
the ReagentSetIdentifier property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getScreenType()

const std::string & ome::xml::meta::OMEXMLMetadata::getScreenType ( index_type  screenIndex) const
virtual

Get the Type property of Screen.

Parameters
screenIndexthe Screen index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getShapeAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getShapeAnnotationRefCount ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the number of AnnotationRef elements in Shape.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getShapeCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getShapeCount ( index_type  ROIIndex) const
virtual

Get the number of Shape elements.

Parameters
ROIIndexthe ROI index.
Returns
the number of Shape elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getShapeType()

const std::string & ome::xml::meta::OMEXMLMetadata::getShapeType ( index_type  ROIIndex,
index_type  shapeIndex 
) const
virtual

Get the type of a Shape.

Parameters
ROIIndexthe ROI index.
shapeIndexthe Shape index.
Returns
the Shape type.
Todo:
Can this be a const reference?

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getStageLabelName()

const std::string & ome::xml::meta::OMEXMLMetadata::getStageLabelName ( index_type  imageIndex) const
virtual

Get the Name property of StageLabel.

Parameters
imageIndexthe Image index.
Returns
the Name property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getStageLabelX()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getStageLabelX ( index_type  imageIndex) const
virtual

Get the X property of StageLabel.

Parameters
imageIndexthe Image index.
Returns
the X property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getStageLabelY()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getStageLabelY ( index_type  imageIndex) const
virtual

Get the Y property of StageLabel.

Parameters
imageIndexthe Image index.
Returns
the Y property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getStageLabelZ()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getStageLabelZ ( index_type  imageIndex) const
virtual

Get the Z property of StageLabel.

Parameters
imageIndexthe Image index.
Returns
the Z property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTagAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getTagAnnotationAnnotationCount ( index_type  tagAnnotationIndex) const
virtual

Get the number of links to a TagAnnotation.

This method returns the number of references to the specified TagAnnotation held by all model objects.

Parameters
tagAnnotationIndexthe TagAnnotation index.
Returns
the number of TagAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTagAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getTagAnnotationAnnotationRef ( index_type  tagAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of TagAnnotation.

Parameters
tagAnnotationIndexthe TagAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTagAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getTagAnnotationAnnotator ( index_type  tagAnnotationIndex) const
virtual

Get the Annotator property of TagAnnotation.

Parameters
tagAnnotationIndexthe TagAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTagAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getTagAnnotationCount ( ) const
virtual

Get the number of TagAnnotation elements.

Returns
the number of TagAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTagAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getTagAnnotationDescription ( index_type  tagAnnotationIndex) const
virtual

Get the Description property of TagAnnotation.

Parameters
tagAnnotationIndexthe TagAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTagAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getTagAnnotationID ( index_type  tagAnnotationIndex) const
virtual

Get the ID property of TagAnnotation.

Parameters
tagAnnotationIndexthe TagAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTagAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getTagAnnotationNamespace ( index_type  tagAnnotationIndex) const
virtual

Get the Namespace property of TagAnnotation.

Parameters
tagAnnotationIndexthe TagAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTagAnnotationValue()

const std::string & ome::xml::meta::OMEXMLMetadata::getTagAnnotationValue ( index_type  tagAnnotationIndex) const
virtual

Get the Value property of TagAnnotation.

Parameters
tagAnnotationIndexthe TagAnnotation index.
Returns
the Value property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTermAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getTermAnnotationAnnotationCount ( index_type  termAnnotationIndex) const
virtual

Get the number of links to a TermAnnotation.

This method returns the number of references to the specified TermAnnotation held by all model objects.

Parameters
termAnnotationIndexthe TermAnnotation index.
Returns
the number of TermAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTermAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getTermAnnotationAnnotationRef ( index_type  termAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of TermAnnotation.

Parameters
termAnnotationIndexthe TermAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTermAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getTermAnnotationAnnotator ( index_type  termAnnotationIndex) const
virtual

Get the Annotator property of TermAnnotation.

Parameters
termAnnotationIndexthe TermAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTermAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getTermAnnotationCount ( ) const
virtual

Get the number of TermAnnotation elements.

Returns
the number of TermAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTermAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getTermAnnotationDescription ( index_type  termAnnotationIndex) const
virtual

Get the Description property of TermAnnotation.

Parameters
termAnnotationIndexthe TermAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTermAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getTermAnnotationID ( index_type  termAnnotationIndex) const
virtual

Get the ID property of TermAnnotation.

Parameters
termAnnotationIndexthe TermAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTermAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getTermAnnotationNamespace ( index_type  termAnnotationIndex) const
virtual

Get the Namespace property of TermAnnotation.

Parameters
termAnnotationIndexthe TermAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTermAnnotationValue()

const std::string & ome::xml::meta::OMEXMLMetadata::getTermAnnotationValue ( index_type  termAnnotationIndex) const
virtual

Get the Value property of TermAnnotation.

Parameters
termAnnotationIndexthe TermAnnotation index.
Returns
the Value property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTiffDataCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getTiffDataCount ( index_type  imageIndex) const
virtual

Get the number of TiffData elements.

Parameters
imageIndexthe Image index.
Returns
the number of TiffData elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTiffDataFirstC()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getTiffDataFirstC ( index_type  imageIndex,
index_type  tiffDataIndex 
) const
virtual

Get the FirstC property of TiffData.

Parameters
imageIndexthe Image index.
tiffDataIndexthe TiffData index.
Returns
the FirstC property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTiffDataFirstT()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getTiffDataFirstT ( index_type  imageIndex,
index_type  tiffDataIndex 
) const
virtual

Get the FirstT property of TiffData.

Parameters
imageIndexthe Image index.
tiffDataIndexthe TiffData index.
Returns
the FirstT property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTiffDataFirstZ()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getTiffDataFirstZ ( index_type  imageIndex,
index_type  tiffDataIndex 
) const
virtual

Get the FirstZ property of TiffData.

Parameters
imageIndexthe Image index.
tiffDataIndexthe TiffData index.
Returns
the FirstZ property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTiffDataIFD()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getTiffDataIFD ( index_type  imageIndex,
index_type  tiffDataIndex 
) const
virtual

Get the IFD property of TiffData.

Parameters
imageIndexthe Image index.
tiffDataIndexthe TiffData index.
Returns
the IFD property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTiffDataPlaneCount()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getTiffDataPlaneCount ( index_type  imageIndex,
index_type  tiffDataIndex 
) const
virtual

Get the PlaneCount property of TiffData.

Parameters
imageIndexthe Image index.
tiffDataIndexthe TiffData index.
Returns
the PlaneCount property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTimestampAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getTimestampAnnotationAnnotationCount ( index_type  timestampAnnotationIndex) const
virtual

Get the number of links to a TimestampAnnotation.

This method returns the number of references to the specified TimestampAnnotation held by all model objects.

Parameters
timestampAnnotationIndexthe TimestampAnnotation index.
Returns
the number of TimestampAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTimestampAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getTimestampAnnotationAnnotationRef ( index_type  timestampAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of TimestampAnnotation.

Parameters
timestampAnnotationIndexthe TimestampAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTimestampAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getTimestampAnnotationAnnotator ( index_type  timestampAnnotationIndex) const
virtual

Get the Annotator property of TimestampAnnotation.

Parameters
timestampAnnotationIndexthe TimestampAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTimestampAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getTimestampAnnotationCount ( ) const
virtual

Get the number of TimestampAnnotation elements.

Returns
the number of TimestampAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTimestampAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getTimestampAnnotationDescription ( index_type  timestampAnnotationIndex) const
virtual

Get the Description property of TimestampAnnotation.

Parameters
timestampAnnotationIndexthe TimestampAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTimestampAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getTimestampAnnotationID ( index_type  timestampAnnotationIndex) const
virtual

Get the ID property of TimestampAnnotation.

Parameters
timestampAnnotationIndexthe TimestampAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTimestampAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getTimestampAnnotationNamespace ( index_type  timestampAnnotationIndex) const
virtual

Get the Namespace property of TimestampAnnotation.

Parameters
timestampAnnotationIndexthe TimestampAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTimestampAnnotationValue()

ome::xml::model::primitives::Timestamp ome::xml::meta::OMEXMLMetadata::getTimestampAnnotationValue ( index_type  timestampAnnotationIndex) const
virtual

Get the Value property of TimestampAnnotation.

Parameters
timestampAnnotationIndexthe TimestampAnnotation index.
Returns
the Value property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTransmittanceRangeCutIn()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getTransmittanceRangeCutIn ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the CutIn property of TransmittanceRange.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the CutIn property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTransmittanceRangeCutInTolerance()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeFloat > ome::xml::meta::OMEXMLMetadata::getTransmittanceRangeCutInTolerance ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the CutInTolerance property of TransmittanceRange.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the CutInTolerance property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTransmittanceRangeCutOut()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > ome::xml::meta::OMEXMLMetadata::getTransmittanceRangeCutOut ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the CutOut property of TransmittanceRange.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the CutOut property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTransmittanceRangeCutOutTolerance()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeFloat > ome::xml::meta::OMEXMLMetadata::getTransmittanceRangeCutOutTolerance ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the CutOutTolerance property of TransmittanceRange.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the CutOutTolerance property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getTransmittanceRangeTransmittance()

ome::xml::model::primitives::PercentFraction ome::xml::meta::OMEXMLMetadata::getTransmittanceRangeTransmittance ( index_type  instrumentIndex,
index_type  filterIndex 
) const
virtual

Get the Transmittance property of TransmittanceRange.

Parameters
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
Returns
the Transmittance property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getUUID()

const std::string & ome::xml::meta::OMEXMLMetadata::getUUID ( ) const
virtual

Get the UUID associated with this collection of metadata.

Returns
the UUID.
Todo:
Can this be a const reference?

Implements ome::xml::meta::MetadataRetrieve.

References root.

Referenced by getUUIDFileName(), and getUUIDValue().

+ Here is the caller graph for this function:

◆ getUUIDFileName()

const std::string & ome::xml::meta::OMEXMLMetadata::getUUIDFileName ( index_type  imageIndex,
index_type  tiffDataIndex 
) const
virtual

Get the FileName property of UUID.

Parameters
imageIndexthe Image index.
tiffDataIndexthe TiffData index.
Returns
the FileName property.

Implements ome::xml::meta::MetadataRetrieve.

References getUUID(), and root.

◆ getUUIDValue()

std::string ome::xml::meta::OMEXMLMetadata::getUUIDValue ( index_type  imageIndex,
index_type  tiffDataIndex 
) const
virtual

Get the text value of UUID.

Parameters
imageIndexthe Image index.
tiffDataIndexthe TiffData index.
Returns
the text value.

Implements ome::xml::meta::MetadataRetrieve.

References getUUID(), and root.

◆ getWellAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getWellAnnotationRef ( index_type  plateIndex,
index_type  wellIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellAnnotationRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getWellAnnotationRefCount ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the number of AnnotationRef elements in Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the number of AnnotationRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellColor()

ome::xml::model::primitives::Color ome::xml::meta::OMEXMLMetadata::getWellColor ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the Color property of Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the Color property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellColumn()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getWellColumn ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the Column property of Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the Column property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getWellCount ( index_type  plateIndex) const
virtual

Get the number of Well elements.

Parameters
plateIndexthe Plate index.
Returns
the number of Well elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellExternalDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getWellExternalDescription ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the ExternalDescription property of Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the ExternalDescription property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellExternalIdentifier()

const std::string & ome::xml::meta::OMEXMLMetadata::getWellExternalIdentifier ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the ExternalIdentifier property of Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the ExternalIdentifier property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellID()

const std::string & ome::xml::meta::OMEXMLMetadata::getWellID ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the ID property of Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellReagentRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getWellReagentRef ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the ReagentRef property of Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the ReagentRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellRow()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getWellRow ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the Row property of Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the Row property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellSampleCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getWellSampleCount ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the number of WellSample elements.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the number of WellSample elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellSampleID()

const std::string & ome::xml::meta::OMEXMLMetadata::getWellSampleID ( index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
) const
virtual

Get the ID property of WellSample.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellSampleImageRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getWellSampleImageRef ( index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
) const
virtual

Get the ImageRef property of WellSample.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.
Returns
the ImageRef property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellSampleIndex()

ome::xml::model::primitives::NonNegativeInteger ome::xml::meta::OMEXMLMetadata::getWellSampleIndex ( index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
) const
virtual

Get the Index property of WellSample.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.
Returns
the Index property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellSamplePositionX()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getWellSamplePositionX ( index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
) const
virtual

Get the PositionX property of WellSample.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.
Returns
the PositionX property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellSamplePositionY()

ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > ome::xml::meta::OMEXMLMetadata::getWellSamplePositionY ( index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
) const
virtual

Get the PositionY property of WellSample.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.
Returns
the PositionY property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellSampleRefCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getWellSampleRefCount ( index_type  plateIndex,
index_type  plateAcquisitionIndex 
) const
virtual

Get the number of WellSampleRef elements.

Parameters
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
Returns
the number of WellSampleRef elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellSampleTimepoint()

ome::xml::model::primitives::Timestamp ome::xml::meta::OMEXMLMetadata::getWellSampleTimepoint ( index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
) const
virtual

Get the Timepoint property of WellSample.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.
Returns
the Timepoint property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getWellType()

const std::string & ome::xml::meta::OMEXMLMetadata::getWellType ( index_type  plateIndex,
index_type  wellIndex 
) const
virtual

Get the Type property of Well.

Parameters
plateIndexthe Plate index.
wellIndexthe Well index.
Returns
the Type property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getXMLAnnotationAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getXMLAnnotationAnnotationCount ( index_type  xmlAnnotationIndex) const
virtual

Get the number of links to an XMLAnnotation.

This method returns the number of references to the specified XMLAnnotation held by all model objects.

Parameters
xmlAnnotationIndexthe XMLAnnotation index.
Returns
the number of XMLAnnotation links.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getXMLAnnotationAnnotationRef()

const std::string & ome::xml::meta::OMEXMLMetadata::getXMLAnnotationAnnotationRef ( index_type  XMLAnnotationIndex,
index_type  annotationRefIndex 
) const
virtual

Get the AnnotationRef property of XMLAnnotation.

Parameters
XMLAnnotationIndexthe XMLAnnotation index.
annotationRefIndexAnnotationRef index.
Returns
the AnnotationRef property.
Todo:
: Need an exception for store inconsistency.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getXMLAnnotationAnnotator()

const std::string & ome::xml::meta::OMEXMLMetadata::getXMLAnnotationAnnotator ( index_type  XMLAnnotationIndex) const
virtual

Get the Annotator property of XMLAnnotation.

Parameters
XMLAnnotationIndexthe XMLAnnotation index.
Returns
the Annotator property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getXMLAnnotationCount()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::getXMLAnnotationCount ( ) const
virtual

Get the number of XMLAnnotation elements.

Returns
the number of XMLAnnotation elements.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getXMLAnnotationDescription()

const std::string & ome::xml::meta::OMEXMLMetadata::getXMLAnnotationDescription ( index_type  XMLAnnotationIndex) const
virtual

Get the Description property of XMLAnnotation.

Parameters
XMLAnnotationIndexthe XMLAnnotation index.
Returns
the Description property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getXMLAnnotationID()

const std::string & ome::xml::meta::OMEXMLMetadata::getXMLAnnotationID ( index_type  XMLAnnotationIndex) const
virtual

Get the ID property of XMLAnnotation.

Parameters
XMLAnnotationIndexthe XMLAnnotation index.
Returns
the ID property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getXMLAnnotationNamespace()

const std::string & ome::xml::meta::OMEXMLMetadata::getXMLAnnotationNamespace ( index_type  XMLAnnotationIndex) const
virtual

Get the Namespace property of XMLAnnotation.

Parameters
XMLAnnotationIndexthe XMLAnnotation index.
Returns
the Namespace property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ getXMLAnnotationValue()

const std::string & ome::xml::meta::OMEXMLMetadata::getXMLAnnotationValue ( index_type  XMLAnnotationIndex) const
virtual

Get the Value property of XMLAnnotation.

Parameters
XMLAnnotationIndexthe XMLAnnotation index.
Returns
the Value property.

Implements ome::xml::meta::MetadataRetrieve.

References root.

◆ resolveReferences()

OMEXMLMetadata::index_type ome::xml::meta::OMEXMLMetadata::resolveReferences ( )

Resolve all references.

Check for invalid references and null model objects.

Returns
the number of unhandled references.
See also
OMEModel::resolveReferences.

References model.

Referenced by dumpXML().

+ Here is the caller graph for this function:

◆ setArcAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setArcAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Arc.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setArcID()

void ome::xml::meta::OMEXMLMetadata::setArcID ( const std::string &  id,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the ID property of Arc.

Parameters
idID to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setArcLotNumber()

void ome::xml::meta::OMEXMLMetadata::setArcLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the LotNumber property of Arc.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setArcManufacturer()

void ome::xml::meta::OMEXMLMetadata::setArcManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Manufacturer property of Arc.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setArcModel()

void ome::xml::meta::OMEXMLMetadata::setArcModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Model property of Arc.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setArcPower()

void ome::xml::meta::OMEXMLMetadata::setArcPower ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower power,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Power property of Arc.

Parameters
powerPower to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setArcSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setArcSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the SerialNumber property of Arc.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setArcType()

void ome::xml::meta::OMEXMLMetadata::setArcType ( ome::xml::model::enums::ArcType  type,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Type property of Arc.

Parameters
typeType to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBinaryFileBinData()

void ome::xml::meta::OMEXMLMetadata::setBinaryFileBinData ( const std::vector< uint8_t > &  base64Binary,
index_type  fileAnnotationIndex 
)
virtual

Set the Base64Binary property of BinData.

Parameters
base64BinaryBase64Binary to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBinaryFileBinDataBigEndian()

void ome::xml::meta::OMEXMLMetadata::setBinaryFileBinDataBigEndian ( bool  bigEndian,
index_type  fileAnnotationIndex 
)
virtual

Set the BigEndian property of BinData.

Parameters
bigEndianBigEndian to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBinaryFileBinDataCompression()

void ome::xml::meta::OMEXMLMetadata::setBinaryFileBinDataCompression ( ome::xml::model::enums::Compression  compression,
index_type  fileAnnotationIndex 
)
virtual

Set the Compression property of BinData.

Parameters
compressionCompression to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBinaryFileBinDataLength()

void ome::xml::meta::OMEXMLMetadata::setBinaryFileBinDataLength ( ome::xml::model::primitives::NonNegativeLong  length,
index_type  fileAnnotationIndex 
)
virtual

Set the Length property of BinData.

Parameters
lengthLength to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBinaryFileFileName()

void ome::xml::meta::OMEXMLMetadata::setBinaryFileFileName ( const std::string &  fileName,
index_type  fileAnnotationIndex 
)
virtual

Set the FileName property of BinaryFile.

Parameters
fileNameFileName to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBinaryFileMIMEType()

void ome::xml::meta::OMEXMLMetadata::setBinaryFileMIMEType ( const std::string &  mimeType,
index_type  fileAnnotationIndex 
)
virtual

Set the MIMEType property of BinaryFile.

Parameters
mimeTypeMIMEType to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBinaryFileSize()

void ome::xml::meta::OMEXMLMetadata::setBinaryFileSize ( ome::xml::model::primitives::NonNegativeLong  size,
index_type  fileAnnotationIndex 
)
virtual

Set the Size property of BinaryFile.

Parameters
sizeSize to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBinaryOnlyMetadataFile()

void ome::xml::meta::OMEXMLMetadata::setBinaryOnlyMetadataFile ( const std::string &  metadataFile)
virtual

Set the MetadataFile property of BinaryOnly.

Parameters
metadataFileMetadataFile to set.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBinaryOnlyUUID()

void ome::xml::meta::OMEXMLMetadata::setBinaryOnlyUUID ( const std::string &  uuid)
virtual

Set the UUID property of BinaryOnly.

Parameters
uuidUUID to set.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBooleanAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setBooleanAnnotationAnnotationRef ( const std::string &  annotation,
index_type  booleanAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of BooleanAnnotation.

Parameters
annotationAnnotationRef to set.
booleanAnnotationIndexthe BooleanAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setBooleanAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setBooleanAnnotationAnnotator ( const std::string &  annotator,
index_type  booleanAnnotationIndex 
)
virtual

Set the Annotator property of BooleanAnnotation.

Parameters
annotatorAnnotator to set.
booleanAnnotationIndexthe BooleanAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBooleanAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setBooleanAnnotationDescription ( const std::string &  description,
index_type  booleanAnnotationIndex 
)
virtual

Set the Description property of BooleanAnnotation.

Parameters
descriptionDescription to set.
booleanAnnotationIndexthe BooleanAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBooleanAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setBooleanAnnotationID ( const std::string &  id,
index_type  booleanAnnotationIndex 
)
virtual

Set the ID property of BooleanAnnotation.

Parameters
idID to set.
booleanAnnotationIndexthe BooleanAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setBooleanAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setBooleanAnnotationNamespace ( const std::string &  namespace_,
index_type  booleanAnnotationIndex 
)
virtual

Set the Namespace property of BooleanAnnotation.

Parameters
namespace_Namespace to set.
booleanAnnotationIndexthe BooleanAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setBooleanAnnotationValue()

void ome::xml::meta::OMEXMLMetadata::setBooleanAnnotationValue ( bool  value,
index_type  booleanAnnotationIndex 
)
virtual

Set the Value property of BooleanAnnotation.

Parameters
valueValue to set.
booleanAnnotationIndexthe BooleanAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelAcquisitionMode()

void ome::xml::meta::OMEXMLMetadata::setChannelAcquisitionMode ( ome::xml::model::enums::AcquisitionMode  acquisitionMode,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the AcquisitionMode property of Channel.

Parameters
acquisitionModeAcquisitionMode to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setChannelAnnotationRef ( const std::string &  annotation,
index_type  imageIndex,
index_type  channelIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Channel.

Parameters
annotationAnnotationRef to set.
imageIndexthe Image index.
channelIndexthe Channel index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setChannelColor()

void ome::xml::meta::OMEXMLMetadata::setChannelColor ( ome::xml::model::primitives::Color  color,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Color property of Channel.

Parameters
colorColor to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelContrastMethod()

void ome::xml::meta::OMEXMLMetadata::setChannelContrastMethod ( ome::xml::model::enums::ContrastMethod  contrastMethod,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the ContrastMethod property of Channel.

Parameters
contrastMethodContrastMethod to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelEmissionWavelength()

void ome::xml::meta::OMEXMLMetadata::setChannelEmissionWavelength ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat emissionWavelength,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the EmissionWavelength property of Channel.

Parameters
emissionWavelengthEmissionWavelength to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelExcitationWavelength()

void ome::xml::meta::OMEXMLMetadata::setChannelExcitationWavelength ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat excitationWavelength,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the ExcitationWavelength property of Channel.

Parameters
excitationWavelengthExcitationWavelength to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelFilterSetRef()

void ome::xml::meta::OMEXMLMetadata::setChannelFilterSetRef ( const std::string &  filterSet,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the FilterSetRef property of Channel.

Parameters
filterSetFilterSetRef to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setChannelFluor()

void ome::xml::meta::OMEXMLMetadata::setChannelFluor ( const std::string &  fluor,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Fluor property of Channel.

Parameters
fluorFluor to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelID()

void ome::xml::meta::OMEXMLMetadata::setChannelID ( const std::string &  id,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the ID property of Channel.

Parameters
idID to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setChannelIlluminationType()

void ome::xml::meta::OMEXMLMetadata::setChannelIlluminationType ( ome::xml::model::enums::IlluminationType  illuminationType,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the IlluminationType property of Channel.

Parameters
illuminationTypeIlluminationType to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelLightSourceSettingsAttenuation()

void ome::xml::meta::OMEXMLMetadata::setChannelLightSourceSettingsAttenuation ( ome::xml::model::primitives::PercentFraction  attenuation,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Attenuation property of LightSourceSettings.

Parameters
attenuationAttenuation to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelLightSourceSettingsID()

void ome::xml::meta::OMEXMLMetadata::setChannelLightSourceSettingsID ( const std::string &  id,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the ID property of LightSourceSettings.

Parameters
idID to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setChannelLightSourceSettingsWavelength()

void ome::xml::meta::OMEXMLMetadata::setChannelLightSourceSettingsWavelength ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat wavelength,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Wavelength property of LightSourceSettings.

Parameters
wavelengthWavelength to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelName()

void ome::xml::meta::OMEXMLMetadata::setChannelName ( const std::string &  name,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Name property of Channel.

Parameters
nameName to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelNDFilter()

void ome::xml::meta::OMEXMLMetadata::setChannelNDFilter ( double  ndFilter,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the NDFilter property of Channel.

Parameters
ndFilterNDFilter to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelPinholeSize()

void ome::xml::meta::OMEXMLMetadata::setChannelPinholeSize ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength pinholeSize,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the PinholeSize property of Channel.

Parameters
pinholeSizePinholeSize to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelPockelCellSetting()

void ome::xml::meta::OMEXMLMetadata::setChannelPockelCellSetting ( int32_t  pockelCellSetting,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the PockelCellSetting property of Channel.

Parameters
pockelCellSettingPockelCellSetting to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setChannelSamplesPerPixel()

void ome::xml::meta::OMEXMLMetadata::setChannelSamplesPerPixel ( ome::xml::model::primitives::PositiveInteger  samplesPerPixel,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the SamplesPerPixel property of Channel.

Parameters
samplesPerPixelSamplesPerPixel to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setCommentAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setCommentAnnotationAnnotationRef ( const std::string &  annotation,
index_type  commentAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of CommentAnnotation.

Parameters
annotationAnnotationRef to set.
commentAnnotationIndexthe CommentAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setCommentAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setCommentAnnotationAnnotator ( const std::string &  annotator,
index_type  commentAnnotationIndex 
)
virtual

Set the Annotator property of CommentAnnotation.

Parameters
annotatorAnnotator to set.
commentAnnotationIndexthe CommentAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setCommentAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setCommentAnnotationDescription ( const std::string &  description,
index_type  commentAnnotationIndex 
)
virtual

Set the Description property of CommentAnnotation.

Parameters
descriptionDescription to set.
commentAnnotationIndexthe CommentAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setCommentAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setCommentAnnotationID ( const std::string &  id,
index_type  commentAnnotationIndex 
)
virtual

Set the ID property of CommentAnnotation.

Parameters
idID to set.
commentAnnotationIndexthe CommentAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setCommentAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setCommentAnnotationNamespace ( const std::string &  namespace_,
index_type  commentAnnotationIndex 
)
virtual

Set the Namespace property of CommentAnnotation.

Parameters
namespace_Namespace to set.
commentAnnotationIndexthe CommentAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setCommentAnnotationValue()

void ome::xml::meta::OMEXMLMetadata::setCommentAnnotationValue ( const std::string &  value,
index_type  commentAnnotationIndex 
)
virtual

Set the Value property of CommentAnnotation.

Parameters
valueValue to set.
commentAnnotationIndexthe CommentAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDatasetAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setDatasetAnnotationRef ( const std::string &  annotation,
index_type  datasetIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Dataset.

Parameters
annotationAnnotationRef to set.
datasetIndexthe Dataset index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDatasetDescription()

void ome::xml::meta::OMEXMLMetadata::setDatasetDescription ( const std::string &  description,
index_type  datasetIndex 
)
virtual

Set the Description property of Dataset.

Parameters
descriptionDescription to set.
datasetIndexthe Dataset index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDatasetExperimenterGroupRef()

void ome::xml::meta::OMEXMLMetadata::setDatasetExperimenterGroupRef ( const std::string &  experimenterGroup,
index_type  datasetIndex 
)
virtual

Set the ExperimenterGroupRef property of Dataset.

Parameters
experimenterGroupExperimenterGroupRef to set.
datasetIndexthe Dataset index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDatasetExperimenterRef()

void ome::xml::meta::OMEXMLMetadata::setDatasetExperimenterRef ( const std::string &  experimenter,
index_type  datasetIndex 
)
virtual

Set the ExperimenterRef property of Dataset.

Parameters
experimenterExperimenterRef to set.
datasetIndexthe Dataset index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDatasetID()

void ome::xml::meta::OMEXMLMetadata::setDatasetID ( const std::string &  id,
index_type  datasetIndex 
)
virtual

Set the ID property of Dataset.

Parameters
idID to set.
datasetIndexthe Dataset index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDatasetImageRef()

void ome::xml::meta::OMEXMLMetadata::setDatasetImageRef ( const std::string &  image,
index_type  datasetIndex,
index_type  imageRefIndex 
)
virtual

Set the ImageRef property of Dataset.

Parameters
imageImageRef to set.
datasetIndexthe Dataset index.
imageRefIndexImageRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDatasetName()

void ome::xml::meta::OMEXMLMetadata::setDatasetName ( const std::string &  name,
index_type  datasetIndex 
)
virtual

Set the Name property of Dataset.

Parameters
nameName to set.
datasetIndexthe Dataset index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorAmplificationGain()

void ome::xml::meta::OMEXMLMetadata::setDetectorAmplificationGain ( double  amplificationGain,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the AmplificationGain property of Detector.

Parameters
amplificationGainAmplificationGain to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setDetectorAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  detectorIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Detector.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDetectorGain()

void ome::xml::meta::OMEXMLMetadata::setDetectorGain ( double  gain,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the Gain property of Detector.

Parameters
gainGain to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorID()

void ome::xml::meta::OMEXMLMetadata::setDetectorID ( const std::string &  id,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the ID property of Detector.

Parameters
idID to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDetectorLotNumber()

void ome::xml::meta::OMEXMLMetadata::setDetectorLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the LotNumber property of Detector.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorManufacturer()

void ome::xml::meta::OMEXMLMetadata::setDetectorManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the Manufacturer property of Detector.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorModel()

void ome::xml::meta::OMEXMLMetadata::setDetectorModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the Model property of Detector.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorOffset()

void ome::xml::meta::OMEXMLMetadata::setDetectorOffset ( double  offset,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the Offset property of Detector.

Parameters
offsetOffset to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setDetectorSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the SerialNumber property of Detector.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorSettingsBinning()

void ome::xml::meta::OMEXMLMetadata::setDetectorSettingsBinning ( ome::xml::model::enums::Binning  binning,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Binning property of DetectorSettings.

Parameters
binningBinning to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorSettingsGain()

void ome::xml::meta::OMEXMLMetadata::setDetectorSettingsGain ( double  gain,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Gain property of DetectorSettings.

Parameters
gainGain to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorSettingsID()

void ome::xml::meta::OMEXMLMetadata::setDetectorSettingsID ( const std::string &  id,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the ID property of DetectorSettings.

Parameters
idID to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDetectorSettingsIntegration()

void ome::xml::meta::OMEXMLMetadata::setDetectorSettingsIntegration ( ome::xml::model::primitives::PositiveInteger  integration,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Integration property of DetectorSettings.

Parameters
integrationIntegration to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorSettingsOffset()

void ome::xml::meta::OMEXMLMetadata::setDetectorSettingsOffset ( double  offset,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Offset property of DetectorSettings.

Parameters
offsetOffset to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorSettingsReadOutRate()

void ome::xml::meta::OMEXMLMetadata::setDetectorSettingsReadOutRate ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency readOutRate,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the ReadOutRate property of DetectorSettings.

Parameters
readOutRateReadOutRate to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorSettingsVoltage()

void ome::xml::meta::OMEXMLMetadata::setDetectorSettingsVoltage ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential voltage,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Voltage property of DetectorSettings.

Parameters
voltageVoltage to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorSettingsZoom()

void ome::xml::meta::OMEXMLMetadata::setDetectorSettingsZoom ( double  zoom,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the Zoom property of DetectorSettings.

Parameters
zoomZoom to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorType()

void ome::xml::meta::OMEXMLMetadata::setDetectorType ( ome::xml::model::enums::DetectorType  type,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the Type property of Detector.

Parameters
typeType to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorVoltage()

void ome::xml::meta::OMEXMLMetadata::setDetectorVoltage ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsElectricPotential voltage,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the Voltage property of Detector.

Parameters
voltageVoltage to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDetectorZoom()

void ome::xml::meta::OMEXMLMetadata::setDetectorZoom ( double  zoom,
index_type  instrumentIndex,
index_type  detectorIndex 
)
virtual

Set the Zoom property of Detector.

Parameters
zoomZoom to set.
instrumentIndexthe Instrument index.
detectorIndexthe Detector index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDichroicAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setDichroicAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  dichroicIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Dichroic.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDichroicID()

void ome::xml::meta::OMEXMLMetadata::setDichroicID ( const std::string &  id,
index_type  instrumentIndex,
index_type  dichroicIndex 
)
virtual

Set the ID property of Dichroic.

Parameters
idID to set.
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDichroicLotNumber()

void ome::xml::meta::OMEXMLMetadata::setDichroicLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  dichroicIndex 
)
virtual

Set the LotNumber property of Dichroic.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDichroicManufacturer()

void ome::xml::meta::OMEXMLMetadata::setDichroicManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  dichroicIndex 
)
virtual

Set the Manufacturer property of Dichroic.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDichroicModel()

void ome::xml::meta::OMEXMLMetadata::setDichroicModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  dichroicIndex 
)
virtual

Set the Model property of Dichroic.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDichroicSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setDichroicSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  dichroicIndex 
)
virtual

Set the SerialNumber property of Dichroic.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
dichroicIndexthe Dichroic index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDoubleAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setDoubleAnnotationAnnotationRef ( const std::string &  annotation,
index_type  doubleAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of DoubleAnnotation.

Parameters
annotationAnnotationRef to set.
doubleAnnotationIndexthe DoubleAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDoubleAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setDoubleAnnotationAnnotator ( const std::string &  annotator,
index_type  doubleAnnotationIndex 
)
virtual

Set the Annotator property of DoubleAnnotation.

Parameters
annotatorAnnotator to set.
doubleAnnotationIndexthe DoubleAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDoubleAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setDoubleAnnotationDescription ( const std::string &  description,
index_type  doubleAnnotationIndex 
)
virtual

Set the Description property of DoubleAnnotation.

Parameters
descriptionDescription to set.
doubleAnnotationIndexthe DoubleAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDoubleAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setDoubleAnnotationID ( const std::string &  id,
index_type  doubleAnnotationIndex 
)
virtual

Set the ID property of DoubleAnnotation.

Parameters
idID to set.
doubleAnnotationIndexthe DoubleAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setDoubleAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setDoubleAnnotationNamespace ( const std::string &  namespace_,
index_type  doubleAnnotationIndex 
)
virtual

Set the Namespace property of DoubleAnnotation.

Parameters
namespace_Namespace to set.
doubleAnnotationIndexthe DoubleAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setDoubleAnnotationValue()

void ome::xml::meta::OMEXMLMetadata::setDoubleAnnotationValue ( double  value,
index_type  doubleAnnotationIndex 
)
virtual

Set the Value property of DoubleAnnotation.

Parameters
valueValue to set.
doubleAnnotationIndexthe DoubleAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setEllipseAnnotationRef ( const std::string &  annotation,
index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Ellipse.

Parameters
annotationAnnotationRef to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setEllipseFillColor()

void ome::xml::meta::OMEXMLMetadata::setEllipseFillColor ( ome::xml::model::primitives::Color  fillColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillColor property of Ellipse.

Parameters
fillColorFillColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseFillRule()

void ome::xml::meta::OMEXMLMetadata::setEllipseFillRule ( ome::xml::model::enums::FillRule  fillRule,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillRule property of Ellipse.

Parameters
fillRuleFillRule to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseFontFamily()

void ome::xml::meta::OMEXMLMetadata::setEllipseFontFamily ( ome::xml::model::enums::FontFamily  fontFamily,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontFamily property of Ellipse.

Parameters
fontFamilyFontFamily to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseFontSize()

void ome::xml::meta::OMEXMLMetadata::setEllipseFontSize ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger fontSize,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontSize property of Ellipse.

Parameters
fontSizeFontSize to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseFontStyle()

void ome::xml::meta::OMEXMLMetadata::setEllipseFontStyle ( ome::xml::model::enums::FontStyle  fontStyle,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontStyle property of Ellipse.

Parameters
fontStyleFontStyle to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseID()

void ome::xml::meta::OMEXMLMetadata::setEllipseID ( const std::string &  id,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the ID property of Ellipse.

Parameters
idID to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setEllipseLocked()

void ome::xml::meta::OMEXMLMetadata::setEllipseLocked ( bool  locked,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Locked property of Ellipse.

Parameters
lockedLocked to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseRadiusX()

void ome::xml::meta::OMEXMLMetadata::setEllipseRadiusX ( double  radiusX,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the RadiusX property of Ellipse.

Parameters
radiusXRadiusX to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseRadiusY()

void ome::xml::meta::OMEXMLMetadata::setEllipseRadiusY ( double  radiusY,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the RadiusY property of Ellipse.

Parameters
radiusYRadiusY to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseStrokeColor()

void ome::xml::meta::OMEXMLMetadata::setEllipseStrokeColor ( ome::xml::model::primitives::Color  strokeColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeColor property of Ellipse.

Parameters
strokeColorStrokeColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseStrokeDashArray()

void ome::xml::meta::OMEXMLMetadata::setEllipseStrokeDashArray ( const std::string &  strokeDashArray,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeDashArray property of Ellipse.

Parameters
strokeDashArrayStrokeDashArray to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseStrokeWidth()

void ome::xml::meta::OMEXMLMetadata::setEllipseStrokeWidth ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength strokeWidth,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeWidth property of Ellipse.

Parameters
strokeWidthStrokeWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseText()

void ome::xml::meta::OMEXMLMetadata::setEllipseText ( const std::string &  text,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Text property of Ellipse.

Parameters
textText to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseTheC()

void ome::xml::meta::OMEXMLMetadata::setEllipseTheC ( ome::xml::model::primitives::NonNegativeInteger  theC,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheC property of Ellipse.

Parameters
theCTheC to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseTheT()

void ome::xml::meta::OMEXMLMetadata::setEllipseTheT ( ome::xml::model::primitives::NonNegativeInteger  theT,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheT property of Ellipse.

Parameters
theTTheT to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseTheZ()

void ome::xml::meta::OMEXMLMetadata::setEllipseTheZ ( ome::xml::model::primitives::NonNegativeInteger  theZ,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheZ property of Ellipse.

Parameters
theZTheZ to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseTransform()

void ome::xml::meta::OMEXMLMetadata::setEllipseTransform ( const ::ome::xml::model::AffineTransform transform,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Transform property of Ellipse.

Parameters
transformTransform to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseX()

void ome::xml::meta::OMEXMLMetadata::setEllipseX ( double  x,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the X property of Ellipse.

Parameters
xX to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setEllipseY()

void ome::xml::meta::OMEXMLMetadata::setEllipseY ( double  y,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Y property of Ellipse.

Parameters
yY to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimentDescription()

void ome::xml::meta::OMEXMLMetadata::setExperimentDescription ( const std::string &  description,
index_type  experimentIndex 
)
virtual

Set the Description property of Experiment.

Parameters
descriptionDescription to set.
experimentIndexthe Experiment index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimenterAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setExperimenterAnnotationRef ( const std::string &  annotation,
index_type  experimenterIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Experimenter.

Parameters
annotationAnnotationRef to set.
experimenterIndexthe Experimenter index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setExperimenterEmail()

void ome::xml::meta::OMEXMLMetadata::setExperimenterEmail ( const std::string &  email,
index_type  experimenterIndex 
)
virtual

Set the Email property of Experimenter.

Parameters
emailEmail to set.
experimenterIndexthe Experimenter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimenterFirstName()

void ome::xml::meta::OMEXMLMetadata::setExperimenterFirstName ( const std::string &  firstName,
index_type  experimenterIndex 
)
virtual

Set the FirstName property of Experimenter.

Parameters
firstNameFirstName to set.
experimenterIndexthe Experimenter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimenterGroupAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setExperimenterGroupAnnotationRef ( const std::string &  annotation,
index_type  experimenterGroupIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of ExperimenterGroup.

Parameters
annotationAnnotationRef to set.
experimenterGroupIndexthe ExperimenterGroup index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setExperimenterGroupDescription()

void ome::xml::meta::OMEXMLMetadata::setExperimenterGroupDescription ( const std::string &  description,
index_type  experimenterGroupIndex 
)
virtual

Set the Description property of ExperimenterGroup.

Parameters
descriptionDescription to set.
experimenterGroupIndexthe ExperimenterGroup index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimenterGroupExperimenterRef()

void ome::xml::meta::OMEXMLMetadata::setExperimenterGroupExperimenterRef ( const std::string &  experimenter,
index_type  experimenterGroupIndex,
index_type  experimenterRefIndex 
)
virtual

Set the ExperimenterRef property of ExperimenterGroup.

Parameters
experimenterExperimenterRef to set.
experimenterGroupIndexthe ExperimenterGroup index.
experimenterRefIndexExperimenterRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setExperimenterGroupID()

void ome::xml::meta::OMEXMLMetadata::setExperimenterGroupID ( const std::string &  id,
index_type  experimenterGroupIndex 
)
virtual

Set the ID property of ExperimenterGroup.

Parameters
idID to set.
experimenterGroupIndexthe ExperimenterGroup index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setExperimenterGroupLeader()

void ome::xml::meta::OMEXMLMetadata::setExperimenterGroupLeader ( const std::string &  leader,
index_type  experimenterGroupIndex,
index_type  leaderIndex 
)
virtual

Set the Leader property of ExperimenterGroup.

Parameters
leaderLeader to set.
experimenterGroupIndexthe ExperimenterGroup index.
leaderIndexLeader index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setExperimenterGroupName()

void ome::xml::meta::OMEXMLMetadata::setExperimenterGroupName ( const std::string &  name,
index_type  experimenterGroupIndex 
)
virtual

Set the Name property of ExperimenterGroup.

Parameters
nameName to set.
experimenterGroupIndexthe ExperimenterGroup index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimenterID()

void ome::xml::meta::OMEXMLMetadata::setExperimenterID ( const std::string &  id,
index_type  experimenterIndex 
)
virtual

Set the ID property of Experimenter.

Parameters
idID to set.
experimenterIndexthe Experimenter index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setExperimenterInstitution()

void ome::xml::meta::OMEXMLMetadata::setExperimenterInstitution ( const std::string &  institution,
index_type  experimenterIndex 
)
virtual

Set the Institution property of Experimenter.

Parameters
institutionInstitution to set.
experimenterIndexthe Experimenter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimenterLastName()

void ome::xml::meta::OMEXMLMetadata::setExperimenterLastName ( const std::string &  lastName,
index_type  experimenterIndex 
)
virtual

Set the LastName property of Experimenter.

Parameters
lastNameLastName to set.
experimenterIndexthe Experimenter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimenterMiddleName()

void ome::xml::meta::OMEXMLMetadata::setExperimenterMiddleName ( const std::string &  middleName,
index_type  experimenterIndex 
)
virtual

Set the MiddleName property of Experimenter.

Parameters
middleNameMiddleName to set.
experimenterIndexthe Experimenter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimenterUserName()

void ome::xml::meta::OMEXMLMetadata::setExperimenterUserName ( const std::string &  userName,
index_type  experimenterIndex 
)
virtual

Set the UserName property of Experimenter.

Parameters
userNameUserName to set.
experimenterIndexthe Experimenter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setExperimentExperimenterRef()

void ome::xml::meta::OMEXMLMetadata::setExperimentExperimenterRef ( const std::string &  experimenter,
index_type  experimentIndex 
)
virtual

Set the ExperimenterRef property of Experiment.

Parameters
experimenterExperimenterRef to set.
experimentIndexthe Experiment index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setExperimentID()

void ome::xml::meta::OMEXMLMetadata::setExperimentID ( const std::string &  id,
index_type  experimentIndex 
)
virtual

Set the ID property of Experiment.

Parameters
idID to set.
experimentIndexthe Experiment index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setExperimentType()

void ome::xml::meta::OMEXMLMetadata::setExperimentType ( ome::xml::model::enums::ExperimentType  type,
index_type  experimentIndex 
)
virtual

Set the Type property of Experiment.

Parameters
typeType to set.
experimentIndexthe Experiment index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilamentAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setFilamentAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Filament.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFilamentID()

void ome::xml::meta::OMEXMLMetadata::setFilamentID ( const std::string &  id,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the ID property of Filament.

Parameters
idID to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFilamentLotNumber()

void ome::xml::meta::OMEXMLMetadata::setFilamentLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the LotNumber property of Filament.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilamentManufacturer()

void ome::xml::meta::OMEXMLMetadata::setFilamentManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Manufacturer property of Filament.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilamentModel()

void ome::xml::meta::OMEXMLMetadata::setFilamentModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Model property of Filament.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilamentPower()

void ome::xml::meta::OMEXMLMetadata::setFilamentPower ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower power,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Power property of Filament.

Parameters
powerPower to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilamentSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setFilamentSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the SerialNumber property of Filament.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilamentType()

void ome::xml::meta::OMEXMLMetadata::setFilamentType ( ome::xml::model::enums::FilamentType  type,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Type property of Filament.

Parameters
typeType to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFileAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setFileAnnotationAnnotationRef ( const std::string &  annotation,
index_type  fileAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of FileAnnotation.

Parameters
annotationAnnotationRef to set.
fileAnnotationIndexthe FileAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFileAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setFileAnnotationAnnotator ( const std::string &  annotator,
index_type  fileAnnotationIndex 
)
virtual

Set the Annotator property of FileAnnotation.

Parameters
annotatorAnnotator to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFileAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setFileAnnotationDescription ( const std::string &  description,
index_type  fileAnnotationIndex 
)
virtual

Set the Description property of FileAnnotation.

Parameters
descriptionDescription to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFileAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setFileAnnotationID ( const std::string &  id,
index_type  fileAnnotationIndex 
)
virtual

Set the ID property of FileAnnotation.

Parameters
idID to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFileAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setFileAnnotationNamespace ( const std::string &  namespace_,
index_type  fileAnnotationIndex 
)
virtual

Set the Namespace property of FileAnnotation.

Parameters
namespace_Namespace to set.
fileAnnotationIndexthe FileAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setFilterAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  filterIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Filter.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFilterFilterWheel()

void ome::xml::meta::OMEXMLMetadata::setFilterFilterWheel ( const std::string &  filterWheel,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the FilterWheel property of Filter.

Parameters
filterWheelFilterWheel to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterID()

void ome::xml::meta::OMEXMLMetadata::setFilterID ( const std::string &  id,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the ID property of Filter.

Parameters
idID to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFilterLotNumber()

void ome::xml::meta::OMEXMLMetadata::setFilterLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the LotNumber property of Filter.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterManufacturer()

void ome::xml::meta::OMEXMLMetadata::setFilterManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the Manufacturer property of Filter.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterModel()

void ome::xml::meta::OMEXMLMetadata::setFilterModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the Model property of Filter.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setFilterSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the SerialNumber property of Filter.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterSetDichroicRef()

void ome::xml::meta::OMEXMLMetadata::setFilterSetDichroicRef ( const std::string &  dichroic,
index_type  instrumentIndex,
index_type  filterSetIndex 
)
virtual

Set the DichroicRef property of FilterSet.

Parameters
dichroicDichroicRef to set.
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFilterSetEmissionFilterRef()

void ome::xml::meta::OMEXMLMetadata::setFilterSetEmissionFilterRef ( const std::string &  emissionFilter,
index_type  instrumentIndex,
index_type  filterSetIndex,
index_type  emissionFilterRefIndex 
)
virtual

Set the EmissionFilterRef property of FilterSet.

Parameters
emissionFilterEmissionFilterRef to set.
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
emissionFilterRefIndexEmissionFilterRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFilterSetExcitationFilterRef()

void ome::xml::meta::OMEXMLMetadata::setFilterSetExcitationFilterRef ( const std::string &  excitationFilter,
index_type  instrumentIndex,
index_type  filterSetIndex,
index_type  excitationFilterRefIndex 
)
virtual

Set the ExcitationFilterRef property of FilterSet.

Parameters
excitationFilterExcitationFilterRef to set.
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.
excitationFilterRefIndexExcitationFilterRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFilterSetID()

void ome::xml::meta::OMEXMLMetadata::setFilterSetID ( const std::string &  id,
index_type  instrumentIndex,
index_type  filterSetIndex 
)
virtual

Set the ID property of FilterSet.

Parameters
idID to set.
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFilterSetLotNumber()

void ome::xml::meta::OMEXMLMetadata::setFilterSetLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  filterSetIndex 
)
virtual

Set the LotNumber property of FilterSet.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterSetManufacturer()

void ome::xml::meta::OMEXMLMetadata::setFilterSetManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  filterSetIndex 
)
virtual

Set the Manufacturer property of FilterSet.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterSetModel()

void ome::xml::meta::OMEXMLMetadata::setFilterSetModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  filterSetIndex 
)
virtual

Set the Model property of FilterSet.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterSetSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setFilterSetSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  filterSetIndex 
)
virtual

Set the SerialNumber property of FilterSet.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
filterSetIndexthe FilterSet index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFilterType()

void ome::xml::meta::OMEXMLMetadata::setFilterType ( ome::xml::model::enums::FilterType  type,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the Type property of Filter.

Parameters
typeType to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFolderAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setFolderAnnotationRef ( const std::string &  annotation,
index_type  folderIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Folder.

Parameters
annotationAnnotationRef to set.
folderIndexthe Folder index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFolderDescription()

void ome::xml::meta::OMEXMLMetadata::setFolderDescription ( const std::string &  description,
index_type  folderIndex 
)
virtual

Set the Description property of Folder.

Parameters
descriptionDescription to set.
folderIndexthe Folder index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFolderFolderRef()

void ome::xml::meta::OMEXMLMetadata::setFolderFolderRef ( const std::string &  folder,
index_type  folderIndex,
index_type  folderRefIndex 
)
virtual

Set the FolderRef property of Folder.

Parameters
folderFolderRef to set.
folderIndexthe Folder index.
folderRefIndexFolderRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFolderID()

void ome::xml::meta::OMEXMLMetadata::setFolderID ( const std::string &  id,
index_type  folderIndex 
)
virtual

Set the ID property of Folder.

Parameters
idID to set.
folderIndexthe Folder index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFolderImageRef()

void ome::xml::meta::OMEXMLMetadata::setFolderImageRef ( const std::string &  image,
index_type  folderIndex,
index_type  imageRefIndex 
)
virtual

Set the ImageRef property of Folder.

Parameters
imageImageRef to set.
folderIndexthe Folder index.
imageRefIndexImageRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setFolderName()

void ome::xml::meta::OMEXMLMetadata::setFolderName ( const std::string &  name,
index_type  folderIndex 
)
virtual

Set the Name property of Folder.

Parameters
nameName to set.
folderIndexthe Folder index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setFolderROIRef()

void ome::xml::meta::OMEXMLMetadata::setFolderROIRef ( const std::string &  roi,
index_type  folderIndex,
index_type  ROIRefIndex 
)
virtual

Set the ROIRef property of Folder.

Parameters
roiROIRef to set.
folderIndexthe Folder index.
ROIRefIndexROIRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setGenericExcitationSourceAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setGenericExcitationSourceAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of GenericExcitationSource.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setGenericExcitationSourceID()

void ome::xml::meta::OMEXMLMetadata::setGenericExcitationSourceID ( const std::string &  id,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the ID property of GenericExcitationSource.

Parameters
idID to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setGenericExcitationSourceLotNumber()

void ome::xml::meta::OMEXMLMetadata::setGenericExcitationSourceLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the LotNumber property of GenericExcitationSource.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setGenericExcitationSourceManufacturer()

void ome::xml::meta::OMEXMLMetadata::setGenericExcitationSourceManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Manufacturer property of GenericExcitationSource.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setGenericExcitationSourceMap()

void ome::xml::meta::OMEXMLMetadata::setGenericExcitationSourceMap ( const ome::xml::model::primitives::OrderedMultimap map,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the map value of GenericExcitationSource.

Parameters
mapthe map value to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setGenericExcitationSourceModel()

void ome::xml::meta::OMEXMLMetadata::setGenericExcitationSourceModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Model property of GenericExcitationSource.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setGenericExcitationSourcePower()

void ome::xml::meta::OMEXMLMetadata::setGenericExcitationSourcePower ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower power,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Power property of GenericExcitationSource.

Parameters
powerPower to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setGenericExcitationSourceSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setGenericExcitationSourceSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the SerialNumber property of GenericExcitationSource.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setImageAcquisitionDate()

void ome::xml::meta::OMEXMLMetadata::setImageAcquisitionDate ( ome::xml::model::primitives::Timestamp  acquisitionDate,
index_type  imageIndex 
)
virtual

Set the AcquisitionDate property of Image.

Parameters
acquisitionDateAcquisitionDate to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setImageAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setImageAnnotationRef ( const std::string &  annotation,
index_type  imageIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Image.

Parameters
annotationAnnotationRef to set.
imageIndexthe Image index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setImageDescription()

void ome::xml::meta::OMEXMLMetadata::setImageDescription ( const std::string &  description,
index_type  imageIndex 
)
virtual

Set the Description property of Image.

Parameters
descriptionDescription to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setImageExperimenterGroupRef()

void ome::xml::meta::OMEXMLMetadata::setImageExperimenterGroupRef ( const std::string &  experimenterGroup,
index_type  imageIndex 
)
virtual

Set the ExperimenterGroupRef property of Image.

Parameters
experimenterGroupExperimenterGroupRef to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setImageExperimenterRef()

void ome::xml::meta::OMEXMLMetadata::setImageExperimenterRef ( const std::string &  experimenter,
index_type  imageIndex 
)
virtual

Set the ExperimenterRef property of Image.

Parameters
experimenterExperimenterRef to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setImageExperimentRef()

void ome::xml::meta::OMEXMLMetadata::setImageExperimentRef ( const std::string &  experiment,
index_type  imageIndex 
)
virtual

Set the ExperimentRef property of Image.

Parameters
experimentExperimentRef to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setImageID()

void ome::xml::meta::OMEXMLMetadata::setImageID ( const std::string &  id,
index_type  imageIndex 
)
virtual

Set the ID property of Image.

Parameters
idID to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setImageInstrumentRef()

void ome::xml::meta::OMEXMLMetadata::setImageInstrumentRef ( const std::string &  instrument,
index_type  imageIndex 
)
virtual

Set the InstrumentRef property of Image.

Parameters
instrumentInstrumentRef to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setImageMicrobeamManipulationRef()

void ome::xml::meta::OMEXMLMetadata::setImageMicrobeamManipulationRef ( const std::string &  microbeamManipulation,
index_type  imageIndex,
index_type  microbeamManipulationRefIndex 
)
virtual

Set the MicrobeamManipulationRef property of Image.

Parameters
microbeamManipulationMicrobeamManipulationRef to set.
imageIndexthe Image index.
microbeamManipulationRefIndexMicrobeamManipulationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setImageName()

void ome::xml::meta::OMEXMLMetadata::setImageName ( const std::string &  name,
index_type  imageIndex 
)
virtual

Set the Name property of Image.

Parameters
nameName to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setImageROIRef()

void ome::xml::meta::OMEXMLMetadata::setImageROIRef ( const std::string &  roi,
index_type  imageIndex,
index_type  ROIRefIndex 
)
virtual

Set the ROIRef property of Image.

Parameters
roiROIRef to set.
imageIndexthe Image index.
ROIRefIndexROIRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setImagingEnvironmentAirPressure()

void ome::xml::meta::OMEXMLMetadata::setImagingEnvironmentAirPressure ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPressure airPressure,
index_type  imageIndex 
)
virtual

Set the AirPressure property of ImagingEnvironment.

Parameters
airPressureAirPressure to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setImagingEnvironmentCO2Percent()

void ome::xml::meta::OMEXMLMetadata::setImagingEnvironmentCO2Percent ( ome::xml::model::primitives::PercentFraction  co2Percent,
index_type  imageIndex 
)
virtual

Set the CO2Percent property of ImagingEnvironment.

Parameters
co2PercentCO2Percent to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setImagingEnvironmentHumidity()

void ome::xml::meta::OMEXMLMetadata::setImagingEnvironmentHumidity ( ome::xml::model::primitives::PercentFraction  humidity,
index_type  imageIndex 
)
virtual

Set the Humidity property of ImagingEnvironment.

Parameters
humidityHumidity to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setImagingEnvironmentMap()

void ome::xml::meta::OMEXMLMetadata::setImagingEnvironmentMap ( const ome::xml::model::primitives::OrderedMultimap map,
index_type  imageIndex 
)
virtual

Set the map value of ImagingEnvironment.

Parameters
mapthe map value to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setImagingEnvironmentTemperature()

void ome::xml::meta::OMEXMLMetadata::setImagingEnvironmentTemperature ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTemperature temperature,
index_type  imageIndex 
)
virtual

Set the Temperature property of ImagingEnvironment.

Parameters
temperatureTemperature to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setInstrumentAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setInstrumentAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Instrument.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setInstrumentID()

void ome::xml::meta::OMEXMLMetadata::setInstrumentID ( const std::string &  id,
index_type  instrumentIndex 
)
virtual

Set the ID property of Instrument.

Parameters
idID to set.
instrumentIndexthe Instrument index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLabelAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setLabelAnnotationRef ( const std::string &  annotation,
index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Label.

Parameters
annotationAnnotationRef to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLabelFillColor()

void ome::xml::meta::OMEXMLMetadata::setLabelFillColor ( ome::xml::model::primitives::Color  fillColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillColor property of Label.

Parameters
fillColorFillColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelFillRule()

void ome::xml::meta::OMEXMLMetadata::setLabelFillRule ( ome::xml::model::enums::FillRule  fillRule,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillRule property of Label.

Parameters
fillRuleFillRule to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelFontFamily()

void ome::xml::meta::OMEXMLMetadata::setLabelFontFamily ( ome::xml::model::enums::FontFamily  fontFamily,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontFamily property of Label.

Parameters
fontFamilyFontFamily to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelFontSize()

void ome::xml::meta::OMEXMLMetadata::setLabelFontSize ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger fontSize,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontSize property of Label.

Parameters
fontSizeFontSize to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelFontStyle()

void ome::xml::meta::OMEXMLMetadata::setLabelFontStyle ( ome::xml::model::enums::FontStyle  fontStyle,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontStyle property of Label.

Parameters
fontStyleFontStyle to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelID()

void ome::xml::meta::OMEXMLMetadata::setLabelID ( const std::string &  id,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the ID property of Label.

Parameters
idID to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLabelLocked()

void ome::xml::meta::OMEXMLMetadata::setLabelLocked ( bool  locked,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Locked property of Label.

Parameters
lockedLocked to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelStrokeColor()

void ome::xml::meta::OMEXMLMetadata::setLabelStrokeColor ( ome::xml::model::primitives::Color  strokeColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeColor property of Label.

Parameters
strokeColorStrokeColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelStrokeDashArray()

void ome::xml::meta::OMEXMLMetadata::setLabelStrokeDashArray ( const std::string &  strokeDashArray,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeDashArray property of Label.

Parameters
strokeDashArrayStrokeDashArray to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelStrokeWidth()

void ome::xml::meta::OMEXMLMetadata::setLabelStrokeWidth ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength strokeWidth,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeWidth property of Label.

Parameters
strokeWidthStrokeWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelText()

void ome::xml::meta::OMEXMLMetadata::setLabelText ( const std::string &  text,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Text property of Label.

Parameters
textText to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelTheC()

void ome::xml::meta::OMEXMLMetadata::setLabelTheC ( ome::xml::model::primitives::NonNegativeInteger  theC,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheC property of Label.

Parameters
theCTheC to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelTheT()

void ome::xml::meta::OMEXMLMetadata::setLabelTheT ( ome::xml::model::primitives::NonNegativeInteger  theT,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheT property of Label.

Parameters
theTTheT to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelTheZ()

void ome::xml::meta::OMEXMLMetadata::setLabelTheZ ( ome::xml::model::primitives::NonNegativeInteger  theZ,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheZ property of Label.

Parameters
theZTheZ to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelTransform()

void ome::xml::meta::OMEXMLMetadata::setLabelTransform ( const ::ome::xml::model::AffineTransform transform,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Transform property of Label.

Parameters
transformTransform to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelX()

void ome::xml::meta::OMEXMLMetadata::setLabelX ( double  x,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the X property of Label.

Parameters
xX to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLabelY()

void ome::xml::meta::OMEXMLMetadata::setLabelY ( double  y,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Y property of Label.

Parameters
yY to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setLaserAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Laser.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLaserFrequencyMultiplication()

void ome::xml::meta::OMEXMLMetadata::setLaserFrequencyMultiplication ( ome::xml::model::primitives::PositiveInteger  frequencyMultiplication,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the FrequencyMultiplication property of Laser.

Parameters
frequencyMultiplicationFrequencyMultiplication to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserID()

void ome::xml::meta::OMEXMLMetadata::setLaserID ( const std::string &  id,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the ID property of Laser.

Parameters
idID to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLaserLaserMedium()

void ome::xml::meta::OMEXMLMetadata::setLaserLaserMedium ( ome::xml::model::enums::LaserMedium  laserMedium,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the LaserMedium property of Laser.

Parameters
laserMediumLaserMedium to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserLotNumber()

void ome::xml::meta::OMEXMLMetadata::setLaserLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the LotNumber property of Laser.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserManufacturer()

void ome::xml::meta::OMEXMLMetadata::setLaserManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Manufacturer property of Laser.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserModel()

void ome::xml::meta::OMEXMLMetadata::setLaserModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Model property of Laser.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserPockelCell()

void ome::xml::meta::OMEXMLMetadata::setLaserPockelCell ( bool  pockelCell,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the PockelCell property of Laser.

Parameters
pockelCellPockelCell to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserPower()

void ome::xml::meta::OMEXMLMetadata::setLaserPower ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower power,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Power property of Laser.

Parameters
powerPower to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserPulse()

void ome::xml::meta::OMEXMLMetadata::setLaserPulse ( ome::xml::model::enums::Pulse  pulse,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Pulse property of Laser.

Parameters
pulsePulse to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserPump()

void ome::xml::meta::OMEXMLMetadata::setLaserPump ( const std::string &  pump,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Pump property of Laser.

Parameters
pumpPump to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLaserRepetitionRate()

void ome::xml::meta::OMEXMLMetadata::setLaserRepetitionRate ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency repetitionRate,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the RepetitionRate property of Laser.

Parameters
repetitionRateRepetitionRate to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setLaserSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the SerialNumber property of Laser.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserTuneable()

void ome::xml::meta::OMEXMLMetadata::setLaserTuneable ( bool  tuneable,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Tuneable property of Laser.

Parameters
tuneableTuneable to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserType()

void ome::xml::meta::OMEXMLMetadata::setLaserType ( ome::xml::model::enums::LaserType  type,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Type property of Laser.

Parameters
typeType to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLaserWavelength()

void ome::xml::meta::OMEXMLMetadata::setLaserWavelength ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat wavelength,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Wavelength property of Laser.

Parameters
wavelengthWavelength to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLightEmittingDiodeAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setLightEmittingDiodeAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  lightSourceIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of LightEmittingDiode.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLightEmittingDiodeID()

void ome::xml::meta::OMEXMLMetadata::setLightEmittingDiodeID ( const std::string &  id,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the ID property of LightEmittingDiode.

Parameters
idID to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLightEmittingDiodeLotNumber()

void ome::xml::meta::OMEXMLMetadata::setLightEmittingDiodeLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the LotNumber property of LightEmittingDiode.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLightEmittingDiodeManufacturer()

void ome::xml::meta::OMEXMLMetadata::setLightEmittingDiodeManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Manufacturer property of LightEmittingDiode.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLightEmittingDiodeModel()

void ome::xml::meta::OMEXMLMetadata::setLightEmittingDiodeModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Model property of LightEmittingDiode.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLightEmittingDiodePower()

void ome::xml::meta::OMEXMLMetadata::setLightEmittingDiodePower ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower power,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the Power property of LightEmittingDiode.

Parameters
powerPower to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLightEmittingDiodeSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setLightEmittingDiodeSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  lightSourceIndex 
)
virtual

Set the SerialNumber property of LightEmittingDiode.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
lightSourceIndexthe LightSource index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLightPathAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setLightPathAnnotationRef ( const std::string &  annotation,
index_type  imageIndex,
index_type  channelIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of LightPath.

Parameters
annotationAnnotationRef to set.
imageIndexthe Image index.
channelIndexthe Channel index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLightPathDichroicRef()

void ome::xml::meta::OMEXMLMetadata::setLightPathDichroicRef ( const std::string &  dichroic,
index_type  imageIndex,
index_type  channelIndex 
)
virtual

Set the DichroicRef property of LightPath.

Parameters
dichroicDichroicRef to set.
imageIndexthe Image index.
channelIndexthe Channel index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLightPathEmissionFilterRef()

void ome::xml::meta::OMEXMLMetadata::setLightPathEmissionFilterRef ( const std::string &  emissionFilter,
index_type  imageIndex,
index_type  channelIndex,
index_type  emissionFilterRefIndex 
)
virtual

Set the EmissionFilterRef property of LightPath.

Parameters
emissionFilterEmissionFilterRef to set.
imageIndexthe Image index.
channelIndexthe Channel index.
emissionFilterRefIndexEmissionFilterRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLightPathExcitationFilterRef()

void ome::xml::meta::OMEXMLMetadata::setLightPathExcitationFilterRef ( const std::string &  excitationFilter,
index_type  imageIndex,
index_type  channelIndex,
index_type  excitationFilterRefIndex 
)
virtual

Set the ExcitationFilterRef property of LightPath.

Parameters
excitationFilterExcitationFilterRef to set.
imageIndexthe Image index.
channelIndexthe Channel index.
excitationFilterRefIndexExcitationFilterRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLineAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setLineAnnotationRef ( const std::string &  annotation,
index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Line.

Parameters
annotationAnnotationRef to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLineFillColor()

void ome::xml::meta::OMEXMLMetadata::setLineFillColor ( ome::xml::model::primitives::Color  fillColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillColor property of Line.

Parameters
fillColorFillColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineFillRule()

void ome::xml::meta::OMEXMLMetadata::setLineFillRule ( ome::xml::model::enums::FillRule  fillRule,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillRule property of Line.

Parameters
fillRuleFillRule to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineFontFamily()

void ome::xml::meta::OMEXMLMetadata::setLineFontFamily ( ome::xml::model::enums::FontFamily  fontFamily,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontFamily property of Line.

Parameters
fontFamilyFontFamily to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineFontSize()

void ome::xml::meta::OMEXMLMetadata::setLineFontSize ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger fontSize,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontSize property of Line.

Parameters
fontSizeFontSize to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineFontStyle()

void ome::xml::meta::OMEXMLMetadata::setLineFontStyle ( ome::xml::model::enums::FontStyle  fontStyle,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontStyle property of Line.

Parameters
fontStyleFontStyle to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineID()

void ome::xml::meta::OMEXMLMetadata::setLineID ( const std::string &  id,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the ID property of Line.

Parameters
idID to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLineLocked()

void ome::xml::meta::OMEXMLMetadata::setLineLocked ( bool  locked,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Locked property of Line.

Parameters
lockedLocked to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineMarkerEnd()

void ome::xml::meta::OMEXMLMetadata::setLineMarkerEnd ( ome::xml::model::enums::Marker  markerEnd,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the MarkerEnd property of Line.

Parameters
markerEndMarkerEnd to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineMarkerStart()

void ome::xml::meta::OMEXMLMetadata::setLineMarkerStart ( ome::xml::model::enums::Marker  markerStart,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the MarkerStart property of Line.

Parameters
markerStartMarkerStart to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineStrokeColor()

void ome::xml::meta::OMEXMLMetadata::setLineStrokeColor ( ome::xml::model::primitives::Color  strokeColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeColor property of Line.

Parameters
strokeColorStrokeColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineStrokeDashArray()

void ome::xml::meta::OMEXMLMetadata::setLineStrokeDashArray ( const std::string &  strokeDashArray,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeDashArray property of Line.

Parameters
strokeDashArrayStrokeDashArray to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineStrokeWidth()

void ome::xml::meta::OMEXMLMetadata::setLineStrokeWidth ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength strokeWidth,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeWidth property of Line.

Parameters
strokeWidthStrokeWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineText()

void ome::xml::meta::OMEXMLMetadata::setLineText ( const std::string &  text,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Text property of Line.

Parameters
textText to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineTheC()

void ome::xml::meta::OMEXMLMetadata::setLineTheC ( ome::xml::model::primitives::NonNegativeInteger  theC,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheC property of Line.

Parameters
theCTheC to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineTheT()

void ome::xml::meta::OMEXMLMetadata::setLineTheT ( ome::xml::model::primitives::NonNegativeInteger  theT,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheT property of Line.

Parameters
theTTheT to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineTheZ()

void ome::xml::meta::OMEXMLMetadata::setLineTheZ ( ome::xml::model::primitives::NonNegativeInteger  theZ,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheZ property of Line.

Parameters
theZTheZ to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineTransform()

void ome::xml::meta::OMEXMLMetadata::setLineTransform ( const ::ome::xml::model::AffineTransform transform,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Transform property of Line.

Parameters
transformTransform to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineX1()

void ome::xml::meta::OMEXMLMetadata::setLineX1 ( double  x1,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the X1 property of Line.

Parameters
x1X1 to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineX2()

void ome::xml::meta::OMEXMLMetadata::setLineX2 ( double  x2,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the X2 property of Line.

Parameters
x2X2 to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineY1()

void ome::xml::meta::OMEXMLMetadata::setLineY1 ( double  y1,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Y1 property of Line.

Parameters
y1Y1 to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLineY2()

void ome::xml::meta::OMEXMLMetadata::setLineY2 ( double  y2,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Y2 property of Line.

Parameters
y2Y2 to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setListAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setListAnnotationAnnotationRef ( const std::string &  annotation,
index_type  listAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of ListAnnotation.

Parameters
annotationAnnotationRef to set.
listAnnotationIndexthe ListAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setListAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setListAnnotationAnnotator ( const std::string &  annotator,
index_type  listAnnotationIndex 
)
virtual

Set the Annotator property of ListAnnotation.

Parameters
annotatorAnnotator to set.
listAnnotationIndexthe ListAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setListAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setListAnnotationDescription ( const std::string &  description,
index_type  listAnnotationIndex 
)
virtual

Set the Description property of ListAnnotation.

Parameters
descriptionDescription to set.
listAnnotationIndexthe ListAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setListAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setListAnnotationID ( const std::string &  id,
index_type  listAnnotationIndex 
)
virtual

Set the ID property of ListAnnotation.

Parameters
idID to set.
listAnnotationIndexthe ListAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setListAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setListAnnotationNamespace ( const std::string &  namespace_,
index_type  listAnnotationIndex 
)
virtual

Set the Namespace property of ListAnnotation.

Parameters
namespace_Namespace to set.
listAnnotationIndexthe ListAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLongAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setLongAnnotationAnnotationRef ( const std::string &  annotation,
index_type  longAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of LongAnnotation.

Parameters
annotationAnnotationRef to set.
longAnnotationIndexthe LongAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLongAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setLongAnnotationAnnotator ( const std::string &  annotator,
index_type  longAnnotationIndex 
)
virtual

Set the Annotator property of LongAnnotation.

Parameters
annotatorAnnotator to set.
longAnnotationIndexthe LongAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLongAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setLongAnnotationDescription ( const std::string &  description,
index_type  longAnnotationIndex 
)
virtual

Set the Description property of LongAnnotation.

Parameters
descriptionDescription to set.
longAnnotationIndexthe LongAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLongAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setLongAnnotationID ( const std::string &  id,
index_type  longAnnotationIndex 
)
virtual

Set the ID property of LongAnnotation.

Parameters
idID to set.
longAnnotationIndexthe LongAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setLongAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setLongAnnotationNamespace ( const std::string &  namespace_,
index_type  longAnnotationIndex 
)
virtual

Set the Namespace property of LongAnnotation.

Parameters
namespace_Namespace to set.
longAnnotationIndexthe LongAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setLongAnnotationValue()

void ome::xml::meta::OMEXMLMetadata::setLongAnnotationValue ( int64_t  value,
index_type  longAnnotationIndex 
)
virtual

Set the Value property of LongAnnotation.

Parameters
valueValue to set.
longAnnotationIndexthe LongAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMapAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setMapAnnotationAnnotationRef ( const std::string &  annotation,
index_type  mapAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of MapAnnotation.

Parameters
annotationAnnotationRef to set.
mapAnnotationIndexthe MapAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setMapAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setMapAnnotationAnnotator ( const std::string &  annotator,
index_type  mapAnnotationIndex 
)
virtual

Set the Annotator property of MapAnnotation.

Parameters
annotatorAnnotator to set.
mapAnnotationIndexthe MapAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMapAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setMapAnnotationDescription ( const std::string &  description,
index_type  mapAnnotationIndex 
)
virtual

Set the Description property of MapAnnotation.

Parameters
descriptionDescription to set.
mapAnnotationIndexthe MapAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMapAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setMapAnnotationID ( const std::string &  id,
index_type  mapAnnotationIndex 
)
virtual

Set the ID property of MapAnnotation.

Parameters
idID to set.
mapAnnotationIndexthe MapAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setMapAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setMapAnnotationNamespace ( const std::string &  namespace_,
index_type  mapAnnotationIndex 
)
virtual

Set the Namespace property of MapAnnotation.

Parameters
namespace_Namespace to set.
mapAnnotationIndexthe MapAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMapAnnotationValue()

void ome::xml::meta::OMEXMLMetadata::setMapAnnotationValue ( const ome::xml::model::primitives::OrderedMultimap value,
index_type  mapAnnotationIndex 
)
virtual

Set the map value of MapAnnotation.

Parameters
valuethe map value to set.
mapAnnotationIndexthe MapAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setMaskAnnotationRef ( const std::string &  annotation,
index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Mask.

Parameters
annotationAnnotationRef to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setMaskBinData()

void ome::xml::meta::OMEXMLMetadata::setMaskBinData ( const std::vector< uint8_t > &  base64Binary,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Base64Binary property of BinData.

Parameters
base64BinaryBase64Binary to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskBinDataBigEndian()

void ome::xml::meta::OMEXMLMetadata::setMaskBinDataBigEndian ( bool  bigEndian,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the BigEndian property of BinData.

Parameters
bigEndianBigEndian to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskBinDataCompression()

void ome::xml::meta::OMEXMLMetadata::setMaskBinDataCompression ( ome::xml::model::enums::Compression  compression,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Compression property of BinData.

Parameters
compressionCompression to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskBinDataLength()

void ome::xml::meta::OMEXMLMetadata::setMaskBinDataLength ( ome::xml::model::primitives::NonNegativeLong  length,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Length property of BinData.

Parameters
lengthLength to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskFillColor()

void ome::xml::meta::OMEXMLMetadata::setMaskFillColor ( ome::xml::model::primitives::Color  fillColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillColor property of Mask.

Parameters
fillColorFillColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskFillRule()

void ome::xml::meta::OMEXMLMetadata::setMaskFillRule ( ome::xml::model::enums::FillRule  fillRule,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillRule property of Mask.

Parameters
fillRuleFillRule to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskFontFamily()

void ome::xml::meta::OMEXMLMetadata::setMaskFontFamily ( ome::xml::model::enums::FontFamily  fontFamily,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontFamily property of Mask.

Parameters
fontFamilyFontFamily to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskFontSize()

void ome::xml::meta::OMEXMLMetadata::setMaskFontSize ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger fontSize,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontSize property of Mask.

Parameters
fontSizeFontSize to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskFontStyle()

void ome::xml::meta::OMEXMLMetadata::setMaskFontStyle ( ome::xml::model::enums::FontStyle  fontStyle,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontStyle property of Mask.

Parameters
fontStyleFontStyle to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskHeight()

void ome::xml::meta::OMEXMLMetadata::setMaskHeight ( double  height,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Height property of Mask.

Parameters
heightHeight to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskID()

void ome::xml::meta::OMEXMLMetadata::setMaskID ( const std::string &  id,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the ID property of Mask.

Parameters
idID to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setMaskLocked()

void ome::xml::meta::OMEXMLMetadata::setMaskLocked ( bool  locked,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Locked property of Mask.

Parameters
lockedLocked to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskStrokeColor()

void ome::xml::meta::OMEXMLMetadata::setMaskStrokeColor ( ome::xml::model::primitives::Color  strokeColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeColor property of Mask.

Parameters
strokeColorStrokeColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskStrokeDashArray()

void ome::xml::meta::OMEXMLMetadata::setMaskStrokeDashArray ( const std::string &  strokeDashArray,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeDashArray property of Mask.

Parameters
strokeDashArrayStrokeDashArray to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskStrokeWidth()

void ome::xml::meta::OMEXMLMetadata::setMaskStrokeWidth ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength strokeWidth,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeWidth property of Mask.

Parameters
strokeWidthStrokeWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskText()

void ome::xml::meta::OMEXMLMetadata::setMaskText ( const std::string &  text,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Text property of Mask.

Parameters
textText to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskTheC()

void ome::xml::meta::OMEXMLMetadata::setMaskTheC ( ome::xml::model::primitives::NonNegativeInteger  theC,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheC property of Mask.

Parameters
theCTheC to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskTheT()

void ome::xml::meta::OMEXMLMetadata::setMaskTheT ( ome::xml::model::primitives::NonNegativeInteger  theT,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheT property of Mask.

Parameters
theTTheT to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskTheZ()

void ome::xml::meta::OMEXMLMetadata::setMaskTheZ ( ome::xml::model::primitives::NonNegativeInteger  theZ,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheZ property of Mask.

Parameters
theZTheZ to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskTransform()

void ome::xml::meta::OMEXMLMetadata::setMaskTransform ( const ::ome::xml::model::AffineTransform transform,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Transform property of Mask.

Parameters
transformTransform to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskWidth()

void ome::xml::meta::OMEXMLMetadata::setMaskWidth ( double  width,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Width property of Mask.

Parameters
widthWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskX()

void ome::xml::meta::OMEXMLMetadata::setMaskX ( double  x,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the X property of Mask.

Parameters
xX to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMaskY()

void ome::xml::meta::OMEXMLMetadata::setMaskY ( double  y,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Y property of Mask.

Parameters
yY to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMicrobeamManipulationDescription()

void ome::xml::meta::OMEXMLMetadata::setMicrobeamManipulationDescription ( const std::string &  description,
index_type  experimentIndex,
index_type  microbeamManipulationIndex 
)
virtual

Set the Description property of MicrobeamManipulation.

Parameters
descriptionDescription to set.
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMicrobeamManipulationExperimenterRef()

void ome::xml::meta::OMEXMLMetadata::setMicrobeamManipulationExperimenterRef ( const std::string &  experimenter,
index_type  experimentIndex,
index_type  microbeamManipulationIndex 
)
virtual

Set the ExperimenterRef property of MicrobeamManipulation.

Parameters
experimenterExperimenterRef to set.
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setMicrobeamManipulationID()

void ome::xml::meta::OMEXMLMetadata::setMicrobeamManipulationID ( const std::string &  id,
index_type  experimentIndex,
index_type  microbeamManipulationIndex 
)
virtual

Set the ID property of MicrobeamManipulation.

Parameters
idID to set.
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setMicrobeamManipulationLightSourceSettingsAttenuation()

void ome::xml::meta::OMEXMLMetadata::setMicrobeamManipulationLightSourceSettingsAttenuation ( ome::xml::model::primitives::PercentFraction  attenuation,
index_type  experimentIndex,
index_type  microbeamManipulationIndex,
index_type  lightSourceSettingsIndex 
)
virtual

Set the Attenuation property of LightSourceSettings.

Parameters
attenuationAttenuation to set.
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
lightSourceSettingsIndexthe LightSourceSettings index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMicrobeamManipulationLightSourceSettingsID()

void ome::xml::meta::OMEXMLMetadata::setMicrobeamManipulationLightSourceSettingsID ( const std::string &  id,
index_type  experimentIndex,
index_type  microbeamManipulationIndex,
index_type  lightSourceSettingsIndex 
)
virtual

Set the ID property of LightSourceSettings.

Parameters
idID to set.
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
lightSourceSettingsIndexthe LightSourceSettings index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setMicrobeamManipulationLightSourceSettingsWavelength()

void ome::xml::meta::OMEXMLMetadata::setMicrobeamManipulationLightSourceSettingsWavelength ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat wavelength,
index_type  experimentIndex,
index_type  microbeamManipulationIndex,
index_type  lightSourceSettingsIndex 
)
virtual

Set the Wavelength property of LightSourceSettings.

Parameters
wavelengthWavelength to set.
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
lightSourceSettingsIndexthe LightSourceSettings index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMicrobeamManipulationROIRef()

void ome::xml::meta::OMEXMLMetadata::setMicrobeamManipulationROIRef ( const std::string &  roi,
index_type  experimentIndex,
index_type  microbeamManipulationIndex,
index_type  ROIRefIndex 
)
virtual

Set the ROIRef property of MicrobeamManipulation.

Parameters
roiROIRef to set.
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.
ROIRefIndexROIRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setMicrobeamManipulationType()

void ome::xml::meta::OMEXMLMetadata::setMicrobeamManipulationType ( ome::xml::model::enums::MicrobeamManipulationType  type,
index_type  experimentIndex,
index_type  microbeamManipulationIndex 
)
virtual

Set the Type property of MicrobeamManipulation.

Parameters
typeType to set.
experimentIndexthe Experiment index.
microbeamManipulationIndexthe MicrobeamManipulation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMicroscopeLotNumber()

void ome::xml::meta::OMEXMLMetadata::setMicroscopeLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex 
)
virtual

Set the LotNumber property of Microscope.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMicroscopeManufacturer()

void ome::xml::meta::OMEXMLMetadata::setMicroscopeManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex 
)
virtual

Set the Manufacturer property of Microscope.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMicroscopeModel()

void ome::xml::meta::OMEXMLMetadata::setMicroscopeModel ( const std::string &  model,
index_type  instrumentIndex 
)
virtual

Set the Model property of Microscope.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMicroscopeSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setMicroscopeSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex 
)
virtual

Set the SerialNumber property of Microscope.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setMicroscopeType()

void ome::xml::meta::OMEXMLMetadata::setMicroscopeType ( ome::xml::model::enums::MicroscopeType  type,
index_type  instrumentIndex 
)
virtual

Set the Type property of Microscope.

Parameters
typeType to set.
instrumentIndexthe Instrument index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setObjectiveAnnotationRef ( const std::string &  annotation,
index_type  instrumentIndex,
index_type  objectiveIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Objective.

Parameters
annotationAnnotationRef to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setObjectiveCalibratedMagnification()

void ome::xml::meta::OMEXMLMetadata::setObjectiveCalibratedMagnification ( double  calibratedMagnification,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the CalibratedMagnification property of Objective.

Parameters
calibratedMagnificationCalibratedMagnification to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveCorrection()

void ome::xml::meta::OMEXMLMetadata::setObjectiveCorrection ( ome::xml::model::enums::Correction  correction,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the Correction property of Objective.

Parameters
correctionCorrection to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveID()

void ome::xml::meta::OMEXMLMetadata::setObjectiveID ( const std::string &  id,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the ID property of Objective.

Parameters
idID to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setObjectiveImmersion()

void ome::xml::meta::OMEXMLMetadata::setObjectiveImmersion ( ome::xml::model::enums::Immersion  immersion,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the Immersion property of Objective.

Parameters
immersionImmersion to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveIris()

void ome::xml::meta::OMEXMLMetadata::setObjectiveIris ( bool  iris,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the Iris property of Objective.

Parameters
irisIris to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveLensNA()

void ome::xml::meta::OMEXMLMetadata::setObjectiveLensNA ( double  lensNA,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the LensNA property of Objective.

Parameters
lensNALensNA to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveLotNumber()

void ome::xml::meta::OMEXMLMetadata::setObjectiveLotNumber ( const std::string &  lotNumber,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the LotNumber property of Objective.

Parameters
lotNumberLotNumber to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveManufacturer()

void ome::xml::meta::OMEXMLMetadata::setObjectiveManufacturer ( const std::string &  manufacturer,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the Manufacturer property of Objective.

Parameters
manufacturerManufacturer to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveModel()

void ome::xml::meta::OMEXMLMetadata::setObjectiveModel ( const std::string &  model,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the Model property of Objective.

Parameters
modelModel to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveNominalMagnification()

void ome::xml::meta::OMEXMLMetadata::setObjectiveNominalMagnification ( double  nominalMagnification,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the NominalMagnification property of Objective.

Parameters
nominalMagnificationNominalMagnification to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveSerialNumber()

void ome::xml::meta::OMEXMLMetadata::setObjectiveSerialNumber ( const std::string &  serialNumber,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the SerialNumber property of Objective.

Parameters
serialNumberSerialNumber to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveSettingsCorrectionCollar()

void ome::xml::meta::OMEXMLMetadata::setObjectiveSettingsCorrectionCollar ( double  correctionCollar,
index_type  imageIndex 
)
virtual

Set the CorrectionCollar property of ObjectiveSettings.

Parameters
correctionCollarCorrectionCollar to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveSettingsID()

void ome::xml::meta::OMEXMLMetadata::setObjectiveSettingsID ( const std::string &  id,
index_type  imageIndex 
)
virtual

Set the ID property of ObjectiveSettings.

Parameters
idID to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setObjectiveSettingsMedium()

void ome::xml::meta::OMEXMLMetadata::setObjectiveSettingsMedium ( ome::xml::model::enums::Medium  medium,
index_type  imageIndex 
)
virtual

Set the Medium property of ObjectiveSettings.

Parameters
mediumMedium to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveSettingsRefractiveIndex()

void ome::xml::meta::OMEXMLMetadata::setObjectiveSettingsRefractiveIndex ( double  refractiveIndex,
index_type  imageIndex 
)
virtual

Set the RefractiveIndex property of ObjectiveSettings.

Parameters
refractiveIndexRefractiveIndex to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setObjectiveWorkingDistance()

void ome::xml::meta::OMEXMLMetadata::setObjectiveWorkingDistance ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength workingDistance,
index_type  instrumentIndex,
index_type  objectiveIndex 
)
virtual

Set the WorkingDistance property of Objective.

Parameters
workingDistanceWorkingDistance to set.
instrumentIndexthe Instrument index.
objectiveIndexthe Objective index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsBigEndian()

void ome::xml::meta::OMEXMLMetadata::setPixelsBigEndian ( bool  bigEndian,
index_type  imageIndex 
)
virtual

Set the BigEndian property of Pixels.

Parameters
bigEndianBigEndian to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsBinData()

void ome::xml::meta::OMEXMLMetadata::setPixelsBinData ( const std::vector< uint8_t > &  base64Binary,
index_type  imageIndex,
index_type  binDataIndex 
)
virtual

Set the Base64Binary property of BinData.

Parameters
base64BinaryBase64Binary to set.
imageIndexthe Image index.
binDataIndexthe BinData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsBinDataBigEndian()

void ome::xml::meta::OMEXMLMetadata::setPixelsBinDataBigEndian ( bool  bigEndian,
index_type  imageIndex,
index_type  binDataIndex 
)
virtual

Set the BigEndian property of BinData.

Parameters
bigEndianBigEndian to set.
imageIndexthe Image index.
binDataIndexthe BinData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsBinDataCompression()

void ome::xml::meta::OMEXMLMetadata::setPixelsBinDataCompression ( ome::xml::model::enums::Compression  compression,
index_type  imageIndex,
index_type  binDataIndex 
)
virtual

Set the Compression property of BinData.

Parameters
compressionCompression to set.
imageIndexthe Image index.
binDataIndexthe BinData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsBinDataLength()

void ome::xml::meta::OMEXMLMetadata::setPixelsBinDataLength ( ome::xml::model::primitives::NonNegativeLong  length,
index_type  imageIndex,
index_type  binDataIndex 
)
virtual

Set the Length property of BinData.

Parameters
lengthLength to set.
imageIndexthe Image index.
binDataIndexthe BinData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsDimensionOrder()

void ome::xml::meta::OMEXMLMetadata::setPixelsDimensionOrder ( ome::xml::model::enums::DimensionOrder  dimensionOrder,
index_type  imageIndex 
)
virtual

Set the DimensionOrder property of Pixels.

Parameters
dimensionOrderDimensionOrder to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsID()

void ome::xml::meta::OMEXMLMetadata::setPixelsID ( const std::string &  id,
index_type  imageIndex 
)
virtual

Set the ID property of Pixels.

Parameters
idID to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPixelsInterleaved()

void ome::xml::meta::OMEXMLMetadata::setPixelsInterleaved ( bool  interleaved,
index_type  imageIndex 
)
virtual

Set the Interleaved property of Pixels.

Parameters
interleavedInterleaved to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsPhysicalSizeX()

void ome::xml::meta::OMEXMLMetadata::setPixelsPhysicalSizeX ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat physicalSizeX,
index_type  imageIndex 
)
virtual

Set the PhysicalSizeX property of Pixels.

Parameters
physicalSizeXPhysicalSizeX to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsPhysicalSizeY()

void ome::xml::meta::OMEXMLMetadata::setPixelsPhysicalSizeY ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat physicalSizeY,
index_type  imageIndex 
)
virtual

Set the PhysicalSizeY property of Pixels.

Parameters
physicalSizeYPhysicalSizeY to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsPhysicalSizeZ()

void ome::xml::meta::OMEXMLMetadata::setPixelsPhysicalSizeZ ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat physicalSizeZ,
index_type  imageIndex 
)
virtual

Set the PhysicalSizeZ property of Pixels.

Parameters
physicalSizeZPhysicalSizeZ to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsSignificantBits()

void ome::xml::meta::OMEXMLMetadata::setPixelsSignificantBits ( ome::xml::model::primitives::PositiveInteger  significantBits,
index_type  imageIndex 
)
virtual

Set the SignificantBits property of Pixels.

Parameters
significantBitsSignificantBits to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsSizeC()

void ome::xml::meta::OMEXMLMetadata::setPixelsSizeC ( ome::xml::model::primitives::PositiveInteger  sizeC,
index_type  imageIndex 
)
virtual

Set the SizeC property of Pixels.

Parameters
sizeCSizeC to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsSizeT()

void ome::xml::meta::OMEXMLMetadata::setPixelsSizeT ( ome::xml::model::primitives::PositiveInteger  sizeT,
index_type  imageIndex 
)
virtual

Set the SizeT property of Pixels.

Parameters
sizeTSizeT to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsSizeX()

void ome::xml::meta::OMEXMLMetadata::setPixelsSizeX ( ome::xml::model::primitives::PositiveInteger  sizeX,
index_type  imageIndex 
)
virtual

Set the SizeX property of Pixels.

Parameters
sizeXSizeX to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsSizeY()

void ome::xml::meta::OMEXMLMetadata::setPixelsSizeY ( ome::xml::model::primitives::PositiveInteger  sizeY,
index_type  imageIndex 
)
virtual

Set the SizeY property of Pixels.

Parameters
sizeYSizeY to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsSizeZ()

void ome::xml::meta::OMEXMLMetadata::setPixelsSizeZ ( ome::xml::model::primitives::PositiveInteger  sizeZ,
index_type  imageIndex 
)
virtual

Set the SizeZ property of Pixels.

Parameters
sizeZSizeZ to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsTimeIncrement()

void ome::xml::meta::OMEXMLMetadata::setPixelsTimeIncrement ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime timeIncrement,
index_type  imageIndex 
)
virtual

Set the TimeIncrement property of Pixels.

Parameters
timeIncrementTimeIncrement to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPixelsType()

void ome::xml::meta::OMEXMLMetadata::setPixelsType ( ome::xml::model::enums::PixelType  type,
index_type  imageIndex 
)
virtual

Set the Type property of Pixels.

Parameters
typeType to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlaneAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setPlaneAnnotationRef ( const std::string &  annotation,
index_type  imageIndex,
index_type  planeIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Plane.

Parameters
annotationAnnotationRef to set.
imageIndexthe Image index.
planeIndexthe Plane index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPlaneDeltaT()

void ome::xml::meta::OMEXMLMetadata::setPlaneDeltaT ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime deltaT,
index_type  imageIndex,
index_type  planeIndex 
)
virtual

Set the DeltaT property of Plane.

Parameters
deltaTDeltaT to set.
imageIndexthe Image index.
planeIndexthe Plane index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlaneExposureTime()

void ome::xml::meta::OMEXMLMetadata::setPlaneExposureTime ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime exposureTime,
index_type  imageIndex,
index_type  planeIndex 
)
virtual

Set the ExposureTime property of Plane.

Parameters
exposureTimeExposureTime to set.
imageIndexthe Image index.
planeIndexthe Plane index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlaneHashSHA1()

void ome::xml::meta::OMEXMLMetadata::setPlaneHashSHA1 ( const std::string &  hashSHA1,
index_type  imageIndex,
index_type  planeIndex 
)
virtual

Set the HashSHA1 property of Plane.

Parameters
hashSHA1HashSHA1 to set.
imageIndexthe Image index.
planeIndexthe Plane index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlanePositionX()

void ome::xml::meta::OMEXMLMetadata::setPlanePositionX ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength positionX,
index_type  imageIndex,
index_type  planeIndex 
)
virtual

Set the PositionX property of Plane.

Parameters
positionXPositionX to set.
imageIndexthe Image index.
planeIndexthe Plane index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlanePositionY()

void ome::xml::meta::OMEXMLMetadata::setPlanePositionY ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength positionY,
index_type  imageIndex,
index_type  planeIndex 
)
virtual

Set the PositionY property of Plane.

Parameters
positionYPositionY to set.
imageIndexthe Image index.
planeIndexthe Plane index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlanePositionZ()

void ome::xml::meta::OMEXMLMetadata::setPlanePositionZ ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength positionZ,
index_type  imageIndex,
index_type  planeIndex 
)
virtual

Set the PositionZ property of Plane.

Parameters
positionZPositionZ to set.
imageIndexthe Image index.
planeIndexthe Plane index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlaneTheC()

void ome::xml::meta::OMEXMLMetadata::setPlaneTheC ( ome::xml::model::primitives::NonNegativeInteger  theC,
index_type  imageIndex,
index_type  planeIndex 
)
virtual

Set the TheC property of Plane.

Parameters
theCTheC to set.
imageIndexthe Image index.
planeIndexthe Plane index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlaneTheT()

void ome::xml::meta::OMEXMLMetadata::setPlaneTheT ( ome::xml::model::primitives::NonNegativeInteger  theT,
index_type  imageIndex,
index_type  planeIndex 
)
virtual

Set the TheT property of Plane.

Parameters
theTTheT to set.
imageIndexthe Image index.
planeIndexthe Plane index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlaneTheZ()

void ome::xml::meta::OMEXMLMetadata::setPlaneTheZ ( ome::xml::model::primitives::NonNegativeInteger  theZ,
index_type  imageIndex,
index_type  planeIndex 
)
virtual

Set the TheZ property of Plane.

Parameters
theZTheZ to set.
imageIndexthe Image index.
planeIndexthe Plane index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateAcquisitionAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setPlateAcquisitionAnnotationRef ( const std::string &  annotation,
index_type  plateIndex,
index_type  plateAcquisitionIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of PlateAcquisition.

Parameters
annotationAnnotationRef to set.
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPlateAcquisitionDescription()

void ome::xml::meta::OMEXMLMetadata::setPlateAcquisitionDescription ( const std::string &  description,
index_type  plateIndex,
index_type  plateAcquisitionIndex 
)
virtual

Set the Description property of PlateAcquisition.

Parameters
descriptionDescription to set.
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateAcquisitionEndTime()

void ome::xml::meta::OMEXMLMetadata::setPlateAcquisitionEndTime ( ome::xml::model::primitives::Timestamp  endTime,
index_type  plateIndex,
index_type  plateAcquisitionIndex 
)
virtual

Set the EndTime property of PlateAcquisition.

Parameters
endTimeEndTime to set.
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateAcquisitionID()

void ome::xml::meta::OMEXMLMetadata::setPlateAcquisitionID ( const std::string &  id,
index_type  plateIndex,
index_type  plateAcquisitionIndex 
)
virtual

Set the ID property of PlateAcquisition.

Parameters
idID to set.
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPlateAcquisitionMaximumFieldCount()

void ome::xml::meta::OMEXMLMetadata::setPlateAcquisitionMaximumFieldCount ( ome::xml::model::primitives::PositiveInteger  maximumFieldCount,
index_type  plateIndex,
index_type  plateAcquisitionIndex 
)
virtual

Set the MaximumFieldCount property of PlateAcquisition.

Parameters
maximumFieldCountMaximumFieldCount to set.
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateAcquisitionName()

void ome::xml::meta::OMEXMLMetadata::setPlateAcquisitionName ( const std::string &  name,
index_type  plateIndex,
index_type  plateAcquisitionIndex 
)
virtual

Set the Name property of PlateAcquisition.

Parameters
nameName to set.
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateAcquisitionStartTime()

void ome::xml::meta::OMEXMLMetadata::setPlateAcquisitionStartTime ( ome::xml::model::primitives::Timestamp  startTime,
index_type  plateIndex,
index_type  plateAcquisitionIndex 
)
virtual

Set the StartTime property of PlateAcquisition.

Parameters
startTimeStartTime to set.
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateAcquisitionWellSampleRef()

void ome::xml::meta::OMEXMLMetadata::setPlateAcquisitionWellSampleRef ( const std::string &  wellSample,
index_type  plateIndex,
index_type  plateAcquisitionIndex,
index_type  wellSampleRefIndex 
)
virtual

Set the WellSampleRef property of PlateAcquisition.

Parameters
wellSampleWellSampleRef to set.
plateIndexthe Plate index.
plateAcquisitionIndexthe PlateAcquisition index.
wellSampleRefIndexWellSampleRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPlateAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setPlateAnnotationRef ( const std::string &  annotation,
index_type  plateIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Plate.

Parameters
annotationAnnotationRef to set.
plateIndexthe Plate index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPlateColumnNamingConvention()

void ome::xml::meta::OMEXMLMetadata::setPlateColumnNamingConvention ( ome::xml::model::enums::NamingConvention  columnNamingConvention,
index_type  plateIndex 
)
virtual

Set the ColumnNamingConvention property of Plate.

Parameters
columnNamingConventionColumnNamingConvention to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateColumns()

void ome::xml::meta::OMEXMLMetadata::setPlateColumns ( ome::xml::model::primitives::PositiveInteger  columns,
index_type  plateIndex 
)
virtual

Set the Columns property of Plate.

Parameters
columnsColumns to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateDescription()

void ome::xml::meta::OMEXMLMetadata::setPlateDescription ( const std::string &  description,
index_type  plateIndex 
)
virtual

Set the Description property of Plate.

Parameters
descriptionDescription to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateExternalIdentifier()

void ome::xml::meta::OMEXMLMetadata::setPlateExternalIdentifier ( const std::string &  externalIdentifier,
index_type  plateIndex 
)
virtual

Set the ExternalIdentifier property of Plate.

Parameters
externalIdentifierExternalIdentifier to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateFieldIndex()

void ome::xml::meta::OMEXMLMetadata::setPlateFieldIndex ( ome::xml::model::primitives::NonNegativeInteger  fieldIndex,
index_type  plateIndex 
)
virtual

Set the FieldIndex property of Plate.

Parameters
fieldIndexFieldIndex to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateID()

void ome::xml::meta::OMEXMLMetadata::setPlateID ( const std::string &  id,
index_type  plateIndex 
)
virtual

Set the ID property of Plate.

Parameters
idID to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPlateName()

void ome::xml::meta::OMEXMLMetadata::setPlateName ( const std::string &  name,
index_type  plateIndex 
)
virtual

Set the Name property of Plate.

Parameters
nameName to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateRowNamingConvention()

void ome::xml::meta::OMEXMLMetadata::setPlateRowNamingConvention ( ome::xml::model::enums::NamingConvention  rowNamingConvention,
index_type  plateIndex 
)
virtual

Set the RowNamingConvention property of Plate.

Parameters
rowNamingConventionRowNamingConvention to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateRows()

void ome::xml::meta::OMEXMLMetadata::setPlateRows ( ome::xml::model::primitives::PositiveInteger  rows,
index_type  plateIndex 
)
virtual

Set the Rows property of Plate.

Parameters
rowsRows to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateStatus()

void ome::xml::meta::OMEXMLMetadata::setPlateStatus ( const std::string &  status,
index_type  plateIndex 
)
virtual

Set the Status property of Plate.

Parameters
statusStatus to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateWellOriginX()

void ome::xml::meta::OMEXMLMetadata::setPlateWellOriginX ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength wellOriginX,
index_type  plateIndex 
)
virtual

Set the WellOriginX property of Plate.

Parameters
wellOriginXWellOriginX to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPlateWellOriginY()

void ome::xml::meta::OMEXMLMetadata::setPlateWellOriginY ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength wellOriginY,
index_type  plateIndex 
)
virtual

Set the WellOriginY property of Plate.

Parameters
wellOriginYWellOriginY to set.
plateIndexthe Plate index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setPointAnnotationRef ( const std::string &  annotation,
index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Point.

Parameters
annotationAnnotationRef to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPointFillColor()

void ome::xml::meta::OMEXMLMetadata::setPointFillColor ( ome::xml::model::primitives::Color  fillColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillColor property of Point.

Parameters
fillColorFillColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointFillRule()

void ome::xml::meta::OMEXMLMetadata::setPointFillRule ( ome::xml::model::enums::FillRule  fillRule,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillRule property of Point.

Parameters
fillRuleFillRule to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointFontFamily()

void ome::xml::meta::OMEXMLMetadata::setPointFontFamily ( ome::xml::model::enums::FontFamily  fontFamily,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontFamily property of Point.

Parameters
fontFamilyFontFamily to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointFontSize()

void ome::xml::meta::OMEXMLMetadata::setPointFontSize ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger fontSize,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontSize property of Point.

Parameters
fontSizeFontSize to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointFontStyle()

void ome::xml::meta::OMEXMLMetadata::setPointFontStyle ( ome::xml::model::enums::FontStyle  fontStyle,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontStyle property of Point.

Parameters
fontStyleFontStyle to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointID()

void ome::xml::meta::OMEXMLMetadata::setPointID ( const std::string &  id,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the ID property of Point.

Parameters
idID to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPointLocked()

void ome::xml::meta::OMEXMLMetadata::setPointLocked ( bool  locked,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Locked property of Point.

Parameters
lockedLocked to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointStrokeColor()

void ome::xml::meta::OMEXMLMetadata::setPointStrokeColor ( ome::xml::model::primitives::Color  strokeColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeColor property of Point.

Parameters
strokeColorStrokeColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointStrokeDashArray()

void ome::xml::meta::OMEXMLMetadata::setPointStrokeDashArray ( const std::string &  strokeDashArray,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeDashArray property of Point.

Parameters
strokeDashArrayStrokeDashArray to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointStrokeWidth()

void ome::xml::meta::OMEXMLMetadata::setPointStrokeWidth ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength strokeWidth,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeWidth property of Point.

Parameters
strokeWidthStrokeWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointText()

void ome::xml::meta::OMEXMLMetadata::setPointText ( const std::string &  text,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Text property of Point.

Parameters
textText to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointTheC()

void ome::xml::meta::OMEXMLMetadata::setPointTheC ( ome::xml::model::primitives::NonNegativeInteger  theC,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheC property of Point.

Parameters
theCTheC to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointTheT()

void ome::xml::meta::OMEXMLMetadata::setPointTheT ( ome::xml::model::primitives::NonNegativeInteger  theT,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheT property of Point.

Parameters
theTTheT to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointTheZ()

void ome::xml::meta::OMEXMLMetadata::setPointTheZ ( ome::xml::model::primitives::NonNegativeInteger  theZ,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheZ property of Point.

Parameters
theZTheZ to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointTransform()

void ome::xml::meta::OMEXMLMetadata::setPointTransform ( const ::ome::xml::model::AffineTransform transform,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Transform property of Point.

Parameters
transformTransform to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointX()

void ome::xml::meta::OMEXMLMetadata::setPointX ( double  x,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the X property of Point.

Parameters
xX to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPointY()

void ome::xml::meta::OMEXMLMetadata::setPointY ( double  y,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Y property of Point.

Parameters
yY to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setPolygonAnnotationRef ( const std::string &  annotation,
index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Polygon.

Parameters
annotationAnnotationRef to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPolygonFillColor()

void ome::xml::meta::OMEXMLMetadata::setPolygonFillColor ( ome::xml::model::primitives::Color  fillColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillColor property of Polygon.

Parameters
fillColorFillColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonFillRule()

void ome::xml::meta::OMEXMLMetadata::setPolygonFillRule ( ome::xml::model::enums::FillRule  fillRule,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillRule property of Polygon.

Parameters
fillRuleFillRule to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonFontFamily()

void ome::xml::meta::OMEXMLMetadata::setPolygonFontFamily ( ome::xml::model::enums::FontFamily  fontFamily,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontFamily property of Polygon.

Parameters
fontFamilyFontFamily to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonFontSize()

void ome::xml::meta::OMEXMLMetadata::setPolygonFontSize ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger fontSize,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontSize property of Polygon.

Parameters
fontSizeFontSize to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonFontStyle()

void ome::xml::meta::OMEXMLMetadata::setPolygonFontStyle ( ome::xml::model::enums::FontStyle  fontStyle,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontStyle property of Polygon.

Parameters
fontStyleFontStyle to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonID()

void ome::xml::meta::OMEXMLMetadata::setPolygonID ( const std::string &  id,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the ID property of Polygon.

Parameters
idID to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPolygonLocked()

void ome::xml::meta::OMEXMLMetadata::setPolygonLocked ( bool  locked,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Locked property of Polygon.

Parameters
lockedLocked to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonPoints()

void ome::xml::meta::OMEXMLMetadata::setPolygonPoints ( const std::string &  points,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Points property of Polygon.

Parameters
pointsPoints to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonStrokeColor()

void ome::xml::meta::OMEXMLMetadata::setPolygonStrokeColor ( ome::xml::model::primitives::Color  strokeColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeColor property of Polygon.

Parameters
strokeColorStrokeColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonStrokeDashArray()

void ome::xml::meta::OMEXMLMetadata::setPolygonStrokeDashArray ( const std::string &  strokeDashArray,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeDashArray property of Polygon.

Parameters
strokeDashArrayStrokeDashArray to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonStrokeWidth()

void ome::xml::meta::OMEXMLMetadata::setPolygonStrokeWidth ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength strokeWidth,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeWidth property of Polygon.

Parameters
strokeWidthStrokeWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonText()

void ome::xml::meta::OMEXMLMetadata::setPolygonText ( const std::string &  text,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Text property of Polygon.

Parameters
textText to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonTheC()

void ome::xml::meta::OMEXMLMetadata::setPolygonTheC ( ome::xml::model::primitives::NonNegativeInteger  theC,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheC property of Polygon.

Parameters
theCTheC to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonTheT()

void ome::xml::meta::OMEXMLMetadata::setPolygonTheT ( ome::xml::model::primitives::NonNegativeInteger  theT,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheT property of Polygon.

Parameters
theTTheT to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonTheZ()

void ome::xml::meta::OMEXMLMetadata::setPolygonTheZ ( ome::xml::model::primitives::NonNegativeInteger  theZ,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheZ property of Polygon.

Parameters
theZTheZ to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolygonTransform()

void ome::xml::meta::OMEXMLMetadata::setPolygonTransform ( const ::ome::xml::model::AffineTransform transform,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Transform property of Polygon.

Parameters
transformTransform to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setPolylineAnnotationRef ( const std::string &  annotation,
index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Polyline.

Parameters
annotationAnnotationRef to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPolylineFillColor()

void ome::xml::meta::OMEXMLMetadata::setPolylineFillColor ( ome::xml::model::primitives::Color  fillColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillColor property of Polyline.

Parameters
fillColorFillColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineFillRule()

void ome::xml::meta::OMEXMLMetadata::setPolylineFillRule ( ome::xml::model::enums::FillRule  fillRule,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillRule property of Polyline.

Parameters
fillRuleFillRule to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineFontFamily()

void ome::xml::meta::OMEXMLMetadata::setPolylineFontFamily ( ome::xml::model::enums::FontFamily  fontFamily,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontFamily property of Polyline.

Parameters
fontFamilyFontFamily to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineFontSize()

void ome::xml::meta::OMEXMLMetadata::setPolylineFontSize ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger fontSize,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontSize property of Polyline.

Parameters
fontSizeFontSize to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineFontStyle()

void ome::xml::meta::OMEXMLMetadata::setPolylineFontStyle ( ome::xml::model::enums::FontStyle  fontStyle,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontStyle property of Polyline.

Parameters
fontStyleFontStyle to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineID()

void ome::xml::meta::OMEXMLMetadata::setPolylineID ( const std::string &  id,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the ID property of Polyline.

Parameters
idID to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setPolylineLocked()

void ome::xml::meta::OMEXMLMetadata::setPolylineLocked ( bool  locked,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Locked property of Polyline.

Parameters
lockedLocked to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineMarkerEnd()

void ome::xml::meta::OMEXMLMetadata::setPolylineMarkerEnd ( ome::xml::model::enums::Marker  markerEnd,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the MarkerEnd property of Polyline.

Parameters
markerEndMarkerEnd to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineMarkerStart()

void ome::xml::meta::OMEXMLMetadata::setPolylineMarkerStart ( ome::xml::model::enums::Marker  markerStart,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the MarkerStart property of Polyline.

Parameters
markerStartMarkerStart to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylinePoints()

void ome::xml::meta::OMEXMLMetadata::setPolylinePoints ( const std::string &  points,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Points property of Polyline.

Parameters
pointsPoints to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineStrokeColor()

void ome::xml::meta::OMEXMLMetadata::setPolylineStrokeColor ( ome::xml::model::primitives::Color  strokeColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeColor property of Polyline.

Parameters
strokeColorStrokeColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineStrokeDashArray()

void ome::xml::meta::OMEXMLMetadata::setPolylineStrokeDashArray ( const std::string &  strokeDashArray,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeDashArray property of Polyline.

Parameters
strokeDashArrayStrokeDashArray to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineStrokeWidth()

void ome::xml::meta::OMEXMLMetadata::setPolylineStrokeWidth ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength strokeWidth,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeWidth property of Polyline.

Parameters
strokeWidthStrokeWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineText()

void ome::xml::meta::OMEXMLMetadata::setPolylineText ( const std::string &  text,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Text property of Polyline.

Parameters
textText to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineTheC()

void ome::xml::meta::OMEXMLMetadata::setPolylineTheC ( ome::xml::model::primitives::NonNegativeInteger  theC,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheC property of Polyline.

Parameters
theCTheC to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineTheT()

void ome::xml::meta::OMEXMLMetadata::setPolylineTheT ( ome::xml::model::primitives::NonNegativeInteger  theT,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheT property of Polyline.

Parameters
theTTheT to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineTheZ()

void ome::xml::meta::OMEXMLMetadata::setPolylineTheZ ( ome::xml::model::primitives::NonNegativeInteger  theZ,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheZ property of Polyline.

Parameters
theZTheZ to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setPolylineTransform()

void ome::xml::meta::OMEXMLMetadata::setPolylineTransform ( const ::ome::xml::model::AffineTransform transform,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Transform property of Polyline.

Parameters
transformTransform to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setProjectAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setProjectAnnotationRef ( const std::string &  annotation,
index_type  projectIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Project.

Parameters
annotationAnnotationRef to set.
projectIndexthe Project index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setProjectDatasetRef()

void ome::xml::meta::OMEXMLMetadata::setProjectDatasetRef ( const std::string &  dataset,
index_type  projectIndex,
index_type  datasetRefIndex 
)
virtual

Set the DatasetRef property of Project.

Parameters
datasetDatasetRef to set.
projectIndexthe Project index.
datasetRefIndexDatasetRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setProjectDescription()

void ome::xml::meta::OMEXMLMetadata::setProjectDescription ( const std::string &  description,
index_type  projectIndex 
)
virtual

Set the Description property of Project.

Parameters
descriptionDescription to set.
projectIndexthe Project index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setProjectExperimenterGroupRef()

void ome::xml::meta::OMEXMLMetadata::setProjectExperimenterGroupRef ( const std::string &  experimenterGroup,
index_type  projectIndex 
)
virtual

Set the ExperimenterGroupRef property of Project.

Parameters
experimenterGroupExperimenterGroupRef to set.
projectIndexthe Project index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setProjectExperimenterRef()

void ome::xml::meta::OMEXMLMetadata::setProjectExperimenterRef ( const std::string &  experimenter,
index_type  projectIndex 
)
virtual

Set the ExperimenterRef property of Project.

Parameters
experimenterExperimenterRef to set.
projectIndexthe Project index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setProjectID()

void ome::xml::meta::OMEXMLMetadata::setProjectID ( const std::string &  id,
index_type  projectIndex 
)
virtual

Set the ID property of Project.

Parameters
idID to set.
projectIndexthe Project index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setProjectName()

void ome::xml::meta::OMEXMLMetadata::setProjectName ( const std::string &  name,
index_type  projectIndex 
)
virtual

Set the Name property of Project.

Parameters
nameName to set.
projectIndexthe Project index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setReagentAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setReagentAnnotationRef ( const std::string &  annotation,
index_type  screenIndex,
index_type  reagentIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Reagent.

Parameters
annotationAnnotationRef to set.
screenIndexthe Screen index.
reagentIndexthe Reagent index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setReagentDescription()

void ome::xml::meta::OMEXMLMetadata::setReagentDescription ( const std::string &  description,
index_type  screenIndex,
index_type  reagentIndex 
)
virtual

Set the Description property of Reagent.

Parameters
descriptionDescription to set.
screenIndexthe Screen index.
reagentIndexthe Reagent index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setReagentID()

void ome::xml::meta::OMEXMLMetadata::setReagentID ( const std::string &  id,
index_type  screenIndex,
index_type  reagentIndex 
)
virtual

Set the ID property of Reagent.

Parameters
idID to set.
screenIndexthe Screen index.
reagentIndexthe Reagent index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setReagentName()

void ome::xml::meta::OMEXMLMetadata::setReagentName ( const std::string &  name,
index_type  screenIndex,
index_type  reagentIndex 
)
virtual

Set the Name property of Reagent.

Parameters
nameName to set.
screenIndexthe Screen index.
reagentIndexthe Reagent index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setReagentReagentIdentifier()

void ome::xml::meta::OMEXMLMetadata::setReagentReagentIdentifier ( const std::string &  reagentIdentifier,
index_type  screenIndex,
index_type  reagentIndex 
)
virtual

Set the ReagentIdentifier property of Reagent.

Parameters
reagentIdentifierReagentIdentifier to set.
screenIndexthe Screen index.
reagentIndexthe Reagent index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setRectangleAnnotationRef ( const std::string &  annotation,
index_type  ROIIndex,
index_type  shapeIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Rectangle.

Parameters
annotationAnnotationRef to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setRectangleFillColor()

void ome::xml::meta::OMEXMLMetadata::setRectangleFillColor ( ome::xml::model::primitives::Color  fillColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillColor property of Rectangle.

Parameters
fillColorFillColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleFillRule()

void ome::xml::meta::OMEXMLMetadata::setRectangleFillRule ( ome::xml::model::enums::FillRule  fillRule,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FillRule property of Rectangle.

Parameters
fillRuleFillRule to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleFontFamily()

void ome::xml::meta::OMEXMLMetadata::setRectangleFontFamily ( ome::xml::model::enums::FontFamily  fontFamily,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontFamily property of Rectangle.

Parameters
fontFamilyFontFamily to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleFontSize()

void ome::xml::meta::OMEXMLMetadata::setRectangleFontSize ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger fontSize,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontSize property of Rectangle.

Parameters
fontSizeFontSize to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleFontStyle()

void ome::xml::meta::OMEXMLMetadata::setRectangleFontStyle ( ome::xml::model::enums::FontStyle  fontStyle,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the FontStyle property of Rectangle.

Parameters
fontStyleFontStyle to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleHeight()

void ome::xml::meta::OMEXMLMetadata::setRectangleHeight ( double  height,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Height property of Rectangle.

Parameters
heightHeight to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleID()

void ome::xml::meta::OMEXMLMetadata::setRectangleID ( const std::string &  id,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the ID property of Rectangle.

Parameters
idID to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setRectangleLocked()

void ome::xml::meta::OMEXMLMetadata::setRectangleLocked ( bool  locked,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Locked property of Rectangle.

Parameters
lockedLocked to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleStrokeColor()

void ome::xml::meta::OMEXMLMetadata::setRectangleStrokeColor ( ome::xml::model::primitives::Color  strokeColor,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeColor property of Rectangle.

Parameters
strokeColorStrokeColor to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleStrokeDashArray()

void ome::xml::meta::OMEXMLMetadata::setRectangleStrokeDashArray ( const std::string &  strokeDashArray,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeDashArray property of Rectangle.

Parameters
strokeDashArrayStrokeDashArray to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleStrokeWidth()

void ome::xml::meta::OMEXMLMetadata::setRectangleStrokeWidth ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength strokeWidth,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the StrokeWidth property of Rectangle.

Parameters
strokeWidthStrokeWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleText()

void ome::xml::meta::OMEXMLMetadata::setRectangleText ( const std::string &  text,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Text property of Rectangle.

Parameters
textText to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleTheC()

void ome::xml::meta::OMEXMLMetadata::setRectangleTheC ( ome::xml::model::primitives::NonNegativeInteger  theC,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheC property of Rectangle.

Parameters
theCTheC to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleTheT()

void ome::xml::meta::OMEXMLMetadata::setRectangleTheT ( ome::xml::model::primitives::NonNegativeInteger  theT,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheT property of Rectangle.

Parameters
theTTheT to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleTheZ()

void ome::xml::meta::OMEXMLMetadata::setRectangleTheZ ( ome::xml::model::primitives::NonNegativeInteger  theZ,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the TheZ property of Rectangle.

Parameters
theZTheZ to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleTransform()

void ome::xml::meta::OMEXMLMetadata::setRectangleTransform ( const ::ome::xml::model::AffineTransform transform,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Transform property of Rectangle.

Parameters
transformTransform to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleWidth()

void ome::xml::meta::OMEXMLMetadata::setRectangleWidth ( double  width,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Width property of Rectangle.

Parameters
widthWidth to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleX()

void ome::xml::meta::OMEXMLMetadata::setRectangleX ( double  x,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the X property of Rectangle.

Parameters
xX to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRectangleY()

void ome::xml::meta::OMEXMLMetadata::setRectangleY ( double  y,
index_type  ROIIndex,
index_type  shapeIndex 
)
virtual

Set the Y property of Rectangle.

Parameters
yY to set.
ROIIndexthe ROI index.
shapeIndexthe Shape index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRightsRightsHeld()

void ome::xml::meta::OMEXMLMetadata::setRightsRightsHeld ( const std::string &  rightsHeld)
virtual

Set the RightsHeld property of Rights.

Parameters
rightsHeldRightsHeld to set.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRightsRightsHolder()

void ome::xml::meta::OMEXMLMetadata::setRightsRightsHolder ( const std::string &  rightsHolder)
virtual

Set the RightsHolder property of Rights.

Parameters
rightsHolderRightsHolder to set.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setROIAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setROIAnnotationRef ( const std::string &  annotation,
index_type  ROIIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of ROI.

Parameters
annotationAnnotationRef to set.
ROIIndexthe ROI index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setROIDescription()

void ome::xml::meta::OMEXMLMetadata::setROIDescription ( const std::string &  description,
index_type  ROIIndex 
)
virtual

Set the Description property of ROI.

Parameters
descriptionDescription to set.
ROIIndexthe ROI index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setROIID()

void ome::xml::meta::OMEXMLMetadata::setROIID ( const std::string &  id,
index_type  ROIIndex 
)
virtual

Set the ID property of ROI.

Parameters
idID to set.
ROIIndexthe ROI index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setROIName()

void ome::xml::meta::OMEXMLMetadata::setROIName ( const std::string &  name,
index_type  ROIIndex 
)
virtual

Set the Name property of ROI.

Parameters
nameName to set.
ROIIndexthe ROI index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setRoot()

void ome::xml::meta::OMEXMLMetadata::setRoot ( std::shared_ptr< MetadataRoot root)
virtual

Set the root node of the metadata.

Note that the root node type will be specific to the concrete metadata implementation. An exception will be thrown if the root node is of an incompatible type.

Parameters
roota pointer to the root node.
Todo:
should this be a reference or shared_ptr?

Implements ome::xml::meta::MetadataStore.

References genericRoot, model, and root.

Referenced by createRoot().

+ Here is the caller graph for this function:

◆ setScreenAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setScreenAnnotationRef ( const std::string &  annotation,
index_type  screenIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Screen.

Parameters
annotationAnnotationRef to set.
screenIndexthe Screen index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setScreenDescription()

void ome::xml::meta::OMEXMLMetadata::setScreenDescription ( const std::string &  description,
index_type  screenIndex 
)
virtual

Set the Description property of Screen.

Parameters
descriptionDescription to set.
screenIndexthe Screen index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setScreenID()

void ome::xml::meta::OMEXMLMetadata::setScreenID ( const std::string &  id,
index_type  screenIndex 
)
virtual

Set the ID property of Screen.

Parameters
idID to set.
screenIndexthe Screen index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setScreenName()

void ome::xml::meta::OMEXMLMetadata::setScreenName ( const std::string &  name,
index_type  screenIndex 
)
virtual

Set the Name property of Screen.

Parameters
nameName to set.
screenIndexthe Screen index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setScreenPlateRef()

void ome::xml::meta::OMEXMLMetadata::setScreenPlateRef ( const std::string &  plate,
index_type  screenIndex,
index_type  plateRefIndex 
)
virtual

Set the PlateRef property of Screen.

Parameters
platePlateRef to set.
screenIndexthe Screen index.
plateRefIndexPlateRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setScreenProtocolDescription()

void ome::xml::meta::OMEXMLMetadata::setScreenProtocolDescription ( const std::string &  protocolDescription,
index_type  screenIndex 
)
virtual

Set the ProtocolDescription property of Screen.

Parameters
protocolDescriptionProtocolDescription to set.
screenIndexthe Screen index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setScreenProtocolIdentifier()

void ome::xml::meta::OMEXMLMetadata::setScreenProtocolIdentifier ( const std::string &  protocolIdentifier,
index_type  screenIndex 
)
virtual

Set the ProtocolIdentifier property of Screen.

Parameters
protocolIdentifierProtocolIdentifier to set.
screenIndexthe Screen index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setScreenReagentSetDescription()

void ome::xml::meta::OMEXMLMetadata::setScreenReagentSetDescription ( const std::string &  reagentSetDescription,
index_type  screenIndex 
)
virtual

Set the ReagentSetDescription property of Screen.

Parameters
reagentSetDescriptionReagentSetDescription to set.
screenIndexthe Screen index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setScreenReagentSetIdentifier()

void ome::xml::meta::OMEXMLMetadata::setScreenReagentSetIdentifier ( const std::string &  reagentSetIdentifier,
index_type  screenIndex 
)
virtual

Set the ReagentSetIdentifier property of Screen.

Parameters
reagentSetIdentifierReagentSetIdentifier to set.
screenIndexthe Screen index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setScreenType()

void ome::xml::meta::OMEXMLMetadata::setScreenType ( const std::string &  type,
index_type  screenIndex 
)
virtual

Set the Type property of Screen.

Parameters
typeType to set.
screenIndexthe Screen index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setStageLabelName()

void ome::xml::meta::OMEXMLMetadata::setStageLabelName ( const std::string &  name,
index_type  imageIndex 
)
virtual

Set the Name property of StageLabel.

Parameters
nameName to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setStageLabelX()

void ome::xml::meta::OMEXMLMetadata::setStageLabelX ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength x,
index_type  imageIndex 
)
virtual

Set the X property of StageLabel.

Parameters
xX to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setStageLabelY()

void ome::xml::meta::OMEXMLMetadata::setStageLabelY ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength y,
index_type  imageIndex 
)
virtual

Set the Y property of StageLabel.

Parameters
yY to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setStageLabelZ()

void ome::xml::meta::OMEXMLMetadata::setStageLabelZ ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength z,
index_type  imageIndex 
)
virtual

Set the Z property of StageLabel.

Parameters
zZ to set.
imageIndexthe Image index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTagAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setTagAnnotationAnnotationRef ( const std::string &  annotation,
index_type  tagAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of TagAnnotation.

Parameters
annotationAnnotationRef to set.
tagAnnotationIndexthe TagAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setTagAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setTagAnnotationAnnotator ( const std::string &  annotator,
index_type  tagAnnotationIndex 
)
virtual

Set the Annotator property of TagAnnotation.

Parameters
annotatorAnnotator to set.
tagAnnotationIndexthe TagAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTagAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setTagAnnotationDescription ( const std::string &  description,
index_type  tagAnnotationIndex 
)
virtual

Set the Description property of TagAnnotation.

Parameters
descriptionDescription to set.
tagAnnotationIndexthe TagAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTagAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setTagAnnotationID ( const std::string &  id,
index_type  tagAnnotationIndex 
)
virtual

Set the ID property of TagAnnotation.

Parameters
idID to set.
tagAnnotationIndexthe TagAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setTagAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setTagAnnotationNamespace ( const std::string &  namespace_,
index_type  tagAnnotationIndex 
)
virtual

Set the Namespace property of TagAnnotation.

Parameters
namespace_Namespace to set.
tagAnnotationIndexthe TagAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTagAnnotationValue()

void ome::xml::meta::OMEXMLMetadata::setTagAnnotationValue ( const std::string &  value,
index_type  tagAnnotationIndex 
)
virtual

Set the Value property of TagAnnotation.

Parameters
valueValue to set.
tagAnnotationIndexthe TagAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTermAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setTermAnnotationAnnotationRef ( const std::string &  annotation,
index_type  termAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of TermAnnotation.

Parameters
annotationAnnotationRef to set.
termAnnotationIndexthe TermAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setTermAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setTermAnnotationAnnotator ( const std::string &  annotator,
index_type  termAnnotationIndex 
)
virtual

Set the Annotator property of TermAnnotation.

Parameters
annotatorAnnotator to set.
termAnnotationIndexthe TermAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTermAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setTermAnnotationDescription ( const std::string &  description,
index_type  termAnnotationIndex 
)
virtual

Set the Description property of TermAnnotation.

Parameters
descriptionDescription to set.
termAnnotationIndexthe TermAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTermAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setTermAnnotationID ( const std::string &  id,
index_type  termAnnotationIndex 
)
virtual

Set the ID property of TermAnnotation.

Parameters
idID to set.
termAnnotationIndexthe TermAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setTermAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setTermAnnotationNamespace ( const std::string &  namespace_,
index_type  termAnnotationIndex 
)
virtual

Set the Namespace property of TermAnnotation.

Parameters
namespace_Namespace to set.
termAnnotationIndexthe TermAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTermAnnotationValue()

void ome::xml::meta::OMEXMLMetadata::setTermAnnotationValue ( const std::string &  value,
index_type  termAnnotationIndex 
)
virtual

Set the Value property of TermAnnotation.

Parameters
valueValue to set.
termAnnotationIndexthe TermAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTiffDataFirstC()

void ome::xml::meta::OMEXMLMetadata::setTiffDataFirstC ( ome::xml::model::primitives::NonNegativeInteger  firstC,
index_type  imageIndex,
index_type  tiffDataIndex 
)
virtual

Set the FirstC property of TiffData.

Parameters
firstCFirstC to set.
imageIndexthe Image index.
tiffDataIndexthe TiffData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTiffDataFirstT()

void ome::xml::meta::OMEXMLMetadata::setTiffDataFirstT ( ome::xml::model::primitives::NonNegativeInteger  firstT,
index_type  imageIndex,
index_type  tiffDataIndex 
)
virtual

Set the FirstT property of TiffData.

Parameters
firstTFirstT to set.
imageIndexthe Image index.
tiffDataIndexthe TiffData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTiffDataFirstZ()

void ome::xml::meta::OMEXMLMetadata::setTiffDataFirstZ ( ome::xml::model::primitives::NonNegativeInteger  firstZ,
index_type  imageIndex,
index_type  tiffDataIndex 
)
virtual

Set the FirstZ property of TiffData.

Parameters
firstZFirstZ to set.
imageIndexthe Image index.
tiffDataIndexthe TiffData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTiffDataIFD()

void ome::xml::meta::OMEXMLMetadata::setTiffDataIFD ( ome::xml::model::primitives::NonNegativeInteger  ifd,
index_type  imageIndex,
index_type  tiffDataIndex 
)
virtual

Set the IFD property of TiffData.

Parameters
ifdIFD to set.
imageIndexthe Image index.
tiffDataIndexthe TiffData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTiffDataPlaneCount()

void ome::xml::meta::OMEXMLMetadata::setTiffDataPlaneCount ( ome::xml::model::primitives::NonNegativeInteger  planeCount,
index_type  imageIndex,
index_type  tiffDataIndex 
)
virtual

Set the PlaneCount property of TiffData.

Parameters
planeCountPlaneCount to set.
imageIndexthe Image index.
tiffDataIndexthe TiffData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTimestampAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setTimestampAnnotationAnnotationRef ( const std::string &  annotation,
index_type  timestampAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of TimestampAnnotation.

Parameters
annotationAnnotationRef to set.
timestampAnnotationIndexthe TimestampAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setTimestampAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setTimestampAnnotationAnnotator ( const std::string &  annotator,
index_type  timestampAnnotationIndex 
)
virtual

Set the Annotator property of TimestampAnnotation.

Parameters
annotatorAnnotator to set.
timestampAnnotationIndexthe TimestampAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTimestampAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setTimestampAnnotationDescription ( const std::string &  description,
index_type  timestampAnnotationIndex 
)
virtual

Set the Description property of TimestampAnnotation.

Parameters
descriptionDescription to set.
timestampAnnotationIndexthe TimestampAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTimestampAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setTimestampAnnotationID ( const std::string &  id,
index_type  timestampAnnotationIndex 
)
virtual

Set the ID property of TimestampAnnotation.

Parameters
idID to set.
timestampAnnotationIndexthe TimestampAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setTimestampAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setTimestampAnnotationNamespace ( const std::string &  namespace_,
index_type  timestampAnnotationIndex 
)
virtual

Set the Namespace property of TimestampAnnotation.

Parameters
namespace_Namespace to set.
timestampAnnotationIndexthe TimestampAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTimestampAnnotationValue()

void ome::xml::meta::OMEXMLMetadata::setTimestampAnnotationValue ( ome::xml::model::primitives::Timestamp  value,
index_type  timestampAnnotationIndex 
)
virtual

Set the Value property of TimestampAnnotation.

Parameters
valueValue to set.
timestampAnnotationIndexthe TimestampAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTransmittanceRangeCutIn()

void ome::xml::meta::OMEXMLMetadata::setTransmittanceRangeCutIn ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat cutIn,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the CutIn property of TransmittanceRange.

Parameters
cutInCutIn to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTransmittanceRangeCutInTolerance()

void ome::xml::meta::OMEXMLMetadata::setTransmittanceRangeCutInTolerance ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeFloat cutInTolerance,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the CutInTolerance property of TransmittanceRange.

Parameters
cutInToleranceCutInTolerance to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTransmittanceRangeCutOut()

void ome::xml::meta::OMEXMLMetadata::setTransmittanceRangeCutOut ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat cutOut,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the CutOut property of TransmittanceRange.

Parameters
cutOutCutOut to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTransmittanceRangeCutOutTolerance()

void ome::xml::meta::OMEXMLMetadata::setTransmittanceRangeCutOutTolerance ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeFloat cutOutTolerance,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the CutOutTolerance property of TransmittanceRange.

Parameters
cutOutToleranceCutOutTolerance to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setTransmittanceRangeTransmittance()

void ome::xml::meta::OMEXMLMetadata::setTransmittanceRangeTransmittance ( ome::xml::model::primitives::PercentFraction  transmittance,
index_type  instrumentIndex,
index_type  filterIndex 
)
virtual

Set the Transmittance property of TransmittanceRange.

Parameters
transmittanceTransmittance to set.
instrumentIndexthe Instrument index.
filterIndexthe Filter index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setUUID()

void ome::xml::meta::OMEXMLMetadata::setUUID ( const std::string &  uuid)
virtual

Set the UUID associated with this collection of metadata.

Parameters
uuidthe UUID to set.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setUUIDFileName()

void ome::xml::meta::OMEXMLMetadata::setUUIDFileName ( const std::string &  fileName,
index_type  imageIndex,
index_type  tiffDataIndex 
)
virtual

Set the FileName property of UUID.

Parameters
fileNameFileName to set.
imageIndexthe Image index.
tiffDataIndexthe TiffData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setUUIDValue()

void ome::xml::meta::OMEXMLMetadata::setUUIDValue ( std::string  value,
index_type  imageIndex,
index_type  tiffDataIndex 
)
virtual

Set the text value of UUID.

Parameters
valuetext value.
imageIndexthe Image index.
tiffDataIndexthe TiffData index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setWellAnnotationRef ( const std::string &  annotation,
index_type  plateIndex,
index_type  wellIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of Well.

Parameters
annotationAnnotationRef to set.
plateIndexthe Plate index.
wellIndexthe Well index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setWellColor()

void ome::xml::meta::OMEXMLMetadata::setWellColor ( ome::xml::model::primitives::Color  color,
index_type  plateIndex,
index_type  wellIndex 
)
virtual

Set the Color property of Well.

Parameters
colorColor to set.
plateIndexthe Plate index.
wellIndexthe Well index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellColumn()

void ome::xml::meta::OMEXMLMetadata::setWellColumn ( ome::xml::model::primitives::NonNegativeInteger  column,
index_type  plateIndex,
index_type  wellIndex 
)
virtual

Set the Column property of Well.

Parameters
columnColumn to set.
plateIndexthe Plate index.
wellIndexthe Well index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellExternalDescription()

void ome::xml::meta::OMEXMLMetadata::setWellExternalDescription ( const std::string &  externalDescription,
index_type  plateIndex,
index_type  wellIndex 
)
virtual

Set the ExternalDescription property of Well.

Parameters
externalDescriptionExternalDescription to set.
plateIndexthe Plate index.
wellIndexthe Well index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellExternalIdentifier()

void ome::xml::meta::OMEXMLMetadata::setWellExternalIdentifier ( const std::string &  externalIdentifier,
index_type  plateIndex,
index_type  wellIndex 
)
virtual

Set the ExternalIdentifier property of Well.

Parameters
externalIdentifierExternalIdentifier to set.
plateIndexthe Plate index.
wellIndexthe Well index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellID()

void ome::xml::meta::OMEXMLMetadata::setWellID ( const std::string &  id,
index_type  plateIndex,
index_type  wellIndex 
)
virtual

Set the ID property of Well.

Parameters
idID to set.
plateIndexthe Plate index.
wellIndexthe Well index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setWellReagentRef()

void ome::xml::meta::OMEXMLMetadata::setWellReagentRef ( const std::string &  reagent,
index_type  plateIndex,
index_type  wellIndex 
)
virtual

Set the ReagentRef property of Well.

Parameters
reagentReagentRef to set.
plateIndexthe Plate index.
wellIndexthe Well index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setWellRow()

void ome::xml::meta::OMEXMLMetadata::setWellRow ( ome::xml::model::primitives::NonNegativeInteger  row,
index_type  plateIndex,
index_type  wellIndex 
)
virtual

Set the Row property of Well.

Parameters
rowRow to set.
plateIndexthe Plate index.
wellIndexthe Well index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellSampleID()

void ome::xml::meta::OMEXMLMetadata::setWellSampleID ( const std::string &  id,
index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
)
virtual

Set the ID property of WellSample.

Parameters
idID to set.
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setWellSampleImageRef()

void ome::xml::meta::OMEXMLMetadata::setWellSampleImageRef ( const std::string &  image,
index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
)
virtual

Set the ImageRef property of WellSample.

Parameters
imageImageRef to set.
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setWellSampleIndex()

void ome::xml::meta::OMEXMLMetadata::setWellSampleIndex ( ome::xml::model::primitives::NonNegativeInteger  index,
index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
)
virtual

Set the Index property of WellSample.

Parameters
indexIndex to set.
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellSamplePositionX()

void ome::xml::meta::OMEXMLMetadata::setWellSamplePositionX ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength positionX,
index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
)
virtual

Set the PositionX property of WellSample.

Parameters
positionXPositionX to set.
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellSamplePositionY()

void ome::xml::meta::OMEXMLMetadata::setWellSamplePositionY ( ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength positionY,
index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
)
virtual

Set the PositionY property of WellSample.

Parameters
positionYPositionY to set.
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellSampleTimepoint()

void ome::xml::meta::OMEXMLMetadata::setWellSampleTimepoint ( ome::xml::model::primitives::Timestamp  timepoint,
index_type  plateIndex,
index_type  wellIndex,
index_type  wellSampleIndex 
)
virtual

Set the Timepoint property of WellSample.

Parameters
timepointTimepoint to set.
plateIndexthe Plate index.
wellIndexthe Well index.
wellSampleIndexthe WellSample index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setWellType()

void ome::xml::meta::OMEXMLMetadata::setWellType ( const std::string &  type,
index_type  plateIndex,
index_type  wellIndex 
)
virtual

Set the Type property of Well.

Parameters
typeType to set.
plateIndexthe Plate index.
wellIndexthe Well index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setXMLAnnotationAnnotationRef()

void ome::xml::meta::OMEXMLMetadata::setXMLAnnotationAnnotationRef ( const std::string &  annotation,
index_type  XMLAnnotationIndex,
index_type  annotationRefIndex 
)
virtual

Set the AnnotationRef property of XMLAnnotation.

Parameters
annotationAnnotationRef to set.
XMLAnnotationIndexthe XMLAnnotation index.
annotationRefIndexAnnotationRef index (unused).

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setXMLAnnotationAnnotator()

void ome::xml::meta::OMEXMLMetadata::setXMLAnnotationAnnotator ( const std::string &  annotator,
index_type  XMLAnnotationIndex 
)
virtual

Set the Annotator property of XMLAnnotation.

Parameters
annotatorAnnotator to set.
XMLAnnotationIndexthe XMLAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setXMLAnnotationDescription()

void ome::xml::meta::OMEXMLMetadata::setXMLAnnotationDescription ( const std::string &  description,
index_type  XMLAnnotationIndex 
)
virtual

Set the Description property of XMLAnnotation.

Parameters
descriptionDescription to set.
XMLAnnotationIndexthe XMLAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setXMLAnnotationID()

void ome::xml::meta::OMEXMLMetadata::setXMLAnnotationID ( const std::string &  id,
index_type  XMLAnnotationIndex 
)
virtual

Set the ID property of XMLAnnotation.

Parameters
idID to set.
XMLAnnotationIndexthe XMLAnnotation index.

Implements ome::xml::meta::MetadataStore.

References model, and root.

◆ setXMLAnnotationNamespace()

void ome::xml::meta::OMEXMLMetadata::setXMLAnnotationNamespace ( const std::string &  namespace_,
index_type  XMLAnnotationIndex 
)
virtual

Set the Namespace property of XMLAnnotation.

Parameters
namespace_Namespace to set.
XMLAnnotationIndexthe XMLAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.

◆ setXMLAnnotationValue()

void ome::xml::meta::OMEXMLMetadata::setXMLAnnotationValue ( const std::string &  value,
index_type  XMLAnnotationIndex 
)
virtual

Set the Value property of XMLAnnotation.

Parameters
valueValue to set.
XMLAnnotationIndexthe XMLAnnotation index.

Implements ome::xml::meta::MetadataStore.

References root.


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