ome-xml  5.2.0
Classes | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ome::xml::model::LightSource Class Referenceabstract

LightSource model object. More...

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

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

Classes

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

Public Member Functions

 LightSource ()
 Default constructor.
 
 LightSource (const LightSource &copy)
 Copy constructor. More...
 
virtual ~LightSource ()
 Destructor.
 
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 (ome::compat::shared_ptr< Reference > &reference, ome::compat::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...
 
ome::compat::shared_ptr< double > getPower ()
 Get the Power property. More...
 
const ome::compat::shared_ptr< double > getPower () const
 Get the Power property. More...
 
void setPower (ome::compat::shared_ptr< double > &power)
 Set the Power property. More...
 
ome::compat::weak_ptr< ome::xml::model::InstrumentgetInstrument ()
 Get the Instrument property. More...
 
const ome::compat::weak_ptr< ome::xml::model::InstrumentgetInstrument () const
 Get the Instrument property. More...
 
void setInstrument (ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
 Set the Instrument property. More...
 
virtual const std::string & getLightSourceType () const =0
 Get the LightSource type. More...
 
const std::string & getXMLNamespace () const
 Get the XML namespace for this model object. More...
 
- Public Member Functions inherited from ome::xml::model::ManufacturerSpec
 ManufacturerSpec ()
 Default constructor.
 
 ManufacturerSpec (const ManufacturerSpec &copy)
 Copy constructor. More...
 
virtual ~ManufacturerSpec ()
 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 (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object)
 Link a given OME model object to this model object. More...
 
ome::compat::shared_ptr< std::string > getLotNumber ()
 Get the LotNumber property. More...
 
const ome::compat::shared_ptr< std::string > getLotNumber () const
 Get the LotNumber property. More...
 
void setLotNumber (ome::compat::shared_ptr< std::string > &lotNumber)
 Set the LotNumber property. More...
 
ome::compat::shared_ptr< std::string > getModel ()
 Get the Model property. More...
 
const ome::compat::shared_ptr< std::string > getModel () const
 Get the Model property. More...
 
void setModel (ome::compat::shared_ptr< std::string > &model)
 Set the Model property. More...
 
ome::compat::shared_ptr< std::string > getSerialNumber ()
 Get the SerialNumber property. More...
 
const ome::compat::shared_ptr< std::string > getSerialNumber () const
 Get the SerialNumber property. More...
 
void setSerialNumber (ome::compat::shared_ptr< std::string > &serialNumber)
 Set the SerialNumber property. More...
 
ome::compat::shared_ptr< std::string > getManufacturer ()
 Get the Manufacturer property. More...
 
const ome::compat::shared_ptr< std::string > getManufacturer () const
 Get the Manufacturer property. More...
 
void setManufacturer (ome::compat::shared_ptr< std::string > &manufacturer)
 Set the Manufacturer property. More...
 
virtual common::xml::dom::Element asXMLElement (common::xml::dom::Document &document) const
 Transform the object hierarchy rooted at this element to XML. 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 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 (ome::compat::shared_ptr< Reference > &reference, ome::compat::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 const std::string & elementName () const =0
 Get the element name of this model object. More...
 
virtual bool link (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< OMEModelObject > &object)=0
 Link a given OME model object to this model object. More...
 

Protected Member Functions

virtual common::xml::dom::Element 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.
 
 OMEModelObject (const OMEModelObject &copy)
 Copy constructor. More...
 
template<class C , typename T >
bool contains (const C &container, const ome::compat::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

ome::compat::shared_ptr< Implimpl
 Private implementation details.
 

Additional Inherited Members

- 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 Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger logger
 Message logger.
 

Detailed Description

LightSource model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters
copythe LightSource to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::LightSource::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.

Parameters
documentXML document for element creation.
elementXML element for setting model data.
Returns
an XML DOM tree root element for this model object.

Reimplemented from ome::xml::model::ManufacturerSpec.

Reimplemented in ome::xml::model::Laser, ome::xml::model::Arc, ome::xml::model::Filament, and ome::xml::model::LightEmittingDiode.

References ome::common::xml::dom::Node::appendChild(), ome::xml::model::ManufacturerSpec::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), ome::common::xml::dom::Element::getTagName(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().

Referenced by ome::xml::model::LightEmittingDiode::asXMLElementInternal(), ome::xml::model::Filament::asXMLElementInternal(), ome::xml::model::Arc::asXMLElementInternal(), and ome::xml::model::Laser::asXMLElementInternal().

+ Here is the caller graph for this function:

const std::string & ome::xml::model::LightSource::getID ( ) const

Get the ID property.

Returns
the ID property.

References impl.

Referenced by ome::xml::meta::OMEXMLMetadata::getArcID(), ome::xml::meta::OMEXMLMetadata::getFilamentID(), ome::xml::meta::OMEXMLMetadata::getLaserID(), ome::xml::meta::OMEXMLMetadata::getLaserPump(), ome::xml::meta::OMEXMLMetadata::getLightEmittingDiodeID(), and update().

+ Here is the caller graph for this function:

ome::compat::weak_ptr< ome::xml::model::Instrument > ome::xml::model::LightSource::getInstrument ( )

Get the Instrument property.

Returns
the Instrument property.

References impl.

const ome::compat::weak_ptr< ome::xml::model::Instrument > ome::xml::model::LightSource::getInstrument ( ) const

Get the Instrument property.

Returns
the Instrument property.

References impl.

virtual const std::string& ome::xml::model::LightSource::getLightSourceType ( ) const
pure virtual
ome::compat::shared_ptr< double > ome::xml::model::LightSource::getPower ( )

Get the Power property.

Returns
the Power property.

References impl.

Referenced by ome::xml::meta::OMEXMLMetadata::getArcPower(), ome::xml::meta::OMEXMLMetadata::getFilamentPower(), ome::xml::meta::OMEXMLMetadata::getLaserPower(), and ome::xml::meta::OMEXMLMetadata::getLightEmittingDiodePower().

+ Here is the caller graph for this function:

const ome::compat::shared_ptr< double > ome::xml::model::LightSource::getPower ( ) const

Get the Power property.

Returns
the Power property.

References impl.

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

bool ome::xml::model::LightSource::link ( ome::compat::shared_ptr< Reference > &  reference,
ome::compat::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::ManufacturerSpec::link(), and ome::xml::model::detail::OMEModelObject::logger.

Referenced by ome::xml::model::LightEmittingDiode::link(), ome::xml::model::Filament::link(), ome::xml::model::Arc::link(), and ome::xml::model::Laser::link().

+ Here is the caller graph for this function:

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

Set the ID property.

Parameters
idthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::LightSource::setInstrument ( ome::compat::weak_ptr< ome::xml::model::Instrument > &  instrument_BackReference)

Set the Instrument property.

Parameters
instrument_BackReferencethe value to set.

References impl.

void ome::xml::model::LightSource::setPower ( ome::compat::shared_ptr< double > &  power)

Set the Power property.

Parameters
powerthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

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

Reimplemented in ome::xml::model::Laser, ome::xml::model::Arc, ome::xml::model::Filament, and ome::xml::model::LightEmittingDiode.

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

Referenced by ome::xml::model::LightEmittingDiode::update(), ome::xml::model::Filament::update(), ome::xml::model::Arc::update(), and ome::xml::model::Laser::update().

+ Here is the caller graph for this function:

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

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

References ome::xml::model::ManufacturerSpec::validElementName().

Referenced by update(), ome::xml::model::LightEmittingDiode::validElementName(), ome::xml::model::Filament::validElementName(), ome::xml::model::Arc::validElementName(), and ome::xml::model::Laser::validElementName().

+ Here is the caller graph for this function:


The documentation for this class was generated from the following files: