PockelsCell¶

Bases: NBOBaseClass

Represents the XML element PockelsCell.

Pockels cells are the basic components of electro-optic modulators. A Pockels cell is a device consisting of an electro-optic crystal (with some electrodes attached to it) through which a light beam can propagate. The phase delay in the crystal (→ Pockels effect) can be modulated by applying a variable electric voltage. The Pockels cell thus acts as a voltage-controlled waveplate.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a PockelsCell.

Parameters:

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

Returns:

Type	Description
`PockelsCell`	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

`setHalfWaveVoltage(value, validate=True)` ¶

Sets the value of the HalfWaveVoltage attribute.

This field record the Voltage required for inducing a phase change equivalent to a half an optical wavelength. In an amplitude modulator, the applied voltage has to be changed by this value in order to go from the operation point with minimum transmission to that with maximum transmission. The HalfWaveVoltage can be referred to as, Uπ, Uλ/2 or Vλ/2.

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`

`getHalfWaveVoltage()` ¶

Returns the value of the HalfWaveVoltage attribute.

This field record the Voltage required for inducing a phase change equivalent to a half an optical wavelength. In an amplitude modulator, the applied voltage has to be changed by this value in order to go from the operation point with minimum transmission to that with maximum transmission. The HalfWaveVoltage can be referred to as, Uπ, Uλ/2 or Vλ/2.

Returns:

Type	Description
`float`	The value of the attribute

`resetHalfWaveVoltage()` ¶

`hasHalfWaveVoltage()` ¶

Checks whether the HalfWaveVoltage attribute is present.

This field record the Voltage required for inducing a phase change equivalent to a half an optical wavelength. In an amplitude modulator, the applied voltage has to be changed by this value in order to go from the operation point with minimum transmission to that with maximum transmission. The HalfWaveVoltage can be referred to as, Uπ, Uλ/2 or Vλ/2.

Returns:

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

`setHalfWaveVoltageUnit(value, validate=True)` ¶

Sets the value of the HalfWaveVoltageUnit attribute.

No description available in the XSD standard.

Parameters:

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

`getHalfWaveVoltageUnit()` ¶

Returns the value of the HalfWaveVoltageUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
`UnitsElectricPotential_Type`	The value of the attribute

`resetHalfWaveVoltageUnit()` ¶

`hasHalfWaveVoltageUnit()` ¶

Checks whether the optional HalfWaveVoltageUnit attribute is present.

No description available in the XSD standard.

Returns:

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

`setMaterial(value, validate=True)` ¶

Sets the value of the Material attribute.

This field describes the nonlinear crystal materials used to contruct this Pockels cell.

Parameters:

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

`getMaterial()` ¶

Returns the value of the Material attribute.

This field describes the nonlinear crystal materials used to contruct this Pockels cell.

Returns:

Type	Description
`PockelsCellMaterial_Type`	The value of the attribute

`resetMaterial()` ¶

`hasMaterial()` ¶

Checks whether the optional Material attribute is present.

This field describes the nonlinear crystal materials used to contruct this Pockels cell.

Returns:

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

PockelsCell¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

fromJsonFile(path, validate=True) ¶

fromJsonString(json_string, validate=True) ¶

fromXmlFile(path, validate=True) ¶

fromXmlString(xml_string, validate=True) ¶

toXmlFile(filename, validate=True) ¶

toXmlString(validate=True) ¶

setHalfWaveVoltage(value, validate=True) ¶

getHalfWaveVoltage() ¶

resetHalfWaveVoltage() ¶

hasHalfWaveVoltage() ¶

setHalfWaveVoltageUnit(value, validate=True) ¶

getHalfWaveVoltageUnit() ¶

resetHalfWaveVoltageUnit() ¶

hasHalfWaveVoltageUnit() ¶

setMaterial(value, validate=True) ¶

getMaterial() ¶

resetMaterial() ¶

hasMaterial() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`fromJsonFile(path, validate=True)` ¶

`fromJsonString(json_string, validate=True)` ¶

`fromXmlFile(path, validate=True)` ¶

`fromXmlString(xml_string, validate=True)` ¶

`toXmlFile(filename, validate=True)` ¶

`toXmlString(validate=True)` ¶

`setHalfWaveVoltage(value, validate=True)` ¶

`getHalfWaveVoltage()` ¶

`resetHalfWaveVoltage()` ¶

`hasHalfWaveVoltage()` ¶

`setHalfWaveVoltageUnit(value, validate=True)` ¶

`getHalfWaveVoltageUnit()` ¶

`resetHalfWaveVoltageUnit()` ¶

`hasHalfWaveVoltageUnit()` ¶

`setMaterial(value, validate=True)` ¶

`getMaterial()` ¶

`resetMaterial()` ¶

`hasMaterial()` ¶