Inscoper::NBO::ElectroOpticalDevice_Type¶

Represents the XML complex type ElectroOpticalDevice. More...

#include <ElectroOpticalDevice_Type.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Inherited by Inscoper::NBO::DeformableMirror, Inscoper::NBO::ElectroOpticalModulator, Inscoper::NBO::LiquidCrystalTuneableFilter, Inscoper::NBO::SpatialLightModulator

Public Functions¶

	Name
	ElectroOpticalDevice_Type()
	~ElectroOpticalDevice_Type()
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	setID(const Inscoper::NBO::ElectroOpticalDeviceID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
ElectroOpticalDeviceID_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	setModulationMode(const Inscoper::NBO::ModulationModeList_TypePtr & value, bool validate =true) Sets the value of the ModulationMode attribute.
ModulationModeList_TypePtr	getModulationMode() const Returns the value of the ModulationMode attribute.
void	resetModulationMode() Resets the ModulationMode attribute to an unset state.
bool	hasModulationMode() const Checks whether the optional ModulationMode attribute is present.
void	setContrastRatio(const Inscoper::NBO::PercentFraction_TypePtr & value, bool validate =true) Sets the value of the ContrastRatio attribute.
PercentFraction_TypePtr	getContrastRatio() const Returns the value of the ContrastRatio attribute.
void	resetContrastRatio() Resets the ContrastRatio attribute to an unset state.
bool	hasContrastRatio() const Checks whether the optional ContrastRatio attribute is present.
void	setCoating(const std::string & value, bool validate =true) Sets the value of the Coating attribute.
std::string	getCoating() const Returns the value of the Coating attribute.
void	resetCoating() Resets the Coating attribute to an unset state.
bool	hasCoating() const Checks whether the Coating attribute is present.
void	setAttenuationMethod(const Inscoper::NBO::AttenuationMethodType_TypePtr & value, bool validate =true) Sets the value of the AttenuationMethod attribute.
AttenuationMethodType_TypePtr	getAttenuationMethod() const Returns the value of the AttenuationMethod attribute.
void	resetAttenuationMethod() Resets the AttenuationMethod attribute to an unset state.
bool	hasAttenuationMethod() const Checks whether the optional AttenuationMethod attribute is present.
void	setAttenuationCoefficient(const float & value, bool validate =true) Sets the value of the AttenuationCoefficient attribute.
float	getAttenuationCoefficient() const Returns the value of the AttenuationCoefficient attribute.
void	resetAttenuationCoefficient() Resets the AttenuationCoefficient attribute to an unset state.
bool	hasAttenuationCoefficient() const Checks whether the AttenuationCoefficient attribute is present.
void	setTuningAccuracy(const float & value, bool validate =true) Sets the value of the TuningAccuracy attribute.
float	getTuningAccuracy() const Returns the value of the TuningAccuracy attribute.
void	resetTuningAccuracy() Resets the TuningAccuracy attribute to an unset state.
bool	hasTuningAccuracy() const Checks whether the TuningAccuracy attribute is present.
void	setTuningAccuracyUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the TuningAccuracyUnit attribute.
UnitsLength_TypePtr	getTuningAccuracyUnit() const Returns the value of the TuningAccuracyUnit attribute.
void	resetTuningAccuracyUnit() Resets the TuningAccuracyUnit attribute to an unset state.
bool	hasTuningAccuracyUnit() const Checks whether the optional TuningAccuracyUnit attribute is present.
void	setTuningResolution(const float & value, bool validate =true) Sets the value of the TuningResolution attribute.
float	getTuningResolution() const Returns the value of the TuningResolution attribute.
void	resetTuningResolution() Resets the TuningResolution attribute to an unset state.
bool	hasTuningResolution() const Checks whether the TuningResolution attribute is present.
void	setTuningResolutionUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the TuningResolutionUnit attribute.
UnitsLength_TypePtr	getTuningResolutionUnit() const Returns the value of the TuningResolutionUnit attribute.
void	resetTuningResolutionUnit() Resets the TuningResolutionUnit attribute to an unset state.
bool	hasTuningResolutionUnit() const Checks whether the optional TuningResolutionUnit attribute is present.
void	setTuningRate(const float & value, bool validate =true) Sets the value of the TuningRate attribute.
float	getTuningRate() const Returns the value of the TuningRate attribute.
void	resetTuningRate() Resets the TuningRate attribute to an unset state.
bool	hasTuningRate() const Checks whether the TuningRate attribute is present.
void	setTuningRateUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the TuningRateUnit attribute.
UnitsTime_TypePtr	getTuningRateUnit() const Returns the value of the TuningRateUnit attribute.
void	resetTuningRateUnit() Resets the TuningRateUnit attribute to an unset state.
bool	hasTuningRateUnit() const Checks whether the optional TuningRateUnit attribute is present.
void	setAngleOfIncidence(const float & value, bool validate =true) Sets the value of the AngleOfIncidence attribute.
float	getAngleOfIncidence() const Returns the value of the AngleOfIncidence attribute.
void	resetAngleOfIncidence() Resets the AngleOfIncidence attribute to an unset state.
bool	hasAngleOfIncidence() const Checks whether the AngleOfIncidence attribute is present.
void	setAngleOfIncidenceUnit(const Inscoper::NBO::UnitsAngle_TypePtr & value, bool validate =true) Sets the value of the AngleOfIncidenceUnit attribute.
UnitsAngle_TypePtr	getAngleOfIncidenceUnit() const Returns the value of the AngleOfIncidenceUnit attribute.
void	resetAngleOfIncidenceUnit() Resets the AngleOfIncidenceUnit attribute to an unset state.
bool	hasAngleOfIncidenceUnit() const Checks whether the optional AngleOfIncidenceUnit attribute is present.
void	setAngularAperture(const float & value, bool validate =true) Sets the value of the AngularAperture attribute.
float	getAngularAperture() const Returns the value of the AngularAperture attribute.
void	resetAngularAperture() Resets the AngularAperture attribute to an unset state.
bool	hasAngularAperture() const Checks whether the AngularAperture attribute is present.
void	setAngularApertureUnit(const Inscoper::NBO::UnitsAngle_TypePtr & value, bool validate =true) Sets the value of the AngularApertureUnit attribute.
UnitsAngle_TypePtr	getAngularApertureUnit() const Returns the value of the AngularApertureUnit attribute.
void	resetAngularApertureUnit() Resets the AngularApertureUnit attribute to an unset state.
bool	hasAngularApertureUnit() const Checks whether the optional AngularApertureUnit attribute is present.
void	setOperatingTemperature(const float & value, bool validate =true) Sets the value of the OperatingTemperature attribute.
float	getOperatingTemperature() const Returns the value of the OperatingTemperature attribute.
void	resetOperatingTemperature() Resets the OperatingTemperature attribute to an unset state.
bool	hasOperatingTemperature() const Checks whether the OperatingTemperature attribute is present.
void	setOperatingTemperatureUnit(const Inscoper::NBO::UnitsTemperature_TypePtr & value, bool validate =true) Sets the value of the OperatingTemperatureUnit attribute.
UnitsTemperature_TypePtr	getOperatingTemperatureUnit() const Returns the value of the OperatingTemperatureUnit attribute.
void	resetOperatingTemperatureUnit() Resets the OperatingTemperatureUnit attribute to an unset state.
bool	hasOperatingTemperatureUnit() const Checks whether the optional OperatingTemperatureUnit attribute is present.
void	setOperatingHumidity(const Inscoper::NBO::PercentFraction_TypePtr & value, bool validate =true) Sets the value of the OperatingHumidity attribute.
PercentFraction_TypePtr	getOperatingHumidity() const Returns the value of the OperatingHumidity attribute.
void	resetOperatingHumidity() Resets the OperatingHumidity attribute to an unset state.
bool	hasOperatingHumidity() const Checks whether the optional OperatingHumidity attribute is present.
void	setWarmUpTime(const float & value, bool validate =true) Sets the value of the WarmUpTime attribute.
float	getWarmUpTime() const Returns the value of the WarmUpTime attribute.
void	resetWarmUpTime() Resets the WarmUpTime attribute to an unset state.
bool	hasWarmUpTime() const Checks whether the WarmUpTime attribute is present.
void	setWarmUpTimeUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the WarmUpTimeUnit attribute.
UnitsTime_TypePtr	getWarmUpTimeUnit() const Returns the value of the WarmUpTimeUnit attribute.
void	resetWarmUpTimeUnit() Resets the WarmUpTimeUnit attribute to an unset state.
bool	hasWarmUpTimeUnit() const Checks whether the optional WarmUpTimeUnit 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.
std::shared_ptr< ElectroOpticalDevice_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a ElectroOpticalDevice_Type.
const std::set< std::string > &	getCoatingAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

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::ElectroOpticalDevice_Type;

Represents the XML complex type ElectroOpticalDevice.

This is is a device which can be used for controlling the power (→ intensity modulators), phase (→ phase modulators) or polarization of light with an electrical control signal. It typically contains one or two Pockels cells, and possibly additional optical elements such as polarizers.

Public Functions Documentation¶

function ElectroOpticalDevice_Type¶

function ~ElectroOpticalDevice_Type¶

function getTypeName¶

virtual std::string getTypeName() const override

Returns the class type name.

Return: The class type name

Reimplemented by: Inscoper::NBO::DeformableMirror::getTypeName, Inscoper::NBO::ElectroOpticalModulator::getTypeName, Inscoper::NBO::LiquidCrystalTuneableFilter::getTypeName, Inscoper::NBO::SpatialLightModulator::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 setID¶

void setID(
    const Inscoper::NBO::ElectroOpticalDeviceID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

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

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setName¶

void setName(
    const Inscoper::NBO::Denomination_TypePtr & value,
    bool validate =true
)

Sets the value of the Name attribute.

Parameters:

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

A User-defined Name for this component.

function getName¶

function resetName¶

function hasName¶

function setModulationMode¶

void setModulationMode(
    const Inscoper::NBO::ModulationModeList_TypePtr & value,
    bool validate =true
)

Sets the value of the ModulationMode attribute.

Parameters:

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

This field records the describes the type of modulation this devices produces on a beam of light.

function getModulationMode¶

ModulationModeList_TypePtr getModulationMode() const

Returns the value of the ModulationMode attribute.

Return: The value of the attribute

This field records the describes the type of modulation this devices produces on a beam of light.

function resetModulationMode¶

function hasModulationMode¶

bool hasModulationMode() const

Checks whether the optional ModulationMode attribute is present.

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

This field records the describes the type of modulation this devices produces on a beam of light.

function setContrastRatio¶

void setContrastRatio(
    const Inscoper::NBO::PercentFraction_TypePtr & value,
    bool validate =true
)

Sets the value of the ContrastRatio attribute.

Parameters:

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

This field records the reports on the ratio of maximum versus minimum transmittance.

function getContrastRatio¶

PercentFraction_TypePtr getContrastRatio() const

Returns the value of the ContrastRatio attribute.

Return: The value of the attribute

This field records the reports on the ratio of maximum versus minimum transmittance.

function resetContrastRatio¶

function hasContrastRatio¶

bool hasContrastRatio() const

Checks whether the optional ContrastRatio attribute is present.

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

This field records the reports on the ratio of maximum versus minimum transmittance.

function setCoating¶

void setCoating(
    const std::string & value,
    bool validate =true
)

Sets the value of the Coating attribute.

Parameters:

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

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

function getCoating¶

std::string getCoating() const

Returns the value of the Coating attribute.

Return: The value of the attribute

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

function resetCoating¶

void resetCoating()

Resets the Coating attribute to an unset state.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

function hasCoating¶

bool hasCoating() const

Checks whether the Coating attribute is present.

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

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

function setAttenuationMethod¶

void setAttenuationMethod(
    const Inscoper::NBO::AttenuationMethodType_TypePtr & value,
    bool validate =true
)

Sets the value of the AttenuationMethod attribute.

Parameters:

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

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function getAttenuationMethod¶

AttenuationMethodType_TypePtr getAttenuationMethod() const

Returns the value of the AttenuationMethod attribute.

Return: The value of the attribute

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function resetAttenuationMethod¶

function hasAttenuationMethod¶

bool hasAttenuationMethod() const

Checks whether the optional AttenuationMethod attribute is present.

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

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function setAttenuationCoefficient¶

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

Sets the value of the AttenuationCoefficient attribute.

Parameters:

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

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function getAttenuationCoefficient¶

float getAttenuationCoefficient() const

Returns the value of the AttenuationCoefficient attribute.

Return: The value of the attribute

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function resetAttenuationCoefficient¶

void resetAttenuationCoefficient()

Resets the AttenuationCoefficient attribute to an unset state.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function hasAttenuationCoefficient¶

bool hasAttenuationCoefficient() const

Checks whether the AttenuationCoefficient attribute is present.

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

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function setTuningAccuracy¶

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

Sets the value of the TuningAccuracy attribute.

Parameters:

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

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

function getTuningAccuracy¶

float getTuningAccuracy() const

Returns the value of the TuningAccuracy attribute.

Return: The value of the attribute

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

function resetTuningAccuracy¶

void resetTuningAccuracy()

Resets the TuningAccuracy attribute to an unset state.

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

function hasTuningAccuracy¶

bool hasTuningAccuracy() const

Checks whether the TuningAccuracy attribute is present.

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

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

function setTuningAccuracyUnit¶

void setTuningAccuracyUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the TuningAccuracyUnit 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 getTuningAccuracyUnit¶

function resetTuningAccuracyUnit¶

function hasTuningAccuracyUnit¶

bool hasTuningAccuracyUnit() const

Checks whether the optional TuningAccuracyUnit attribute is present.

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

No description available in the XSD standard.

function setTuningResolution¶

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

Sets the value of the TuningResolution attribute.

Parameters:

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

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

function getTuningResolution¶

float getTuningResolution() const

Returns the value of the TuningResolution attribute.

Return: The value of the attribute

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

function resetTuningResolution¶

void resetTuningResolution()

Resets the TuningResolution attribute to an unset state.

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

function hasTuningResolution¶

bool hasTuningResolution() const

Checks whether the TuningResolution attribute is present.

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

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

function setTuningResolutionUnit¶

void setTuningResolutionUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the TuningResolutionUnit 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 getTuningResolutionUnit¶

function resetTuningResolutionUnit¶

function hasTuningResolutionUnit¶

bool hasTuningResolutionUnit() const

Checks whether the optional TuningResolutionUnit attribute is present.

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

No description available in the XSD standard.

function setTuningRate¶

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

Sets the value of the TuningRate attribute.

Parameters:

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

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

function getTuningRate¶

float getTuningRate() const

Returns the value of the TuningRate attribute.

Return: The value of the attribute

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

function resetTuningRate¶

void resetTuningRate()

Resets the TuningRate attribute to an unset state.

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

function hasTuningRate¶

bool hasTuningRate() const

Checks whether the TuningRate attribute is present.

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

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

function setTuningRateUnit¶

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

Sets the value of the TuningRateUnit 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 getTuningRateUnit¶

function resetTuningRateUnit¶

function hasTuningRateUnit¶

bool hasTuningRateUnit() const

Checks whether the optional TuningRateUnit attribute is present.

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

No description available in the XSD standard.

function setAngleOfIncidence¶

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

Sets the value of the AngleOfIncidence attribute.

Parameters:

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

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function getAngleOfIncidence¶

float getAngleOfIncidence() const

Returns the value of the AngleOfIncidence attribute.

Return: The value of the attribute

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function resetAngleOfIncidence¶

void resetAngleOfIncidence()

Resets the AngleOfIncidence attribute to an unset state.

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function hasAngleOfIncidence¶

bool hasAngleOfIncidence() const

Checks whether the AngleOfIncidence attribute is present.

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

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function setAngleOfIncidenceUnit¶

void setAngleOfIncidenceUnit(
    const Inscoper::NBO::UnitsAngle_TypePtr & value,
    bool validate =true
)

Sets the value of the AngleOfIncidenceUnit 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 getAngleOfIncidenceUnit¶

function resetAngleOfIncidenceUnit¶

function hasAngleOfIncidenceUnit¶

bool hasAngleOfIncidenceUnit() const

Checks whether the optional AngleOfIncidenceUnit attribute is present.

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

No description available in the XSD standard.

function setAngularAperture¶

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

Sets the value of the AngularAperture attribute.

Parameters:

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

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

function getAngularAperture¶

float getAngularAperture() const

Returns the value of the AngularAperture attribute.

Return: The value of the attribute

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

function resetAngularAperture¶

void resetAngularAperture()

Resets the AngularAperture attribute to an unset state.

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

function hasAngularAperture¶

bool hasAngularAperture() const

Checks whether the AngularAperture attribute is present.

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

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

function setAngularApertureUnit¶

void setAngularApertureUnit(
    const Inscoper::NBO::UnitsAngle_TypePtr & value,
    bool validate =true
)

Sets the value of the AngularApertureUnit 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 getAngularApertureUnit¶

function resetAngularApertureUnit¶

function hasAngularApertureUnit¶

bool hasAngularApertureUnit() const

Checks whether the optional AngularApertureUnit attribute is present.

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

No description available in the XSD standard.

function setOperatingTemperature¶

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

Sets the value of the OperatingTemperature attribute.

Parameters:

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

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

function getOperatingTemperature¶

float getOperatingTemperature() const

Returns the value of the OperatingTemperature attribute.

Return: The value of the attribute

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

function resetOperatingTemperature¶

void resetOperatingTemperature()

Resets the OperatingTemperature attribute to an unset state.

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

function hasOperatingTemperature¶

bool hasOperatingTemperature() const

Checks whether the OperatingTemperature attribute is present.

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

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

function setOperatingTemperatureUnit¶

void setOperatingTemperatureUnit(
    const Inscoper::NBO::UnitsTemperature_TypePtr & value,
    bool validate =true
)

Sets the value of the OperatingTemperatureUnit 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 getOperatingTemperatureUnit¶

UnitsTemperature_TypePtr getOperatingTemperatureUnit() const

Returns the value of the OperatingTemperatureUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetOperatingTemperatureUnit¶

function hasOperatingTemperatureUnit¶

bool hasOperatingTemperatureUnit() const

Checks whether the optional OperatingTemperatureUnit attribute is present.

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

No description available in the XSD standard.

function setOperatingHumidity¶

void setOperatingHumidity(
    const Inscoper::NBO::PercentFraction_TypePtr & value,
    bool validate =true
)

Sets the value of the OperatingHumidity attribute.

Parameters:

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

This field records the ambient humidity at which this device is designed to operate, according to the manufactuer.

function getOperatingHumidity¶

PercentFraction_TypePtr getOperatingHumidity() const

Returns the value of the OperatingHumidity attribute.

Return: The value of the attribute

This field records the ambient humidity at which this device is designed to operate, according to the manufactuer.

function resetOperatingHumidity¶

void resetOperatingHumidity()

Resets the OperatingHumidity attribute to an unset state.

This field records the ambient humidity at which this device is designed to operate, according to the manufactuer.

function hasOperatingHumidity¶

bool hasOperatingHumidity() const

Checks whether the optional OperatingHumidity attribute is present.

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

This field records the ambient humidity at which this device is designed to operate, according to the manufactuer.

function setWarmUpTime¶

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

Sets the value of the WarmUpTime attribute.

Parameters:

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

This field records the time it takes for this device to reach operating conditions according to the Manufacturer.

function getWarmUpTime¶

float getWarmUpTime() const

Returns the value of the WarmUpTime attribute.

Return: The value of the attribute

This field records the time it takes for this device to reach operating conditions according to the Manufacturer.

function resetWarmUpTime¶

function hasWarmUpTime¶

bool hasWarmUpTime() const

Checks whether the WarmUpTime attribute is present.

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

This field records the time it takes for this device to reach operating conditions according to the Manufacturer.

function setWarmUpTimeUnit¶

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

Sets the value of the WarmUpTimeUnit 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 getWarmUpTimeUnit¶

function resetWarmUpTimeUnit¶

function hasWarmUpTimeUnit¶

bool hasWarmUpTimeUnit() const

Checks whether the optional WarmUpTimeUnit attribute is present.

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

No description available in the XSD standard.

function setAnnotationRef¶

void setAnnotationRef(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

Sets the value of the AnnotationRef 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 getAnnotationRef¶

function resetAnnotationRef¶

function hasAnnotationRef¶

bool hasAnnotationRef() const

Checks whether the optional AnnotationRef element is present.

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

No description available in the XSD standard.

function fromBase¶

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

Cast a NBOBaseClass to a ElectroOpticalDevice_Type.

Parameters:

base The base class to cast

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

function getCoatingAllowedValues¶

static const std::set< std::string > & getCoatingAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

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