MultiLaserEngine

Bases: LightSource_Type

Represents the XML element MultiLaserEngine.

This element describes a Light Source device that contains multiple Lasers built into a single box. This element contains Reference(s) to individual Laser components built separately and assembled as part of this device.

`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

`setSingleMode(value)`

Sets the value of the SingleMode attribute.

Whether the output mode of this Multi Laser Engine is single-mode (True) or multi-mode (False).

Parameters:

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

`getSingleMode()`

Returns the value of the SingleMode attribute.

Whether the output mode of this Multi Laser Engine is single-mode (True) or multi-mode (False).

Returns:

Type	Description
`boolean`	The value of the attribute

`resetSingleMode()`

Resets the SingleMode attribute to an unset state.

Whether the output mode of this Multi Laser Engine is single-mode (True) or multi-mode (False).

`hasSingleMode()`

Checks whether the optional SingleMode attribute is present.

Whether the output mode of this Multi Laser Engine is single-mode (True) or multi-mode (False).

Returns:

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

`setNumberOfLasers(value)`

Sets the value of the NumberOfLasers attribute.

This field records the number of Laser lines associated with this Multi Laser Engine.

Parameters:

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

`getNumberOfLasers()`

Returns the value of the NumberOfLasers attribute.

This field records the number of Laser lines associated with this Multi Laser Engine.

Returns:

Type	Description
`int`	The value of the attribute

`resetNumberOfLasers()`

Resets the NumberOfLasers attribute to an unset state.

This field records the number of Laser lines associated with this Multi Laser Engine.

`hasNumberOfLasers()`

Checks whether the optional NumberOfLasers attribute is present.

This field records the number of Laser lines associated with this Multi Laser Engine.

Returns:

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

`setOutputPortNumber(value)`

Sets the value of the OutputPortNumber attribute.

This field records the number of Light Guide ports used as output by this Multi Laser Engine.

Parameters:

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

`getOutputPortNumber()`

Returns the value of the OutputPortNumber attribute.

This field records the number of Light Guide ports used as output by this Multi Laser Engine.

Returns:

Type	Description
`int`	The value of the attribute

`resetOutputPortNumber()`

Resets the OutputPortNumber attribute to an unset state.

This field records the number of Light Guide ports used as output by this Multi Laser Engine.

`hasOutputPortNumber()`

Checks whether the optional OutputPortNumber attribute is present.

This field records the number of Light Guide ports used as output by this Multi Laser Engine.

Returns:

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

`setMultiportSwitchTime(value)`

Sets the value of the MultiportSwitchTime attribute.

This field records the time it takes for this Multi Laser Engine to switch between Laser lines.

Parameters:

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

`getMultiportSwitchTime()`

Returns the value of the MultiportSwitchTime attribute.

This field records the time it takes for this Multi Laser Engine to switch between Laser lines.

Returns:

Type	Description
`float`	The value of the attribute

`resetMultiportSwitchTime()`

Resets the MultiportSwitchTime attribute to an unset state.

This field records the time it takes for this Multi Laser Engine to switch between Laser lines.

`hasMultiportSwitchTime()`

Checks whether the optional MultiportSwitchTime attribute is present.

This field records the time it takes for this Multi Laser Engine to switch between Laser lines.

Returns:

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