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::Line Class Reference

Line model object. More...

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

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

Classes

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

Public Member Functions

 Line ()
 Default constructor.
 
 Line (const Line &copy)
 Copy constructor. More...
 
virtual ~Line ()
 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...
 
double getY2 () const
 Get the Y2 property. More...
 
void setY2 (double y2)
 Set the Y2 property. More...
 
double getX2 () const
 Get the X2 property. More...
 
void setX2 (double x2)
 Set the X2 property. More...
 
std::shared_ptr< ome::xml::model::enums::MarkergetMarkerEnd ()
 Get the MarkerEnd property. More...
 
const std::shared_ptr< ome::xml::model::enums::MarkergetMarkerEnd () const
 Get the MarkerEnd property. More...
 
void setMarkerEnd (std::shared_ptr< ome::xml::model::enums::Marker > &markerEnd)
 Set the MarkerEnd property. More...
 
double getY1 () const
 Get the Y1 property. More...
 
void setY1 (double y1)
 Set the Y1 property. More...
 
double getX1 () const
 Get the X1 property. More...
 
void setX1 (double x1)
 Set the X1 property. More...
 
std::shared_ptr< ome::xml::model::enums::MarkergetMarkerStart ()
 Get the MarkerStart property. More...
 
const std::shared_ptr< ome::xml::model::enums::MarkergetMarkerStart () const
 Get the MarkerStart property. More...
 
void setMarkerStart (std::shared_ptr< ome::xml::model::enums::Marker > &markerStart)
 Set the MarkerStart property. More...
 
const std::string & getShapeType () const
 Get the Shape type. More...
 
const std::string & getXMLNamespace () const
 Get the XML namespace for this model object. More...
 
- Public Member Functions inherited from ome::xml::model::Shape
 Shape ()
 Default constructor.
 
 Shape (const Shape &copy)
 Copy constructor. More...
 
virtual ~Shape ()
 Destructor.
 
bool validElementName (const std::string &name) const
 Check if a given element name is valid for processing by this model object. 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::shared_ptr< std::string > getStrokeDashArray ()
 Get the StrokeDashArray property. More...
 
const std::shared_ptr< std::string > getStrokeDashArray () const
 Get the StrokeDashArray property. More...
 
void setStrokeDashArray (std::shared_ptr< std::string > &strokeDashArray)
 Set the StrokeDashArray property. More...
 
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getStrokeWidth ()
 Get the StrokeWidth property. More...
 
const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getStrokeWidth () const
 Get the StrokeWidth property. More...
 
void setStrokeWidth (const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &strokeWidth)
 Set the StrokeWidth property. More...
 
std::shared_ptr< bool > getLocked ()
 Get the Locked property. More...
 
const std::shared_ptr< bool > getLocked () const
 Get the Locked property. More...
 
void setLocked (std::shared_ptr< bool > &locked)
 Set the Locked property. More...
 
std::shared_ptr< ome::xml::model::enums::FillRulegetFillRule ()
 Get the FillRule property. More...
 
const std::shared_ptr< ome::xml::model::enums::FillRulegetFillRule () const
 Get the FillRule property. More...
 
void setFillRule (std::shared_ptr< ome::xml::model::enums::FillRule > &fillRule)
 Set the FillRule property. More...
 
std::shared_ptr< std::string > getText ()
 Get the Text property. More...
 
const std::shared_ptr< std::string > getText () const
 Get the Text property. More...
 
void setText (std::shared_ptr< std::string > &text)
 Set the Text property. More...
 
std::shared_ptr< ome::xml::model::primitives::NonNegativeIntegergetTheC ()
 Get the TheC property. More...
 
const std::shared_ptr< ome::xml::model::primitives::NonNegativeIntegergetTheC () const
 Get the TheC property. More...
 
void setTheC (std::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &theC)
 Set the TheC property. More...
 
std::shared_ptr< ome::xml::model::enums::FontFamilygetFontFamily ()
 Get the FontFamily property. More...
 
const std::shared_ptr< ome::xml::model::enums::FontFamilygetFontFamily () const
 Get the FontFamily property. More...
 
void setFontFamily (std::shared_ptr< ome::xml::model::enums::FontFamily > &fontFamily)
 Set the FontFamily property. More...
 
std::shared_ptr< ome::xml::model::enums::FontStylegetFontStyle ()
 Get the FontStyle property. More...
 
const std::shared_ptr< ome::xml::model::enums::FontStylegetFontStyle () const
 Get the FontStyle property. More...
 
void setFontStyle (std::shared_ptr< ome::xml::model::enums::FontStyle > &fontStyle)
 Set the FontStyle property. More...
 
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > > & getFontSize ()
 Get the FontSize property. More...
 
const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > > & getFontSize () const
 Get the FontSize property. More...
 
void setFontSize (const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::NonNegativeInteger > > &fontSize)
 Set the FontSize property. More...
 
std::shared_ptr< ome::xml::model::primitives::ColorgetFillColor ()
 Get the FillColor property. More...
 
const std::shared_ptr< ome::xml::model::primitives::ColorgetFillColor () const
 Get the FillColor property. More...
 
void setFillColor (std::shared_ptr< ome::xml::model::primitives::Color > &fillColor)
 Set the FillColor property. More...
 
std::shared_ptr< ome::xml::model::primitives::ColorgetStrokeColor ()
 Get the StrokeColor property. More...
 
const std::shared_ptr< ome::xml::model::primitives::ColorgetStrokeColor () const
 Get the StrokeColor property. More...
 
void setStrokeColor (std::shared_ptr< ome::xml::model::primitives::Color > &strokeColor)
 Set the StrokeColor property. More...
 
