Annotation model object. More...
#include <ome/xml/model/Annotation.h>
Inheritance diagram for ome::xml::model::Annotation: Collaboration diagram for ome::xml::model::Annotation:Classes | |
| class | Impl |
| Private implementation details of Annotation model object. More... | |
Protected Member Functions | |
| virtual void | asXMLElementInternal (common::xml::dom::Document &document, common::xml::dom::Element &element) const |
| Transform the object hierarchy rooted at this element to XML. More... | |
| Protected Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
| OMEModelObject (const std::string &objectType="OMEModelObject") | |
| Constructor. More... | |
| OMEModelObject (const OMEModelObject ©) | |
| Copy constructor. More... | |
| template<class C , typename T > | |
| bool | contains (const C &container, const std::shared_ptr< T > &element) |
| Check if a container contains a particular element. More... | |
| Protected Member Functions inherited from ome::xml::model::OMEModelObject | |
| OMEModelObject () | |
| Constructor. | |
Private Attributes | |
| std::shared_ptr< Impl > | impl |
| Private implementation details. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
| static std::vector< common::xml::dom::Element > | getChildrenByTagName (const common::xml::dom::Element &parent, const std::string &name) |
| Retrieve all the children of an element that have a given tag name. More... | |
| static std::string | stripNamespacePrefix (const std::string &value) |
| Strip the namespace prefix from a tag name. More... | |
| Protected Attributes inherited from ome::xml::model::detail::OMEModelObject | |
| ome::common::Logger | logger |
| Message logger. | |
Detailed Description
Annotation model object.
Constructor & Destructor Documentation
◆ Annotation()
| ome::xml::model::Annotation::Annotation | ( | const Annotation & | copy | ) |
Copy constructor.
- Parameters
-
copy the Annotation to copy.
Member Function Documentation
◆ asXMLElementInternal()
|
protectedvirtual |
Transform the object hierarchy rooted at this element to XML.
This internal implementation of asXMLelement also requires an XML element, which must not be null, or may be instantiated and passed from superclasses.
Concrete model object implementations should override this method.
- Parameters
-
document XML document for element creation. element XML element for setting model data.
Implements ome::xml::model::detail::OMEModelObject.
Reimplemented in ome::xml::model::FileAnnotation, ome::xml::model::MapAnnotation, ome::xml::model::TimestampAnnotation, ome::xml::model::BooleanAnnotation, ome::xml::model::CommentAnnotation, ome::xml::model::DoubleAnnotation, ome::xml::model::LongAnnotation, ome::xml::model::TagAnnotation, ome::xml::model::TermAnnotation, ome::xml::model::XMLAnnotation, ome::xml::model::ListAnnotation, ome::xml::model::OriginalMetadataAnnotation, ome::xml::model::BasicAnnotation, ome::xml::model::NumericAnnotation, ome::xml::model::TextAnnotation, and ome::xml::model::TypeAnnotation.
References ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().
Referenced by ome::xml::model::BasicAnnotation::asXMLElementInternal(), ome::xml::model::TypeAnnotation::asXMLElementInternal(), ome::xml::model::TextAnnotation::asXMLElementInternal(), ome::xml::model::ListAnnotation::asXMLElementInternal(), and ome::xml::model::MapAnnotation::asXMLElementInternal().
Here is the caller graph for this function:◆ getAnnotator() [1/2]
| std::shared_ptr< std::string > ome::xml::model::Annotation::getAnnotator | ( | ) |
◆ getAnnotator() [2/2]
| const std::shared_ptr< std::string > ome::xml::model::Annotation::getAnnotator | ( | ) | const |
◆ getDescription() [1/2]
| std::shared_ptr< std::string > ome::xml::model::Annotation::getDescription | ( | ) |
◆ getDescription() [2/2]
| const std::shared_ptr< std::string > ome::xml::model::Annotation::getDescription | ( | ) | const |
◆ getID()
| const std::string & ome::xml::model::Annotation::getID | ( | ) | const |
◆ getLinkedAnnotation()
| const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Annotation::getLinkedAnnotation | ( | OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type | index | ) | const |
Get linked Annotation.
- Parameters
-
index the index number of the Annotation.
- Returns
- a weak pointer to the Annotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getLinkedAnnotationList()
| OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedAnnotationList | ( | ) | const |
◆ getLinkedChannel()
| const std::weak_ptr< ome::xml::model::Channel > & ome::xml::model::Annotation::getLinkedChannel | ( | OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedChannelList()
| OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedChannelList | ( | ) | const |
◆ getLinkedDataset()
| const std::weak_ptr< ome::xml::model::Dataset > & ome::xml::model::Annotation::getLinkedDataset | ( | OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedDatasetList()
| OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedDatasetList | ( | ) | const |
◆ getLinkedDetector()
| const std::weak_ptr< ome::xml::model::Detector > & ome::xml::model::Annotation::getLinkedDetector | ( | OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedDetectorList()
| OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedDetectorList | ( | ) | const |
◆ getLinkedDichroic()
| const std::weak_ptr< ome::xml::model::Dichroic > & ome::xml::model::Annotation::getLinkedDichroic | ( | OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedDichroicList()
| OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedDichroicList | ( | ) | const |
◆ getLinkedExperimenter()
| const std::weak_ptr< ome::xml::model::Experimenter > & ome::xml::model::Annotation::getLinkedExperimenter | ( | OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type::size_type | index | ) | const |
Get linked Experimenter.
- Parameters
-
index the index number of the Experimenter.
- Returns
- a weak pointer to the Experimenter.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getLinkedExperimenterGroup()
| const std::weak_ptr< ome::xml::model::ExperimenterGroup > & ome::xml::model::Annotation::getLinkedExperimenterGroup | ( | OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type | index | ) | const |
Get linked ExperimenterGroup.
- Parameters
-
index the index number of the ExperimenterGroup.
- Returns
- a weak pointer to the ExperimenterGroup.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getLinkedExperimenterGroupList()
| OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedExperimenterGroupList | ( | ) | const |
◆ getLinkedExperimenterList()
| OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedExperimenterList | ( | ) | const |
◆ getLinkedFilter()
| const std::weak_ptr< ome::xml::model::Filter > & ome::xml::model::Annotation::getLinkedFilter | ( | OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedFilterList()
| OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedFilterList | ( | ) | const |
◆ getLinkedFolder()
| const std::weak_ptr< ome::xml::model::Folder > & ome::xml::model::Annotation::getLinkedFolder | ( | OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedFolderList()
| OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedFolderList | ( | ) | const |
◆ getLinkedImage()
| const std::weak_ptr< ome::xml::model::Image > & ome::xml::model::Annotation::getLinkedImage | ( | OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedImageList()
| OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedImageList | ( | ) | const |
◆ getLinkedInstrument()
| const std::weak_ptr< ome::xml::model::Instrument > & ome::xml::model::Annotation::getLinkedInstrument | ( | OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type::size_type | index | ) | const |
Get linked Instrument.
- Parameters
-
index the index number of the Instrument.
- Returns
- a weak pointer to the Instrument.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getLinkedInstrumentList()
| OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedInstrumentList | ( | ) | const |
◆ getLinkedLightPath()
| const std::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Annotation::getLinkedLightPath | ( | OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedLightPathList()
| OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedLightPathList | ( | ) | const |
◆ getLinkedLightSource()
| const std::weak_ptr< ome::xml::model::LightSource > & ome::xml::model::Annotation::getLinkedLightSource | ( | OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type::size_type | index | ) | const |
Get linked LightSource.
- Parameters
-
index the index number of the LightSource.
- Returns
- a weak pointer to the LightSource.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getLinkedLightSourceList()
| OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedLightSourceList | ( | ) | const |
◆ getLinkedObjective()
| const std::weak_ptr< ome::xml::model::Objective > & ome::xml::model::Annotation::getLinkedObjective | ( | OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedObjectiveList()
| OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedObjectiveList | ( | ) | const |
◆ getLinkedPlane()
| const std::weak_ptr< ome::xml::model::Plane > & ome::xml::model::Annotation::getLinkedPlane | ( | OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedPlaneList()
| OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedPlaneList | ( | ) | const |
◆ getLinkedPlate()
| const std::weak_ptr< ome::xml::model::Plate > & ome::xml::model::Annotation::getLinkedPlate | ( | OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedPlateAcquisition()
| const std::weak_ptr< ome::xml::model::PlateAcquisition > & ome::xml::model::Annotation::getLinkedPlateAcquisition | ( | OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type::size_type | index | ) | const |
Get linked PlateAcquisition.
- Parameters
-
index the index number of the PlateAcquisition.
- Returns
- a weak pointer to the PlateAcquisition.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getLinkedPlateAcquisitionList()
| OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedPlateAcquisitionList | ( | ) | const |
◆ getLinkedPlateList()
| OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedPlateList | ( | ) | const |
◆ getLinkedProject()
| const std::weak_ptr< ome::xml::model::Project > & ome::xml::model::Annotation::getLinkedProject | ( | OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedProjectList()
| OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedProjectList | ( | ) | const |
◆ getLinkedReagent()
| const std::weak_ptr< ome::xml::model::Reagent > & ome::xml::model::Annotation::getLinkedReagent | ( | OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedReagentList()
| OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedReagentList | ( | ) | const |
◆ getLinkedROI()
| const std::weak_ptr< ome::xml::model::ROI > & ome::xml::model::Annotation::getLinkedROI | ( | OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedROIList()
| OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedROIList | ( | ) | const |
◆ getLinkedScreen()
| const std::weak_ptr< ome::xml::model::Screen > & ome::xml::model::Annotation::getLinkedScreen | ( | OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedScreenList()
| OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedScreenList | ( | ) | const |
◆ getLinkedShape()
| const std::weak_ptr< ome::xml::model::Shape > & ome::xml::model::Annotation::getLinkedShape | ( | OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedShapeList()
| OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedShapeList | ( | ) | const |
◆ getLinkedWell()
| const std::weak_ptr< ome::xml::model::Well > & ome::xml::model::Annotation::getLinkedWell | ( | OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type | index | ) | const |
◆ getLinkedWellList()
| OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type ome::xml::model::Annotation::getLinkedWellList | ( | ) | const |
◆ getNamespace() [1/2]
| std::shared_ptr< std::string > ome::xml::model::Annotation::getNamespace | ( | ) |
◆ getNamespace() [2/2]
| const std::shared_ptr< std::string > ome::xml::model::Annotation::getNamespace | ( | ) | const |
◆ getXMLNamespace()
|
virtual |
Get the XML namespace for this model object.
- Returns
- the XML namespace.
Implements ome::xml::model::OMEModelObject.
Reimplemented in ome::xml::model::FileAnnotation, ome::xml::model::MapAnnotation, ome::xml::model::TimestampAnnotation, ome::xml::model::BooleanAnnotation, ome::xml::model::CommentAnnotation, ome::xml::model::DoubleAnnotation, ome::xml::model::LongAnnotation, ome::xml::model::TagAnnotation, ome::xml::model::TermAnnotation, ome::xml::model::XMLAnnotation, ome::xml::model::ListAnnotation, ome::xml::model::BasicAnnotation, ome::xml::model::NumericAnnotation, ome::xml::model::TextAnnotation, and ome::xml::model::TypeAnnotation.
Referenced by asXMLElementInternal().
Here is the caller graph for this function:◆ link()
| bool ome::xml::model::Annotation::link | ( | std::shared_ptr< Reference > & | reference, |
| std::shared_ptr< ome::xml::model::OMEModelObject > & | object | ||
| ) |
Link a given OME model object to this model object.
- Parameters
-
reference type qualifier for the reference. This should be the corresponding reference type for object. If, for example, object is of type Image, reference must be of type ImageRef. object Model object to link to.
- Returns
trueif this model object was able to handle the reference, otherwisefalse.
- Todo:
- the use of reference to provide type information for the type of object is unconventional and quite possibly unnecessary–a simple string or type_info would suffice for what it's being used for, if it's needed at all. Is this true for all cases? The implementation also needs to do strict checking of the object type; it's not currently failing if it's of the wrong type. This applies to all generated model objects implementing this interface.
- Todo:
- This bit is silly; why do we have two dynamic_casts here.
References impl, ome::xml::model::detail::OMEModelObject::link(), and ome::xml::model::detail::OMEModelObject::logger.
Referenced by ome::xml::model::BasicAnnotation::link(), ome::xml::model::TypeAnnotation::link(), ome::xml::model::TextAnnotation::link(), ome::xml::model::ListAnnotation::link(), and ome::xml::model::MapAnnotation::link().
Here is the caller graph for this function:◆ linkAnnotation()
| bool ome::xml::model::Annotation::linkAnnotation | ( | const std::shared_ptr< ome::xml::model::Annotation > & | annotation | ) |
Link Annotation.
- Parameters
-
annotation the Annotation to link.
- Returns
trueif the object was added to the internal annotationLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
◆ linkChannel()
| bool ome::xml::model::Annotation::linkChannel | ( | const std::shared_ptr< ome::xml::model::Channel > & | channel_BackReference | ) |
Link Channel.
- Parameters
-
channel_BackReference the Channel to link.
- Returns
trueif the object was added to the internal channelLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Channel::link().
Here is the caller graph for this function:◆ linkDataset()
| bool ome::xml::model::Annotation::linkDataset | ( | const std::shared_ptr< ome::xml::model::Dataset > & | dataset_BackReference | ) |
Link Dataset.
- Parameters
-
dataset_BackReference the Dataset to link.
- Returns
trueif the object was added to the internal datasetLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Dataset::link().
Here is the caller graph for this function:◆ linkDetector()
| bool ome::xml::model::Annotation::linkDetector | ( | const std::shared_ptr< ome::xml::model::Detector > & | detector_BackReference | ) |
Link Detector.
- Parameters
-
detector_BackReference the Detector to link.
- Returns
trueif the object was added to the internal detectorLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Detector::link().
Here is the caller graph for this function:◆ linkDichroic()
| bool ome::xml::model::Annotation::linkDichroic | ( | const std::shared_ptr< ome::xml::model::Dichroic > & | dichroic_BackReference | ) |
Link Dichroic.
- Parameters
-
dichroic_BackReference the Dichroic to link.
- Returns
trueif the object was added to the internal dichroicLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Dichroic::link().
Here is the caller graph for this function:◆ linkExperimenter()
| bool ome::xml::model::Annotation::linkExperimenter | ( | const std::shared_ptr< ome::xml::model::Experimenter > & | experimenter_BackReference | ) |
Link Experimenter.
- Parameters
-
experimenter_BackReference the Experimenter to link.
- Returns
trueif the object was added to the internal experimenterLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Experimenter::link().
Here is the caller graph for this function:◆ linkExperimenterGroup()
| bool ome::xml::model::Annotation::linkExperimenterGroup | ( | const std::shared_ptr< ome::xml::model::ExperimenterGroup > & | experimenterGroup_BackReference | ) |
Link ExperimenterGroup.
- Parameters
-
experimenterGroup_BackReference the ExperimenterGroup to link.
- Returns
trueif the object was added to the internal experimenterGroupLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::ExperimenterGroup::link().
Here is the caller graph for this function:◆ linkFilter()
| bool ome::xml::model::Annotation::linkFilter | ( | const std::shared_ptr< ome::xml::model::Filter > & | filter_BackReference | ) |
Link Filter.
- Parameters
-
filter_BackReference the Filter to link.
- Returns
trueif the object was added to the internal filterLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Filter::link().
Here is the caller graph for this function:◆ linkFolder()
| bool ome::xml::model::Annotation::linkFolder | ( | const std::shared_ptr< ome::xml::model::Folder > & | folder_BackReference | ) |
Link Folder.
- Parameters
-
folder_BackReference the Folder to link.
- Returns
trueif the object was added to the internal folderLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Folder::link().
Here is the caller graph for this function:◆ linkImage()
| bool ome::xml::model::Annotation::linkImage | ( | const std::shared_ptr< ome::xml::model::Image > & | image_BackReference | ) |
Link Image.
- Parameters
-
image_BackReference the Image to link.
- Returns
trueif the object was added to the internal imageLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Image::link().
Here is the caller graph for this function:◆ linkInstrument()
| bool ome::xml::model::Annotation::linkInstrument | ( | const std::shared_ptr< ome::xml::model::Instrument > & | instrument_BackReference | ) |
Link Instrument.
- Parameters
-
instrument_BackReference the Instrument to link.
- Returns
trueif the object was added to the internal instrumentLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Instrument::link().
Here is the caller graph for this function:◆ linkLightPath()
| bool ome::xml::model::Annotation::linkLightPath | ( | const std::shared_ptr< ome::xml::model::LightPath > & | lightPath_BackReference | ) |
Link LightPath.
- Parameters
-
lightPath_BackReference the LightPath to link.
- Returns
trueif the object was added to the internal lightPathLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::LightPath::link().
Here is the caller graph for this function:◆ linkLightSource()
| bool ome::xml::model::Annotation::linkLightSource | ( | const std::shared_ptr< ome::xml::model::LightSource > & | lightSource_BackReference | ) |
Link LightSource.
- Parameters
-
lightSource_BackReference the LightSource to link.
- Returns
trueif the object was added to the internal lightSourceLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::LightSource::link().
Here is the caller graph for this function:◆ linkObjective()
| bool ome::xml::model::Annotation::linkObjective | ( | const std::shared_ptr< ome::xml::model::Objective > & | objective_BackReference | ) |
Link Objective.
- Parameters
-
objective_BackReference the Objective to link.
- Returns
trueif the object was added to the internal objectiveLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Objective::link().
Here is the caller graph for this function:◆ linkPlane()
| bool ome::xml::model::Annotation::linkPlane | ( | const std::shared_ptr< ome::xml::model::Plane > & | plane_BackReference | ) |
Link Plane.
- Parameters
-
plane_BackReference the Plane to link.
- Returns
trueif the object was added to the internal planeLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Plane::link().
Here is the caller graph for this function:◆ linkPlate()
| bool ome::xml::model::Annotation::linkPlate | ( | const std::shared_ptr< ome::xml::model::Plate > & | plate_BackReference | ) |
Link Plate.
- Parameters
-
plate_BackReference the Plate to link.
- Returns
trueif the object was added to the internal plateLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Plate::link().
Here is the caller graph for this function:◆ linkPlateAcquisition()
| bool ome::xml::model::Annotation::linkPlateAcquisition | ( | const std::shared_ptr< ome::xml::model::PlateAcquisition > & | plateAcquisition_BackReference | ) |
Link PlateAcquisition.
- Parameters
-
plateAcquisition_BackReference the PlateAcquisition to link.
- Returns
trueif the object was added to the internal plateAcquisitionLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::PlateAcquisition::link().
Here is the caller graph for this function:◆ linkProject()
| bool ome::xml::model::Annotation::linkProject | ( | const std::shared_ptr< ome::xml::model::Project > & | project_BackReference | ) |
Link Project.
- Parameters
-
project_BackReference the Project to link.
- Returns
trueif the object was added to the internal projectLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Project::link().
Here is the caller graph for this function:◆ linkReagent()
| bool ome::xml::model::Annotation::linkReagent | ( | const std::shared_ptr< ome::xml::model::Reagent > & | reagent_BackReference | ) |
Link Reagent.
- Parameters
-
reagent_BackReference the Reagent to link.
- Returns
trueif the object was added to the internal reagentLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Reagent::link().
Here is the caller graph for this function:◆ linkROI()
| bool ome::xml::model::Annotation::linkROI | ( | const std::shared_ptr< ome::xml::model::ROI > & | roi_BackReference | ) |
Link ROI.
- Parameters
-
roi_BackReference the ROI to link.
- Returns
trueif the object was added to the internal roiLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::ROI::link().
Here is the caller graph for this function:◆ linkScreen()
| bool ome::xml::model::Annotation::linkScreen | ( | const std::shared_ptr< ome::xml::model::Screen > & | screen_BackReference | ) |
Link Screen.
- Parameters
-
screen_BackReference the Screen to link.
- Returns
trueif the object was added to the internal screenLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Screen::link().
Here is the caller graph for this function:◆ linkShape()
| bool ome::xml::model::Annotation::linkShape | ( | const std::shared_ptr< ome::xml::model::Shape > & | shape_BackReference | ) |
Link Shape.
- Parameters
-
shape_BackReference the Shape to link.
- Returns
trueif the object was added to the internal shapeLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Shape::link().
Here is the caller graph for this function:◆ linkWell()
| bool ome::xml::model::Annotation::linkWell | ( | const std::shared_ptr< ome::xml::model::Well > & | well_BackReference | ) |
Link Well.
- Parameters
-
well_BackReference the Well to link.
- Returns
trueif the object was added to the internal wellLinks list, otherwisefalse.
- Todo:
- Why have a return value here; what is it used for? Is this an artifact of the Java API?
References impl.
Referenced by ome::xml::model::Well::link().
Here is the caller graph for this function:◆ setAnnotator()
| void ome::xml::model::Annotation::setAnnotator | ( | std::shared_ptr< std::string > & | annotator | ) |
◆ setDescription()
| void ome::xml::model::Annotation::setDescription | ( | std::shared_ptr< std::string > & | description | ) |
◆ setID()
| void ome::xml::model::Annotation::setID | ( | const std::string & | id | ) |
◆ setLinkedAnnotation()
| const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Annotation::setLinkedAnnotation | ( | OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Annotation > & | annotation | ||
| ) |
Set linked Annotation.
- Note
- The index must be valid.
- Parameters
-
index the index number of the Annotation. annotation the Annotation to set.
- Returns
- a weak pointer to the Annotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setLinkedChannel()
| const std::weak_ptr< ome::xml::model::Channel > & ome::xml::model::Annotation::setLinkedChannel | ( | OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Channel > & | channel_BackReference | ||
| ) |
◆ setLinkedDataset()
| const std::weak_ptr< ome::xml::model::Dataset > & ome::xml::model::Annotation::setLinkedDataset | ( | OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Dataset > & | dataset_BackReference | ||
| ) |
◆ setLinkedDetector()
| const std::weak_ptr< ome::xml::model::Detector > & ome::xml::model::Annotation::setLinkedDetector | ( | OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Detector > & | detector_BackReference | ||
| ) |
◆ setLinkedDichroic()
| const std::weak_ptr< ome::xml::model::Dichroic > & ome::xml::model::Annotation::setLinkedDichroic | ( | OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Dichroic > & | dichroic_BackReference | ||
| ) |
◆ setLinkedExperimenter()
| const std::weak_ptr< ome::xml::model::Experimenter > & ome::xml::model::Annotation::setLinkedExperimenter | ( | OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Experimenter > & | experimenter_BackReference | ||
| ) |
Set linked Experimenter.
- Note
- The index must be valid.
- Parameters
-
index the index number of the Experimenter. experimenter_BackReference the Experimenter to set.
- Returns
- a weak pointer to the Experimenter.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setLinkedExperimenterGroup()
| const std::weak_ptr< ome::xml::model::ExperimenterGroup > & ome::xml::model::Annotation::setLinkedExperimenterGroup | ( | OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::ExperimenterGroup > & | experimenterGroup_BackReference | ||
| ) |
Set linked ExperimenterGroup.
- Note
- The index must be valid.
- Parameters
-
index the index number of the ExperimenterGroup. experimenterGroup_BackReference the ExperimenterGroup to set.
- Returns
- a weak pointer to the ExperimenterGroup.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setLinkedFilter()
| const std::weak_ptr< ome::xml::model::Filter > & ome::xml::model::Annotation::setLinkedFilter | ( | OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Filter > & | filter_BackReference | ||
| ) |
◆ setLinkedFolder()
| const std::weak_ptr< ome::xml::model::Folder > & ome::xml::model::Annotation::setLinkedFolder | ( | OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Folder > & | folder_BackReference | ||
| ) |
◆ setLinkedImage()
| const std::weak_ptr< ome::xml::model::Image > & ome::xml::model::Annotation::setLinkedImage | ( | OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Image > & | image_BackReference | ||
| ) |
◆ setLinkedInstrument()
| const std::weak_ptr< ome::xml::model::Instrument > & ome::xml::model::Annotation::setLinkedInstrument | ( | OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Instrument > & | instrument_BackReference | ||
| ) |
Set linked Instrument.
- Note
- The index must be valid.
- Parameters
-
index the index number of the Instrument. instrument_BackReference the Instrument to set.
- Returns
- a weak pointer to the Instrument.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setLinkedLightPath()
| const std::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Annotation::setLinkedLightPath | ( | OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::LightPath > & | lightPath_BackReference | ||
| ) |
◆ setLinkedLightSource()
| const std::weak_ptr< ome::xml::model::LightSource > & ome::xml::model::Annotation::setLinkedLightSource | ( | OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::LightSource > & | lightSource_BackReference | ||
| ) |
Set linked LightSource.
- Note
- The index must be valid.
- Parameters
-
index the index number of the LightSource. lightSource_BackReference the LightSource to set.
- Returns
- a weak pointer to the LightSource.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setLinkedObjective()
| const std::weak_ptr< ome::xml::model::Objective > & ome::xml::model::Annotation::setLinkedObjective | ( | OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Objective > & | objective_BackReference | ||
| ) |
◆ setLinkedPlane()
| const std::weak_ptr< ome::xml::model::Plane > & ome::xml::model::Annotation::setLinkedPlane | ( | OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Plane > & | plane_BackReference | ||
| ) |
◆ setLinkedPlate()
| const std::weak_ptr< ome::xml::model::Plate > & ome::xml::model::Annotation::setLinkedPlate | ( | OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Plate > & | plate_BackReference | ||
| ) |
◆ setLinkedPlateAcquisition()
| const std::weak_ptr< ome::xml::model::PlateAcquisition > & ome::xml::model::Annotation::setLinkedPlateAcquisition | ( | OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::PlateAcquisition > & | plateAcquisition_BackReference | ||
| ) |
Set linked PlateAcquisition.
- Note
- The index must be valid.
- Parameters
-
index the index number of the PlateAcquisition. plateAcquisition_BackReference the PlateAcquisition to set.
- Returns
- a weak pointer to the PlateAcquisition.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setLinkedProject()
| const std::weak_ptr< ome::xml::model::Project > & ome::xml::model::Annotation::setLinkedProject | ( | OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Project > & | project_BackReference | ||
| ) |
◆ setLinkedReagent()
| const std::weak_ptr< ome::xml::model::Reagent > & ome::xml::model::Annotation::setLinkedReagent | ( | OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Reagent > & | reagent_BackReference | ||
| ) |
◆ setLinkedROI()
| const std::weak_ptr< ome::xml::model::ROI > & ome::xml::model::Annotation::setLinkedROI | ( | OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::ROI > & | roi_BackReference | ||
| ) |
◆ setLinkedScreen()
| const std::weak_ptr< ome::xml::model::Screen > & ome::xml::model::Annotation::setLinkedScreen | ( | OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Screen > & | screen_BackReference | ||
| ) |
◆ setLinkedShape()
| const std::weak_ptr< ome::xml::model::Shape > & ome::xml::model::Annotation::setLinkedShape | ( | OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Shape > & | shape_BackReference | ||
| ) |
◆ setLinkedWell()
| const std::weak_ptr< ome::xml::model::Well > & ome::xml::model::Annotation::setLinkedWell | ( | OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type | index, |
| const std::shared_ptr< ome::xml::model::Well > & | well_BackReference | ||
| ) |
◆ setNamespace()
| void ome::xml::model::Annotation::setNamespace | ( | std::shared_ptr< std::string > & | namespace_ | ) |
◆ sizeOfLinkedAnnotationList()
| OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedAnnotationList | ( | ) | const |
◆ sizeOfLinkedChannelList()
| OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedChannelList | ( | ) | const |
◆ sizeOfLinkedDatasetList()
| OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedDatasetList | ( | ) | const |
◆ sizeOfLinkedDetectorList()
| OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedDetectorList | ( | ) | const |
◆ sizeOfLinkedDichroicList()
| OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedDichroicList | ( | ) | const |
◆ sizeOfLinkedExperimenterGroupList()
| OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedExperimenterGroupList | ( | ) | const |
◆ sizeOfLinkedExperimenterList()
| OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedExperimenterList | ( | ) | const |
◆ sizeOfLinkedFilterList()
| OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedFilterList | ( | ) | const |
◆ sizeOfLinkedFolderList()
| OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedFolderList | ( | ) | const |
◆ sizeOfLinkedImageList()
| OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedImageList | ( | ) | const |
◆ sizeOfLinkedInstrumentList()
| OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedInstrumentList | ( | ) | const |
◆ sizeOfLinkedLightPathList()
| OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedLightPathList | ( | ) | const |
◆ sizeOfLinkedLightSourceList()
| OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedLightSourceList | ( | ) | const |
◆ sizeOfLinkedObjectiveList()
| OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedObjectiveList | ( | ) | const |
◆ sizeOfLinkedPlaneList()
| OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedPlaneList | ( | ) | const |
◆ sizeOfLinkedPlateAcquisitionList()
| OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedPlateAcquisitionList | ( | ) | const |
◆ sizeOfLinkedPlateList()
| OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedPlateList | ( | ) | const |
◆ sizeOfLinkedProjectList()
| OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedProjectList | ( | ) | const |
◆ sizeOfLinkedReagentList()
| OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedReagentList | ( | ) | const |
◆ sizeOfLinkedROIList()
| OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedROIList | ( | ) | const |
◆ sizeOfLinkedScreenList()
| OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedScreenList | ( | ) | const |
◆ sizeOfLinkedShapeList()
| OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedShapeList | ( | ) | const |
◆ sizeOfLinkedWellList()
| OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type ome::xml::model::Annotation::sizeOfLinkedWellList | ( | ) | const |
◆ unlinkAnnotation()
| bool ome::xml::model::Annotation::unlinkAnnotation | ( | const std::shared_ptr< ome::xml::model::Annotation > & | annotation | ) |
Unlink Annotation.
- Parameters
-
annotation the Annotation to unlink.
- Returns
trueif the Annotation was unlinked, otherwisefalseif the Annotation was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkChannel()
| bool ome::xml::model::Annotation::unlinkChannel | ( | const std::shared_ptr< ome::xml::model::Channel > & | channel_BackReference | ) |
Unlink Channel.
- Parameters
-
channel_BackReference the Channel to unlink.
- Returns
trueif the Channel was unlinked, otherwisefalseif the Channel was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkDataset()
| bool ome::xml::model::Annotation::unlinkDataset | ( | const std::shared_ptr< ome::xml::model::Dataset > & | dataset_BackReference | ) |
Unlink Dataset.
- Parameters
-
dataset_BackReference the Dataset to unlink.
- Returns
trueif the Dataset was unlinked, otherwisefalseif the Dataset was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkDetector()
| bool ome::xml::model::Annotation::unlinkDetector | ( | const std::shared_ptr< ome::xml::model::Detector > & | detector_BackReference | ) |
Unlink Detector.
- Parameters
-
detector_BackReference the Detector to unlink.
- Returns
trueif the Detector was unlinked, otherwisefalseif the Detector was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkDichroic()
| bool ome::xml::model::Annotation::unlinkDichroic | ( | const std::shared_ptr< ome::xml::model::Dichroic > & | dichroic_BackReference | ) |
Unlink Dichroic.
- Parameters
-
dichroic_BackReference the Dichroic to unlink.
- Returns
trueif the Dichroic was unlinked, otherwisefalseif the Dichroic was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkExperimenter()
| bool ome::xml::model::Annotation::unlinkExperimenter | ( | const std::shared_ptr< ome::xml::model::Experimenter > & | experimenter_BackReference | ) |
Unlink Experimenter.
- Parameters
-
experimenter_BackReference the Experimenter to unlink.
- Returns
trueif the Experimenter was unlinked, otherwisefalseif the Experimenter was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkExperimenterGroup()
| bool ome::xml::model::Annotation::unlinkExperimenterGroup | ( | const std::shared_ptr< ome::xml::model::ExperimenterGroup > & | experimenterGroup_BackReference | ) |
Unlink ExperimenterGroup.
- Parameters
-
experimenterGroup_BackReference the ExperimenterGroup to unlink.
- Returns
trueif the ExperimenterGroup was unlinked, otherwisefalseif the ExperimenterGroup was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkFilter()
| bool ome::xml::model::Annotation::unlinkFilter | ( | const std::shared_ptr< ome::xml::model::Filter > & | filter_BackReference | ) |
Unlink Filter.
- Parameters
-
filter_BackReference the Filter to unlink.
- Returns
trueif the Filter was unlinked, otherwisefalseif the Filter was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkFolder()
| bool ome::xml::model::Annotation::unlinkFolder | ( | const std::shared_ptr< ome::xml::model::Folder > & | folder_BackReference | ) |
Unlink Folder.
- Parameters
-
folder_BackReference the Folder to unlink.
- Returns
trueif the Folder was unlinked, otherwisefalseif the Folder was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkImage()
| bool ome::xml::model::Annotation::unlinkImage | ( | const std::shared_ptr< ome::xml::model::Image > & | image_BackReference | ) |
Unlink Image.
- Parameters
-
image_BackReference the Image to unlink.
- Returns
trueif the Image was unlinked, otherwisefalseif the Image was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkInstrument()
| bool ome::xml::model::Annotation::unlinkInstrument | ( | const std::shared_ptr< ome::xml::model::Instrument > & | instrument_BackReference | ) |
Unlink Instrument.
- Parameters
-
instrument_BackReference the Instrument to unlink.
- Returns
trueif the Instrument was unlinked, otherwisefalseif the Instrument was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkLightPath()
| bool ome::xml::model::Annotation::unlinkLightPath | ( | const std::shared_ptr< ome::xml::model::LightPath > & | lightPath_BackReference | ) |
Unlink LightPath.
- Parameters
-
lightPath_BackReference the LightPath to unlink.
- Returns
trueif the LightPath was unlinked, otherwisefalseif the LightPath was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkLightSource()
| bool ome::xml::model::Annotation::unlinkLightSource | ( | const std::shared_ptr< ome::xml::model::LightSource > & | lightSource_BackReference | ) |
Unlink LightSource.
- Parameters
-
lightSource_BackReference the LightSource to unlink.
- Returns
trueif the LightSource was unlinked, otherwisefalseif the LightSource was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkObjective()
| bool ome::xml::model::Annotation::unlinkObjective | ( | const std::shared_ptr< ome::xml::model::Objective > & | objective_BackReference | ) |
Unlink Objective.
- Parameters
-
objective_BackReference the Objective to unlink.
- Returns
trueif the Objective was unlinked, otherwisefalseif the Objective was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkPlane()
| bool ome::xml::model::Annotation::unlinkPlane | ( | const std::shared_ptr< ome::xml::model::Plane > & | plane_BackReference | ) |
Unlink Plane.
- Parameters
-
plane_BackReference the Plane to unlink.
- Returns
trueif the Plane was unlinked, otherwisefalseif the Plane was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkPlate()
| bool ome::xml::model::Annotation::unlinkPlate | ( | const std::shared_ptr< ome::xml::model::Plate > & | plate_BackReference | ) |
Unlink Plate.
- Parameters
-
plate_BackReference the Plate to unlink.
- Returns
trueif the Plate was unlinked, otherwisefalseif the Plate was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkPlateAcquisition()
| bool ome::xml::model::Annotation::unlinkPlateAcquisition | ( | const std::shared_ptr< ome::xml::model::PlateAcquisition > & | plateAcquisition_BackReference | ) |
Unlink PlateAcquisition.
- Parameters
-
plateAcquisition_BackReference the PlateAcquisition to unlink.
- Returns
trueif the PlateAcquisition was unlinked, otherwisefalseif the PlateAcquisition was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkProject()
| bool ome::xml::model::Annotation::unlinkProject | ( | const std::shared_ptr< ome::xml::model::Project > & | project_BackReference | ) |
Unlink Project.
- Parameters
-
project_BackReference the Project to unlink.
- Returns
trueif the Project was unlinked, otherwisefalseif the Project was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkReagent()
| bool ome::xml::model::Annotation::unlinkReagent | ( | const std::shared_ptr< ome::xml::model::Reagent > & | reagent_BackReference | ) |
Unlink Reagent.
- Parameters
-
reagent_BackReference the Reagent to unlink.
- Returns
trueif the Reagent was unlinked, otherwisefalseif the Reagent was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkROI()
| bool ome::xml::model::Annotation::unlinkROI | ( | const std::shared_ptr< ome::xml::model::ROI > & | roi_BackReference | ) |
Unlink ROI.
- Parameters
-
roi_BackReference the ROI to unlink.
- Returns
trueif the ROI was unlinked, otherwisefalseif the ROI was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkScreen()
| bool ome::xml::model::Annotation::unlinkScreen | ( | const std::shared_ptr< ome::xml::model::Screen > & | screen_BackReference | ) |
Unlink Screen.
- Parameters
-
screen_BackReference the Screen to unlink.
- Returns
trueif the Screen was unlinked, otherwisefalseif the Screen was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkShape()
| bool ome::xml::model::Annotation::unlinkShape | ( | const std::shared_ptr< ome::xml::model::Shape > & | shape_BackReference | ) |
Unlink Shape.
- Parameters
-
shape_BackReference the Shape to unlink.
- Returns
trueif the Shape was unlinked, otherwisefalseif the Shape was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ unlinkWell()
| bool ome::xml::model::Annotation::unlinkWell | ( | const std::shared_ptr< ome::xml::model::Well > & | well_BackReference | ) |
Unlink Well.
- Parameters
-
well_BackReference the Well to unlink.
- Returns
trueif the Well was unlinked, otherwisefalseif the Well was not linked and could hence not be unlinked.
- Todo:
Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ update()
|
virtual |
Update the object hierarchy recursively from an XML DOM tree.
- Note
- No properties are removed, only added or updated.
- Parameters
-
element root of the XML DOM tree to from which to construct the model object graph. model handler for the OME model used to track instances and references seen during the update.
- Exceptions
-
EnumerationException if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.
Implements ome::xml::model::OMEModelObject.
Reimplemented in ome::xml::model::FileAnnotation, ome::xml::model::MapAnnotation, ome::xml::model::TimestampAnnotation, ome::xml::model::BooleanAnnotation, ome::xml::model::CommentAnnotation, ome::xml::model::DoubleAnnotation, ome::xml::model::ListAnnotation, ome::xml::model::LongAnnotation, ome::xml::model::TagAnnotation, ome::xml::model::TermAnnotation, ome::xml::model::XMLAnnotation, ome::xml::model::BasicAnnotation, ome::xml::model::NumericAnnotation, ome::xml::model::TextAnnotation, and ome::xml::model::TypeAnnotation.
References ome::xml::model::OMEModel::addModelObject(), ome::xml::model::OMEModel::addReference(), ome::common::xml::dom::Element::getAttribute(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), getID(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setAnnotator(), setDescription(), setID(), setNamespace(), ome::xml::model::detail::OMEModelObject::update(), and validElementName().
Referenced by ome::xml::model::BasicAnnotation::update(), ome::xml::model::TypeAnnotation::update(), ome::xml::model::TextAnnotation::update(), ome::xml::model::ListAnnotation::update(), and ome::xml::model::MapAnnotation::update().
Here is the caller graph for this function:◆ validElementName()
|
virtual |
Check if a given element name is valid for processing by this model object.
Used for processing nodes when interitance is involved.
- Parameters
-
name the element name to check.
- Returns
trueif valid,falseif invalid.
- Deprecated:
- Always returns true since any element name is now regarded as being valid.
Implements ome::xml::model::detail::OMEModelObject.
Reimplemented in ome::xml::model::FileAnnotation, ome::xml::model::MapAnnotation, ome::xml::model::TimestampAnnotation, ome::xml::model::BooleanAnnotation, ome::xml::model::CommentAnnotation, ome::xml::model::DoubleAnnotation, ome::xml::model::ListAnnotation, ome::xml::model::LongAnnotation, ome::xml::model::TagAnnotation, ome::xml::model::TermAnnotation, ome::xml::model::XMLAnnotation, ome::xml::model::BasicAnnotation, ome::xml::model::NumericAnnotation, ome::xml::model::TextAnnotation, and ome::xml::model::TypeAnnotation.
Referenced by update().
Here is the caller graph for this function:The documentation for this class was generated from the following files:
- ome/xml/model/Annotation.h
- ome/xml/model/Annotation.cpp
