LiquidCrystalTuneableFilter

Bases: ElectroOpticalDevice_Type

Represents the XML element LiquidCrystalTuneableFilter.

This element describes a liquid crystal tunable filter (LCTF) is an optical filter that uses electronically controlled liquid crystal (LC) elements to transmit a selectable wavelength of light and exclude others.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

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

Returns:

Type	Description
LiquidCrystalTuneableFilter	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

setSelectableBandwidth(value, validate=True)

Sets the value of the SelectableBandwidth attribute.

This field indicates whether the bandwidth of this tuneable filter can be selected (True) or it is fixed (False).

Parameters:

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

getSelectableBandwidth()

Returns the value of the SelectableBandwidth attribute.

This field indicates whether the bandwidth of this tuneable filter can be selected (True) or it is fixed (False).

Returns:

Type	Description
boolean	The value of the attribute

resetSelectableBandwidth()

Resets the SelectableBandwidth attribute to an unset state.

This field indicates whether the bandwidth of this tuneable filter can be selected (True) or it is fixed (False).

hasSelectableBandwidth()

Checks whether the SelectableBandwidth attribute is present.

This field indicates whether the bandwidth of this tuneable filter can be selected (True) or it is fixed (False).

Returns:

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

setMaximumPower(value, validate=True)

Sets the value of the MaximumPower attribute.

This field describes the maximum Power this device can tolerate (typically expressed in Joules).

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

getMaximumPower()

Returns the value of the MaximumPower attribute.

This field describes the maximum Power this device can tolerate (typically expressed in Joules).

Returns:

Type	Description
float	The value of the attribute

resetMaximumPower()

Resets the MaximumPower attribute to an unset state.

This field describes the maximum Power this device can tolerate (typically expressed in Joules).

hasMaximumPower()

Checks whether the MaximumPower attribute is present.

This field describes the maximum Power this device can tolerate (typically expressed in Joules).

Returns:

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

setMaximumPowerUnit(value, validate=True)

Sets the value of the MaximumPowerUnit attribute.

No description available in the XSD standard.

Parameters:

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

getMaximumPowerUnit()

Returns the value of the MaximumPowerUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsPower_Type	The value of the attribute

resetMaximumPowerUnit()

Resets the MaximumPowerUnit attribute to an unset state.

No description available in the XSD standard.

hasMaximumPowerUnit()

Checks whether the optional MaximumPowerUnit attribute is present.

No description available in the XSD standard.

Returns:

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