MirroringDeviceSettings¶
Bases: Settings_Type
Represents the XML element MirroringDeviceSettings.
This element holds the Setting applied to a Mirror used in the Light Path during the acquisition of this Channel as well as a reference (the ID attribute) to the Mirror in question.
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 |
|---|---|
MirroringDeviceSettings
|
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 device used in this case.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
MirrorID_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 device used in this case.
Returns:
| Type | Description |
|---|---|
MirrorID_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 |
setActualMountedAngle(value, validate=True)
¶
Sets the value of the ActualMountedAngle attribute.
This field records the Angle at which this mirror was mounted during the Acqusition of this Channel with respect to the optical axis.
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
|
getActualMountedAngle()
¶
Returns the value of the ActualMountedAngle attribute.
This field records the Angle at which this mirror was mounted during the Acqusition of this Channel with respect to the optical axis.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetActualMountedAngle()
¶
Resets the ActualMountedAngle attribute to an unset state.
This field records the Angle at which this mirror was mounted during the Acqusition of this Channel with respect to the optical axis.
hasActualMountedAngle()
¶
Checks whether the ActualMountedAngle attribute is present.
This field records the Angle at which this mirror was mounted during the Acqusition of this Channel with respect to the optical axis.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |