OpticalAperture_Type

Bases: ManufacturerSpec_Type

Represents the XML complex type OpticalAperture.

This element represents any mechanical, non optical device that is placed in the Light Path and spatially modifies the light beam. Examples include, Pin Holes, Phase Rings, Dark Field Stops, Hoffman Modulators, Diffraction Gratings etc. This element can be associated with an optional Optics Turret.

`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

`setID(value)`

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
`value`	`LensID_Type`	The value to set	required

`getID()`

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
`LensID_Type`	The value of the attribute

`resetID()`

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

`hasID()`

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

`setName(value)`

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

Name	Type	Description	Default
`value`	`Denomination_Type`	The value to set	required

`getName()`

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
`Denomination_Type`	The value of the attribute

`resetName()`

Resets the Name attribute to an unset state.

A User-defined Name for this component.

`hasName()`

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

`setOpticsHolderPosition(value)`

Sets the value of the OpticsHolderPosition attribute.

This field records the position of this Optical Aperture in a Optics Turret.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getOpticsHolderPosition()`

Returns the value of the OpticsHolderPosition attribute.

This field records the position of this Optical Aperture in a Optics Turret.

Returns:

Type	Description
`string`	The value of the attribute

`resetOpticsHolderPosition()`

Resets the OpticsHolderPosition attribute to an unset state.

This field records the position of this Optical Aperture in a Optics Turret.

`hasOpticsHolderPosition()`

Checks whether the optional OpticsHolderPosition attribute is present.

This field records the position of this Optical Aperture in a Optics Turret.

Returns:

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

`setOuterDiameter(value)`

Sets the value of the OuterDiameter attribute.

This field captures the physical outer diameter of the component

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required

`getOuterDiameter()`

Returns the value of the OuterDiameter attribute.

This field captures the physical outer diameter of the component

Returns:

Type	Description
`float`	The value of the attribute

`resetOuterDiameter()`

Resets the OuterDiameter attribute to an unset state.

This field captures the physical outer diameter of the component

`hasOuterDiameter()`

Checks whether the optional OuterDiameter attribute is present.

This field captures the physical outer diameter of the component

Returns:

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