Inscoper::NBO::Laser¶

Represents the XML element Laser. More...

#include <Laser.h>

Inherits from Inscoper::NBO::LightSource_Type, Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions¶

	Name
	Laser()
	~Laser()
virtual std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setType(const Inscoper::NBO::LaserType_TypePtr & value, bool validate =true) Sets the value of the Type attribute.
LaserType_TypePtr	getType() const Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
bool	hasType() const Checks whether the optional Type attribute is present.
void	setTuneable(const bool & value, bool validate =true) Sets the value of the Tuneable attribute.
bool	getTuneable() const Returns the value of the Tuneable attribute.
void	resetTuneable() Resets the Tuneable attribute to an unset state.
bool	hasTuneable() const Checks whether the Tuneable attribute is present.
void	setModulationMechanism(const Inscoper::NBO::LaserModulation_TypePtr & value, bool validate =true) Sets the value of the ModulationMechanism attribute.
LaserModulation_TypePtr	getModulationMechanism() const Returns the value of the ModulationMechanism attribute.
void	resetModulationMechanism() Resets the ModulationMechanism attribute to an unset state.
bool	hasModulationMechanism() const Checks whether the optional ModulationMechanism attribute is present.
void	setPulse(const bool & value, bool validate =true) Sets the value of the Pulse attribute.
bool	getPulse() const Returns the value of the Pulse attribute.
void	resetPulse() Resets the Pulse attribute to an unset state.
bool	hasPulse() const Checks whether the Pulse attribute is present.
void	setLaserClass(const Inscoper::NBO::LaserClass_TypePtr & value, bool validate =true) Sets the value of the LaserClass attribute.
LaserClass_TypePtr	getLaserClass() const Returns the value of the LaserClass attribute.
void	resetLaserClass() Resets the LaserClass attribute to an unset state.
bool	hasLaserClass() const Checks whether the optional LaserClass attribute is present.
void	setLaserMedium(const Inscoper::NBO::LaserMedium_TypePtr & value, bool validate =true) Sets the value of the LaserMedium attribute.
LaserMedium_TypePtr	getLaserMedium() const Returns the value of the LaserMedium attribute.
void	resetLaserMedium() Resets the LaserMedium attribute to an unset state.
bool	hasLaserMedium() const Checks whether the optional LaserMedium attribute is present.
void	setIsPumped(const bool & value, bool validate =true) Sets the value of the IsPumped attribute.
bool	getIsPumped() const Returns the value of the IsPumped attribute.
void	resetIsPumped() Resets the IsPumped attribute to an unset state.
bool	hasIsPumped() const Checks whether the IsPumped attribute is present.
void	setIsPump(const bool & value, bool validate =true) Sets the value of the IsPump attribute.
bool	getIsPump() const Returns the value of the IsPump attribute.
void	resetIsPump() Resets the IsPump attribute to an unset state.
bool	hasIsPump() const Checks whether the IsPump attribute is present.
void	setPosition(const long long & value, bool validate =true) Sets the value of the Position attribute.
long long	getPosition() const Returns the value of the Position attribute.
void	resetPosition() Resets the Position attribute to an unset state.
bool	hasPosition() const Checks whether the Position attribute is present.
void	setRepetitionRate(const float & value, bool validate =true) Sets the value of the RepetitionRate attribute.
float	getRepetitionRate() const Returns the value of the RepetitionRate attribute.
void	resetRepetitionRate() Resets the RepetitionRate attribute to an unset state.
bool	hasRepetitionRate() const Checks whether the RepetitionRate attribute is present.
void	setRepetitionRateUnit(const Inscoper::NBO::UnitsFrequency_TypePtr & value, bool validate =true) Sets the value of the RepetitionRateUnit attribute.
UnitsFrequency_TypePtr	getRepetitionRateUnit() const Returns the value of the RepetitionRateUnit attribute.
void	resetRepetitionRateUnit() Resets the RepetitionRateUnit attribute to an unset state.
bool	hasRepetitionRateUnit() const Checks whether the optional RepetitionRateUnit attribute is present.
void	setPulseDuration(const float & value, bool validate =true) Sets the value of the PulseDuration attribute.
float	getPulseDuration() const Returns the value of the PulseDuration attribute.
void	resetPulseDuration() Resets the PulseDuration attribute to an unset state.
bool	hasPulseDuration() const Checks whether the PulseDuration attribute is present.
void	setPulseDurationUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the PulseDurationUnit attribute.
UnitsTime_TypePtr	getPulseDurationUnit() const Returns the value of the PulseDurationUnit attribute.
void	resetPulseDurationUnit() Resets the PulseDurationUnit attribute to an unset state.
bool	hasPulseDurationUnit() const Checks whether the optional PulseDurationUnit attribute is present.
void	setFrequencyMultiplication(const float & value, bool validate =true) Sets the value of the FrequencyMultiplication attribute.
float	getFrequencyMultiplication() const Returns the value of the FrequencyMultiplication attribute.
void	resetFrequencyMultiplication() Resets the FrequencyMultiplication attribute to an unset state.
bool	hasFrequencyMultiplication() const Checks whether the FrequencyMultiplication attribute is present.
void	setUsedAcoustoOpticalDevice(const bool & value, bool validate =true) Sets the value of the UsedAcoustoOpticalDevice attribute.
bool	getUsedAcoustoOpticalDevice() const Returns the value of the UsedAcoustoOpticalDevice attribute.
void	resetUsedAcoustoOpticalDevice() Resets the UsedAcoustoOpticalDevice attribute to an unset state.
bool	hasUsedAcoustoOpticalDevice() const Checks whether the UsedAcoustoOpticalDevice attribute is present.
void	setIlluminationWavelengthRange_List(const std::vector< Inscoper::NBO::IlluminationWavelengthRangePtr > & value, bool validate =true) Sets the list of IlluminationWavelengthRange elements.
std::vector< Inscoper::NBO::IlluminationWavelengthRangePtr >	getIlluminationWavelengthRange_List() const Returns the list of IlluminationWavelengthRange elements.
void	addToIlluminationWavelengthRange_List(const Inscoper::NBO::IlluminationWavelengthRangePtr & value, bool validate =true) Adds a new IlluminationWavelengthRange element to this object.
void	clearIlluminationWavelengthRange_List() Clear the list of IlluminationWavelengthRange.
void	setAcoustoOpticalDeviceRef_List(const std::vector< Inscoper::NBO::AcoustoOpticalDeviceRefPtr > & value, bool validate =true) Sets the list of AcoustoOpticalDeviceRef elements.
std::vector< Inscoper::NBO::AcoustoOpticalDeviceRefPtr >	getAcoustoOpticalDeviceRef_List() const Returns the list of AcoustoOpticalDeviceRef elements.
void	addToAcoustoOpticalDeviceRef_List(const Inscoper::NBO::AcoustoOpticalDeviceRefPtr & value, bool validate =true) Adds a new AcoustoOpticalDeviceRef element to this object.
void	clearAcoustoOpticalDeviceRef_List() Clear the list of AcoustoOpticalDeviceRef.
void	setPump(const Inscoper::NBO::PumpPtr & value, bool validate =true) Sets the value of the Pump element.
Inscoper::NBO::PumpPtr	getPump() const Returns the value of the Pump element.
void	resetPump() Resets the Pump element to an unset state.
bool	hasPump() const Checks whether the optional Pump element is present.
std::shared_ptr< Laser >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Laser.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::LightSource_Type

	Name
	LightSource_Type()
	~LightSource_Type()
void	setID(const Inscoper::NBO::LightSourceID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LightSourceID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setName(const Inscoper::NBO::Denomination_TypePtr & value, bool validate =true) Sets the value of the Name attribute.
Denomination_TypePtr	getName() const Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
bool	hasName() const Checks whether the optional Name attribute is present.
void	setPurchaseDate(const std::string & value, bool validate =true) Sets the value of the PurchaseDate attribute.
std::string	getPurchaseDate() const Returns the value of the PurchaseDate attribute.
void	resetPurchaseDate() Resets the PurchaseDate attribute to an unset state.
bool	hasPurchaseDate() const Checks whether the PurchaseDate attribute is present.
void	setIlluminationPowerReportingStatistic(const Inscoper::NBO::LightSourceIlluminationPowerReportingStatistic_TypePtr & value, bool validate =true) Sets the value of the IlluminationPowerReportingStatistic attribute.
LightSourceIlluminationPowerReportingStatistic_TypePtr	getIlluminationPowerReportingStatistic() const Returns the value of the IlluminationPowerReportingStatistic attribute.
void	resetIlluminationPowerReportingStatistic() Resets the IlluminationPowerReportingStatistic attribute to an unset state.
bool	hasIlluminationPowerReportingStatistic() const Checks whether the optional IlluminationPowerReportingStatistic attribute is present.
void	setIlluminationPowerReportingPosition(const Inscoper::NBO::LightSourceIlluminationPowerReportingPosition_TypePtr & value, bool validate =true) Sets the value of the IlluminationPowerReportingPosition attribute.
LightSourceIlluminationPowerReportingPosition_TypePtr	getIlluminationPowerReportingPosition() const Returns the value of the IlluminationPowerReportingPosition attribute.
void	resetIlluminationPowerReportingPosition() Resets the IlluminationPowerReportingPosition attribute to an unset state.
bool	hasIlluminationPowerReportingPosition() const Checks whether the optional IlluminationPowerReportingPosition attribute is present.
void	setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::AnnotationRefPtr	getAnnotationRef() const Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
bool	hasAnnotationRef() const Checks whether the optional AnnotationRef element is present.
const std::set< std::string > &	getPurchaseDateAllowedValues() Returns the allowed values for this attribut.

Public Functions inherited from Inscoper::NBO::ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
	~ManufacturerSpec_Type()
void	setManufacturer(const std::string & value, bool validate =true) Sets the value of the Manufacturer attribute.
std::string	getManufacturer() const Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
bool	hasManufacturer() const Checks whether the Manufacturer attribute is present.
void	setModel(const std::string & value, bool validate =true) Sets the value of the Model attribute.
std::string	getModel() const Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
bool	hasModel() const Checks whether the Model attribute is present.
void	setCatalogNumber(const std::string & value, bool validate =true) Sets the value of the CatalogNumber attribute.
std::string	getCatalogNumber() const Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
bool	hasCatalogNumber() const Checks whether the CatalogNumber attribute is present.
void	setLotNumber(const std::string & value, bool validate =true) Sets the value of the LotNumber attribute.
std::string	getLotNumber() const Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
bool	hasLotNumber() const Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true) Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr >	getMapAnnotation_List() const Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(const Inscoper::NBO::FileAnnotation_TypePtr & value, bool validate =true) Sets the value of the SpecsFile element.
Inscoper::NBO::FileAnnotation_TypePtr	getSpecsFile() const Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
bool	hasSpecsFile() const Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true) Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr >	getAdditionalVendorInformation_List() const Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
const std::set< std::string > &	getManufacturerAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getModelAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Laser;

