Inscoper::NBO::AcoustoOpticalModulatorSettings¶

Represents the XML element AcoustoOpticalModulatorSettings. More...

#include <AcoustoOpticalModulatorSettings.h>

Inherits from Inscoper::NBO::AcoustoOpticalDeviceSettings_Type, Inscoper::NBO::Settings_Type, Inscoper::NBO::Reference_Type, NBOBaseClass

Public Functions¶

	Name
	AcoustoOpticalModulatorSettings()
	~AcoustoOpticalModulatorSettings()
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.
std::shared_ptr< AcoustoOpticalModulatorSettings >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a AcoustoOpticalModulatorSettings.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::AcoustoOpticalDeviceSettings_Type

	Name
	AcoustoOpticalDeviceSettings_Type()
	~AcoustoOpticalDeviceSettings_Type()
void	setID(const Inscoper::NBO::AcoustoOpticalDeviceID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
AcoustoOpticalDeviceID_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	setDiffractionEfficiency(const Inscoper::NBO::PercentFraction_TypePtr & value, bool validate =true) Sets the value of the DiffractionEfficiency attribute.
PercentFraction_TypePtr	getDiffractionEfficiency() const Returns the value of the DiffractionEfficiency attribute.
void	resetDiffractionEfficiency() Resets the DiffractionEfficiency attribute to an unset state.
bool	hasDiffractionEfficiency() const Checks whether the optional DiffractionEfficiency attribute is present.
void	setAcousticVelocity(const float & value, bool validate =true) Sets the value of the AcousticVelocity attribute.
float	getAcousticVelocity() const Returns the value of the AcousticVelocity attribute.
void	resetAcousticVelocity() Resets the AcousticVelocity attribute to an unset state.
bool	hasAcousticVelocity() const Checks whether the AcousticVelocity attribute is present.
void	setAcousticVelocityUnit(const Inscoper::NBO::UnitsVelocity_TypePtr & value, bool validate =true) Sets the value of the AcousticVelocityUnit attribute.
UnitsVelocity_TypePtr	getAcousticVelocityUnit() const Returns the value of the AcousticVelocityUnit attribute.
void	resetAcousticVelocityUnit() Resets the AcousticVelocityUnit attribute to an unset state.
bool	hasAcousticVelocityUnit() const Checks whether the optional AcousticVelocityUnit attribute is present.
void	setAcousticFrequency(const float & value, bool validate =true) Sets the value of the AcousticFrequency attribute.
float	getAcousticFrequency() const Returns the value of the AcousticFrequency attribute.
void	resetAcousticFrequency() Resets the AcousticFrequency attribute to an unset state.
bool	hasAcousticFrequency() const Checks whether the AcousticFrequency attribute is present.
void	setAcousticFrequencyUnit(const Inscoper::NBO::UnitsFrequency_TypePtr & value, bool validate =true) Sets the value of the AcousticFrequencyUnit attribute.
UnitsFrequency_TypePtr	getAcousticFrequencyUnit() const Returns the value of the AcousticFrequencyUnit attribute.
void	resetAcousticFrequencyUnit() Resets the AcousticFrequencyUnit attribute to an unset state.
bool	hasAcousticFrequencyUnit() const Checks whether the optional AcousticFrequencyUnit attribute is present.
void	setTransmittanceProfileFile_List(const std::vector< Inscoper::NBO::TransmittanceProfileFilePtr > & value, bool validate =true) Sets the list of TransmittanceProfileFile elements.
std::vector< Inscoper::NBO::TransmittanceProfileFilePtr >	getTransmittanceProfileFile_List() const Returns the list of TransmittanceProfileFile elements.
void	addToTransmittanceProfileFile_List(const Inscoper::NBO::TransmittanceProfileFilePtr & value, bool validate =true) Adds a new TransmittanceProfileFile element to this object.
void	clearTransmittanceProfileFile_List() Clear the list of TransmittanceProfileFile.
void	setReflectanceProfileFile_List(const std::vector< Inscoper::NBO::ReflectanceProfileFilePtr > & value, bool validate =true) Sets the list of ReflectanceProfileFile elements.
std::vector< Inscoper::NBO::ReflectanceProfileFilePtr >	getReflectanceProfileFile_List() const Returns the list of ReflectanceProfileFile elements.
void	addToReflectanceProfileFile_List(const Inscoper::NBO::ReflectanceProfileFilePtr & value, bool validate =true) Adds a new ReflectanceProfileFile element to this object.
void	clearReflectanceProfileFile_List() Clear the list of ReflectanceProfileFile.
void	setTransmissionWavelengthRangeSettings_List(const std::vector< Inscoper::NBO::TransmissionWavelengthRangeSettingsPtr > & value, bool validate =true) Sets the list of TransmissionWavelengthRangeSettings elements.
std::vector< Inscoper::NBO::TransmissionWavelengthRangeSettingsPtr >	getTransmissionWavelengthRangeSettings_List() const Returns the list of TransmissionWavelengthRangeSettings elements.
void	addToTransmissionWavelengthRangeSettings_List(const Inscoper::NBO::TransmissionWavelengthRangeSettingsPtr & value, bool validate =true) Adds a new TransmissionWavelengthRangeSettings element to this object.
void	clearTransmissionWavelengthRangeSettings_List() Clear the list of TransmissionWavelengthRangeSettings.
void	setReflectionWavelengthRangeSettings_List(const std::vector< Inscoper::NBO::ReflectionWavelengthRangeSettingsPtr > & value, bool validate =true) Sets the list of ReflectionWavelengthRangeSettings elements.
std::vector< Inscoper::NBO::ReflectionWavelengthRangeSettingsPtr >	getReflectionWavelengthRangeSettings_List() const Returns the list of ReflectionWavelengthRangeSettings elements.
void	addToReflectionWavelengthRangeSettings_List(const Inscoper::NBO::ReflectionWavelengthRangeSettingsPtr & value, bool validate =true) Adds a new ReflectionWavelengthRangeSettings element to this object.
void	clearReflectionWavelengthRangeSettings_List() Clear the list of ReflectionWavelengthRangeSettings.

Public Functions inherited from Inscoper::NBO::Settings_Type

	Name
	Settings_Type()
	~Settings_Type()
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	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.

Public Functions inherited from Inscoper::NBO::Reference_Type

	Name
	Reference_Type()
	~Reference_Type()

Detailed Description¶

class Inscoper::NBO::AcoustoOpticalModulatorSettings;

Represents the XML element AcoustoOpticalModulatorSettings.

This element holds the Setting applied to an Acousto Optical Modulator used during the Acquisition of this Channel as well as a reference (the ID attribute) to the Acousto Optical Modulator in question.

Public Functions Documentation¶

function AcoustoOpticalModulatorSettings¶

function ~AcoustoOpticalModulatorSettings¶

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 fromBase¶

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

Cast a NBOBaseClass to a AcoustoOpticalModulatorSettings.

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:36 +0200