Inscoper::NBO::WavelengthRangeSettingsType_Type¶

Represents the XML complex type WavelengthRangeSettingsType. More...

#include <WavelengthRangeSettingsType_Type.h>

Inherits from NBOBaseClass

Inherited by Inscoper::NBO::ReflectionWavelengthRangeSettings, Inscoper::NBO::TransmissionWavelengthRangeSettings

Public Functions¶

	Name
	WavelengthRangeSettingsType_Type()
	~WavelengthRangeSettingsType_Type()
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	setCutOn(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the CutOn attribute.
PositiveFloat_TypePtr	getCutOn() const Returns the value of the CutOn attribute.
void	resetCutOn() Resets the CutOn attribute to an unset state.
bool	hasCutOn() const Checks whether the optional CutOn attribute is present.
void	setCutOff(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the CutOff attribute.
PositiveFloat_TypePtr	getCutOff() const Returns the value of the CutOff attribute.
void	resetCutOff() Resets the CutOff attribute to an unset state.
bool	hasCutOff() const Checks whether the optional CutOff attribute is present.
void	setWavelengthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the WavelengthUnit attribute.
UnitsLength_TypePtr	getWavelengthUnit() const Returns the value of the WavelengthUnit attribute.
void	resetWavelengthUnit() Resets the WavelengthUnit attribute to an unset state.
bool	hasWavelengthUnit() const Checks whether the optional WavelengthUnit attribute is present.
std::shared_ptr< WavelengthRangeSettingsType_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a WavelengthRangeSettingsType_Type.

Detailed Description¶

class Inscoper::NBO::WavelengthRangeSettingsType_Type;

Represents the XML complex type WavelengthRangeSettingsType.

CutOn is the Wavelength below which the response rate is below 50%. In case a CutOn Wavelength is not available, such as in the case of a ShortPass or Notch configuration, please enter 000.

Public Functions Documentation¶

function WavelengthRangeSettingsType_Type¶

function ~WavelengthRangeSettingsType_Type¶

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

void setCutOn(
    const Inscoper::NBO::PositiveFloat_TypePtr & value,
    bool validate =true
)

Sets the value of the CutOn attribute.

Parameters:

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

CutOn is the Wavelength below which the response rate is below 50%. In case a CutOn Wavelength is not available, such as in the case of a ShortPass or Notch configuration, please enter 000.

function getCutOn¶

PositiveFloat_TypePtr getCutOn() const

Returns the value of the CutOn attribute.

Return: The value of the attribute

CutOn is the Wavelength below which the response rate is below 50%. In case a CutOn Wavelength is not available, such as in the case of a ShortPass or Notch configuration, please enter 000.

function resetCutOn¶

void resetCutOn()

Resets the CutOn attribute to an unset state.

CutOn is the Wavelength below which the response rate is below 50%. In case a CutOn Wavelength is not available, such as in the case of a ShortPass or Notch configuration, please enter 000.

function hasCutOn¶

bool hasCutOn() const

Checks whether the optional CutOn attribute is present.

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

CutOn is the Wavelength below which the response rate is below 50%. In case a CutOn Wavelength is not available, such as in the case of a ShortPass or Notch configuration, please enter 000.

function setCutOff¶

void setCutOff(
    const Inscoper::NBO::PositiveFloat_TypePtr & value,
    bool validate =true
)

Sets the value of the CutOff attribute.

Parameters:

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

CutOff is the Wavelength below which the response rate is below 50%. In case a CutOff Wavelength is not available, such as in the case of a LongPass configuration, please enter 000.

function getCutOff¶

PositiveFloat_TypePtr getCutOff() const

Returns the value of the CutOff attribute.

Return: The value of the attribute

CutOff is the Wavelength below which the response rate is below 50%. In case a CutOff Wavelength is not available, such as in the case of a LongPass configuration, please enter 000.

function resetCutOff¶

void resetCutOff()

Resets the CutOff attribute to an unset state.

CutOff is the Wavelength below which the response rate is below 50%. In case a CutOff Wavelength is not available, such as in the case of a LongPass configuration, please enter 000.

function hasCutOff¶

bool hasCutOff() const

Checks whether the optional CutOff attribute is present.

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

CutOff is the Wavelength below which the response rate is below 50%. In case a CutOff Wavelength is not available, such as in the case of a LongPass configuration, please enter 000.

function setWavelengthUnit¶

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

Sets the value of the WavelengthUnit 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 getWavelengthUnit¶

function resetWavelengthUnit¶

function hasWavelengthUnit¶

bool hasWavelengthUnit() const

Checks whether the optional WavelengthUnit attribute 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< WavelengthRangeSettingsType_Type > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a WavelengthRangeSettingsType_Type.

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