MicroscopeTableSettings¶
Bases: Settings_Type
Represents the XML element MicroscopeTableSettings.
This element refers to the MicroscopeTable used to support the Microscope used to acquire this Image and holds the settings that were applied to the Microscope during this Acquisition.
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 |
|---|---|
MicroscopeTableSettings
|
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 |
setID(value, validate=True)
¶
Sets the value of the ID attribute.
This is the Unique Identifier of the Microscope Table used in this case.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
MicroscopeTableID_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getID()
¶
Returns the value of the ID attribute.
This is the Unique Identifier of the Microscope Table used in this case.
Returns:
| Type | Description |
|---|---|
MicroscopeTableID_Type
|
The value of the attribute |
resetID()
¶
Resets the ID attribute to an unset state.
This is the Unique Identifier of the Microscope Table used in this case.
hasID()
¶
Checks whether the optional ID attribute is present.
This is the Unique Identifier of the Microscope Table used in this case.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setFloating(value, validate=True)
¶
Sets the value of the Floating attribute.
This field recods whether the Microscope Table was Floating (True) or not (False) during the acquistion of this Image.
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
|
getFloating()
¶
Returns the value of the Floating attribute.
This field recods whether the Microscope Table was Floating (True) or not (False) during the acquistion of this Image.
Returns:
| Type | Description |
|---|---|
boolean
|
The value of the attribute |
resetFloating()
¶
Resets the Floating attribute to an unset state.
This field recods whether the Microscope Table was Floating (True) or not (False) during the acquistion of this Image.
hasFloating()
¶
Checks whether the Floating attribute is present.
This field recods whether the Microscope Table was Floating (True) or not (False) during the acquistion of this Image.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |