MaskingPlate¶

Bases: OpticalAperture_Type

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.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`MaskingPlate`	The casted element, or nullptr if the cast fails

`getTypeName()` ¶

Returns the class type name.

Returns:

Type	Description
`string`	The class type name

`getXMLName()` ¶

Returns the XML element name corresponding to this class.

Returns:

Type	Description
`string`	The XML element name

`getNBOType()` ¶

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
`int`	The NBO Type value

`getChildren()` ¶

Returns a list of all classes derived from this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of derived classes

`getSubElements()` ¶

Returns a list of all child elements contained in this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of child classes

`fromJsonFile(path, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

Type	Description
`string`	A string containing the XML representation of this object

`setFunction(value, validate=True)` ¶

Sets the value of the Function attribute.

This field describes the Function of this Spatial Mask.

Parameters:

Name	Type	Description	Default
`value`	`MaskingPlateFunction_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getFunction()` ¶

Returns the value of the Function attribute.

This field describes the Function of this Spatial Mask.

Returns:

Type	Description
`MaskingPlateFunction_Type`	The value of the attribute

`resetFunction()` ¶

Resets the Function attribute to an unset state.

This field describes the Function of this Spatial Mask.

`hasFunction()` ¶

Checks whether the optional Function attribute is present.

This field describes the Function of this Spatial Mask.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setExcitation(value, validate=True)` ¶

Sets the value of the Excitation attribute.

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

Parameters:

Name	Type	Description	Default
`value`	`boolean`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getExcitation()` ¶

Returns the value of the Excitation attribute.

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

Returns:

Type	Description
`boolean`	The value of the attribute

`resetExcitation()` ¶

Resets the Excitation attribute to an unset state.

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

`hasExcitation()` ¶

Checks whether the Excitation attribute is present.

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

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setApertureSize(value, validate=True)` ¶

Sets the value of the ApertureSize attribute.

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

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getApertureSize()` ¶

Returns the value of the ApertureSize attribute.

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

Returns:

Type	Description
`float`	The value of the attribute

`resetApertureSize()` ¶

Resets the ApertureSize attribute to an unset state.

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

`hasApertureSize()` ¶

Checks whether the ApertureSize attribute is present.

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

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setApertureSizeUnit(value, validate=True)` ¶

Sets the value of the ApertureSizeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
`value`	`UnitsLength_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getApertureSizeUnit()` ¶

Returns the value of the ApertureSizeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
`UnitsLength_Type`	The value of the attribute

`resetApertureSizeUnit()` ¶

Resets the ApertureSizeUnit attribute to an unset state.

No description available in the XSD standard.

`hasApertureSizeUnit()` ¶

Checks whether the optional ApertureSizeUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setApertureNr_(value, validate=True)` ¶

Sets the value of the ApertureNr_ attribute.

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

Parameters:

Name	Type	Description	Default
`value`	`int`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getApertureNr_()` ¶

Returns the value of the ApertureNr_ attribute.

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

Returns:

Type	Description
`int`	The value of the attribute

`resetApertureNr_()` ¶

Resets the ApertureNr_ attribute to an unset state.

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

`hasApertureNr_()` ¶

Checks whether the ApertureNr_ attribute is present.

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

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setApertureShape(value, validate=True)` ¶

Sets the value of the ApertureShape attribute.

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

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getApertureShape()` ¶

Returns the value of the ApertureShape attribute.

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

Returns:

Type	Description
`string`	The value of the attribute

`resetApertureShape()` ¶

Resets the ApertureShape attribute to an unset state.

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

`hasApertureShape()` ¶

Checks whether the ApertureShape attribute is present.

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

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`getApertureShapeAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

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

Returns:

Type	Description
`std::set< str,std::less< str >,std::allocator< str > >`	The list of allowed values