ome-xml
5.5.1
|
#include <ome/xml/model/Mask.h>
Classes | |
class | Impl |
Private implementation details of Mask model object. More... | |
Public Member Functions | |
Mask () | |
Default constructor. | |
Mask (const Mask ©) | |
Copy constructor. More... | |
virtual | ~Mask () |
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 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 | getY () const |
Get the Y property. More... | |
void | setY (double y) |
Set the Y property. More... | |
double | getX () const |
Get the X property. More... | |
void | setX (double x) |
Set the X property. More... | |
double | getHeight () const |
Get the Height property. More... | |
void | setHeight (double height) |
Set the Height property. More... | |
double | getWidth () const |
Get the Width property. More... | |
void | setWidth (double width) |
Set the Width property. More... | |
std::shared_ptr < ome::xml::model::BinData > | getBinData () |
Get the BinData property. More... | |
const std::shared_ptr < ome::xml::model::BinData > | getBinData () const |
Get the BinData property. More... | |
void | setBinData (std::shared_ptr< ome::xml::model::BinData > &binData) |
Set the BinData 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... | |
![]() | |
Shape () | |
Default constructor. | |
Shape (const Shape ©) | |
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::FillRule > | getFillRule () |
Get the FillRule property. More... | |
const std::shared_ptr < ome::xml::model::enums::FillRule > | getFillRule () 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::NonNegativeInteger > | getTheC () |
Get the TheC property. More... | |
const std::shared_ptr < ome::xml::model::primitives::NonNegativeInteger > | getTheC () 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::FontFamily > | getFontFamily () |
Get the FontFamily property. More... | |
const std::shared_ptr < ome::xml::model::enums::FontFamily > | getFontFamily () 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::FontStyle > | getFontStyle () |
Get the FontStyle property. More... | |
const std::shared_ptr < ome::xml::model::enums::FontStyle > | getFontStyle () 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::Color > | getFillColor () |
Get the FillColor property. More... | |
const std::shared_ptr < ome::xml::model::primitives::Color > | getFillColor () 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::Color > | getStrokeColor () |
Get the StrokeColor property. More... | |
const std::shared_ptr < ome::xml::model::primitives::Color > | getStrokeColor () 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::NonNegativeInteger > | getTheT () |
Get the TheT property. More... | |
const std::shared_ptr < ome::xml::model::primitives::NonNegativeInteger > | getTheT () 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::NonNegativeInteger > | getTheZ () |
Get the TheZ property. More... | |
const std::shared_ptr < ome::xml::model::primitives::NonNegativeInteger > | getTheZ () 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::AffineTransform > | getTransform () |
Get the Transform property. More... | |
const std::shared_ptr < ome::xml::model::AffineTransform > | getTransform () 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::Union > | getUnion () |
Get the Union property. More... | |
const std::weak_ptr < ome::xml::model::Union > | getUnion () 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... | |
![]() | |
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... | |
![]() | |
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< Mask > | create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Create a Mask model object from DOM element. More... | |
![]() | |
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... | |
![]() | |
OMEModelObject (const std::string &objectType="OMEModelObject") | |
Constructor. | |
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... | |
![]() | |
OMEModelObject () | |
Constructor. | |
Private Member Functions | |
Mask & | operator= (const Mask &) |
Assignment operator (deleted). | |
Private Attributes | |
std::shared_ptr< Impl > | impl |
Private implementation details. | |
Additional Inherited Members | |
![]() | |
ome::common::Logger | logger |
Message logger. | |
Mask model object.
|
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.
document | XML document for element creation. |
element | XML 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().
|
static |
Create a Mask model object from DOM element.
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. |
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. |
Referenced by ome::xml::model::Union::update().
|
virtual |
Get the element name of this model object.
This will be the most-derived class name.
Implements ome::xml::model::OMEModelObject.
std::shared_ptr< ome::xml::model::BinData > ome::xml::model::Mask::getBinData | ( | ) |
const std::shared_ptr< ome::xml::model::BinData > ome::xml::model::Mask::getBinData | ( | ) | const |
double ome::xml::model::Mask::getHeight | ( | ) | const |
|
virtual |
double ome::xml::model::Mask::getWidth | ( | ) | const |
double ome::xml::model::Mask::getX | ( | ) | const |
|
virtual |
Get the XML namespace for this model object.
Implements ome::xml::model::OMEModelObject.
Referenced by asXMLElementInternal().
double ome::xml::model::Mask::getY | ( | ) | const |
bool ome::xml::model::Mask::link | ( | std::shared_ptr< Reference > & | reference, |
std::shared_ptr< ome::xml::model::OMEModelObject > & | object | ||
) |
Link a given OME model object to this model object.
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. |
true
if this model object was able to handle the reference, otherwise false
.References ome::xml::model::Shape::link(), and ome::xml::model::detail::OMEModelObject::logger.
void ome::xml::model::Mask::setBinData | ( | std::shared_ptr< ome::xml::model::BinData > & | binData | ) |
void ome::xml::model::Mask::setHeight | ( | double | height | ) |
void ome::xml::model::Mask::setWidth | ( | double | width | ) |
void ome::xml::model::Mask::setX | ( | double | x | ) |
void ome::xml::model::Mask::setY | ( | double | y | ) |
|
virtual |
Update the object hierarchy recursively from an XML DOM tree.
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. |
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. |
Reimplemented from ome::xml::model::Shape.
References ome::xml::model::BinData::create(), ome::common::xml::dom::Element::getAttribute(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setBinData(), setHeight(), setWidth(), setX(), setY(), ome::xml::model::Shape::update(), and validElementName().
|
virtual |
Check if a given element name is valid for processing by this model object.
Used for processing nodes when interitance is involved.
name | the element name to check. |
true
if valid, false
if invalid. Implements ome::xml::model::detail::OMEModelObject.
Referenced by update().