Inscoper::NBO::Prism::InlineWavelengthRange¶

Represents the XML element WavelengthRange. More...

#include <Prism.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	InlineWavelengthRange()
	~InlineWavelengthRange()
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	setPeakWavelength(const float & value, bool validate =true) Sets the value of the PeakWavelength attribute.
float	getPeakWavelength() const Returns the value of the PeakWavelength attribute.
void	resetPeakWavelength() Resets the PeakWavelength attribute to an unset state.
bool	hasPeakWavelength() const Checks whether the PeakWavelength attribute is present.
void	setPeakWavelengthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the PeakWavelengthUnit attribute.
UnitsLength_TypePtr	getPeakWavelengthUnit() const Returns the value of the PeakWavelengthUnit attribute.
void	resetPeakWavelengthUnit() Resets the PeakWavelengthUnit attribute to an unset state.
bool	hasPeakWavelengthUnit() const Checks whether the optional PeakWavelengthUnit attribute is present.
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	setCutOnUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the CutOnUnit attribute.
UnitsLength_TypePtr	getCutOnUnit() const Returns the value of the CutOnUnit attribute.
void	resetCutOnUnit() Resets the CutOnUnit attribute to an unset state.
bool	hasCutOnUnit() const Checks whether the optional CutOnUnit 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	setCutOffUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the CutOffUnit attribute.
UnitsLength_TypePtr	getCutOffUnit() const Returns the value of the CutOffUnit attribute.
void	resetCutOffUnit() Resets the CutOffUnit attribute to an unset state.
bool	hasCutOffUnit() const Checks whether the optional CutOffUnit attribute is present.
void	setWavelengthProfile(const std::string & value, bool validate =true) Sets the value of the WavelengthProfile attribute.
std::string	getWavelengthProfile() const Returns the value of the WavelengthProfile attribute.
void	resetWavelengthProfile() Resets the WavelengthProfile attribute to an unset state.
bool	hasWavelengthProfile() const Checks whether the WavelengthProfile attribute is present.
std::shared_ptr< InlineWavelengthRange >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a InlineWavelengthRange.
const std::set< std::string > &	getWavelengthProfileAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Prism::InlineWavelengthRange;

Represents the XML element WavelengthRange.

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

Public Functions Documentation¶

function InlineWavelengthRange¶

function ~InlineWavelengthRange¶

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

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

Sets the value of the PeakWavelength attribute.

Parameters:

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

This field records the nominal Wavelength associated with the peak response rate of this device.

function getPeakWavelength¶

float getPeakWavelength() const

Returns the value of the PeakWavelength attribute.

Return: The value of the attribute

This field records the nominal Wavelength associated with the peak response rate of this device.

function resetPeakWavelength¶

function hasPeakWavelength¶

bool hasPeakWavelength() const

Checks whether the PeakWavelength attribute is present.

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

This field records the nominal Wavelength associated with the peak response rate of this device.

function setPeakWavelengthUnit¶

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

Sets the value of the PeakWavelengthUnit 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 getPeakWavelengthUnit¶

function resetPeakWavelengthUnit¶

function hasPeakWavelengthUnit¶

bool hasPeakWavelengthUnit() const

Checks whether the optional PeakWavelengthUnit attribute is present.

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

No description available in the XSD standard.

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%.

function getCutOn¶

function resetCutOn¶

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%.

function setCutOnUnit¶

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

Sets the value of the CutOnUnit 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 getCutOnUnit¶

function resetCutOnUnit¶

function hasCutOnUnit¶

bool hasCutOnUnit() const

Checks whether the optional CutOnUnit attribute is present.

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

No description available in the XSD standard.

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 above which the response rate is below 50%.

function getCutOff¶

function resetCutOff¶

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 above which the response rate is below 50%.

function setCutOffUnit¶

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

Sets the value of the CutOffUnit 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 getCutOffUnit¶

function resetCutOffUnit¶

function hasCutOffUnit¶

bool hasCutOffUnit() const

Checks whether the optional CutOffUnit attribute is present.

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

No description available in the XSD standard.

function setWavelengthProfile¶

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

Sets the value of the WavelengthProfile attribute.

Parameters:

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

The location of a file containing the Wavelength profile of this hardware component.

function getWavelengthProfile¶

std::string getWavelengthProfile() const

Returns the value of the WavelengthProfile attribute.

Return: The value of the attribute

The location of a file containing the Wavelength profile of this hardware component.

function resetWavelengthProfile¶

function hasWavelengthProfile¶

bool hasWavelengthProfile() const

Checks whether the WavelengthProfile attribute is present.

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

The location of a file containing the Wavelength profile of this hardware component.

function fromBase¶

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

Cast a NBOBaseClass to a InlineWavelengthRange.

Parameters:

base The base class to cast

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

function getWavelengthProfileAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

The location of a file containing the Wavelength profile of this hardware component.

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