WavelengthRangeType_Type¶
Bases: NBOBaseClass
Represents the XML complex type WavelengthRangeType.
This field records the nominal Wavelength associated with the peak response rate of this device.
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 |
|---|---|
WavelengthRangeType_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 |
setPeakWavelength(value, validate=True)
¶
Sets the value of the PeakWavelength attribute.
This field records the nominal Wavelength associated with the peak response rate of this device.
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
|
getPeakWavelength()
¶
Returns the value of the PeakWavelength attribute.
This field records the nominal Wavelength associated with the peak response rate of this device.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetPeakWavelength()
¶
Resets the PeakWavelength attribute to an unset state.
This field records the nominal Wavelength associated with the peak response rate of this device.
hasPeakWavelength()
¶
Checks whether the PeakWavelength attribute is present.
This field records the nominal Wavelength associated with the peak response rate of this device.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |
setPeakWavelengthUnit(value, validate=True)
¶
Sets the value of the PeakWavelengthUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getPeakWavelengthUnit()
¶
Returns the value of the PeakWavelengthUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetPeakWavelengthUnit()
¶
Resets the PeakWavelengthUnit attribute to an unset state.
No description available in the XSD standard.
hasPeakWavelengthUnit()
¶
Checks whether the optional PeakWavelengthUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setCutOn(value, validate=True)
¶
Sets the value of the CutOn attribute.
CutOn is the Wavelength below which the response rate is below 50%. In case a CutOn Wavelength is not available, such as in the case of a ShortPass or Notch configuration, please enter 000.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PositiveFloat_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getCutOn()
¶
Returns the value of the CutOn attribute.
CutOn is the Wavelength below which the response rate is below 50%. In case a CutOn Wavelength is not available, such as in the case of a ShortPass or Notch configuration, please enter 000.
Returns:
| Type | Description |
|---|---|
PositiveFloat_Type
|
The value of the attribute |
resetCutOn()
¶
Resets the CutOn attribute to an unset state.
CutOn is the Wavelength below which the response rate is below 50%. In case a CutOn Wavelength is not available, such as in the case of a ShortPass or Notch configuration, please enter 000.
hasCutOn()
¶
Checks whether the optional CutOn attribute is present.
CutOn is the Wavelength below which the response rate is below 50%. In case a CutOn Wavelength is not available, such as in the case of a ShortPass or Notch configuration, please enter 000.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setCutOnUnit(value, validate=True)
¶
Sets the value of the CutOnUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getCutOnUnit()
¶
Returns the value of the CutOnUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetCutOnUnit()
¶
Resets the CutOnUnit attribute to an unset state.
No description available in the XSD standard.
hasCutOnUnit()
¶
Checks whether the optional CutOnUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setCutOff(value, validate=True)
¶
Sets the value of the CutOff attribute.
CutOff is the Wavelength above which the response rate is below 50%. In case a CutOff Wavelength is not available, such as in the case of a LongPass configuration, please enter 000.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PositiveFloat_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getCutOff()
¶
Returns the value of the CutOff attribute.
CutOff is the Wavelength above which the response rate is below 50%. In case a CutOff Wavelength is not available, such as in the case of a LongPass configuration, please enter 000.
Returns:
| Type | Description |
|---|---|
PositiveFloat_Type
|
The value of the attribute |
resetCutOff()
¶
Resets the CutOff attribute to an unset state.
CutOff is the Wavelength above which the response rate is below 50%. In case a CutOff Wavelength is not available, such as in the case of a LongPass configuration, please enter 000.
hasCutOff()
¶
Checks whether the optional CutOff attribute is present.
CutOff is the Wavelength above which the response rate is below 50%. In case a CutOff Wavelength is not available, such as in the case of a LongPass configuration, please enter 000.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setCutOffUnit(value, validate=True)
¶
Sets the value of the CutOffUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getCutOffUnit()
¶
Returns the value of the CutOffUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetCutOffUnit()
¶
Resets the CutOffUnit attribute to an unset state.
No description available in the XSD standard.
hasCutOffUnit()
¶
Checks whether the optional CutOffUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setWavelengthProfileFile_List(value, validate=True)
¶
Sets the list of WavelengthProfileFile elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[WavelengthProfileFile]
|
The new list of WavelengthProfileFile elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getWavelengthProfileFile_List()
¶
Returns the list of WavelengthProfileFile elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[WavelengthProfileFile]
|
The list of WavelengthProfileFile elements |
addToWavelengthProfileFile_List(value, validate=True)
¶
Adds a new WavelengthProfileFile element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
WavelengthProfileFile
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearWavelengthProfileFile_List()
¶
Clear the list of WavelengthProfileFile.
No description available in the XSD standard.