Inscoper::NBO::IlluminationWavelengthRange¶

Represents the XML element IlluminationWavelengthRange. More...

#include <IlluminationWavelengthRange.h>

Inherits from Inscoper::NBO::IlluminationWavelengthRangeType_Type, Inscoper::NBO::WavelengthRangeType_Type, NBOBaseClass

Public Functions¶

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

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::IlluminationWavelengthRangeType_Type

	Name
	IlluminationWavelengthRangeType_Type()
	~IlluminationWavelengthRangeType_Type()
void	setIlluminationPower(const float & value, bool validate =true) Sets the value of the IlluminationPower attribute.
float	getIlluminationPower() const Returns the value of the IlluminationPower attribute.
void	resetIlluminationPower() Resets the IlluminationPower attribute to an unset state.
bool	hasIlluminationPower() const Checks whether the IlluminationPower attribute is present.
void	setIlluminationPowerUnit(const Inscoper::NBO::UnitsPower_TypePtr & value, bool validate =true) Sets the value of the IlluminationPowerUnit attribute.
UnitsPower_TypePtr	getIlluminationPowerUnit() const Returns the value of the IlluminationPowerUnit attribute.
void	resetIlluminationPowerUnit() Resets the IlluminationPowerUnit attribute to an unset state.
bool	hasIlluminationPowerUnit() const Checks whether the optional IlluminationPowerUnit attribute is present.

Public Functions inherited from Inscoper::NBO::WavelengthRangeType_Type

	Name
	WavelengthRangeType_Type()
	~WavelengthRangeType_Type()
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	setWavelengthProfileFile_List(const std::vector< Inscoper::NBO::WavelengthProfileFilePtr > & value, bool validate =true) Sets the list of WavelengthProfileFile elements.
std::vector< Inscoper::NBO::WavelengthProfileFilePtr >	getWavelengthProfileFile_List() const Returns the list of WavelengthProfileFile elements.
void	addToWavelengthProfileFile_List(const Inscoper::NBO::WavelengthProfileFilePtr & value, bool validate =true) Adds a new WavelengthProfileFile element to this object.
void	clearWavelengthProfileFile_List() Clear the list of WavelengthProfileFile.

Detailed Description¶

class Inscoper::NBO::IlluminationWavelengthRange;

Represents the XML element IlluminationWavelengthRange.

This element records a range of Wavelengths at which this Light Source emits, according to the Manufacturer. Multiple of this element may be used.

Public Functions Documentation¶

function IlluminationWavelengthRange¶

function ~IlluminationWavelengthRange¶

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< IlluminationWavelengthRange > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a IlluminationWavelengthRange.

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