Represents the XML element Laser.

This element describes a Light Source, which emits coherent radiation at high spectral concentrations of radiance and minimal solid angles. This includes proper Light Amplification by Stimulated Emission of Radiation (LASER) sources that emit light through a process of optical amplification based on the stimulated emission of electromagnetic radiation. It also includes Optical Parametric Oscillator (OPO) sources that use a kind of LASER resonator but based on optical gain from parametric amplification in a nonlinear crystal rather than from stimulated emission.

Public Functions Documentation¶

function Laser¶

function ~Laser¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function setType¶

void setType(
    const Inscoper::NBO::LaserType_TypePtr & value,
    bool validate =true
)

Sets the value of the Type attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.

function getType¶

LaserType_TypePtr getType() const

Returns the value of the Type attribute.

Return: The value of the attribute

This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.

function resetType¶

void resetType()

Resets the Type attribute to an unset state.

This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.

function hasType¶

bool hasType() const

Checks whether the optional Type attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.

function setTuneable¶

void setTuneable(
    const bool & value,
    bool validate =true
)

Sets the value of the Tuneable attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records whether (True) or not (False) this Laser is Tunable to different Wavelengths

function getTuneable¶

bool getTuneable() const

Returns the value of the Tuneable attribute.

Return: The value of the attribute

This field records whether (True) or not (False) this Laser is Tunable to different Wavelengths

function resetTuneable¶

function hasTuneable¶

bool hasTuneable() const

Checks whether the Tuneable attribute is present.

Return: true if the attribute has been set, false otherwise

This field records whether (True) or not (False) this Laser is Tunable to different Wavelengths

function setModulationMechanism¶

void setModulationMechanism(
    const Inscoper::NBO::LaserModulation_TypePtr & value,
    bool validate =true
)

Sets the value of the ModulationMechanism attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field captures the Modulation Mechanism used for this Laser.

function getModulationMechanism¶

LaserModulation_TypePtr getModulationMechanism() const

Returns the value of the ModulationMechanism attribute.

Return: The value of the attribute

This field captures the Modulation Mechanism used for this Laser.

function resetModulationMechanism¶

