ome-xml
5.5.1
|
#include <ome/xml/model/Laser.h>
Classes | |
class | Impl |
Private implementation details of Laser model object. More... | |
Public Member Functions | |
Laser () | |
Default constructor. | |
Laser (const Laser ©) | |
Copy constructor. More... | |
virtual | ~Laser () |
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... | |
std::shared_ptr< bool > | getPockelCell () |
Get the PockelCell property. More... | |
const std::shared_ptr< bool > | getPockelCell () const |
Get the PockelCell property. More... | |
void | setPockelCell (std::shared_ptr< bool > &pockelCell) |
Set the PockelCell property. More... | |
std::shared_ptr< bool > | getTuneable () |
Get the Tuneable property. More... | |
const std::shared_ptr< bool > | getTuneable () const |
Get the Tuneable property. More... | |
void | setTuneable (std::shared_ptr< bool > &tuneable) |
Set the Tuneable property. More... | |
std::shared_ptr < ome::xml::model::enums::LaserMedium > | getLaserMedium () |
Get the LaserMedium property. More... | |
const std::shared_ptr < ome::xml::model::enums::LaserMedium > | getLaserMedium () const |
Get the LaserMedium property. More... | |
void | setLaserMedium (std::shared_ptr< ome::xml::model::enums::LaserMedium > &laserMedium) |
Set the LaserMedium property. More... | |
std::shared_ptr < ome::xml::model::enums::Pulse > | getPulse () |
Get the Pulse property. More... | |
const std::shared_ptr < ome::xml::model::enums::Pulse > | getPulse () const |
Get the Pulse property. More... | |
void | setPulse (std::shared_ptr< ome::xml::model::enums::Pulse > &pulse) |
Set the Pulse property. 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::PositiveInteger > | getFrequencyMultiplication () |
Get the FrequencyMultiplication property. More... | |
const std::shared_ptr < ome::xml::model::primitives::PositiveInteger > | getFrequencyMultiplication () const |
Get the FrequencyMultiplication property. More... | |
void | setFrequencyMultiplication (std::shared_ptr< ome::xml::model::primitives::PositiveInteger > &frequencyMultiplication) |
Set the FrequencyMultiplication property. More... | |
std::shared_ptr < ome::xml::model::enums::LaserType > | getType () |
Get the Type property. More... | |
const std::shared_ptr < ome::xml::model::enums::LaserType > | getType () const |
Get the Type property. More... | |
void | setType (std::shared_ptr< ome::xml::model::enums::LaserType > &type) |
Set the Type property. More... | |
std::shared_ptr < ome::xml::model::primitives::Quantity < ome::xml::model::enums::UnitsFrequency > > & | getRepetitionRate () |
Get the RepetitionRate property. More... | |
const std::shared_ptr < ome::xml::model::primitives::Quantity < ome::xml::model::enums::UnitsFrequency > > & | getRepetitionRate () const |
Get the RepetitionRate property. More... | |
void | setRepetitionRate (const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > > &repetitionRate) |
Set the RepetitionRate property. More... | |
std::weak_ptr < ome::xml::model::LightSource > | getLinkedPump () |
Get linked Pump. More... | |
const std::weak_ptr < ome::xml::model::LightSource > | getLinkedPump () const |
Get linked Pump. More... | |
void | linkPump (std::shared_ptr< ome::xml::model::LightSource > &pump) |
Link Pump. More... | |
void | unlinkPump (std::shared_ptr< ome::xml::model::LightSource > &pump) |
Unlink Pump. More... | |
const std::string & | getLightSourceType () const |
Get the LightSource type. More... | |
const std::string & | getXMLNamespace () const |
Get the XML namespace for this model object. More... | |
![]() | |
LightSource () | |
Default constructor. | |
LightSource (const LightSource ©) | |
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... | |
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... | |
std::shared_ptr < ome::xml::model::primitives::Quantity < ome::xml::model::enums::UnitsPower > > & | getPower () |
Get the Power property. More... | |
const std::shared_ptr < ome::xml::model::primitives::Quantity < ome::xml::model::enums::UnitsPower > > & | getPower () const |
Get the Power property. More... | |
void | setPower (const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsPower > > &power) |
Set the Power 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::Instrument > | getInstrument () |
Get the Instrument property. More... | |
const std::weak_ptr < ome::xml::model::Instrument > | getInstrument () const |
Get the Instrument property. More... | |
void | setInstrument (std::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference) |
Set the Instrument property. More... | |
const std::string & | getXMLNamespace () const |
Get the XML namespace for this model object. More... | |
![]() | |
ManufacturerSpec () | |
Default constructor. | |
ManufacturerSpec (const ManufacturerSpec ©) | |
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 (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 > | getLotNumber () |
Get the LotNumber property. More... | |
const std::shared_ptr < std::string > | getLotNumber () const |
Get the LotNumber property. More... | |
void | setLotNumber (std::shared_ptr< std::string > &lotNumber) |
Set the LotNumber property. More... | |
std::shared_ptr< std::string > | getModel () |
Get the Model property. More... | |
const std::shared_ptr < std::string > | getModel () const |
Get the Model property. More... | |
void | setModel (std::shared_ptr< std::string > &model) |
Set the Model property. More... | |
std::shared_ptr< std::string > | getSerialNumber () |
Get the SerialNumber property. More... | |
const std::shared_ptr < std::string > | getSerialNumber () const |
Get the SerialNumber property. More... | |
void | setSerialNumber (std::shared_ptr< std::string > &serialNumber) |
Set the SerialNumber property. More... | |
std::shared_ptr< std::string > | getManufacturer () |
Get the Manufacturer property. More... | |
const std::shared_ptr < std::string > | getManufacturer () const |
Get the Manufacturer property. More... | |
void | setManufacturer (std::shared_ptr< std::string > &manufacturer) |
Set the Manufacturer 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< Laser > | create (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Create a Laser 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 | |
Laser & | operator= (const Laser &) |
Assignment operator (deleted). | |
Private Attributes | |
std::shared_ptr< Impl > | impl |
Private implementation details. | |
Additional Inherited Members | |
![]() | |
ome::common::Logger | logger |
Message logger. | |
Laser model object.
ome::xml::model::Laser::Laser | ( | const Laser & | copy | ) |
Copy constructor.
copy | the Laser to copy. |
|
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::LightSource.
References ome::xml::model::LightSource::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().
|
static |
Create a Laser 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::Instrument::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::primitives::PositiveInteger > ome::xml::model::Laser::getFrequencyMultiplication | ( | ) |
Get the FrequencyMultiplication property.
References impl.
const std::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Laser::getFrequencyMultiplication | ( | ) | const |
Get the FrequencyMultiplication property.
References impl.
std::shared_ptr< ome::xml::model::enums::LaserMedium > ome::xml::model::Laser::getLaserMedium | ( | ) |
const std::shared_ptr< ome::xml::model::enums::LaserMedium > ome::xml::model::Laser::getLaserMedium | ( | ) | const |
|
virtual |
Get the LightSource type.
Implements ome::xml::model::LightSource.
std::weak_ptr< ome::xml::model::LightSource > ome::xml::model::Laser::getLinkedPump | ( | ) |
const std::weak_ptr< ome::xml::model::LightSource > ome::xml::model::Laser::getLinkedPump | ( | ) | const |
std::shared_ptr< bool > ome::xml::model::Laser::getPockelCell | ( | ) |
const std::shared_ptr< bool > ome::xml::model::Laser::getPockelCell | ( | ) | const |
std::shared_ptr< ome::xml::model::enums::Pulse > ome::xml::model::Laser::getPulse | ( | ) |
const std::shared_ptr< ome::xml::model::enums::Pulse > ome::xml::model::Laser::getPulse | ( | ) | const |
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > > & ome::xml::model::Laser::getRepetitionRate | ( | ) |
const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > > & ome::xml::model::Laser::getRepetitionRate | ( | ) | const |
std::shared_ptr< bool > ome::xml::model::Laser::getTuneable | ( | ) |
const std::shared_ptr< bool > ome::xml::model::Laser::getTuneable | ( | ) | const |
std::shared_ptr< ome::xml::model::enums::LaserType > ome::xml::model::Laser::getType | ( | ) |
const std::shared_ptr< ome::xml::model::enums::LaserType > ome::xml::model::Laser::getType | ( | ) | const |
std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & ome::xml::model::Laser::getWavelength | ( | ) |
const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & ome::xml::model::Laser::getWavelength | ( | ) | const |
|
virtual |
Get the XML namespace for this model object.
Implements ome::xml::model::OMEModelObject.
Referenced by asXMLElementInternal().
bool ome::xml::model::Laser::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 impl, ome::xml::model::LightSource::link(), and ome::xml::model::detail::OMEModelObject::logger.
void ome::xml::model::Laser::linkPump | ( | std::shared_ptr< ome::xml::model::LightSource > & | pump | ) |
void ome::xml::model::Laser::setFrequencyMultiplication | ( | std::shared_ptr< ome::xml::model::primitives::PositiveInteger > & | frequencyMultiplication | ) |
void ome::xml::model::Laser::setLaserMedium | ( | std::shared_ptr< ome::xml::model::enums::LaserMedium > & | laserMedium | ) |
void ome::xml::model::Laser::setPockelCell | ( | std::shared_ptr< bool > & | pockelCell | ) |
void ome::xml::model::Laser::setPulse | ( | std::shared_ptr< ome::xml::model::enums::Pulse > & | pulse | ) |
void ome::xml::model::Laser::setRepetitionRate | ( | const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsFrequency > > & | repetitionRate | ) |
void ome::xml::model::Laser::setTuneable | ( | std::shared_ptr< bool > & | tuneable | ) |
void ome::xml::model::Laser::setType | ( | std::shared_ptr< ome::xml::model::enums::LaserType > & | type | ) |
void ome::xml::model::Laser::setWavelength | ( | const std::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength, ome::xml::model::primitives::PositiveFloat > > & | wavelength | ) |
void ome::xml::model::Laser::unlinkPump | ( | std::shared_ptr< ome::xml::model::LightSource > & | pump | ) |
|
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::LightSource.
References ome::xml::model::OMEModel::addReference(), 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, setFrequencyMultiplication(), setLaserMedium(), setPockelCell(), setPulse(), setRepetitionRate(), setTuneable(), setType(), setWavelength(), ome::xml::model::LightSource::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().