Inscoper::NBO::MaskingPlate¶

Represents the XML element MaskingPlate. More...

#include <MaskingPlate.h>

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

Public Functions¶

	Name
	MaskingPlate()
	~MaskingPlate()
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	setFunction(const Inscoper::NBO::MaskingPlateFunction_TypePtr & value, bool validate =true) Sets the value of the Function attribute.
MaskingPlateFunction_TypePtr	getFunction() const Returns the value of the Function attribute.
void	resetFunction() Resets the Function attribute to an unset state.
bool	hasFunction() const Checks whether the optional Function attribute is present.
void	setExcitation(const bool & value, bool validate =true) Sets the value of the Excitation attribute.
bool	getExcitation() const Returns the value of the Excitation attribute.
void	resetExcitation() Resets the Excitation attribute to an unset state.
bool	hasExcitation() const Checks whether the Excitation attribute is present.
void	setApertureSize(const float & value, bool validate =true) Sets the value of the ApertureSize attribute.
float	getApertureSize() const Returns the value of the ApertureSize attribute.
void	resetApertureSize() Resets the ApertureSize attribute to an unset state.
bool	hasApertureSize() const Checks whether the ApertureSize attribute is present.
void	setApertureSizeUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ApertureSizeUnit attribute.
UnitsLength_TypePtr	getApertureSizeUnit() const Returns the value of the ApertureSizeUnit attribute.
void	resetApertureSizeUnit() Resets the ApertureSizeUnit attribute to an unset state.
bool	hasApertureSizeUnit() const Checks whether the optional ApertureSizeUnit attribute is present.
void	setApertureNr_(const int & value, bool validate =true) Sets the value of the ApertureNr_ attribute.
int	getApertureNr_() const Returns the value of the ApertureNr_ attribute.
void	resetApertureNr_() Resets the ApertureNr_ attribute to an unset state.
bool	hasApertureNr_() const Checks whether the ApertureNr_ attribute is present.
void	setApertureShape(const std::string & value, bool validate =true) Sets the value of the ApertureShape attribute.
std::string	getApertureShape() const Returns the value of the ApertureShape attribute.
void	resetApertureShape() Resets the ApertureShape attribute to an unset state.
bool	hasApertureShape() const Checks whether the ApertureShape attribute is present.
void	setMaterial(const std::string & value, bool validate =true) Sets the value of the Material attribute.
std::string	getMaterial() const Returns the value of the Material attribute.
void	resetMaterial() Resets the Material attribute to an unset state.
bool	hasMaterial() const Checks whether the Material attribute is present.
std::shared_ptr< MaskingPlate >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a MaskingPlate.
const std::set< std::string > &	getApertureShapeAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getMaterialAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::OpticalAperture_Type

	Name
	OpticalAperture_Type()
	~OpticalAperture_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	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	setOuterDiameter(const float & value, bool validate =true) Sets the value of the OuterDiameter attribute.
float	getOuterDiameter() const Returns the value of the OuterDiameter attribute.
void	resetOuterDiameter() Resets the OuterDiameter attribute to an unset state.
bool	hasOuterDiameter() const Checks whether the OuterDiameter attribute is present.
void	setOuterDiameterUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the OuterDiameterUnit attribute.
UnitsLength_TypePtr	getOuterDiameterUnit() const Returns the value of the OuterDiameterUnit attribute.
void	resetOuterDiameterUnit() Resets the OuterDiameterUnit attribute to an unset state.
bool	hasOuterDiameterUnit() const Checks whether the optional OuterDiameterUnit 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.

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

Represents the XML element MaskingPlate.

This element describes an opaque Masking Plate positioned in the light path to block specific components of the light beam.

Public Functions Documentation¶

function MaskingPlate¶

function ~MaskingPlate¶

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

void setFunction(
    const Inscoper::NBO::MaskingPlateFunction_TypePtr & value,
    bool validate =true
)

Sets the value of the Function attribute.

Parameters:

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

This field describes the Function of this Spatial Mask.

function getFunction¶

function resetFunction¶

function hasFunction¶

bool hasFunction() const

Checks whether the optional Function attribute is present.

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

This field describes the Function of this Spatial Mask.

function setExcitation¶

void setExcitation(
    const bool & value,
    bool validate =true
)

Sets the value of the Excitation attribute.

Parameters:

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

This field records whether this Spatial Mask is placed in the Excitation (True) or the Emission (False) light path.

function getExcitation¶

bool getExcitation() const

Returns the value of the Excitation attribute.

Return: The value of the attribute

This field records whether this Spatial Mask is placed in the Excitation (True) or the Emission (False) light path.

function resetExcitation¶

function hasExcitation¶

bool hasExcitation() const

Checks whether the Excitation attribute is present.

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

This field records whether this Spatial Mask is placed in the Excitation (True) or the Emission (False) light path.

function setApertureSize¶

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

Sets the value of the ApertureSize attribute.

Parameters:

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

This field captures the maximum physical Width of individual Apertures present in this Spatial Mask.

function getApertureSize¶

float getApertureSize() const

Returns the value of the ApertureSize attribute.

Return: The value of the attribute

This field captures the maximum physical Width of individual Apertures present in this Spatial Mask.

function resetApertureSize¶

function hasApertureSize¶

bool hasApertureSize() const

Checks whether the ApertureSize attribute is present.

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

This field captures the maximum physical Width of individual Apertures present in this Spatial Mask.

function setApertureSizeUnit¶

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

Sets the value of the ApertureSizeUnit 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 getApertureSizeUnit¶

function resetApertureSizeUnit¶

function hasApertureSizeUnit¶

bool hasApertureSizeUnit() const

Checks whether the optional ApertureSizeUnit attribute is present.

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

No description available in the XSD standard.

function setApertureNr_¶

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

Sets the value of the ApertureNr_ attribute.

Parameters:

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

This field captures the Number of individual apertures present in this Spatial Mask.

function getApertureNr_¶

function resetApertureNr_¶

function hasApertureNr_¶

bool hasApertureNr_() const

Checks whether the ApertureNr_ attribute is present.

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

This field captures the Number of individual apertures present in this Spatial Mask.

function setApertureShape¶

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

Sets the value of the ApertureShape attribute.

Parameters:

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

This field captures the Shape of individual apertures present in this Spatial Mask.

function getApertureShape¶

std::string getApertureShape() const

Returns the value of the ApertureShape attribute.

Return: The value of the attribute

This field captures the Shape of individual apertures present in this Spatial Mask.

function resetApertureShape¶

function hasApertureShape¶

bool hasApertureShape() const

Checks whether the ApertureShape attribute is present.

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

This field captures the Shape of individual apertures present in this Spatial Mask.

function setMaterial¶

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

Sets the value of the Material attribute.

Parameters:

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

This field captures the Material with which this Spatial Mask is constructed.

function getMaterial¶

function resetMaterial¶

function hasMaterial¶

bool hasMaterial() const

Checks whether the Material attribute is present.

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

This field captures the Material with which this Spatial Mask is constructed.

function fromBase¶

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

Cast a NBOBaseClass to a MaskingPlate.

Parameters:

base The base class to cast

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

function getApertureShapeAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

This field captures the Shape of individual apertures present in this Spatial Mask.

function getMaterialAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

This field captures the Material with which this Spatial Mask is constructed.

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