function hasModulationMechanism¶

bool hasModulationMechanism() const

Checks whether the optional ModulationMechanism attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the Modulation Mechanism used for this Laser.

function setPulse¶

void setPulse(
    const bool & value,
    bool validate =true
)

Sets the value of the Pulse attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).

function getPulse¶

bool getPulse() const

Returns the value of the Pulse attribute.

Return: The value of the attribute

Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).

function resetPulse¶

function hasPulse¶

bool hasPulse() const

Checks whether the Pulse attribute is present.

Return: true if the attribute has been set, false otherwise

Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).

function setLaserClass¶

void setLaserClass(
    const Inscoper::NBO::LaserClass_TypePtr & value,
    bool validate =true
)

Sets the value of the LaserClass attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.

function getLaserClass¶

LaserClass_TypePtr getLaserClass() const

Returns the value of the LaserClass attribute.

Return: The value of the attribute

This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.

function resetLaserClass¶

void resetLaserClass()

Resets the LaserClass attribute to an unset state.

This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.

function hasLaserClass¶

bool hasLaserClass() const

Checks whether the optional LaserClass attribute is present.

Return: true if the optional attribute has been set, false otherwise

This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.

function setLaserMedium¶

void setLaserMedium(
    const Inscoper::NBO::LaserMedium_TypePtr & value,
    bool validate =true
)

Sets the value of the LaserMedium attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field captures the material out of which this Laser is constructed.

function getLaserMedium¶

LaserMedium_TypePtr getLaserMedium() const

Returns the value of the LaserMedium attribute.

Return: The value of the attribute

This field captures the material out of which this Laser is constructed.

function resetLaserMedium¶

function hasLaserMedium¶

bool hasLaserMedium() const

Checks whether the optional LaserMedium attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the material out of which this Laser is constructed.

function setIsPumped¶

void setIsPumped(
    const bool & value,
    bool validate =true
)

Sets the value of the IsPumped attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

Whether (True) or not (False) this is a pumped Laser.

function getIsPumped¶

function resetIsPumped¶

function hasIsPumped¶

function setIsPump¶

void setIsPump(
    const bool & value,
    bool validate =true
)

Sets the value of the IsPump attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

Whether (True) or not (False) this laser serves as a Pump for a downstream laser.

function getIsPump¶

function resetIsPump¶

function hasIsPump¶

bool hasIsPump() const

Checks whether the IsPump attribute is present.

Return: true if the attribute has been set, false otherwise

Whether (True) or not (False) this laser serves as a Pump for a downstream laser.

function setPosition¶

void setPosition(
    const long long & value,
    bool validate =true
)

Sets the value of the Position attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field captures the position of this Laser on a Multi Laser Engine.

function getPosition¶

function resetPosition¶

function hasPosition¶

bool hasPosition() const

Checks whether the Position attribute is present.

Return: true if the attribute has been set, false otherwise

This field captures the position of this Laser on a Multi Laser Engine.

function setRepetitionRate¶

void setRepetitionRate(
    const float & value,
    bool validate =true
)

Sets the value of the RepetitionRate attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.

function getRepetitionRate¶

float getRepetitionRate() const

Returns the value of the RepetitionRate attribute.

Return: The value of the attribute

In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.

function resetRepetitionRate¶

void resetRepetitionRate()

Resets the RepetitionRate attribute to an unset state.

In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.

function hasRepetitionRate¶

bool hasRepetitionRate() const

Checks whether the RepetitionRate attribute is present.

Return: true if the attribute has been set, false otherwise

In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.

function setRepetitionRateUnit¶

void setRepetitionRateUnit(
    const Inscoper::NBO::UnitsFrequency_TypePtr & value,
    bool validate =true
)

Sets the value of the RepetitionRateUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getRepetitionRateUnit¶

function resetRepetitionRateUnit¶

function hasRepetitionRateUnit¶

bool hasRepetitionRateUnit() const

Checks whether the optional RepetitionRateUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPulseDuration¶

void setPulseDuration(
    const float & value,
    bool validate =true
)

Sets the value of the PulseDuration attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.

function getPulseDuration¶

float getPulseDuration() const

Returns the value of the PulseDuration attribute.

Return: The value of the attribute

In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.

function resetPulseDuration¶

function hasPulseDuration¶

bool hasPulseDuration() const

Checks whether the PulseDuration attribute is present.

Return: true if the attribute has been set, false otherwise

In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.

function setPulseDurationUnit¶

