Inscoper::NBO::BeamSplitter¶

Represents the XML element BeamSplitter. More...

#include <BeamSplitter.h>

Inherits from Inscoper::NBO::MirroringDevice_Type, Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions¶

	Name
	BeamSplitter()
	~BeamSplitter()
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	setTransmittance(const float & value, bool validate =true) Sets the value of the Transmittance attribute.
float	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 Transmittance attribute is present.
void	setTransmittanceProfileFile(const std::string & value, bool validate =true) Sets the value of the TransmittanceProfileFile attribute.
std::string	getTransmittanceProfileFile() const Returns the value of the TransmittanceProfileFile attribute.
void	resetTransmittanceProfileFile() Resets the TransmittanceProfileFile attribute to an unset state.
bool	hasTransmittanceProfileFile() const Checks whether the TransmittanceProfileFile attribute is present.
void	setTransmissionAngle(const float & value, bool validate =true) Sets the value of the TransmissionAngle attribute.
float	getTransmissionAngle() const Returns the value of the TransmissionAngle attribute.
void	resetTransmissionAngle() Resets the TransmissionAngle attribute to an unset state.
bool	hasTransmissionAngle() const Checks whether the TransmissionAngle attribute is present.
void	setTransmissionAngleUnit(const Inscoper::NBO::UnitsAngle_TypePtr & value, bool validate =true) Sets the value of the TransmissionAngleUnit attribute.
UnitsAngle_TypePtr	getTransmissionAngleUnit() const Returns the value of the TransmissionAngleUnit attribute.
void	resetTransmissionAngleUnit() Resets the TransmissionAngleUnit attribute to an unset state.
bool	hasTransmissionAngleUnit() const Checks whether the optional TransmissionAngleUnit attribute is present.
void	setReflectance(const float & value, bool validate =true) Sets the value of the Reflectance attribute.
float	getReflectance() const Returns the value of the Reflectance attribute.
void	resetReflectance() Resets the Reflectance attribute to an unset state.
bool	hasReflectance() const Checks whether the Reflectance attribute is present.
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	setReflectanceProfileFile_List(const std::vector< Inscoper::NBO::ReflectanceProfileFilePtr > & value, bool validate =true) Sets the list of ReflectanceProfileFile elements.
std::vector< Inscoper::NBO::ReflectanceProfileFilePtr >	getReflectanceProfileFile_List() const Returns the list of ReflectanceProfileFile elements.
void	addToReflectanceProfileFile_List(const Inscoper::NBO::ReflectanceProfileFilePtr & value, bool validate =true) Adds a new ReflectanceProfileFile element to this object.
void	clearReflectanceProfileFile_List() Clear the list of ReflectanceProfileFile.
std::shared_ptr< BeamSplitter >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a BeamSplitter.
const std::set< std::string > &	getTransmittanceProfileFileAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::MirroringDevice_Type

	Name
	MirroringDevice_Type()
	~MirroringDevice_Type()
