StructuredAnnotations model object. More...
#include <ome/xml/model/StructuredAnnotations.h>
Inheritance diagram for ome::xml::model::StructuredAnnotations: Collaboration diagram for ome::xml::model::StructuredAnnotations:Classes | |
| class | Impl |
| Private implementation details of StructuredAnnotations model object. More... | |
Static Public Member Functions | |
| static std::shared_ptr< StructuredAnnotations > | create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
| Create a StructuredAnnotations model object from DOM element. More... | |
| Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
| static std::vector< common::xml::dom::Element > | getChildrenByTagName (const common::xml::dom::Element &parent, const std::string &name) |
| Retrieve all the children of an element that have a given tag name. More... | |
| static std::string | stripNamespacePrefix (const std::string &value) |
| Strip the namespace prefix from a tag name. More... | |
Protected 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 | |
| Protected Attributes inherited from ome::xml::model::detail::OMEModelObject | |
| ome::common::Logger | logger |
| Message logger. | |
Detailed Description
StructuredAnnotations model object.
Constructor & Destructor Documentation
◆ StructuredAnnotations()
| ome::xml::model::StructuredAnnotations::StructuredAnnotations | ( | const StructuredAnnotations & | copy | ) |
Copy constructor.
- Parameters
-
copy the StructuredAnnotations to copy.
Member Function Documentation
◆ addBooleanAnnotation()
| void ome::xml::model::StructuredAnnotations::addBooleanAnnotation | ( | std::shared_ptr< ome::xml::model::BooleanAnnotation > & | booleanAnnotation | ) |
Add BooleanAnnotation.
- Parameters
-
booleanAnnotation the BooleanAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addCommentAnnotation()
| void ome::xml::model::StructuredAnnotations::addCommentAnnotation | ( | std::shared_ptr< ome::xml::model::CommentAnnotation > & | commentAnnotation | ) |
Add CommentAnnotation.
- Parameters
-
commentAnnotation the CommentAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addDoubleAnnotation()
| void ome::xml::model::StructuredAnnotations::addDoubleAnnotation | ( | std::shared_ptr< ome::xml::model::DoubleAnnotation > & | doubleAnnotation | ) |
Add DoubleAnnotation.
- Parameters
-
doubleAnnotation the DoubleAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addFileAnnotation()
| void ome::xml::model::StructuredAnnotations::addFileAnnotation | ( | std::shared_ptr< ome::xml::model::FileAnnotation > & | fileAnnotation | ) |
Add FileAnnotation.
- Parameters
-
fileAnnotation the FileAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addListAnnotation()
| void ome::xml::model::StructuredAnnotations::addListAnnotation | ( | std::shared_ptr< ome::xml::model::ListAnnotation > & | listAnnotation | ) |
Add ListAnnotation.
- Parameters
-
listAnnotation the ListAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addLongAnnotation()
| void ome::xml::model::StructuredAnnotations::addLongAnnotation | ( | std::shared_ptr< ome::xml::model::LongAnnotation > & | longAnnotation | ) |
Add LongAnnotation.
- Parameters
-
longAnnotation the LongAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addMapAnnotation()
| void ome::xml::model::StructuredAnnotations::addMapAnnotation | ( | std::shared_ptr< ome::xml::model::MapAnnotation > & | mapAnnotation | ) |
Add MapAnnotation.
- Parameters
-
mapAnnotation the MapAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addTagAnnotation()
| void ome::xml::model::StructuredAnnotations::addTagAnnotation | ( | std::shared_ptr< ome::xml::model::TagAnnotation > & | tagAnnotation | ) |
Add TagAnnotation.
- Parameters
-
tagAnnotation the TagAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addTermAnnotation()
| void ome::xml::model::StructuredAnnotations::addTermAnnotation | ( | std::shared_ptr< ome::xml::model::TermAnnotation > & | termAnnotation | ) |
Add TermAnnotation.
- Parameters
-
termAnnotation the TermAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addTimestampAnnotation()
| void ome::xml::model::StructuredAnnotations::addTimestampAnnotation | ( | std::shared_ptr< ome::xml::model::TimestampAnnotation > & | timestampAnnotation | ) |
Add TimestampAnnotation.
- Parameters
-
timestampAnnotation the TimestampAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ addXMLAnnotation()
| void ome::xml::model::StructuredAnnotations::addXMLAnnotation | ( | std::shared_ptr< ome::xml::model::XMLAnnotation > & | xmlAnnotation | ) |
Add XMLAnnotation.
- Parameters
-
xmlAnnotation the XMLAnnotation to add.
- Todo:
Return list position?
Detect and handle duplicates?
References impl.
Referenced by update().
Here is the caller graph for this function:◆ 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.
References ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), and impl.
◆ create()
|
static |
Create a StructuredAnnotations model object from DOM element.
- 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.
- Returns
- a new model object.
Referenced by ome::xml::model::OME::update().
Here is the caller graph for this function:◆ elementName()
|
virtual |
Get the element name of this model object.
This will be the most-derived class name.
- Returns
- the element type.
Implements ome::xml::model::OMEModelObject.
◆ getBooleanAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::BooleanAnnotation > & ome::xml::model::StructuredAnnotations::getBooleanAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::BooleanAnnotation >>::size_type | index | ) |
Get BooleanAnnotation.
- Parameters
-
index the index number of the BooleanAnnotation.
- Returns
- the BooleanAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getBooleanAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::BooleanAnnotation > & ome::xml::model::StructuredAnnotations::getBooleanAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::BooleanAnnotation >>::size_type | index | ) | const |
Get BooleanAnnotation.
- Parameters
-
index the index number of the BooleanAnnotation.
- Returns
- the BooleanAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getBooleanAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::BooleanAnnotation > > & ome::xml::model::StructuredAnnotations::getBooleanAnnotationList | ( | ) |
◆ getBooleanAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::BooleanAnnotation > > & ome::xml::model::StructuredAnnotations::getBooleanAnnotationList | ( | ) | const |
◆ getCommentAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::CommentAnnotation > & ome::xml::model::StructuredAnnotations::getCommentAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::CommentAnnotation >>::size_type | index | ) |
Get CommentAnnotation.
- Parameters
-
index the index number of the CommentAnnotation.
- Returns
- the CommentAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getCommentAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::CommentAnnotation > & ome::xml::model::StructuredAnnotations::getCommentAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::CommentAnnotation >>::size_type | index | ) | const |
Get CommentAnnotation.
- Parameters
-
index the index number of the CommentAnnotation.
- Returns
- the CommentAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getCommentAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::CommentAnnotation > > & ome::xml::model::StructuredAnnotations::getCommentAnnotationList | ( | ) |
◆ getCommentAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::CommentAnnotation > > & ome::xml::model::StructuredAnnotations::getCommentAnnotationList | ( | ) | const |
◆ getDoubleAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::DoubleAnnotation > & ome::xml::model::StructuredAnnotations::getDoubleAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::DoubleAnnotation >>::size_type | index | ) |
Get DoubleAnnotation.
- Parameters
-
index the index number of the DoubleAnnotation.
- Returns
- the DoubleAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getDoubleAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::DoubleAnnotation > & ome::xml::model::StructuredAnnotations::getDoubleAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::DoubleAnnotation >>::size_type | index | ) | const |
Get DoubleAnnotation.
- Parameters
-
index the index number of the DoubleAnnotation.
- Returns
- the DoubleAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getDoubleAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::DoubleAnnotation > > & ome::xml::model::StructuredAnnotations::getDoubleAnnotationList | ( | ) |
◆ getDoubleAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::DoubleAnnotation > > & ome::xml::model::StructuredAnnotations::getDoubleAnnotationList | ( | ) | const |
◆ getFileAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::FileAnnotation > & ome::xml::model::StructuredAnnotations::getFileAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::FileAnnotation >>::size_type | index | ) |
Get FileAnnotation.
- Parameters
-
index the index number of the FileAnnotation.
- Returns
- the FileAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getFileAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::FileAnnotation > & ome::xml::model::StructuredAnnotations::getFileAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::FileAnnotation >>::size_type | index | ) | const |
Get FileAnnotation.
- Parameters
-
index the index number of the FileAnnotation.
- Returns
- the FileAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getFileAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::FileAnnotation > > & ome::xml::model::StructuredAnnotations::getFileAnnotationList | ( | ) |
◆ getFileAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::FileAnnotation > > & ome::xml::model::StructuredAnnotations::getFileAnnotationList | ( | ) | const |
◆ getListAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::ListAnnotation > & ome::xml::model::StructuredAnnotations::getListAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::ListAnnotation >>::size_type | index | ) |
Get ListAnnotation.
- Parameters
-
index the index number of the ListAnnotation.
- Returns
- the ListAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getListAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::ListAnnotation > & ome::xml::model::StructuredAnnotations::getListAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::ListAnnotation >>::size_type | index | ) | const |
Get ListAnnotation.
- Parameters
-
index the index number of the ListAnnotation.
- Returns
- the ListAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getListAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::ListAnnotation > > & ome::xml::model::StructuredAnnotations::getListAnnotationList | ( | ) |
◆ getListAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::ListAnnotation > > & ome::xml::model::StructuredAnnotations::getListAnnotationList | ( | ) | const |
◆ getLongAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::LongAnnotation > & ome::xml::model::StructuredAnnotations::getLongAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::LongAnnotation >>::size_type | index | ) |
Get LongAnnotation.
- Parameters
-
index the index number of the LongAnnotation.
- Returns
- the LongAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getLongAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::LongAnnotation > & ome::xml::model::StructuredAnnotations::getLongAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::LongAnnotation >>::size_type | index | ) | const |
Get LongAnnotation.
- Parameters
-
index the index number of the LongAnnotation.
- Returns
- the LongAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getLongAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::LongAnnotation > > & ome::xml::model::StructuredAnnotations::getLongAnnotationList | ( | ) |
◆ getLongAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::LongAnnotation > > & ome::xml::model::StructuredAnnotations::getLongAnnotationList | ( | ) | const |
◆ getMapAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::MapAnnotation > & ome::xml::model::StructuredAnnotations::getMapAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::MapAnnotation >>::size_type | index | ) |
Get MapAnnotation.
- Parameters
-
index the index number of the MapAnnotation.
- Returns
- the MapAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getMapAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::MapAnnotation > & ome::xml::model::StructuredAnnotations::getMapAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::MapAnnotation >>::size_type | index | ) | const |
Get MapAnnotation.
- Parameters
-
index the index number of the MapAnnotation.
- Returns
- the MapAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getMapAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::MapAnnotation > > & ome::xml::model::StructuredAnnotations::getMapAnnotationList | ( | ) |
◆ getMapAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::MapAnnotation > > & ome::xml::model::StructuredAnnotations::getMapAnnotationList | ( | ) | const |
◆ getTagAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::TagAnnotation > & ome::xml::model::StructuredAnnotations::getTagAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::TagAnnotation >>::size_type | index | ) |
Get TagAnnotation.
- Parameters
-
index the index number of the TagAnnotation.
- Returns
- the TagAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getTagAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::TagAnnotation > & ome::xml::model::StructuredAnnotations::getTagAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::TagAnnotation >>::size_type | index | ) | const |
Get TagAnnotation.
- Parameters
-
index the index number of the TagAnnotation.
- Returns
- the TagAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getTagAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::TagAnnotation > > & ome::xml::model::StructuredAnnotations::getTagAnnotationList | ( | ) |
◆ getTagAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::TagAnnotation > > & ome::xml::model::StructuredAnnotations::getTagAnnotationList | ( | ) | const |
◆ getTermAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::TermAnnotation > & ome::xml::model::StructuredAnnotations::getTermAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::TermAnnotation >>::size_type | index | ) |
Get TermAnnotation.
- Parameters
-
index the index number of the TermAnnotation.
- Returns
- the TermAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getTermAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::TermAnnotation > & ome::xml::model::StructuredAnnotations::getTermAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::TermAnnotation >>::size_type | index | ) | const |
Get TermAnnotation.
- Parameters
-
index the index number of the TermAnnotation.
- Returns
- the TermAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getTermAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::TermAnnotation > > & ome::xml::model::StructuredAnnotations::getTermAnnotationList | ( | ) |
◆ getTermAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::TermAnnotation > > & ome::xml::model::StructuredAnnotations::getTermAnnotationList | ( | ) | const |
◆ getTimestampAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::TimestampAnnotation > & ome::xml::model::StructuredAnnotations::getTimestampAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::TimestampAnnotation >>::size_type | index | ) |
Get TimestampAnnotation.
- Parameters
-
index the index number of the TimestampAnnotation.
- Returns
- the TimestampAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getTimestampAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::TimestampAnnotation > & ome::xml::model::StructuredAnnotations::getTimestampAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::TimestampAnnotation >>::size_type | index | ) | const |
Get TimestampAnnotation.
- Parameters
-
index the index number of the TimestampAnnotation.
- Returns
- the TimestampAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getTimestampAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::TimestampAnnotation > > & ome::xml::model::StructuredAnnotations::getTimestampAnnotationList | ( | ) |
◆ getTimestampAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::TimestampAnnotation > > & ome::xml::model::StructuredAnnotations::getTimestampAnnotationList | ( | ) | const |
◆ getXMLAnnotation() [1/2]
| std::shared_ptr< ome::xml::model::XMLAnnotation > & ome::xml::model::StructuredAnnotations::getXMLAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::XMLAnnotation >>::size_type | index | ) |
Get XMLAnnotation.
- Parameters
-
index the index number of the XMLAnnotation.
- Returns
- the XMLAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getXMLAnnotation() [2/2]
| const std::shared_ptr< ome::xml::model::XMLAnnotation > & ome::xml::model::StructuredAnnotations::getXMLAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::XMLAnnotation >>::size_type | index | ) | const |
Get XMLAnnotation.
- Parameters
-
index the index number of the XMLAnnotation.
- Returns
- the XMLAnnotation.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ getXMLAnnotationList() [1/2]
| std::vector< std::shared_ptr< ome::xml::model::XMLAnnotation > > & ome::xml::model::StructuredAnnotations::getXMLAnnotationList | ( | ) |
◆ getXMLAnnotationList() [2/2]
| const std::vector< std::shared_ptr< ome::xml::model::XMLAnnotation > > & ome::xml::model::StructuredAnnotations::getXMLAnnotationList | ( | ) | const |
◆ getXMLNamespace()
|
virtual |
Get the XML namespace for this model object.
- Returns
- the XML namespace.
Implements ome::xml::model::OMEModelObject.
Referenced by asXMLElementInternal().
Here is the caller graph for this function:◆ link()
| bool ome::xml::model::StructuredAnnotations::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.
References ome::xml::model::detail::OMEModelObject::link(), and ome::xml::model::detail::OMEModelObject::logger.
◆ removeBooleanAnnotation()
| void ome::xml::model::StructuredAnnotations::removeBooleanAnnotation | ( | std::shared_ptr< ome::xml::model::BooleanAnnotation > & | booleanAnnotation | ) |
Remove BooleanAnnotation.
- Parameters
-
booleanAnnotation the BooleanAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeCommentAnnotation()
| void ome::xml::model::StructuredAnnotations::removeCommentAnnotation | ( | std::shared_ptr< ome::xml::model::CommentAnnotation > & | commentAnnotation | ) |
Remove CommentAnnotation.
- Parameters
-
commentAnnotation the CommentAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeDoubleAnnotation()
| void ome::xml::model::StructuredAnnotations::removeDoubleAnnotation | ( | std::shared_ptr< ome::xml::model::DoubleAnnotation > & | doubleAnnotation | ) |
Remove DoubleAnnotation.
- Parameters
-
doubleAnnotation the DoubleAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeFileAnnotation()
| void ome::xml::model::StructuredAnnotations::removeFileAnnotation | ( | std::shared_ptr< ome::xml::model::FileAnnotation > & | fileAnnotation | ) |
Remove FileAnnotation.
- Parameters
-
fileAnnotation the FileAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeListAnnotation()
| void ome::xml::model::StructuredAnnotations::removeListAnnotation | ( | std::shared_ptr< ome::xml::model::ListAnnotation > & | listAnnotation | ) |
Remove ListAnnotation.
- Parameters
-
listAnnotation the ListAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeLongAnnotation()
| void ome::xml::model::StructuredAnnotations::removeLongAnnotation | ( | std::shared_ptr< ome::xml::model::LongAnnotation > & | longAnnotation | ) |
Remove LongAnnotation.
- Parameters
-
longAnnotation the LongAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeMapAnnotation()
| void ome::xml::model::StructuredAnnotations::removeMapAnnotation | ( | std::shared_ptr< ome::xml::model::MapAnnotation > & | mapAnnotation | ) |
Remove MapAnnotation.
- Parameters
-
mapAnnotation the MapAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeTagAnnotation()
| void ome::xml::model::StructuredAnnotations::removeTagAnnotation | ( | std::shared_ptr< ome::xml::model::TagAnnotation > & | tagAnnotation | ) |
Remove TagAnnotation.
- Parameters
-
tagAnnotation the TagAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeTermAnnotation()
| void ome::xml::model::StructuredAnnotations::removeTermAnnotation | ( | std::shared_ptr< ome::xml::model::TermAnnotation > & | termAnnotation | ) |
Remove TermAnnotation.
- Parameters
-
termAnnotation the TermAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeTimestampAnnotation()
| void ome::xml::model::StructuredAnnotations::removeTimestampAnnotation | ( | std::shared_ptr< ome::xml::model::TimestampAnnotation > & | timestampAnnotation | ) |
Remove TimestampAnnotation.
- Parameters
-
timestampAnnotation the TimestampAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ removeXMLAnnotation()
| void ome::xml::model::StructuredAnnotations::removeXMLAnnotation | ( | std::shared_ptr< ome::xml::model::XMLAnnotation > & | xmlAnnotation | ) |
Remove XMLAnnotation.
- Parameters
-
xmlAnnotation the XMLAnnotation to remove.
- Todo:
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
◆ setBooleanAnnotation()
| void ome::xml::model::StructuredAnnotations::setBooleanAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::BooleanAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::BooleanAnnotation > & | booleanAnnotation | ||
| ) |
Set BooleanAnnotation.
- Parameters
-
index the index number of the BooleanAnnotation. booleanAnnotation the BooleanAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setCommentAnnotation()
| void ome::xml::model::StructuredAnnotations::setCommentAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::CommentAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::CommentAnnotation > & | commentAnnotation | ||
| ) |
Set CommentAnnotation.
- Parameters
-
index the index number of the CommentAnnotation. commentAnnotation the CommentAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setDoubleAnnotation()
| void ome::xml::model::StructuredAnnotations::setDoubleAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::DoubleAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::DoubleAnnotation > & | doubleAnnotation | ||
| ) |
Set DoubleAnnotation.
- Parameters
-
index the index number of the DoubleAnnotation. doubleAnnotation the DoubleAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setFileAnnotation()
| void ome::xml::model::StructuredAnnotations::setFileAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::FileAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::FileAnnotation > & | fileAnnotation | ||
| ) |
Set FileAnnotation.
- Parameters
-
index the index number of the FileAnnotation. fileAnnotation the FileAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setListAnnotation()
| void ome::xml::model::StructuredAnnotations::setListAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::ListAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::ListAnnotation > & | listAnnotation | ||
| ) |
Set ListAnnotation.
- Parameters
-
index the index number of the ListAnnotation. listAnnotation the ListAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setLongAnnotation()
| void ome::xml::model::StructuredAnnotations::setLongAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::LongAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::LongAnnotation > & | longAnnotation | ||
| ) |
Set LongAnnotation.
- Parameters
-
index the index number of the LongAnnotation. longAnnotation the LongAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setMapAnnotation()
| void ome::xml::model::StructuredAnnotations::setMapAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::MapAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::MapAnnotation > & | mapAnnotation | ||
| ) |
Set MapAnnotation.
- Parameters
-
index the index number of the MapAnnotation. mapAnnotation the MapAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setTagAnnotation()
| void ome::xml::model::StructuredAnnotations::setTagAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::TagAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::TagAnnotation > & | tagAnnotation | ||
| ) |
Set TagAnnotation.
- Parameters
-
index the index number of the TagAnnotation. tagAnnotation the TagAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setTermAnnotation()
| void ome::xml::model::StructuredAnnotations::setTermAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::TermAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::TermAnnotation > & | termAnnotation | ||
| ) |
Set TermAnnotation.
- Parameters
-
index the index number of the TermAnnotation. termAnnotation the TermAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setTimestampAnnotation()
| void ome::xml::model::StructuredAnnotations::setTimestampAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::TimestampAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::TimestampAnnotation > & | timestampAnnotation | ||
| ) |
Set TimestampAnnotation.
- Parameters
-
index the index number of the TimestampAnnotation. timestampAnnotation the TimestampAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ setXMLAnnotation()
| void ome::xml::model::StructuredAnnotations::setXMLAnnotation | ( | std::vector< std::shared_ptr< ome::xml::model::XMLAnnotation >>::size_type | index, |
| std::shared_ptr< ome::xml::model::XMLAnnotation > & | xmlAnnotation | ||
| ) |
Set XMLAnnotation.
- Parameters
-
index the index number of the XMLAnnotation. xmlAnnotation the XMLAnnotation to set.
- Exceptions
-
std::out_of_range if the index is invalid.
References impl.
◆ sizeOfBooleanAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::BooleanAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfBooleanAnnotationList | ( | ) | const |
◆ sizeOfCommentAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::CommentAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfCommentAnnotationList | ( | ) | const |
◆ sizeOfDoubleAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::DoubleAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfDoubleAnnotationList | ( | ) | const |
◆ sizeOfFileAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::FileAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfFileAnnotationList | ( | ) | const |
◆ sizeOfListAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::ListAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfListAnnotationList | ( | ) | const |
◆ sizeOfLongAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::LongAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfLongAnnotationList | ( | ) | const |
◆ sizeOfMapAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::MapAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfMapAnnotationList | ( | ) | const |
◆ sizeOfTagAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::TagAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfTagAnnotationList | ( | ) | const |
◆ sizeOfTermAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::TermAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfTermAnnotationList | ( | ) | const |
◆ sizeOfTimestampAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::TimestampAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfTimestampAnnotationList | ( | ) | const |
◆ sizeOfXMLAnnotationList()
| std::vector< std::shared_ptr< ome::xml::model::XMLAnnotation > >::size_type ome::xml::model::StructuredAnnotations::sizeOfXMLAnnotationList | ( | ) | const |
◆ 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.
References addBooleanAnnotation(), addCommentAnnotation(), addDoubleAnnotation(), addFileAnnotation(), addListAnnotation(), addLongAnnotation(), addMapAnnotation(), addTagAnnotation(), addTermAnnotation(), addTimestampAnnotation(), addXMLAnnotation(), ome::xml::model::CommentAnnotation::create(), ome::xml::model::LongAnnotation::create(), ome::xml::model::DoubleAnnotation::create(), ome::xml::model::BooleanAnnotation::create(), ome::xml::model::TagAnnotation::create(), ome::xml::model::XMLAnnotation::create(), ome::xml::model::ListAnnotation::create(), ome::xml::model::TermAnnotation::create(), ome::xml::model::FileAnnotation::create(), ome::xml::model::MapAnnotation::create(), ome::xml::model::TimestampAnnotation::create(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), ome::common::xml::dom::Element::getTagName(), ome::xml::model::detail::OMEModelObject::logger, ome::xml::model::detail::OMEModelObject::update(), and validElementName().
◆ 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.
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/StructuredAnnotations.h
- ome/xml/model/StructuredAnnotations.cpp
