IndividualObjectiveFocusing

Bases: FocusingDevice_Type

Represents the XML element IndividualObjectiveFocusing.

A Focusing mechanism is used to obtain maximum sharpness in an Image by changing the distance between a Sample and the optical system forming the Image. In most cases, a Z-axis Focusing mechanism moves the Objective along the optical axis. This element describes an optional objective nano-Focusing Device associated with this Instrument. These devices might be driven using piezoelectric mechanisms or linear motor actuators associated with crossed roller guideways. They typically achieve higher precision, accuracy, and speed than traditional Focusing Devices.

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

setPiezoElectric(value, validate=True)

Sets the value of the PiezoElectric attribute.

This field describes whether this device is Piezoelectric driven (True) or not (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

getPiezoElectric()

Returns the value of the PiezoElectric attribute.

This field describes whether this device is Piezoelectric driven (True) or not (False).

Returns:

Type	Description
boolean	The value of the attribute

resetPiezoElectric()

Resets the PiezoElectric attribute to an unset state.

This field describes whether this device is Piezoelectric driven (True) or not (False).

hasPiezoElectric()

Checks whether the PiezoElectric attribute is present.

This field describes whether this device is Piezoelectric driven (True) or not (False).

Returns:

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