Inscoper::NBO::BeamExpander¶

Represents the XML element BeamExpander. More...

#include <BeamExpander.h>

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

Public Functions¶

	Name
	BeamExpander()
	~BeamExpander()
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	setConfiguration(const Inscoper::NBO::BeamExpanderConfiguration_TypePtr & value, bool validate =true) Sets the value of the Configuration attribute.
BeamExpanderConfiguration_TypePtr	getConfiguration() const Returns the value of the Configuration attribute.
void	resetConfiguration() Resets the Configuration attribute to an unset state.
bool	hasConfiguration() const Checks whether the optional Configuration attribute is present.
std::shared_ptr< BeamExpander >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a BeamExpander.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::OpticalAssembly_Type

	Name
	OpticalAssembly_Type()
	~OpticalAssembly_Type()
void	setID(const Inscoper::NBO::LSID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LSID_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	setFilterRef_List(const std::vector< Inscoper::NBO::FilterRef_TypePtr > & value, bool validate =true) Sets the list of FilterRef elements.
std::vector< Inscoper::NBO::FilterRef_TypePtr >	getFilterRef_List() const Returns the list of FilterRef elements.
void	addToFilterRef_List(const Inscoper::NBO::FilterRef_TypePtr & value, bool validate =true) Adds a new FilterRef element to this object.
void	clearFilterRef_List() Clear the list of FilterRef.
void	setLensRef_List(const std::vector< Inscoper::NBO::LensRefPtr > & value, bool validate =true) Sets the list of LensRef elements.
std::vector< Inscoper::NBO::LensRefPtr >	getLensRef_List() const Returns the list of LensRef elements.
void	addToLensRef_List(const Inscoper::NBO::LensRefPtr & value, bool validate =true) Adds a new LensRef element to this object.
void	clearLensRef_List() Clear the list of LensRef.
void	setMirroringDeviceRef_List(const std::vector< Inscoper::NBO::MirroringDeviceRefPtr > & value, bool validate =true) Sets the list of MirroringDeviceRef elements.
std::vector< Inscoper::NBO::MirroringDeviceRefPtr >	getMirroringDeviceRef_List() const Returns the list of MirroringDeviceRef elements.
void	addToMirroringDeviceRef_List(const Inscoper::NBO::MirroringDeviceRefPtr & value, bool validate =true) Adds a new MirroringDeviceRef element to this object.
void	clearMirroringDeviceRef_List() Clear the list of MirroringDeviceRef.
void	setApertureRef_List(const std::vector< Inscoper::NBO::ApertureRefPtr > & value, bool validate =true) Sets the list of ApertureRef elements.
std::vector< Inscoper::NBO::ApertureRefPtr >	getApertureRef_List() const Returns the list of ApertureRef elements.
void	addToApertureRef_List(const Inscoper::NBO::ApertureRefPtr & value, bool validate =true) Adds a new ApertureRef element to this object.
void	clearApertureRef_List() Clear the list of ApertureRef.
void	setPolarizationOpticsRef_List(const std::vector< Inscoper::NBO::PolarizationOpticsRefPtr > & value, bool validate =true) Sets the list of PolarizationOpticsRef elements.
std::vector< Inscoper::NBO::PolarizationOpticsRefPtr >	getPolarizationOpticsRef_List() const Returns the list of PolarizationOpticsRef elements.
void	addToPolarizationOpticsRef_List(const Inscoper::NBO::PolarizationOpticsRefPtr & value, bool validate =true) Adds a new PolarizationOpticsRef element to this object.
void	clearPolarizationOpticsRef_List() Clear the list of PolarizationOpticsRef.
void	setPrismRef_List(const std::vector< Inscoper::NBO::PrismRefPtr > & value, bool validate =true) Sets the list of PrismRef elements.
std::vector< Inscoper::NBO::PrismRefPtr >	getPrismRef_List() const Returns the list of PrismRef elements.
void	addToPrismRef_List(const Inscoper::NBO::PrismRefPtr & value, bool validate =true) Adds a new PrismRef element to this object.
void	clearPrismRef_List() Clear the list of PrismRef.
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.

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

Represents the XML element BeamExpander.

Beam Expanders are Lens Systems whose role is to increase the diameter of a collimated input beam to a larger collimated output beam. Beam Expanders typically are afocal systems in which object rays enter and exit parallel to the optical axis. As such a Beam Expander does not have a focal length. In most cases, Beam Expanders are realized as optical telescopes consisting of two lenses. Beam Expanders can be custom built or they are also available as pre-assembled optical devices.

Public Functions Documentation¶

function BeamExpander¶

function ~BeamExpander¶

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

void setConfiguration(
    const Inscoper::NBO::BeamExpanderConfiguration_TypePtr & value,
    bool validate =true
)

Sets the value of the Configuration attribute.

Parameters:

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

This field captures the Configuration of this Beam Expander.

function getConfiguration¶

BeamExpanderConfiguration_TypePtr getConfiguration() const

Returns the value of the Configuration attribute.

Return: The value of the attribute

This field captures the Configuration of this Beam Expander.

function resetConfiguration¶

function hasConfiguration¶

bool hasConfiguration() const

Checks whether the optional Configuration attribute is present.

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

This field captures the Configuration of this Beam Expander.

function fromBase¶

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

Cast a NBOBaseClass to a BeamExpander.

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