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

LightSourceSettings model object. More...

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

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

Classes

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

Public Member Functions

 LightSourceSettings ()
 Default constructor.
 
 LightSourceSettings (const LightSourceSettings &copy)
 Copy constructor. More...
 
virtual ~LightSourceSettings ()
 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::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & getWavelength ()
 Get the Wavelength property. More...
 
const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & getWavelength () const
 Get the Wavelength property. More...
 
void setWavelength (const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > &wavelength)
 Set the Wavelength property. More...
 
std::shared_ptr< ome::xml::model::primitives::PercentFractiongetAttenuation ()
 Get the Attenuation property. More...
 
const std::shared_ptr< ome::xml::model::primitives::PercentFractiongetAttenuation () const
 Get the Attenuation property. More...
 
void setAttenuation (std::shared_ptr< ome::xml::model::primitives::PercentFraction > &attenuation)
 Set the Attenuation property. More...
 
const std::string & getID () const
 Get the ID property. More...
 
void setID (const std::string &id)
 Set the ID property. More...
 
std::weak_ptr< ome::xml::model::LightSourcegetLightSource ()
 Get the LightSource property. More...
 
const std::weak_ptr< ome::xml::model::LightSourcegetLightSource () const
 Get the LightSource property. More...
 
void setLightSource (std::weak_ptr< ome::xml::model::LightSource > &lightSource)
 Set the LightSource property. More...
 
std::weak_ptr< ome::xml::model::MicrobeamManipulationgetMicrobeamManipulation ()
 Get the MicrobeamManipulation property. More...
 
const std::weak_ptr< ome::xml::model::MicrobeamManipulationgetMicrobeamManipulation () const
 Get the MicrobeamManipulation property. More...
 
void setMicrobeamManipulation (std::weak_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
 Set the MicrobeamManipulation property. More...
 
const std::string & getXMLNamespace () const
 Get the XML namespace for this model object. More...
 
- Public Member Functions inherited from ome::xml::model::Settings
 Settings ()
 Default constructor.
 
 Settings (const Settings &copy)
 Copy constructor. More...
 
virtual ~Settings ()
 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::Reference
 Reference ()
 Default constructor.
 
 Reference (const Reference &copy)
 Copy constructor. More...
 
virtual ~Reference ()
 Destructor.
 
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::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< LightSourceSettingscreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a LightSourceSettings 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

LightSourceSettings model object.

Constructor & Destructor Documentation

◆ LightSourceSettings()

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

Copy constructor.

Parameters
copythe LightSourceSettings to copy.

Member Function Documentation

◆ asXMLElementInternal()

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

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

◆ create()

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

Create a LightSourceSettings 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::MicrobeamManipulation::update(), and ome::xml::model::Channel::update().

+ Here is the caller graph for this function:

◆ elementName()

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

◆ getAttenuation() [1/2]

std::shared_ptr< ome::xml::model::primitives::PercentFraction > ome::xml::model::LightSourceSettings::getAttenuation ( )

Get the Attenuation property.

Returns
the Attenuation property.

References impl.

◆ getAttenuation() [2/2]

const std::shared_ptr< ome::xml::model::primitives::PercentFraction > ome::xml::model::LightSourceSettings::getAttenuation ( ) const

Get the Attenuation property.

Returns
the Attenuation property.

References impl.

◆ getID()

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

◆ getLightSource() [1/2]

std::weak_ptr< ome::xml::model::LightSource > ome::xml::model::LightSourceSettings::getLightSource ( )

Get the LightSource property.

Returns
the LightSource property.

References impl.

◆ getLightSource() [2/2]

const std::weak_ptr< ome::xml::model::LightSource > ome::xml::model::LightSourceSettings::getLightSource ( ) const

Get the LightSource property.

Returns
the LightSource property.

References impl.

◆ getMicrobeamManipulation() [1/2]

std::weak_ptr< ome::xml::model::MicrobeamManipulation > ome::xml::model::LightSourceSettings::getMicrobeamManipulation ( )

Get the MicrobeamManipulation property.

Returns
the MicrobeamManipulation property.

References impl.

◆ getMicrobeamManipulation() [2/2]

const std::weak_ptr< ome::xml::model::MicrobeamManipulation > ome::xml::model::LightSourceSettings::getMicrobeamManipulation ( ) const

Get the MicrobeamManipulation property.

Returns
the MicrobeamManipulation property.

References impl.

◆ getWavelength() [1/2]

std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & ome::xml::model::LightSourceSettings::getWavelength ( )

Get the Wavelength property.

Returns
the Wavelength property.

References impl.

◆ getWavelength() [2/2]

const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & ome::xml::model::LightSourceSettings::getWavelength ( ) const

Get the Wavelength property.

Returns
the Wavelength property.

References impl.

◆ getXMLNamespace()

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

◆ setAttenuation()

void ome::xml::model::LightSourceSettings::setAttenuation ( std::shared_ptr< ome::xml::model::primitives::PercentFraction > &  attenuation)

Set the Attenuation property.

Parameters
attenuationthe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ setID()

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

◆ setLightSource()

void ome::xml::model::LightSourceSettings::setLightSource ( std::weak_ptr< ome::xml::model::LightSource > &  lightSource)

Set the LightSource property.

Parameters
lightSourcethe value to set.

References impl.

◆ setMicrobeamManipulation()

void ome::xml::model::LightSourceSettings::setMicrobeamManipulation ( std::weak_ptr< ome::xml::model::MicrobeamManipulation > &  microbeamManipulation_BackReference)

Set the MicrobeamManipulation property.

Parameters
microbeamManipulation_BackReferencethe value to set.

References impl.

◆ setWavelength()

void ome::xml::model::LightSourceSettings::setWavelength ( const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > &  wavelength)

Set the Wavelength property.

Parameters
wavelengththe value to set.

References impl.

Referenced by update().

+ Here is the caller graph for this function:

◆ update()

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

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, setAttenuation(), setID(), setWavelength(), ome::xml::model::Settings::update(), and validElementName().

◆ validElementName()

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