ome-xml  5.6.0
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ome::xml::model::Union Class Reference

Union model object. More...

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

+ Inheritance diagram for ome::xml::model::Union:
+ Collaboration diagram for ome::xml::model::Union:

Classes

class  Impl
 Private implementation details of Union model object. More...
 

Public Member Functions

 Union ()
 Default constructor.
 
 Union (const Union &copy)
 Copy constructor. More...
 
virtual ~Union ()
 Destructor.
 
const std::string & elementName () const
 Get the element name of this model object. More...
 
bool validElementName (const std::string &name) const
 Check if a given element name is valid for processing by this model object. More...
 
virtual SKIP void update (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Update the object hierarchy recursively from an XML DOM tree. More...
 
bool link (std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
std::vector< std::shared_ptr< ome::xml::model::Shape > >::size_type sizeOfShapeList () const
 Get size of linked Shape list. More...
 
std::vector< std::shared_ptr< ome::xml::model::Shape > > & getShapeList ()
 Get the Shape list. More...
 
const std::vector< std::shared_ptr< ome::xml::model::Shape > > & getShapeList () const
 Get the Shape list. More...
 
std::shared_ptr< ome::xml::model::Shape > & getShape (std::vector< std::shared_ptr< ome::xml::model::Shape >>::size_type index)
 Get Shape. More...
 
const std::shared_ptr< ome::xml::model::Shape > & getShape (std::vector< std::shared_ptr< ome::xml::model::Shape >>::size_type index) const
 Get Shape. More...
 
void setShape (std::vector< std::shared_ptr< ome::xml::model::Shape >>::size_type index, std::shared_ptr< ome::xml::model::Shape > &shape)
 Set Shape. More...
 
void addShape (std::shared_ptr< ome::xml::model::Shape > &shape)
 Add Shape. More...
 
void removeShape (std::shared_ptr< ome::xml::model::Shape > &shape)
 Remove Shape. More...
 
const std::string & getXMLNamespace () const
 Get the XML namespace for this model object. More...
 
- Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
virtual ~OMEModelObject ()
 Destructor.
 
virtual common::xml::dom::Element asXMLElement (common::xml::dom::Document &document) const
 Transform the object hierarchy rooted at this element to XML. More...
 
virtual void asXMLElement (common::xml::dom::Document &document, common::xml::dom::Element &element) const
 Transform the object hierarchy rooted at this element to XML. More...
 
virtual void update (const common::xml::dom::Element &element, ::ome::xml::model::OMEModel &model)
 Update the object hierarchy recursively from an XML DOM tree. More...
 
virtual bool link (std::shared_ptr< Reference > &reference, std::shared_ptr<::ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
- Public Member Functions inherited from ome::xml::model::OMEModelObject
virtual bool link (std::shared_ptr< Reference > &reference, std::shared_ptr< OMEModelObject > &object)=0
 Link a given OME model object to this model object. More...
 

Static Public Member Functions

static std::shared_ptr< Unioncreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a Union model object from DOM element. More...
 
- Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject
static std::vector< common::xml::dom::ElementgetChildrenByTagName (const common::xml::dom::Element &parent, const std::string &name)
 Retrieve all the children of an element that have a given tag name. More...
 
static std::string stripNamespacePrefix (const std::string &value)
 Strip the namespace prefix from a tag name. More...
 

Protected Member Functions

virtual void asXMLElementInternal (common::xml::dom::Document &document, common::xml::dom::Element &element) const
 Transform the object hierarchy rooted at this element to XML. More...
 
- Protected Member Functions inherited from ome::xml::model::detail::OMEModelObject
 OMEModelObject (const std::string &objectType="OMEModelObject")
 Constructor. More...
 
 OMEModelObject (const OMEModelObject &copy)
 Copy constructor. More...
 
template<class C , typename T >
bool contains (const C &container, const std::shared_ptr< T > &element)
 Check if a container contains a particular element. More...
 
- Protected Member Functions inherited from ome::xml::model::OMEModelObject
 OMEModelObject ()
 Constructor.
 

Private Attributes

std::shared_ptr< Implimpl
 Private implementation details.
 

Additional Inherited Members

- Protected Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger logger
 Message logger.
 

Detailed Description

Union model object.

Constructor & Destructor Documentation

◆ Union()

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

Copy constructor.

Parameters
copythe Union to copy.

Member Function Documentation

◆ addShape()

void ome::xml::model::Union::addShape ( std::shared_ptr< ome::xml::model::Shape > &  shape)

Add Shape.

Parameters
shapethe Shape to add.
Todo:

Return list position?

Detect and handle duplicates?

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ asXMLElementInternal()

void ome::xml::model::Union::asXMLElementInternal ( common::xml::dom::Document document,
common::xml::dom::Element element 
) const
protectedvirtual

Transform the object hierarchy rooted at this element to XML.

This internal implementation of asXMLelement also requires an XML element, which must not be null, or may be instantiated and passed from superclasses.

Concrete model object implementations should override this method.

Parameters
documentXML document for element creation.
elementXML 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()

std::shared_ptr< Union > ome::xml::model::Union::create ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
static

Create a Union model object from DOM element.

Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.
Returns
a new model object.

Referenced by ome::xml::model::ROI::update().

+ Here is the caller graph for this function:

◆ elementName()

const std::string & ome::xml::model::Union::elementName ( ) const
virtual

Get the element name of this model object.

This will be the most-derived class name.

Returns
the element type.

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

◆ getShape() [1/2]

std::shared_ptr< ome::xml::model::Shape > & ome::xml::model::Union::getShape ( std::vector< std::shared_ptr< ome::xml::model::Shape >>::size_type  index)

Get Shape.

Parameters
indexthe index number of the Shape.
Returns
the Shape.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getShape() [2/2]

const std::shared_ptr< ome::xml::model::Shape > & ome::xml::model::Union::getShape ( std::vector< std::shared_ptr< ome::xml::model::Shape >>::size_type  index) const

Get Shape.

Parameters
indexthe index number of the Shape.
Returns
the Shape.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getShapeList() [1/2]

std::vector< std::shared_ptr< ome::xml::model::Shape > > & ome::xml::model::Union::getShapeList ( )

Get the Shape list.

Returns
a reference to the list.

References impl.

◆ getShapeList() [2/2]

const std::vector< std::shared_ptr< ome::xml::model::Shape > > & ome::xml::model::Union::getShapeList ( ) const

Get the Shape list.

Returns
a reference to the list.

References impl.

◆ getXMLNamespace()

const std::string & ome::xml::model::Union::getXMLNamespace ( ) const
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::Union::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
referencetype qualifier for the reference. This should be the corresponding reference type for object. If, for example, object is of type Image, reference must be of type ImageRef.
objectModel object to link to.
Returns
true if this model object was able to handle the reference, otherwise false.
Todo:
the use of reference to provide type information for the type of object is unconventional and quite possibly unnecessary–a simple string or type_info would suffice for what it's being used for, if it's needed at all. Is this true for all cases? The implementation also needs to do strict checking of the object type; it's not currently failing if it's of the wrong type. This applies to all generated model objects implementing this interface.

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

◆ removeShape()

void ome::xml::model::Union::removeShape ( std::shared_ptr< ome::xml::model::Shape > &  shape)

Remove Shape.

Parameters
shapethe Shape 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.

◆ setShape()

void ome::xml::model::Union::setShape ( std::vector< std::shared_ptr< ome::xml::model::Shape >>::size_type  index,
std::shared_ptr< ome::xml::model::Shape > &  shape 
)

Set Shape.

Parameters
indexthe index number of the Shape.
shapethe Shape to set.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ sizeOfShapeList()

std::vector< std::shared_ptr< ome::xml::model::Shape > >::size_type ome::xml::model::Union::sizeOfShapeList ( ) const

Get size of linked Shape list.

Returns
the size of the list.

References impl.

◆ update()

void ome::xml::model::Union::update ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
virtual

Update the object hierarchy recursively from an XML DOM tree.

Note
No properties are removed, only added or updated.
Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.

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

References addShape(), ome::xml::model::Label::create(), ome::xml::model::Point::create(), ome::xml::model::Ellipse::create(), ome::xml::model::Polygon::create(), ome::xml::model::Rectangle::create(), ome::xml::model::Polyline::create(), ome::xml::model::Line::create(), ome::xml::model::Mask::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()

bool ome::xml::model::Union::validElementName ( const std::string &  name) const
virtual

Check if a given element name is valid for processing by this model object.

Used for processing nodes when interitance is involved.

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