Inscoper::NBO::BeamExpanderLens¶

Represents the XML element BeamExpanderLens. More...

#include <BeamExpanderLens.h>

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

Public Functions¶

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

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Lens_Type

	Name
	Lens_Type()
	~Lens_Type()
void	setID(const Inscoper::NBO::LensID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LensID_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	setMagnification(const float & value, bool validate =true) Sets the value of the Magnification attribute.
float	getMagnification() const Returns the value of the Magnification attribute.
void	resetMagnification() Resets the Magnification attribute to an unset state.
bool	hasMagnification() const Checks whether the Magnification attribute is present.
void	setLensNA(const float & value, bool validate =true) Sets the value of the LensNA attribute.
float	getLensNA() const Returns the value of the LensNA attribute.
void	resetLensNA() Resets the LensNA attribute to an unset state.
bool	hasLensNA() const Checks whether the LensNA attribute is present.
void	setInfinity(const bool & value, bool validate =true) Sets the value of the Infinity attribute.
bool	getInfinity() const Returns the value of the Infinity attribute.
void	resetInfinity() Resets the Infinity attribute to an unset state.
bool	hasInfinity() const Checks whether the Infinity attribute is present.
void	setComposite(const bool & value, bool validate =true) Sets the value of the Composite attribute.
bool	getComposite() const Returns the value of the Composite attribute.
void	resetComposite() Resets the Composite attribute to an unset state.
bool	hasComposite() const Checks whether the Composite attribute is present.
void	setShape(const Inscoper::NBO::LensShapeType_TypePtr & value, bool validate =true) Sets the value of the Shape attribute.
LensShapeType_TypePtr	getShape() const Returns the value of the Shape attribute.
void	resetShape() Resets the Shape attribute to an unset state.
bool	hasShape() const Checks whether the optional Shape attribute is present.
void	setGeometry(const Inscoper::NBO::LensGeometry_TypePtr & value, bool validate =true) Sets the value of the Geometry attribute.
LensGeometry_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	setCoating(const std::string & value, bool validate =true) Sets the value of the Coating attribute.
std::string	getCoating() const Returns the value of the Coating attribute.
void	resetCoating() Resets the Coating attribute to an unset state.
bool	hasCoating() const Checks whether the Coating 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	setWorkingDistance(const float & value, bool validate =true) Sets the value of the WorkingDistance attribute.
float	getWorkingDistance() const Returns the value of the WorkingDistance attribute.
void	resetWorkingDistance() Resets the WorkingDistance attribute to an unset state.
bool	hasWorkingDistance() const Checks whether the WorkingDistance attribute is present.
void	setWorkingDistanceUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the WorkingDistanceUnit attribute.
UnitsLength_TypePtr	getWorkingDistanceUnit() const Returns the value of the WorkingDistanceUnit attribute.
void	resetWorkingDistanceUnit() Resets the WorkingDistanceUnit attribute to an unset state.
bool	hasWorkingDistanceUnit() const Checks whether the optional WorkingDistanceUnit attribute is present.
void	setImageDistance(const float & value, bool validate =true) Sets the value of the ImageDistance attribute.
float	getImageDistance() const Returns the value of the ImageDistance attribute.
void	resetImageDistance() Resets the ImageDistance attribute to an unset state.
bool	hasImageDistance() const Checks whether the ImageDistance attribute is present.
void	setImageDistanceUnits(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ImageDistanceUnits attribute.
UnitsLength_TypePtr	getImageDistanceUnits() const Returns the value of the ImageDistanceUnits attribute.
void	resetImageDistanceUnits() Resets the ImageDistanceUnits attribute to an unset state.
bool	hasImageDistanceUnits() const Checks whether the optional ImageDistanceUnits attribute is present.
void	setFrontFocalLength(const float & value, bool validate =true) Sets the value of the FrontFocalLength attribute.
float	getFrontFocalLength() const Returns the value of the FrontFocalLength attribute.
void	resetFrontFocalLength() Resets the FrontFocalLength attribute to an unset state.
bool	hasFrontFocalLength() const Checks whether the FrontFocalLength attribute is present.
void	setFrontFocalLengthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the FrontFocalLengthUnit attribute.
UnitsLength_TypePtr	getFrontFocalLengthUnit() const Returns the value of the FrontFocalLengthUnit attribute.
void	resetFrontFocalLengthUnit() Resets the FrontFocalLengthUnit attribute to an unset state.
bool	hasFrontFocalLengthUnit() const Checks whether the optional FrontFocalLengthUnit attribute is present.
void	setBackFocalLength(const float & value, bool validate =true) Sets the value of the BackFocalLength attribute.
float	getBackFocalLength() const Returns the value of the BackFocalLength attribute.
void	resetBackFocalLength() Resets the BackFocalLength attribute to an unset state.
bool	hasBackFocalLength() const Checks whether the BackFocalLength attribute is present.
void	setBackFocalLengthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the BackFocalLengthUnit attribute.
UnitsLength_TypePtr	getBackFocalLengthUnit() const Returns the value of the BackFocalLengthUnit attribute.
void	resetBackFocalLengthUnit() Resets the BackFocalLengthUnit attribute to an unset state.
bool	hasBackFocalLengthUnit() const Checks whether the optional BackFocalLengthUnit 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	setMaterialName(const Inscoper::NBO::OpticalMaterialName_TypePtr & value, bool validate =true) Sets the value of the MaterialName attribute.
OpticalMaterialName_TypePtr	getMaterialName() const Returns the value of the MaterialName attribute.
void	resetMaterialName() Resets the MaterialName attribute to an unset state.
bool	hasMaterialName() const Checks whether the optional MaterialName 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	setRefractiveIndex(const float & value, bool validate =true) Sets the value of the RefractiveIndex attribute.
float	getRefractiveIndex() const Returns the value of the RefractiveIndex attribute.
void	resetRefractiveIndex() Resets the RefractiveIndex attribute to an unset state.
bool	hasRefractiveIndex() const Checks whether the RefractiveIndex attribute is present.
void	setAbbeNumber(const float & value, bool validate =true) Sets the value of the AbbeNumber attribute.
float	getAbbeNumber() const Returns the value of the AbbeNumber attribute.
void	resetAbbeNumber() Resets the AbbeNumber attribute to an unset state.
bool	hasAbbeNumber() const Checks whether the AbbeNumber attribute is present.
void	setDensity(const float & value, bool validate =true) Sets the value of the Density attribute.
float	getDensity() const Returns the value of the Density attribute.
void	resetDensity() Resets the Density attribute to an unset state.
bool	hasDensity() const Checks whether the Density attribute is present.
void	setDensityUnit(const Inscoper::NBO::UnitsDensity_TypePtr & value, bool validate =true) Sets the value of the DensityUnit attribute.
UnitsDensity_TypePtr	getDensityUnit() const Returns the value of the DensityUnit attribute.
void	resetDensityUnit() Resets the DensityUnit attribute to an unset state.
bool	hasDensityUnit() const Checks whether the optional DensityUnit 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 > &	getCoatingAllowedValues() 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::BeamExpanderLens;

Represents the XML element BeamExpanderLens.

A Beam Expander Lens is a Lens designed to work in combination with other optical components to form a Beam Expander device. As such, its role is to increase the diameter of a collimated input beam to a larger collimated output beam.

Public Functions Documentation¶

function BeamExpanderLens¶

function ~BeamExpanderLens¶

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

Cast a NBOBaseClass to a BeamExpanderLens.

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