MicroscopeTable

Bases: ManufacturerSpec_Type

Represents the XML element MicroscopeTable.

This element describes the Table used to support this Instrument during Image Acquisition.

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.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	LSID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
LSID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

setName(value)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	The value to set	required

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

setMultipleMicroscopes(value)

Sets the value of the MultipleMicroscopes attribute.

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getMultipleMicroscopes()

Returns the value of the MultipleMicroscopes attribute.

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

Returns:

Type	Description
boolean	The value of the attribute

resetMultipleMicroscopes()

Resets the MultipleMicroscopes attribute to an unset state.

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

hasMultipleMicroscopes()

Checks whether the optional MultipleMicroscopes attribute is present.

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

Returns:

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

setType(value)

Sets the value of the Type attribute.

This field describes the type of this Microscope Table.

Parameters:

Name	Type	Description	Default
value	MicroscopeTableType_Type	The value to set	required

getType()

Returns the value of the Type attribute.

This field describes the type of this Microscope Table.

Returns:

Type	Description
MicroscopeTableType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field describes the type of this Microscope Table.

hasType()

Checks whether the optional Type attribute is present.

This field describes the type of this Microscope Table.

Returns:

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

setTableWidth(value)

Sets the value of the TableWidth attribute.

The Width of this Microscope Table.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getTableWidth()

Returns the value of the TableWidth attribute.

The Width of this Microscope Table.

Returns:

Type	Description
float	The value of the attribute

resetTableWidth()

Resets the TableWidth attribute to an unset state.

The Width of this Microscope Table.

hasTableWidth()

Checks whether the optional TableWidth attribute is present.

The Width of this Microscope Table.

Returns:

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

setTableWidthUnit(value)

Sets the value of the TableWidthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getTableWidthUnit()

Returns the value of the TableWidthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetTableWidthUnit()

Resets the TableWidthUnit attribute to an unset state.

No description available in the XSD standard.

hasTableWidthUnit()

Checks whether the optional TableWidthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setTableDepth(value)

Sets the value of the TableDepth attribute.

The Depth of this Microscope Table.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getTableDepth()

Returns the value of the TableDepth attribute.

The Depth of this Microscope Table.

Returns:

Type	Description
float	The value of the attribute

resetTableDepth()

Resets the TableDepth attribute to an unset state.

The Depth of this Microscope Table.

hasTableDepth()

Checks whether the optional TableDepth attribute is present.

The Depth of this Microscope Table.

Returns:

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

setTableDepthUnit(value)

Sets the value of the TableDepthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getTableDepthUnit()

Returns the value of the TableDepthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetTableDepthUnit()

Resets the TableDepthUnit attribute to an unset state.

No description available in the XSD standard.

hasTableDepthUnit()

Checks whether the optional TableDepthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setAnnotationRef(value)

Sets the value of the AnnotationRef element.

This is a simple multi-line comment or annotation describing this component.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The value to set	required

getAnnotationRef()

Returns the value of the AnnotationRef element.

This is a simple multi-line comment or annotation describing this component.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

This is a simple multi-line comment or annotation describing this component.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

This is a simple multi-line comment or annotation describing this component.

Returns:

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