ElectroOpticalDeviceSettings_Type¶
Bases: Settings_Type
Represents the XML complex type ElectroOpticalDeviceSettings.
This element refers to the Electro-Optical Device used to acquire this image and it holds the settings that were applied to it 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 |
|---|---|
ElectroOpticalDeviceSettings_Type
|
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
|
ElectroOpticalDeviceID_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 |
|---|---|
ElectroOpticalDeviceID_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 |
setTransmittanceProfileFile_List(value, validate=True)
¶
Sets the list of TransmittanceProfileFile elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[TransmittanceProfileFile]
|
The new list of TransmittanceProfileFile elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getTransmittanceProfileFile_List()
¶
Returns the list of TransmittanceProfileFile elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[TransmittanceProfileFile]
|
The list of TransmittanceProfileFile elements |
addToTransmittanceProfileFile_List(value, validate=True)
¶
Adds a new TransmittanceProfileFile element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
TransmittanceProfileFile
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearTransmittanceProfileFile_List()
¶
Clear the list of TransmittanceProfileFile.
No description available in the XSD standard.
setReflectanceProfileFile_List(value, validate=True)
¶
Sets the list of ReflectanceProfileFile elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[ReflectanceProfileFile]
|
The new list of ReflectanceProfileFile elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getReflectanceProfileFile_List()
¶
Returns the list of ReflectanceProfileFile elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[ReflectanceProfileFile]
|
The list of ReflectanceProfileFile elements |
addToReflectanceProfileFile_List(value, validate=True)
¶
Adds a new ReflectanceProfileFile element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ReflectanceProfileFile
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearReflectanceProfileFile_List()
¶
Clear the list of ReflectanceProfileFile.
No description available in the XSD standard.
setTransmissionWavelengthRangeSettings_List(value, validate=True)
¶
Sets the list of TransmissionWavelengthRangeSettings elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[TransmissionWavelengthRangeSettings]
|
The new list of TransmissionWavelengthRangeSettings elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getTransmissionWavelengthRangeSettings_List()
¶
Returns the list of TransmissionWavelengthRangeSettings elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[TransmissionWavelengthRangeSettings]
|
The list of TransmissionWavelengthRangeSettings elements |
addToTransmissionWavelengthRangeSettings_List(value, validate=True)
¶
Adds a new TransmissionWavelengthRangeSettings element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
TransmissionWavelengthRangeSettings
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearTransmissionWavelengthRangeSettings_List()
¶
Clear the list of TransmissionWavelengthRangeSettings.
No description available in the XSD standard.
setReflectionWavelengthRangeSettings_List(value, validate=True)
¶
Sets the list of ReflectionWavelengthRangeSettings elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[ReflectionWavelengthRangeSettings]
|
The new list of ReflectionWavelengthRangeSettings elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getReflectionWavelengthRangeSettings_List()
¶
Returns the list of ReflectionWavelengthRangeSettings elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[ReflectionWavelengthRangeSettings]
|
The list of ReflectionWavelengthRangeSettings elements |
addToReflectionWavelengthRangeSettings_List(value, validate=True)
¶
Adds a new ReflectionWavelengthRangeSettings element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ReflectionWavelengthRangeSettings
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearReflectionWavelengthRangeSettings_List()
¶
Clear the list of ReflectionWavelengthRangeSettings.
No description available in the XSD standard.