LensSettings

Bases: Settings_Type

Represents the XML element LensSettings.

This element holds the Setting applied to a Lens used in the Light Path during the acquisition of this Channel as well as a reference (the ID attribute) to the Lens 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

setID(value)

Sets the value of the ID attribute.

This is the Unique Identifier of the device used in this case.

Parameters:

Name	Type	Description	Default
value	LensID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

This is the Unique Identifier of the device used in this case.

Returns:

Type	Description
LensID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the device used in this case.

hasID()

Checks whether the optional ID attribute is present.

This is the Unique Identifier of the device used in this case.

Returns:

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

setFunction(value)

Sets the value of the Function attribute.

This field records the purpose for which this Additinal Lens was used during the Acquisition of this Channel.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getFunction()

Returns the value of the Function attribute.

This field records the purpose for which this Additinal Lens was used during the Acquisition of this Channel.

Returns:

Type	Description
string	The value of the attribute