Inscoper::NBO::TransmittanceRange¶

Represents the XML element TransmittanceRange. More...

#include <TransmittanceRange.h>

Inherits from Inscoper::NBO::TransmittanceRangeType_Type, NBOBaseClass

Public Functions¶

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

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::TransmittanceRangeType_Type

	Name
	TransmittanceRangeType_Type()
	~TransmittanceRangeType_Type()
void	setWavelength(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the Wavelength attribute.
PositiveFloat_TypePtr	getWavelength() const Returns the value of the Wavelength attribute.
void	resetWavelength() Resets the Wavelength attribute to an unset state.
bool	hasWavelength() const Checks whether the optional Wavelength attribute is present.
void	setFWHMBandwidth(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the FWHMBandwidth attribute.
PositiveFloat_TypePtr	getFWHMBandwidth() const Returns the value of the FWHMBandwidth attribute.
void	resetFWHMBandwidth() Resets the FWHMBandwidth attribute to an unset state.
bool	hasFWHMBandwidth() const Checks whether the optional FWHMBandwidth 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.
void	setTransmittance(const Inscoper::NBO::PercentFraction_TypePtr & value, bool validate =true) Sets the value of the Transmittance attribute.
PercentFraction_TypePtr	getTransmittance() const Returns the value of the Transmittance attribute.
void	resetTransmittance() Resets the Transmittance attribute to an unset state.
bool	hasTransmittance() const Checks whether the optional Transmittance attribute is present.

Detailed Description¶

class Inscoper::NBO::TransmittanceRange;

Represents the XML element TransmittanceRange.

This element records the Range (also known as Band) of Wavelengths that are transmitted by this optical component. It also records the maximum amount of light transmitted. Multiple of these elements can be used.

Public Functions Documentation¶

function TransmittanceRange¶

function ~TransmittanceRange¶

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

Cast a NBOBaseClass to a TransmittanceRange.

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