Inscoper::NBO::DeformableMirror¶

Represents the XML element DeformableMirror. More...

#include <DeformableMirror.h>

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

Public Functions¶

	Name
	DeformableMirror()
	~DeformableMirror()
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::DeformableMirrorType_TypePtr & value, bool validate =true) Sets the value of the Type attribute.
DeformableMirrorType_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	setActuators(const int & value, bool validate =true) Sets the value of the Actuators attribute.
int	getActuators() const Returns the value of the Actuators attribute.
void	resetActuators() Resets the Actuators attribute to an unset state.
bool	hasActuators() const Checks whether the Actuators attribute is present.
void	setActuatorPitch(const float & value, bool validate =true) Sets the value of the ActuatorPitch attribute.
float	getActuatorPitch() const Returns the value of the ActuatorPitch attribute.
void	resetActuatorPitch() Resets the ActuatorPitch attribute to an unset state.
bool	hasActuatorPitch() const Checks whether the ActuatorPitch attribute is present.
void	setActuatorPitchUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ActuatorPitchUnit attribute.
UnitsLength_TypePtr	getActuatorPitchUnit() const Returns the value of the ActuatorPitchUnit attribute.
void	resetActuatorPitchUnit() Resets the ActuatorPitchUnit attribute to an unset state.
bool	hasActuatorPitchUnit() const Checks whether the optional ActuatorPitchUnit attribute is present.
void	setActuatorStroke(const float & value, bool validate =true) Sets the value of the ActuatorStroke attribute.
float	getActuatorStroke() const Returns the value of the ActuatorStroke attribute.
void	resetActuatorStroke() Resets the ActuatorStroke attribute to an unset state.
bool	hasActuatorStroke() const Checks whether the ActuatorStroke attribute is present.
void	setActuatorStrokeUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ActuatorStrokeUnit attribute.
UnitsLength_TypePtr	getActuatorStrokeUnit() const Returns the value of the ActuatorStrokeUnit attribute.
void	resetActuatorStrokeUnit() Resets the ActuatorStrokeUnit attribute to an unset state.
bool	hasActuatorStrokeUnit() const Checks whether the optional ActuatorStrokeUnit attribute is present.
void	setResponseTime(const float & value, bool validate =true) Sets the value of the ResponseTime attribute.
float	getResponseTime() const Returns the value of the ResponseTime attribute.
void	resetResponseTime() Resets the ResponseTime attribute to an unset state.
bool	hasResponseTime() const Checks whether the ResponseTime attribute is present.
void	setResponseTimeUnit(const std::string & value, bool validate =true) Sets the value of the ResponseTimeUnit attribute.
std::string	getResponseTimeUnit() const Returns the value of the ResponseTimeUnit attribute.
void	resetResponseTimeUnit() Resets the ResponseTimeUnit attribute to an unset state.
bool	hasResponseTimeUnit() const Checks whether the ResponseTimeUnit attribute is present.
std::shared_ptr< DeformableMirror >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a DeformableMirror.
const std::set< std::string > &	getResponseTimeUnitAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::ElectroOpticalDevice_Type

	Name
	ElectroOpticalDevice_Type()
	~ElectroOpticalDevice_Type()
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.
const std::set< std::string > &	getCoatingAllowedValues() 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::DeformableMirror;

Represents the XML element DeformableMirror.

A Deformable Mirror (DM) is a Mechano Electro-Optical Device that has a controllable spatially varying mirror surface to modulate the wavefront of a beam of light impinging on it. This type of device is typically used in adaptive optics.

Public Functions Documentation¶

function DeformableMirror¶

function ~DeformableMirror¶

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::DeformableMirrorType_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 records the type of this Deformable Mirror.

function getType¶

function resetType¶

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 records the type of this Deformable Mirror.

function setActuators¶

void setActuators(
    const int & value,
    bool validate =true
)

Sets the value of the Actuators attribute.

Parameters:

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

This field records the number of Actuators available for this device.

function getActuators¶

function resetActuators¶

function hasActuators¶

bool hasActuators() const

Checks whether the Actuators attribute is present.

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

This field records the number of Actuators available for this device.

function setActuatorPitch¶

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

Sets the value of the ActuatorPitch attribute.

Parameters:

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

This field records the distance between the center of each Actuator in this device.

function getActuatorPitch¶

float getActuatorPitch() const

Returns the value of the ActuatorPitch attribute.

Return: The value of the attribute

This field records the distance between the center of each Actuator in this device.

function resetActuatorPitch¶

function hasActuatorPitch¶

bool hasActuatorPitch() const

Checks whether the ActuatorPitch attribute is present.

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

This field records the distance between the center of each Actuator in this device.

function setActuatorPitchUnit¶

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

Sets the value of the ActuatorPitchUnit 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 getActuatorPitchUnit¶

function resetActuatorPitchUnit¶

function hasActuatorPitchUnit¶

bool hasActuatorPitchUnit() const

Checks whether the optional ActuatorPitchUnit attribute is present.

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

No description available in the XSD standard.

function setActuatorStroke¶

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

Sets the value of the ActuatorStroke attribute.

Parameters:

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

This field records the maximum possible Actuator displacement available for this device.

function getActuatorStroke¶

float getActuatorStroke() const

Returns the value of the ActuatorStroke attribute.

Return: The value of the attribute

This field records the maximum possible Actuator displacement available for this device.

function resetActuatorStroke¶

function hasActuatorStroke¶

bool hasActuatorStroke() const

Checks whether the ActuatorStroke attribute is present.

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

This field records the maximum possible Actuator displacement available for this device.

function setActuatorStrokeUnit¶

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

Sets the value of the ActuatorStrokeUnit 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 getActuatorStrokeUnit¶

function resetActuatorStrokeUnit¶

function hasActuatorStrokeUnit¶

bool hasActuatorStrokeUnit() const

Checks whether the optional ActuatorStrokeUnit attribute is present.

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

No description available in the XSD standard.

function setResponseTime¶

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

Sets the value of the ResponseTime attribute.

Parameters:

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

This field records the rate at which this Deformable Mirror can change patterns.

function getResponseTime¶

function resetResponseTime¶

function hasResponseTime¶

bool hasResponseTime() const

Checks whether the ResponseTime attribute is present.

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

This field records the rate at which this Deformable Mirror can change patterns.

function setResponseTimeUnit¶

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

Sets the value of the ResponseTimeUnit 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 getResponseTimeUnit¶

function resetResponseTimeUnit¶

function hasResponseTimeUnit¶

bool hasResponseTimeUnit() const

Checks whether the ResponseTimeUnit attribute is present.

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

No description available in the XSD standard.

function fromBase¶

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

Cast a NBOBaseClass to a DeformableMirror.

Parameters:

base The base class to cast

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

function getResponseTimeUnitAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

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