void	setID(const Inscoper::NBO::MirrorID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
MirrorID_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	setOpticsHolderPosition(const std::string & value, bool validate =true) Sets the value of the OpticsHolderPosition attribute.
std::string	getOpticsHolderPosition() const Returns the value of the OpticsHolderPosition attribute.
void	resetOpticsHolderPosition() Resets the OpticsHolderPosition attribute to an unset state.
bool	hasOpticsHolderPosition() const Checks whether the OpticsHolderPosition attribute is present.
void	setMirrorType(const Inscoper::NBO::MirrorType_TypePtr & value, bool validate =true) Sets the value of the MirrorType attribute.
MirrorType_TypePtr	getMirrorType() const Returns the value of the MirrorType attribute.
void	resetMirrorType() Resets the MirrorType attribute to an unset state.
bool	hasMirrorType() const Checks whether the optional MirrorType attribute is present.
void	setGeometry(const Inscoper::NBO::MirrorGeometry_TypePtr & value, bool validate =true) Sets the value of the Geometry attribute.
MirrorGeometry_TypePtr	getGeometry() const Returns the value of the Geometry attribute.
void	resetGeometry() Resets the Geometry attribute to an unset state.
bool	hasGeometry() const Checks whether the optional Geometry 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	setRadiusOfCurvature(const float & value, bool validate =true) Sets the value of the RadiusOfCurvature attribute.
float	getRadiusOfCurvature() const Returns the value of the RadiusOfCurvature attribute.
void	resetRadiusOfCurvature() Resets the RadiusOfCurvature attribute to an unset state.
bool	hasRadiusOfCurvature() const Checks whether the RadiusOfCurvature attribute is present.
void	setRadiusOfCurvatureUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the RadiusOfCurvatureUnit attribute.
UnitsLength_TypePtr	getRadiusOfCurvatureUnit() const Returns the value of the RadiusOfCurvatureUnit attribute.
void	resetRadiusOfCurvatureUnit() Resets the RadiusOfCurvatureUnit attribute to an unset state.
bool	hasRadiusOfCurvatureUnit() const Checks whether the optional RadiusOfCurvatureUnit 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	setSubstrateType(const std::string & value, bool validate =true) Sets the value of the SubstrateType attribute.
std::string	getSubstrateType() const Returns the value of the SubstrateType attribute.
void	resetSubstrateType() Resets the SubstrateType attribute to an unset state.
bool	hasSubstrateType() const Checks whether the SubstrateType attribute is present.
void	setSubstrateMaterial(const Inscoper::NBO::OpticalMaterialName_TypePtr & value, bool validate =true) Sets the value of the SubstrateMaterial attribute.
OpticalMaterialName_TypePtr	getSubstrateMaterial() const Returns the value of the SubstrateMaterial attribute.
void	resetSubstrateMaterial() Resets the SubstrateMaterial attribute to an unset state.
bool	hasSubstrateMaterial() const Checks whether the optional SubstrateMaterial attribute is present.
void	setGlassCode(const std::string & value, bool validate =true) Sets the value of the GlassCode attribute.
std::string	getGlassCode() const Returns the value of the GlassCode attribute.
void	resetGlassCode() Resets the GlassCode attribute to an unset state.
bool	hasGlassCode() const Checks whether the GlassCode attribute is present.
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.
const std::set< std::string > &	getOpticsHolderPositionAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getAngleOfIncidenceUnitAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getSubstrateTypeAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getGlassCodeAllowedValues() Returns the allowed values for this attribut.

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::BeamSplitter;

Represents the XML element BeamSplitter.

This element describes a Mirror that reflects part of the light, regardless of wavelength.

Public Functions Documentation¶

function BeamSplitter¶

function ~BeamSplitter¶

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 float & 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.

The field records the maximum amount of light this Beamsplitteris capable of transmitting at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function getTransmittance¶

float getTransmittance() const

Returns the value of the Transmittance attribute.

Return: The value of the attribute

The field records the maximum amount of light this Beamsplitteris capable of transmitting 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.

The field records the maximum amount of light this Beamsplitteris capable of transmitting 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 Transmittance attribute is present.

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

The field records the maximum amount of light this Beamsplitteris capable of transmitting at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function setTransmittanceProfileFile¶

void setTransmittanceProfileFile(
    const std::string & value,
    bool validate =true
)

Sets the value of the TransmittanceProfileFile attribute.

Parameters:

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

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

function getTransmittanceProfileFile¶

std::string getTransmittanceProfileFile() const

Returns the value of the TransmittanceProfileFile attribute.

Return: The value of the attribute

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

function resetTransmittanceProfileFile¶

void resetTransmittanceProfileFile()

Resets the TransmittanceProfileFile attribute to an unset state.

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

function hasTransmittanceProfileFile¶

bool hasTransmittanceProfileFile() const

Checks whether the TransmittanceProfileFile attribute is present.

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

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

function setTransmissionAngle¶

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

Sets the value of the TransmissionAngle attribute.

Parameters:

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

The angle at which light is transmitted by this Beamsplitter.

function getTransmissionAngle¶

function resetTransmissionAngle¶

function hasTransmissionAngle¶

bool hasTransmissionAngle() const

Checks whether the TransmissionAngle attribute is present.

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

The angle at which light is transmitted by this Beamsplitter.

function setTransmissionAngleUnit¶

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

Sets the value of the TransmissionAngleUnit 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 getTransmissionAngleUnit¶

function resetTransmissionAngleUnit¶

function hasTransmissionAngleUnit¶

bool hasTransmissionAngleUnit() const

Checks whether the optional TransmissionAngleUnit attribute is present.

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

No description available in the XSD standard.

function setReflectance¶

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

Sets the value of the Reflectance attribute.

Parameters:

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

The field records the maximum amount of light this Beamsplitteris capable of reflecting at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function getReflectance¶

float getReflectance() const

Returns the value of the Reflectance attribute.

Return: The value of the attribute

The field records the maximum amount of light this Beamsplitteris capable of reflecting at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function resetReflectance¶

void resetReflectance()

Resets the Reflectance attribute to an unset state.

The field records the maximum amount of light this Beamsplitteris capable of reflecting at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function hasReflectance¶

bool hasReflectance() const

Checks whether the Reflectance attribute is present.

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

The field records the maximum amount of light this Beamsplitteris capable of reflecting at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

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 setReflectanceProfileFile_List¶

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

Sets the list of ReflectanceProfileFile elements.

Parameters:

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

No description available in the XSD standard.

function getReflectanceProfileFile_List¶

std::vector< Inscoper::NBO::ReflectanceProfileFilePtr > getReflectanceProfileFile_List() const

Returns the list of ReflectanceProfileFile elements.

Return: The list of ReflectanceProfileFile elements

No description available in the XSD standard.

function addToReflectanceProfileFile_List¶

void addToReflectanceProfileFile_List(
    const Inscoper::NBO::ReflectanceProfileFilePtr & value,
    bool validate =true
)

Adds a new ReflectanceProfileFile 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 clearReflectanceProfileFile_List¶

function fromBase¶

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

Cast a NBOBaseClass to a BeamSplitter.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getTransmittanceProfileFileAllowedValues¶

static const std::set< std::string > & getTransmittanceProfileFileAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

Updated on 2026-09-23 at 16:50:37 +0200