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

Pump model object. More...

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

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

Classes

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

Public Member Functions

 Pump ()
 Default constructor.
 
 Pump (const Pump &copy)
 Copy constructor. More...
 
virtual ~Pump ()
 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...
 
const std::string & getID () const
 Get the ID property. More...
 
void setID (const std::string &id)
 Set the ID property. More...
 
OMEModelObject::indexed_container< ome::xml::model::Laser, std::weak_ptr >::type::size_type sizeOfLinkedLaserList () const
 Get size of linked Laser list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Laser, std::weak_ptr >::type getLinkedLaserList () const
 Get the linked Laser list. More...
 
const std::weak_ptr< ome::xml::model::Laser > & getLinkedLaser (OMEModelObject::indexed_container< ome::xml::model::Laser, std::weak_ptr >::type::size_type index) const
 Get linked Laser. More...
 
const std::weak_ptr< ome::xml::model::Laser > & setLinkedLaser (OMEModelObject::indexed_container< ome::xml::model::Laser, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
 Set linked Laser. More...
 
bool linkLaser (const std::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
 Link Laser. More...
 
bool unlinkLaser (const std::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
 Unlink Laser. More...
 
const std::string & getXMLNamespace () const
 Get the XML namespace for this model object. More...
 
- Public Member Functions inherited from ome::xml::model::Reference
 Reference ()
 Default constructor.
 
 Reference (const Reference &copy)
 Copy constructor. More...
 
virtual ~Reference ()
 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...
 
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< Pumpcreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a Pump 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

Pump model object.

Constructor & Destructor Documentation

◆ Pump()

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

Copy constructor.

Parameters
copythe Pump to copy.

Member Function Documentation

◆ asXMLElementInternal()

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

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

◆ create()

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

Create a Pump 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.

◆ elementName()

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

◆ getID()

const std::string & ome::xml::model::Pump::getID ( ) const
virtual

Get the ID property.

Returns
the ID property.

Implements ome::xml::model::Reference.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ getLinkedLaser()

const std::weak_ptr< ome::xml::model::Laser > & ome::xml::model::Pump::getLinkedLaser ( OMEModelObject::indexed_container< ome::xml::model::Laser, std::weak_ptr >::type::size_type  index) const

Get linked Laser.

Parameters
indexthe index number of the Laser.
Returns
a weak pointer to the Laser.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ getLinkedLaserList()

OMEModelObject::indexed_container< ome::xml::model::Laser, std::weak_ptr >::type ome::xml::model::Pump::getLinkedLaserList ( ) const

Get the linked Laser list.

Returns
a reference to the list.

References impl.

◆ getXMLNamespace()

const std::string & ome::xml::model::Pump::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::Pump::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::Reference::link(), and ome::xml::model::detail::OMEModelObject::logger.

◆ linkLaser()

bool ome::xml::model::Pump::linkLaser ( const std::shared_ptr< ome::xml::model::Laser > &  laser_BackReference)

Link Laser.

Parameters
laser_BackReferencethe Laser to link.
Returns
true if the object was added to the internal lasers list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References impl.

◆ setID()

void ome::xml::model::Pump::setID ( const std::string &  id)
virtual

Set the ID property.

Parameters
idthe value to set.

Implements ome::xml::model::Reference.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setLinkedLaser()

const std::weak_ptr< ome::xml::model::Laser > & ome::xml::model::Pump::setLinkedLaser ( OMEModelObject::indexed_container< ome::xml::model::Laser, std::weak_ptr >::type::size_type  index,
const std::shared_ptr< ome::xml::model::Laser > &  laser_BackReference 
)

Set linked Laser.

Note
The index must be valid.
Parameters
indexthe index number of the Laser.
laser_BackReferencethe Laser to set.
Returns
a weak pointer to the Laser.
Exceptions
std::out_of_rangeif the index is invalid.

References impl.

◆ sizeOfLinkedLaserList()

OMEModelObject::indexed_container< ome::xml::model::Laser, std::weak_ptr >::type::size_type ome::xml::model::Pump::sizeOfLinkedLaserList ( ) const

Get size of linked Laser list.

Returns
the size of the list.

References impl.

◆ unlinkLaser()

bool ome::xml::model::Pump::unlinkLaser ( const std::shared_ptr< ome::xml::model::Laser > &  laser_BackReference)

Unlink Laser.

Parameters
laser_BackReferencethe Laser to unlink.
Returns
true if the Laser was unlinked, otherwise false if the Laser 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()

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

References ome::xml::model::OMEModel::addModelObject(), ome::common::xml::dom::Element::getAttribute(), getID(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setID(), ome::xml::model::Reference::update(), and validElementName().

◆ validElementName()

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