Inscoper::NBO::OpticalAssembly_Type¶

Represents the XML complex type OpticalAssembly. More...

#include <OpticalAssembly_Type.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Inherited by Inscoper::NBO::BeamCollimator, Inscoper::NBO::BeamExpander, Inscoper::NBO::Condenser, Inscoper::NBO::MicroscopeTube

Public Functions¶

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

Represents the XML complex type OpticalAssembly.

This is a device that might include one or more Lenses, other Optics and Optics Holders. Optical Devices might be custom built or they might also be available as pre-assembled units. Such devices might be embedded within the Microscope Stand or exist as independent units. Examples include the Condenser and the Microscope Tube.

Public Functions Documentation¶

function OpticalAssembly_Type¶

function ~OpticalAssembly_Type¶

function getTypeName¶

virtual std::string getTypeName() const override

Returns the class type name.

Return: The class type name

Reimplemented by: Inscoper::NBO::BeamCollimator::getTypeName, Inscoper::NBO::BeamExpander::getTypeName, Inscoper::NBO::Condenser::getTypeName, Inscoper::NBO::MicroscopeTube::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::LSID_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 setFilterRef_List¶

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

Sets the list of FilterRef elements.

Parameters:

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

This refers to an available Filter, which is part of this Optical Assembly.

function getFilterRef_List¶

std::vector< Inscoper::NBO::FilterRef_TypePtr > getFilterRef_List() const

Returns the list of FilterRef elements.

Return: The list of FilterRef elements

This refers to an available Filter, which is part of this Optical Assembly.

function addToFilterRef_List¶

void addToFilterRef_List(
    const Inscoper::NBO::FilterRef_TypePtr & value,
    bool validate =true
)

Adds a new FilterRef element to this object.

Parameters:

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

This refers to an available Filter, which is part of this Optical Assembly.

function clearFilterRef_List¶

function setLensRef_List¶

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

Sets the list of LensRef elements.

Parameters:

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

No description available in the XSD standard.

function getLensRef_List¶

function addToLensRef_List¶

void addToLensRef_List(
    const Inscoper::NBO::LensRefPtr & value,
    bool validate =true
)

Adds a new LensRef 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 clearLensRef_List¶

function setMirroringDeviceRef_List¶

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

Sets the list of MirroringDeviceRef elements.

Parameters:

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

No description available in the XSD standard.

function getMirroringDeviceRef_List¶

std::vector< Inscoper::NBO::MirroringDeviceRefPtr > getMirroringDeviceRef_List() const

Returns the list of MirroringDeviceRef elements.

Return: The list of MirroringDeviceRef elements

No description available in the XSD standard.

function addToMirroringDeviceRef_List¶

void addToMirroringDeviceRef_List(
    const Inscoper::NBO::MirroringDeviceRefPtr & value,
    bool validate =true
)

Adds a new MirroringDeviceRef 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 clearMirroringDeviceRef_List¶

function setApertureRef_List¶

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

Sets the list of ApertureRef elements.

Parameters:

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

No description available in the XSD standard.

function getApertureRef_List¶

std::vector< Inscoper::NBO::ApertureRefPtr > getApertureRef_List() const

Returns the list of ApertureRef elements.

Return: The list of ApertureRef elements

No description available in the XSD standard.

function addToApertureRef_List¶

void addToApertureRef_List(
    const Inscoper::NBO::ApertureRefPtr & value,
    bool validate =true
)

Adds a new ApertureRef 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 clearApertureRef_List¶

function setPolarizationOpticsRef_List¶

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

Sets the list of PolarizationOpticsRef elements.

Parameters:

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

No description available in the XSD standard.

function getPolarizationOpticsRef_List¶

std::vector< Inscoper::NBO::PolarizationOpticsRefPtr > getPolarizationOpticsRef_List() const

Returns the list of PolarizationOpticsRef elements.

Return: The list of PolarizationOpticsRef elements

No description available in the XSD standard.

function addToPolarizationOpticsRef_List¶

void addToPolarizationOpticsRef_List(
    const Inscoper::NBO::PolarizationOpticsRefPtr & value,
    bool validate =true
)

Adds a new PolarizationOpticsRef 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 clearPolarizationOpticsRef_List¶

function setPrismRef_List¶

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

Sets the list of PrismRef elements.

Parameters:

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

No description available in the XSD standard.

function getPrismRef_List¶

function addToPrismRef_List¶

void addToPrismRef_List(
    const Inscoper::NBO::PrismRefPtr & value,
    bool validate =true
)

Adds a new PrismRef 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 clearPrismRef_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.

No description available in the XSD standard.

function getAnnotationRef¶

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

No description available in the XSD standard.

function fromBase¶

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

Cast a NBOBaseClass to a OpticalAssembly_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:38 +0200