Inscoper::NBO::TransmittanceRangeType_Type¶

Represents the XML complex type TransmittanceRangeType. More...

#include <TransmittanceRangeType_Type.h>

Inherits from NBOBaseClass

Inherited by Inscoper::NBO::TransmittanceRange

Public Functions¶

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

Detailed Description¶

class Inscoper::NBO::TransmittanceRangeType_Type;

Represents the XML complex type TransmittanceRangeType.

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

Public Functions Documentation¶

function TransmittanceRangeType_Type¶

function ~TransmittanceRangeType_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 setWavelength¶

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

Sets the value of the Wavelength attribute.

Parameters:

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

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

function getWavelength¶

PositiveFloat_TypePtr getWavelength() const

Returns the value of the Wavelength attribute.

Return: The value of the attribute

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

function resetWavelength¶

void resetWavelength()

Resets the Wavelength attribute to an unset state.

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

function hasWavelength¶

bool hasWavelength() const

Checks whether the optional Wavelength attribute is present.

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

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

function setFWHMBandwidth¶

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

Sets the value of the FWHMBandwidth attribute.

Parameters:

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

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

function getFWHMBandwidth¶

PositiveFloat_TypePtr getFWHMBandwidth() const

Returns the value of the FWHMBandwidth attribute.

Return: The value of the attribute

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

function resetFWHMBandwidth¶

void resetFWHMBandwidth()

Resets the FWHMBandwidth attribute to an unset state.

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

function hasFWHMBandwidth¶

bool hasFWHMBandwidth() const

Checks whether the optional FWHMBandwidth attribute is present.

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

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass 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 setTransmittance¶

void setTransmittance(
    const Inscoper::NBO::PercentFraction_TypePtr & value,
    bool validate =true
)

Sets the value of the Transmittance attribute.

Parameters:

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

This field records the maximum amount of light this optical component is capable of transmitting in this Wavelength Range, at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function getTransmittance¶

PercentFraction_TypePtr getTransmittance() const

Returns the value of the Transmittance attribute.

Return: The value of the attribute

This field records the maximum amount of light this optical component is capable of transmitting in this Wavelength Range, at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function resetTransmittance¶

void resetTransmittance()

Resets the Transmittance attribute to an unset state.

This field records the maximum amount of light this optical component is capable of transmitting in this Wavelength Range, at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function hasTransmittance¶

bool hasTransmittance() const

Checks whether the optional Transmittance attribute is present.

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

This field records the maximum amount of light this optical component is capable of transmitting in this Wavelength Range, at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function fromBase¶

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

Cast a NBOBaseClass to a TransmittanceRangeType_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