DiffractionGratingSettings

Bases: OpticalApertureSettings_Type

Represents the XML element DiffractionGratingSettings.

This element holds the Setting applied to a Diffraction Grating used during the Acquisition of this Channel as well as a reference (the ID attribute) to the Diffraction Grating in question.

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

setDiffractionEfficiency(value)

Sets the value of the DiffractionEfficiency attribute.

This is a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.

Parameters:

Name	Type	Description	Default
value	PercentFraction_Type	The value to set	required

getDiffractionEfficiency()

Returns the value of the DiffractionEfficiency attribute.

This is a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.

Returns:

Type	Description
PercentFraction_Type	The value of the attribute

resetDiffractionEfficiency()

Resets the DiffractionEfficiency attribute to an unset state.

This is a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.

hasDiffractionEfficiency()

Checks whether the optional DiffractionEfficiency attribute is present.

This is a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.

Returns:

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