com.inscoper.nbo.PockelsCell¶

Represents the XML element PockelsCell. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	PockelsCell()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setHalfWaveVoltage(float value, boolean validate) Sets the value of the HalfWaveVoltage attribute.
void	setHalfWaveVoltage(float value) Sets the value of the HalfWaveVoltage attribute.
float	getHalfWaveVoltage() Returns the value of the HalfWaveVoltage attribute.
void	resetHalfWaveVoltage() Resets the HalfWaveVoltage attribute to an unset state.
boolean	hasHalfWaveVoltage() Checks whether the HalfWaveVoltage attribute is present.
void	setHalfWaveVoltageUnit(UnitsElectricPotential_Type value, boolean validate) Sets the value of the HalfWaveVoltageUnit attribute.
void	setHalfWaveVoltageUnit(UnitsElectricPotential_Type value) Sets the value of the HalfWaveVoltageUnit attribute.
UnitsElectricPotential_Type	getHalfWaveVoltageUnit() Returns the value of the HalfWaveVoltageUnit attribute.
void	resetHalfWaveVoltageUnit() Resets the HalfWaveVoltageUnit attribute to an unset state.
boolean	hasHalfWaveVoltageUnit() Checks whether the optional HalfWaveVoltageUnit attribute is present.
void	setMaterial(PockelsCellMaterial_Type value, boolean validate) Sets the value of the Material attribute.
void	setMaterial(PockelsCellMaterial_Type value) Sets the value of the Material attribute.
PockelsCellMaterial_Type	getMaterial() Returns the value of the Material attribute.
void	resetMaterial() Resets the Material attribute to an unset state.
boolean	hasMaterial() Checks whether the optional Material attribute is present.
PockelsCell	__internal_create(long cPtr, boolean own)
PockelsCell	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a PockelsCell.

Protected Functions¶

	Name
	PockelsCell(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(PockelsCell obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.PockelsCell;

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.

Public Functions Documentation¶

function delete¶

function PockelsCell¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

public NBOBaseClassVector getSubElements()

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

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonFile¶

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function toXmlString¶

function setHalfWaveVoltage¶

public void setHalfWaveVoltage(
    float value,
    boolean validate
)

Sets the value of the HalfWaveVoltage attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setHalfWaveVoltage¶

public void setHalfWaveVoltage(
    float value
)

Sets the value of the HalfWaveVoltage attribute.

Parameters:

value The value to set

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.

function getHalfWaveVoltage¶

public float getHalfWaveVoltage()

Returns the value of the HalfWaveVoltage attribute.

Return: The value of the 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.

function resetHalfWaveVoltage¶

public void resetHalfWaveVoltage()

Resets the HalfWaveVoltage attribute to an unset state.

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.

function hasHalfWaveVoltage¶

public boolean hasHalfWaveVoltage()

Checks whether the HalfWaveVoltage attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setHalfWaveVoltageUnit¶

public void setHalfWaveVoltageUnit(
    UnitsElectricPotential_Type value,
    boolean validate
)

Sets the value of the HalfWaveVoltageUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setHalfWaveVoltageUnit¶

public void setHalfWaveVoltageUnit(
    UnitsElectricPotential_Type value
)

Sets the value of the HalfWaveVoltageUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getHalfWaveVoltageUnit¶

public UnitsElectricPotential_Type getHalfWaveVoltageUnit()

Returns the value of the HalfWaveVoltageUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetHalfWaveVoltageUnit¶

function hasHalfWaveVoltageUnit¶

public boolean hasHalfWaveVoltageUnit()

Checks whether the optional HalfWaveVoltageUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMaterial¶

public void setMaterial(
    PockelsCellMaterial_Type value,
    boolean validate
)

Sets the value of the Material attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setMaterial¶

public void setMaterial(
    PockelsCellMaterial_Type value
)

Sets the value of the Material attribute.

Parameters:

value The value to set

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

function getMaterial¶

public PockelsCellMaterial_Type getMaterial()

Returns the value of the Material attribute.

Return: The value of the attribute

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

function resetMaterial¶

function hasMaterial¶

public boolean hasMaterial()

Checks whether the optional Material attribute is present.

Return: true if the optional attribute has been set, false otherwise

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

function __internal_create¶

function fromBase¶

public static PockelsCell fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a PockelsCell.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

com.inscoper.nbo.PockelsCell¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function PockelsCell¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonFile¶

function fromJsonString¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlFile¶

function fromXmlString¶

function fromXmlString¶

function toXmlFile¶

function toXmlFile¶

function toXmlString¶

function toXmlString¶

function setHalfWaveVoltage¶

function setHalfWaveVoltage¶

function getHalfWaveVoltage¶

function resetHalfWaveVoltage¶

function hasHalfWaveVoltage¶

function setHalfWaveVoltageUnit¶

function setHalfWaveVoltageUnit¶

function getHalfWaveVoltageUnit¶

function resetHalfWaveVoltageUnit¶

function hasHalfWaveVoltageUnit¶

function setMaterial¶

function setMaterial¶

function getMaterial¶

function resetMaterial¶

function hasMaterial¶

function __internal_create¶

function fromBase¶

Protected Functions Documentation¶

function PockelsCell¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