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) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setHalfWaveVoltage(float value) Sets the value of the HalfWaveVoltage attribute.
float	getHalfWaveVoltage() Returns the value of the HalfWaveVoltage 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) 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)

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

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function PockelsCell

public PockelsCell()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.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
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

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 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

public void resetHalfWaveVoltageUnit()

Resets the HalfWaveVoltageUnit attribute to an unset state.

No description available in the XSD standard.

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
)

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

public void resetMaterial()

Resets the Material attribute to an unset state.

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

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

public static PockelsCell __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Protected Functions Documentation

function PockelsCell

protected PockelsCell(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr

protected static long getCPtr(
    PockelsCell obj
)

Updated on 2026-02-13 at 16:11:05 +0100