std::shared_ptr< ome::xml::model::primitives::NonNegativeIntegergetTheT ()
 Get the TheT property. More...
 
const std::shared_ptr< ome::xml::model::primitives::NonNegativeIntegergetTheT () const
 Get the TheT property. More...
 
void setTheT (std::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &theT)
 Set the TheT property. More...
 
const std::string & getID () const
 Get the ID property. More...
 
void setID (const std::string &id)
 Set the ID property. More...
 
std::shared_ptr< ome::xml::model::primitives::NonNegativeIntegergetTheZ ()
 Get the TheZ property. More...
 
const std::shared_ptr< ome::xml::model::primitives::NonNegativeIntegergetTheZ () const
 Get the TheZ property. More...
 
void setTheZ (std::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &theZ)
 Set the TheZ property. More...
 
std::shared_ptr< ome::xml::model::AffineTransformgetTransform ()
 Get the Transform property. More...
 
const std::shared_ptr< ome::xml::model::AffineTransformgetTransform () const
 Get the Transform property. More...
 
void setTransform (std::shared_ptr< ome::xml::model::AffineTransform > &transform)
 Set the Transform property. More...
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList () const
 Get size of linked Annotation list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList () const
 Get the linked Annotation list. More...
 
const std::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
 Get linked Annotation. More...
 
const std::weak_ptr< 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. More...
 
bool linkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation)
 Link Annotation. More...
 
bool unlinkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation)
 Unlink Annotation. More...
 
std::weak_ptr< ome::xml::model::UniongetUnion ()
 Get the Union property. More...
 
const std::weak_ptr< ome::xml::model::UniongetUnion () const
 Get the Union property. More...
 
void setUnion (std::weak_ptr< ome::xml::model::Union > &union_BackReference)
 Set the Union property. 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< Linecreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a Line 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

Line model object.

Constructor & Destructor Documentation

◆ Line()

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

Copy constructor.

Parameters
copythe Line to copy.

Member Function Documentation

◆ asXMLElementInternal()

void ome::xml::model::Line::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.

Reimplemented from ome::xml::model::Shape.

References ome::xml::model::Shape::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().

◆ create()

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

Create a Line 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::Union::update().

+ Here is the caller graph for this function:

◆ elementName()

const std::string & ome::xml::model::Line::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.

◆ getMarkerEnd() [1/2]

std::shared_ptr< ome::xml::model::enums::Marker > ome::xml::model::Line::getMarkerEnd ( )

Get the MarkerEnd property.

Returns
the MarkerEnd property.

References impl.

◆ getMarkerEnd() [2/2]

const std::shared_ptr< ome::xml::model::enums::Marker > ome::xml::model::Line::getMarkerEnd ( ) const

Get the MarkerEnd property.

Returns
the MarkerEnd property.

References impl.

◆ getMarkerStart() [1/2]

std::shared_ptr< ome::xml::model::enums::Marker > ome::xml::model::Line::getMarkerStart ( )

Get the MarkerStart property.

Returns
the MarkerStart property.

References impl.

◆ getMarkerStart() [2/2]

const std::shared_ptr< ome::xml::model::enums::Marker > ome::xml::model::Line::getMarkerStart ( ) const

Get the MarkerStart property.

Returns
the MarkerStart property.

References impl.

◆ getShapeType()

const std::string & ome::xml::model::Line::getShapeType ( ) const
virtual

Get the Shape type.

Returns
the concrete type of the Shape.

Implements ome::xml::model::Shape.

◆ getX1()

double ome::xml::model::Line::getX1 ( ) const

Get the X1 property.

Returns
the X1 property.

References impl.

◆ getX2()

double ome::xml::model::Line::getX2 ( ) const

Get the X2 property.

Returns
the X2 property.

References impl.

◆ getXMLNamespace()

const std::string & ome::xml::model::Line::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:

◆ getY1()

double ome::xml::model::Line::getY1 ( ) const

Get the Y1 property.

Returns
the Y1 property.

References impl.

◆ getY2()

double ome::xml::model::Line::getY2 ( ) const

Get the Y2 property.

Returns
the Y2 property.

References impl.

◆ link()

bool ome::xml::model::Line::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::Shape::link(), and ome::xml::model::detail::OMEModelObject::logger.

◆ setMarkerEnd()

void ome::xml::model::Line::setMarkerEnd ( std::shared_ptr< ome::xml::model::enums::Marker > &  markerEnd)

Set the MarkerEnd property.

Parameters
markerEndthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setMarkerStart()

void ome::xml::model::Line::setMarkerStart ( std::shared_ptr< ome::xml::model::enums::Marker > &  markerStart)

Set the MarkerStart property.

Parameters
markerStartthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setX1()

void ome::xml::model::Line::setX1 ( double  x1)

Set the X1 property.

Parameters
x1the value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setX2()

void ome::xml::model::Line::setX2 ( double  x2)

Set the X2 property.

Parameters
x2the value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setY1()

void ome::xml::model::Line::setY1 ( double  y1)

Set the Y1 property.

Parameters
y1the value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setY2()

void ome::xml::model::Line::setY2 ( double  y2)

Set the Y2 property.

Parameters
y2the value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ update()

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

Update the object hierarchy recursively from an XML DOM tree.

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

Reimplemented from ome::xml::model::Shape.

References ome::common::xml::dom::Element::getAttribute(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setMarkerEnd(), setMarkerStart(), setX1(), setX2(), setY1(), setY2(), ome::xml::model::Shape::update(), and validElementName().

◆ validElementName()

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