Inscoper::NBO::TransmissionWavelengthRangeSettings¶

Represents the XML element TransmissionWavelengthRangeSettings. More...

#include <TransmissionWavelengthRangeSettings.h>

Inherits from Inscoper::NBO::WavelengthRangeSettingsType_Type, NBOBaseClass

Public Functions¶

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

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::WavelengthRangeSettingsType_Type

	Name
	WavelengthRangeSettingsType_Type()
	~WavelengthRangeSettingsType_Type()
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.

Detailed Description¶

class Inscoper::NBO::TransmissionWavelengthRangeSettings;

Represents the XML element TransmissionWavelengthRangeSettings.

This element records the range of Transmission Wavelengths that were set for this optical component during the Acquisition of this Image. It also records the maximum amount of light transmitted. Multiple of this elements can be used.

Public Functions Documentation¶

function TransmissionWavelengthRangeSettings¶

function ~TransmissionWavelengthRangeSettings¶

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

Cast a NBOBaseClass to a TransmissionWavelengthRangeSettings.

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