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.

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)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

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

setFunction(value)

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

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)

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

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

setApertureSize(value)

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

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

setApertureSizeUnit(value)

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

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)

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

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

setApertureShape(value)

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

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 optional ApertureShape attribute is present.

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

Returns:

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

setMaterial(value)

Sets the value of the Material attribute.

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

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getMaterial()

Returns the value of the Material attribute.

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

Returns:

Type	Description
string	The value of the attribute

resetMaterial()

Resets the Material attribute to an unset state.

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

hasMaterial()

Checks whether the optional Material attribute is present.

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

Returns:

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