SpinningDisk

Bases: ConfocalScanner_Type

Represents the XML element SpinningDisk.

A Spinning disk confocal scanner is a device in which the scanning of the illuminated and detected spots is performed simultaneously using an opaque disk called a Nipkow disk, which has many ideally identical small holes arranged in Archimedean spirals. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

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

setSingleDisk(value, validate=True)

Sets the value of the SingleDisk attribute.

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

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

getSingleDisk()

Returns the value of the SingleDisk attribute.

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

Returns:

Type	Description
boolean	The value of the attribute

resetSingleDisk()

Resets the SingleDisk attribute to an unset state.

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

hasSingleDisk()

Checks whether the SingleDisk attribute is present.

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

Returns:

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

setDiskSpeed(value, validate=True)

Sets the value of the DiskSpeed attribute.

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

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

getDiskSpeed()

Returns the value of the DiskSpeed attribute.

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

Returns:

Type	Description
float	The value of the attribute

resetDiskSpeed()

Resets the DiskSpeed attribute to an unset state.

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

hasDiskSpeed()

Checks whether the DiskSpeed attribute is present.

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

Returns:

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

setDiskSpeedUnit(value, validate=True)

Sets the value of the DiskSpeedUnit attribute.

No description available in the XSD standard.

Parameters:

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

getDiskSpeedUnit()

Returns the value of the DiskSpeedUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsVelocity_Type	The value of the attribute

resetDiskSpeedUnit()

Resets the DiskSpeedUnit attribute to an unset state.

No description available in the XSD standard.

hasDiskSpeedUnit()

Checks whether the optional DiskSpeedUnit attribute is present.

No description available in the XSD standard.

Returns:

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