Inscoper::NBO::Filter_Type¶

Represents the XML complex type Filter. More...

#include <Filter_Type.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Inherited by Inscoper::NBO::EmissionFilter, Inscoper::NBO::ExcitationFilter, Inscoper::NBO::GenericFilter, Inscoper::NBO::NeutralDensityFilter

Public Functions¶

	Name
	Filter_Type()
	~Filter_Type()
virtual 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	setID(const Inscoper::NBO::FilterID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
FilterID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setName(const Inscoper::NBO::Denomination_TypePtr & value, bool validate =true) Sets the value of the Name attribute.
Denomination_TypePtr	getName() const Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
bool	hasName() const Checks whether the optional Name attribute is present.
void	setType(const Inscoper::NBO::FilterType_TypePtr & value, bool validate =true) Sets the value of the Type attribute.
FilterType_TypePtr	getType() const Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
bool	hasType() const Checks whether the optional Type attribute is present.
void	setCoatingMethod(const Inscoper::NBO::CoatingMethod_TypePtr & value, bool validate =true) Sets the value of the CoatingMethod attribute.
CoatingMethod_TypePtr	getCoatingMethod() const Returns the value of the CoatingMethod attribute.
void	resetCoatingMethod() Resets the CoatingMethod attribute to an unset state.
bool	hasCoatingMethod() const Checks whether the optional CoatingMethod attribute is present.
void	setLightPathLocation(const Inscoper::NBO::LightPathLocationOptions_TypePtr & value, bool validate =true) Sets the value of the LightPathLocation attribute.
LightPathLocationOptions_TypePtr	getLightPathLocation() const Returns the value of the LightPathLocation attribute.
void	resetLightPathLocation() Resets the LightPathLocation attribute to an unset state.
bool	hasLightPathLocation() const Checks whether the optional LightPathLocation attribute is present.
void	setFilterHolderPosition(const int & value, bool validate =true) Sets the value of the FilterHolderPosition attribute.
int	getFilterHolderPosition() const Returns the value of the FilterHolderPosition attribute.
void	resetFilterHolderPosition() Resets the FilterHolderPosition attribute to an unset state.
bool	hasFilterHolderPosition() const Checks whether the FilterHolderPosition attribute is present.
void	setTechnology(const Inscoper::NBO::FilterTechnologyType_TypePtr & value, bool validate =true) Sets the value of the Technology attribute.
FilterTechnologyType_TypePtr	getTechnology() const Returns the value of the Technology attribute.
void	resetTechnology() Resets the Technology attribute to an unset state.
bool	hasTechnology() const Checks whether the optional Technology attribute is present.
void	setAttenuationMethod(const Inscoper::NBO::AttenuationMethodType_TypePtr & value, bool validate =true) Sets the value of the AttenuationMethod attribute.
AttenuationMethodType_TypePtr	getAttenuationMethod() const Returns the value of the AttenuationMethod attribute.
void	resetAttenuationMethod() Resets the AttenuationMethod attribute to an unset state.
bool	hasAttenuationMethod() const Checks whether the optional AttenuationMethod attribute is present.
void	setAttenuationCoefficient(const float & value, bool validate =true) Sets the value of the AttenuationCoefficient attribute.
float	getAttenuationCoefficient() const Returns the value of the AttenuationCoefficient attribute.
void	resetAttenuationCoefficient() Resets the AttenuationCoefficient attribute to an unset state.
bool	hasAttenuationCoefficient() const Checks whether the AttenuationCoefficient attribute is present.
void	setDiameter(const float & value, bool validate =true) Sets the value of the Diameter attribute.
float	getDiameter() const Returns the value of the Diameter attribute.
void	resetDiameter() Resets the Diameter attribute to an unset state.
bool	hasDiameter() const Checks whether the Diameter attribute is present.
void	setDiameterUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the DiameterUnit attribute.
UnitsLength_TypePtr	getDiameterUnit() const Returns the value of the DiameterUnit attribute.
void	resetDiameterUnit() Resets the DiameterUnit attribute to an unset state.
bool	hasDiameterUnit() const Checks whether the optional DiameterUnit attribute is present.
void	setThickness(const float & value, bool validate =true) Sets the value of the Thickness attribute.
float	getThickness() const Returns the value of the Thickness attribute.
void	resetThickness() Resets the Thickness attribute to an unset state.
bool	hasThickness() const Checks whether the Thickness attribute is present.
void	setThicknessUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ThicknessUnit attribute.
UnitsLength_TypePtr	getThicknessUnit() const Returns the value of the ThicknessUnit attribute.
void	resetThicknessUnit() Resets the ThicknessUnit attribute to an unset state.
bool	hasThicknessUnit() const Checks whether the optional ThicknessUnit attribute is present.
void	setAngleOfIncidence(const float & value, bool validate =true) Sets the value of the AngleOfIncidence attribute.
float	getAngleOfIncidence() const Returns the value of the AngleOfIncidence attribute.
void	resetAngleOfIncidence() Resets the AngleOfIncidence attribute to an unset state.
bool	hasAngleOfIncidence() const Checks whether the AngleOfIncidence attribute is present.
void	setAngleOfIncidenceUnit(const Inscoper::NBO::UnitsAngle_TypePtr & value, bool validate =true) Sets the value of the AngleOfIncidenceUnit attribute.
UnitsAngle_TypePtr	getAngleOfIncidenceUnit() const Returns the value of the AngleOfIncidenceUnit attribute.
void	resetAngleOfIncidenceUnit() Resets the AngleOfIncidenceUnit attribute to an unset state.
bool	hasAngleOfIncidenceUnit() const Checks whether the optional AngleOfIncidenceUnit attribute is present.
void	setPolarization(const Inscoper::NBO::FilterPolarizationType_TypePtr & value, bool validate =true) Sets the value of the Polarization attribute.
FilterPolarizationType_TypePtr	getPolarization() const Returns the value of the Polarization attribute.
void	resetPolarization() Resets the Polarization attribute to an unset state.
bool	hasPolarization() const Checks whether the optional Polarization attribute is present.
void	setTransmittanceRange_List(const std::vector< Inscoper::NBO::TransmittanceRangePtr > & value, bool validate =true) Sets the list of TransmittanceRange elements.
std::vector< Inscoper::NBO::TransmittanceRangePtr >	getTransmittanceRange_List() const Returns the list of TransmittanceRange elements.
void	addToTransmittanceRange_List(const Inscoper::NBO::TransmittanceRangePtr & value, bool validate =true) Adds a new TransmittanceRange element to this object.
void	clearTransmittanceRange_List() Clear the list of TransmittanceRange.
void	setTransmittanceProfileFile_List(const std::vector< Inscoper::NBO::TransmittanceProfileFilePtr > & value, bool validate =true) Sets the list of TransmittanceProfileFile elements.
std::vector< Inscoper::NBO::TransmittanceProfileFilePtr >	getTransmittanceProfileFile_List() const Returns the list of TransmittanceProfileFile elements.
void	addToTransmittanceProfileFile_List(const Inscoper::NBO::TransmittanceProfileFilePtr & value, bool validate =true) Adds a new TransmittanceProfileFile element to this object.
void	clearTransmittanceProfileFile_List() Clear the list of TransmittanceProfileFile.
void	setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::AnnotationRefPtr	getAnnotationRef() const Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
bool	hasAnnotationRef() const Checks whether the optional AnnotationRef element is present.
std::shared_ptr< Filter_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Filter_Type.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
	~ManufacturerSpec_Type()
void	setManufacturer(const std::string & value, bool validate =true) Sets the value of the Manufacturer attribute.
std::string	getManufacturer() const Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
bool	hasManufacturer() const Checks whether the Manufacturer attribute is present.
void	setModel(const std::string & value, bool validate =true) Sets the value of the Model attribute.
std::string	getModel() const Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
bool	hasModel() const Checks whether the Model attribute is present.
void	setCatalogNumber(const std::string & value, bool validate =true) Sets the value of the CatalogNumber attribute.
std::string	getCatalogNumber() const Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
bool	hasCatalogNumber() const Checks whether the CatalogNumber attribute is present.
void	setLotNumber(const std::string & value, bool validate =true) Sets the value of the LotNumber attribute.
std::string	getLotNumber() const Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
bool	hasLotNumber() const Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true) Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr >	getMapAnnotation_List() const Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(const Inscoper::NBO::FileAnnotation_TypePtr & value, bool validate =true) Sets the value of the SpecsFile element.
Inscoper::NBO::FileAnnotation_TypePtr	getSpecsFile() const Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
bool	hasSpecsFile() const Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true) Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr >	getAdditionalVendorInformation_List() const Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
const std::set< std::string > &	getManufacturerAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getModelAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Filter_Type;