void setPulseDurationUnit(
    const Inscoper::NBO::UnitsTime_TypePtr & value,
    bool validate =true
)

Sets the value of the PulseDurationUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getPulseDurationUnit¶

function resetPulseDurationUnit¶

function hasPulseDurationUnit¶

bool hasPulseDurationUnit() const

Checks whether the optional PulseDurationUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setFrequencyMultiplication¶

void setFrequencyMultiplication(
    const float & value,
    bool validate =true
)

Sets the value of the FrequencyMultiplication attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field captures the optical frequency multiplication factor that may be specified for this Laser.

function getFrequencyMultiplication¶

float getFrequencyMultiplication() const

Returns the value of the FrequencyMultiplication attribute.

Return: The value of the attribute

This field captures the optical frequency multiplication factor that may be specified for this Laser.

function resetFrequencyMultiplication¶

void resetFrequencyMultiplication()

Resets the FrequencyMultiplication attribute to an unset state.

This field captures the optical frequency multiplication factor that may be specified for this Laser.

function hasFrequencyMultiplication¶

bool hasFrequencyMultiplication() const

Checks whether the FrequencyMultiplication attribute is present.

Return: true if the attribute has been set, false otherwise

This field captures the optical frequency multiplication factor that may be specified for this Laser.

function setUsedAcoustoOpticalDevice¶

void setUsedAcoustoOpticalDevice(
    const bool & value,
    bool validate =true
)

Sets the value of the UsedAcoustoOpticalDevice attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

function getUsedAcoustoOpticalDevice¶

bool getUsedAcoustoOpticalDevice() const

Returns the value of the UsedAcoustoOpticalDevice attribute.

Return: The value of the attribute

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

function resetUsedAcoustoOpticalDevice¶

void resetUsedAcoustoOpticalDevice()

Resets the UsedAcoustoOpticalDevice attribute to an unset state.

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

function hasUsedAcoustoOpticalDevice¶

bool hasUsedAcoustoOpticalDevice() const

Checks whether the UsedAcoustoOpticalDevice attribute is present.

Return: true if the attribute has been set, false otherwise

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

function setIlluminationWavelengthRange_List¶

void setIlluminationWavelengthRange_List(
    const std::vector< Inscoper::NBO::IlluminationWavelengthRangePtr > & value,
    bool validate =true
)

Sets the list of IlluminationWavelengthRange elements.

Parameters:

value The new list of IlluminationWavelengthRange elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getIlluminationWavelengthRange_List¶

std::vector< Inscoper::NBO::IlluminationWavelengthRangePtr > getIlluminationWavelengthRange_List() const

Returns the list of IlluminationWavelengthRange elements.

Return: The list of IlluminationWavelengthRange elements

No description available in the XSD standard.

function addToIlluminationWavelengthRange_List¶

void addToIlluminationWavelengthRange_List(
    const Inscoper::NBO::IlluminationWavelengthRangePtr & value,
    bool validate =true
)

Adds a new IlluminationWavelengthRange element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function clearIlluminationWavelengthRange_List¶

function setAcoustoOpticalDeviceRef_List¶

void setAcoustoOpticalDeviceRef_List(
    const std::vector< Inscoper::NBO::AcoustoOpticalDeviceRefPtr > & value,
    bool validate =true
)

Sets the list of AcoustoOpticalDeviceRef elements.

Parameters:

value The new list of AcoustoOpticalDeviceRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getAcoustoOpticalDeviceRef_List¶

std::vector< Inscoper::NBO::AcoustoOpticalDeviceRefPtr > getAcoustoOpticalDeviceRef_List() const

Returns the list of AcoustoOpticalDeviceRef elements.

Return: The list of AcoustoOpticalDeviceRef elements

No description available in the XSD standard.

function addToAcoustoOpticalDeviceRef_List¶

void addToAcoustoOpticalDeviceRef_List(
    const Inscoper::NBO::AcoustoOpticalDeviceRefPtr & value,
    bool validate =true
)

Adds a new AcoustoOpticalDeviceRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function clearAcoustoOpticalDeviceRef_List¶

function setPump¶

void setPump(
    const Inscoper::NBO::PumpPtr & value,
    bool validate =true
)

Sets the value of the Pump element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getPump¶

function resetPump¶

function hasPump¶

function fromBase¶

static std::shared_ptr< Laser > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a Laser.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Updated on 2026-09-23 at 16:50:38 +0200