Arc¶
Bases: LightSource_Type
Represents the XML element Arc.
An Arc lamp is a discharge lamp that produces light by an electric arc (also called a voltaic arc), which is typically generated between metal electrodes and travels through an inert gas in a glass bulb. The inert gas can be Mercury (He), Xenon (Xe), or a mixture of the two. The choice of the gas is important because its nature determines the spectral behavior of the lamp. Refer to Type for more informations about this aspect.
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 |
|---|---|
Arc
|
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 |
setType(value, validate=True)
¶
Sets the value of the Type attribute.
This field records the inert gas vapor contained in the Arc lamp bulb. The nature of the gas determines the spectral behavior of the lamp. At low pressure, Hg lamps emit a characteristic line spectrum, which becomes more uniform as the lamp heats up. On the other hand, Xe lamps emit light of high luminance, high color temperature, and an almost continuous spectrum distributed from the ultraviolet to the infrared.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ArcType_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getType()
¶
Returns the value of the Type attribute.
This field records the inert gas vapor contained in the Arc lamp bulb. The nature of the gas determines the spectral behavior of the lamp. At low pressure, Hg lamps emit a characteristic line spectrum, which becomes more uniform as the lamp heats up. On the other hand, Xe lamps emit light of high luminance, high color temperature, and an almost continuous spectrum distributed from the ultraviolet to the infrared.
Returns:
| Type | Description |
|---|---|
ArcType_Type
|
The value of the attribute |
resetType()
¶
Resets the Type attribute to an unset state.
This field records the inert gas vapor contained in the Arc lamp bulb. The nature of the gas determines the spectral behavior of the lamp. At low pressure, Hg lamps emit a characteristic line spectrum, which becomes more uniform as the lamp heats up. On the other hand, Xe lamps emit light of high luminance, high color temperature, and an almost continuous spectrum distributed from the ultraviolet to the infrared.
hasType()
¶
Checks whether the optional Type attribute is present.
This field records the inert gas vapor contained in the Arc lamp bulb. The nature of the gas determines the spectral behavior of the lamp. At low pressure, Hg lamps emit a characteristic line spectrum, which becomes more uniform as the lamp heats up. On the other hand, Xe lamps emit light of high luminance, high color temperature, and an almost continuous spectrum distributed from the ultraviolet to the infrared.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setIlluminationWavelengthRange_List(value, validate=True)
¶
Sets the list of IlluminationWavelengthRange elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[IlluminationWavelengthRange]
|
The new list of IlluminationWavelengthRange elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getIlluminationWavelengthRange_List()
¶
Returns the list of IlluminationWavelengthRange elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[IlluminationWavelengthRange]
|
The list of IlluminationWavelengthRange elements |
addToIlluminationWavelengthRange_List(value, validate=True)
¶
Adds a new IlluminationWavelengthRange element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
IlluminationWavelengthRange
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearIlluminationWavelengthRange_List()
¶
Clear the list of IlluminationWavelengthRange.
No description available in the XSD standard.