Represents the XML complex type Filter.

This element describes an optical Filter positioned in the Light Path for one or more Channels available for this Instrument. An optical Filter is a device designed to selectively control the Wavelengths, color temperature, vibration direction, and/or intensity of the radiation which it transmits or reflects. An Instrument may have several Filters of different types, such as an Excitation, Emission, Neutral Density or an additional Generic Filter positioned in the Light Path for different purposes. For each fluorescence Image there should be at least one Filter element specified per Channel. This element can be associated with an optional Optics Holder, such as a Filter Cube, Filter Turret, Filtr Wheel, or Filter Slider.

Public Functions Documentation¶

function Filter_Type¶

function ~Filter_Type¶

function getTypeName¶

virtual std::string getTypeName() const override

Returns the class type name.

Return: The class type name

Reimplemented by: Inscoper::NBO::EmissionFilter::getTypeName, Inscoper::NBO::ExcitationFilter::getTypeName, Inscoper::NBO::GenericFilter::getTypeName, Inscoper::NBO::NeutralDensityFilter::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 setID¶

void setID(
    const Inscoper::NBO::FilterID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

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

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setName¶

void setName(
    const Inscoper::NBO::Denomination_TypePtr & value,
    bool validate =true
)

Sets the value of the Name attribute.

Parameters:

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

A User-defined Name for this component.

function getName¶

function resetName¶

function hasName¶

function setType¶

void setType(
    const Inscoper::NBO::FilterType_TypePtr & value,
    bool validate =true
)

Sets the value of the Type attribute.

Parameters:

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

This field captures the Type of Filter used in this case.

function getType¶

function resetType¶

function hasType¶

bool hasType() const

Checks whether the optional Type attribute is present.

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

This field captures the Type of Filter used in this case.

function setCoatingMethod¶

void setCoatingMethod(
    const Inscoper::NBO::CoatingMethod_TypePtr & value,
    bool validate =true
)

Sets the value of the CoatingMethod attribute.

Parameters:

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

This field records the type of Coating used in this case. An optical coating is one or more thin layers of material deposited on an optical component such as a Lens, Filter or Mirror, which alters the way in which the optic reflects and transmits light.

function getCoatingMethod¶

CoatingMethod_TypePtr getCoatingMethod() const

Returns the value of the CoatingMethod attribute.

Return: The value of the attribute

This field records the type of Coating used in this case. An optical coating is one or more thin layers of material deposited on an optical component such as a Lens, Filter or Mirror, which alters the way in which the optic reflects and transmits light.

function resetCoatingMethod¶

void resetCoatingMethod()

Resets the CoatingMethod attribute to an unset state.

This field records the type of Coating used in this case. An optical coating is one or more thin layers of material deposited on an optical component such as a Lens, Filter or Mirror, which alters the way in which the optic reflects and transmits light.

function hasCoatingMethod¶

bool hasCoatingMethod() const

Checks whether the optional CoatingMethod attribute is present.

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

This field records the type of Coating used in this case. An optical coating is one or more thin layers of material deposited on an optical component such as a Lens, Filter or Mirror, which alters the way in which the optic reflects and transmits light.

function setLightPathLocation¶

void setLightPathLocation(
    const Inscoper::NBO::LightPathLocationOptions_TypePtr & value,
    bool validate =true
)

Sets the value of the LightPathLocation attribute.

Parameters:

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

This field records the location of this component in the Microscope Light Path. The most common positions are: Infinity Space, Camera Port or Illumination Port.

function getLightPathLocation¶

LightPathLocationOptions_TypePtr getLightPathLocation() const

Returns the value of the LightPathLocation attribute.

Return: The value of the attribute

This field records the location of this component in the Microscope Light Path. The most common positions are: Infinity Space, Camera Port or Illumination Port.

function resetLightPathLocation¶

void resetLightPathLocation()

Resets the LightPathLocation attribute to an unset state.

This field records the location of this component in the Microscope Light Path. The most common positions are: Infinity Space, Camera Port or Illumination Port.

function hasLightPathLocation¶

bool hasLightPathLocation() const

Checks whether the optional LightPathLocation attribute is present.

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

This field records the location of this component in the Microscope Light Path. The most common positions are: Infinity Space, Camera Port or Illumination Port.

function setFilterHolderPosition¶

void setFilterHolderPosition(
    const int & value,
    bool validate =true
)

Sets the value of the FilterHolderPosition attribute.

Parameters:

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

This field records the position of this element in a Filter Holder of any kind, such as a Filter Slider, Turret or Wheel.

function getFilterHolderPosition¶

int getFilterHolderPosition() const

Returns the value of the FilterHolderPosition attribute.

Return: The value of the attribute

This field records the position of this element in a Filter Holder of any kind, such as a Filter Slider, Turret or Wheel.

function resetFilterHolderPosition¶

void resetFilterHolderPosition()

Resets the FilterHolderPosition attribute to an unset state.

This field records the position of this element in a Filter Holder of any kind, such as a Filter Slider, Turret or Wheel.

function hasFilterHolderPosition¶

bool hasFilterHolderPosition() const

Checks whether the FilterHolderPosition attribute is present.

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

This field records the position of this element in a Filter Holder of any kind, such as a Filter Slider, Turret or Wheel.

function setTechnology¶

void setTechnology(
    const Inscoper::NBO::FilterTechnologyType_TypePtr & value,
    bool validate =true
)

Sets the value of the Technology attribute.

Parameters:

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

This field records Filtering technology utilized by this optical element. The main types of Filter technology used in fluorescence analysis are Absorption (aka colored) glass, Metallic-coating, Polymer-Based, or Thin-film interference-coating.

function getTechnology¶

FilterTechnologyType_TypePtr getTechnology() const

Returns the value of the Technology attribute.

Return: The value of the attribute

This field records Filtering technology utilized by this optical element. The main types of Filter technology used in fluorescence analysis are Absorption (aka colored) glass, Metallic-coating, Polymer-Based, or Thin-film interference-coating.

function resetTechnology¶

void resetTechnology()

Resets the Technology attribute to an unset state.

This field records Filtering technology utilized by this optical element. The main types of Filter technology used in fluorescence analysis are Absorption (aka colored) glass, Metallic-coating, Polymer-Based, or Thin-film interference-coating.

function hasTechnology¶

bool hasTechnology() const

Checks whether the optional Technology attribute is present.

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

This field records Filtering technology utilized by this optical element. The main types of Filter technology used in fluorescence analysis are Absorption (aka colored) glass, Metallic-coating, Polymer-Based, or Thin-film interference-coating.

function setAttenuationMethod¶

void setAttenuationMethod(
    const Inscoper::NBO::AttenuationMethodType_TypePtr & value,
    bool validate =true
)

Sets the value of the AttenuationMethod attribute.

Parameters:

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

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function getAttenuationMethod¶

AttenuationMethodType_TypePtr getAttenuationMethod() const

Returns the value of the AttenuationMethod attribute.

Return: The value of the attribute

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function resetAttenuationMethod¶

function hasAttenuationMethod¶

bool hasAttenuationMethod() const

Checks whether the optional AttenuationMethod attribute is present.

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

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function setAttenuationCoefficient¶

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

Sets the value of the AttenuationCoefficient attribute.

Parameters:

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

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function getAttenuationCoefficient¶

float getAttenuationCoefficient() const

Returns the value of the AttenuationCoefficient attribute.

Return: The value of the attribute

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function resetAttenuationCoefficient¶

void resetAttenuationCoefficient()

Resets the AttenuationCoefficient attribute to an unset state.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function hasAttenuationCoefficient¶

bool hasAttenuationCoefficient() const

Checks whether the AttenuationCoefficient attribute is present.

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

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function setDiameter¶

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

Sets the value of the Diameter attribute.

Parameters:

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

This field describes the Diameter of this optical element.

function getDiameter¶

function resetDiameter¶

function hasDiameter¶

function setDiameterUnit¶

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

Sets the value of the DiameterUnit 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 getDiameterUnit¶

function resetDiameterUnit¶

function hasDiameterUnit¶

bool hasDiameterUnit() const

Checks whether the optional DiameterUnit attribute is present.

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

No description available in the XSD standard.

function setThickness¶

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

Sets the value of the Thickness attribute.

Parameters:

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

This field describes the Thickness of this optical element.

function getThickness¶

function resetThickness¶

function hasThickness¶

bool hasThickness() const

Checks whether the Thickness attribute is present.

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

This field describes the Thickness of this optical element.

function setThicknessUnit¶

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

Sets the value of the ThicknessUnit 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 getThicknessUnit¶

function resetThicknessUnit¶

function hasThicknessUnit¶

bool hasThicknessUnit() const

Checks whether the optional ThicknessUnit attribute is present.

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

No description available in the XSD standard.

function setAngleOfIncidence¶

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

Sets the value of the AngleOfIncidence attribute.

Parameters:

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

This field records the optimal angle of incidence (AOI) for this Filter. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function getAngleOfIncidence¶

float getAngleOfIncidence() const

Returns the value of the AngleOfIncidence attribute.

Return: The value of the attribute

This field records the optimal angle of incidence (AOI) for this Filter. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function resetAngleOfIncidence¶

void resetAngleOfIncidence()

Resets the AngleOfIncidence attribute to an unset state.

This field records the optimal angle of incidence (AOI) for this Filter. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function hasAngleOfIncidence¶

bool hasAngleOfIncidence() const

Checks whether the AngleOfIncidence attribute is present.

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

This field records the optimal angle of incidence (AOI) for this Filter. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function setAngleOfIncidenceUnit¶

void setAngleOfIncidenceUnit(
    const Inscoper::NBO::UnitsAngle_TypePtr & value,
    bool validate =true
)

Sets the value of the AngleOfIncidenceUnit 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 getAngleOfIncidenceUnit¶

function resetAngleOfIncidenceUnit¶

function hasAngleOfIncidenceUnit¶

bool hasAngleOfIncidenceUnit() const

Checks whether the optional AngleOfIncidenceUnit attribute is present.

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

No description available in the XSD standard.

function setPolarization¶

void setPolarization(
    const Inscoper::NBO::FilterPolarizationType_TypePtr & value,
    bool validate =true
)

Sets the value of the Polarization attribute.

Parameters:

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

This field records the Polarization effect of this optical element. Any thin-film interference coating that is used at non-normal AOI will cause some amount of Polarization, the precise effect varying greatly with Wavelength and with the particular coating design.

function getPolarization¶

FilterPolarizationType_TypePtr getPolarization() const

Returns the value of the Polarization attribute.

Return: The value of the attribute

This field records the Polarization effect of this optical element. Any thin-film interference coating that is used at non-normal AOI will cause some amount of Polarization, the precise effect varying greatly with Wavelength and with the particular coating design.

function resetPolarization¶

void resetPolarization()

Resets the Polarization attribute to an unset state.

This field records the Polarization effect of this optical element. Any thin-film interference coating that is used at non-normal AOI will cause some amount of Polarization, the precise effect varying greatly with Wavelength and with the particular coating design.

function hasPolarization¶

bool hasPolarization() const

Checks whether the optional Polarization attribute is present.

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

This field records the Polarization effect of this optical element. Any thin-film interference coating that is used at non-normal AOI will cause some amount of Polarization, the precise effect varying greatly with Wavelength and with the particular coating design.

function setTransmittanceRange_List¶

void setTransmittanceRange_List(
    const std::vector< Inscoper::NBO::TransmittanceRangePtr > & value,
    bool validate =true
)

Sets the list of TransmittanceRange elements.

Parameters:

value The new list of TransmittanceRange elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getTransmittanceRange_List¶

std::vector< Inscoper::NBO::TransmittanceRangePtr > getTransmittanceRange_List() const

Returns the list of TransmittanceRange elements.

Return: The list of TransmittanceRange elements

No description available in the XSD standard.

function addToTransmittanceRange_List¶

void addToTransmittanceRange_List(
    const Inscoper::NBO::TransmittanceRangePtr & value,
    bool validate =true
)

Adds a new TransmittanceRange element to this object.

Parameters:

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

No description available in the XSD standard.

function clearTransmittanceRange_List¶

function setTransmittanceProfileFile_List¶

void setTransmittanceProfileFile_List(
    const std::vector< Inscoper::NBO::TransmittanceProfileFilePtr > & value,
    bool validate =true
)

Sets the list of TransmittanceProfileFile elements.

Parameters:

value The new list of TransmittanceProfileFile elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getTransmittanceProfileFile_List¶

std::vector< Inscoper::NBO::TransmittanceProfileFilePtr > getTransmittanceProfileFile_List() const

Returns the list of TransmittanceProfileFile elements.

Return: The list of TransmittanceProfileFile elements

No description available in the XSD standard.

function addToTransmittanceProfileFile_List¶

void addToTransmittanceProfileFile_List(
    const Inscoper::NBO::TransmittanceProfileFilePtr & value,
    bool validate =true
)

Adds a new TransmittanceProfileFile element to this object.

Parameters:

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

No description available in the XSD standard.

function clearTransmittanceProfileFile_List¶

function setAnnotationRef¶

void setAnnotationRef(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

Sets the value of the AnnotationRef element.

Parameters:

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

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef¶

Inscoper::NBO::AnnotationRefPtr getAnnotationRef() const

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

function resetAnnotationRef¶

function hasAnnotationRef¶

bool hasAnnotationRef() const

Checks whether the optional AnnotationRef element is present.

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

This is a simple multi-line comment or annotation describing this component.

function fromBase¶

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

Cast a NBOBaseClass to a Filter_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:37 +0200