Filament¶

Bases: LightSource_Type

Represents the XML element Filament.

A Filament lamp is an incandescent Light Source with a wire filament (usually tungsten), which is heated by the passage of an electric current to such a high temperature that it glows with visible light (incandescence). The emitted spectrum is continuous, and it approximates that of a black-body radiator.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a Filament.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`Filament`	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 type of Filament lamp Light Source. A Halogen lamp is a Filament lamp whose envelope contains halogen vapor, which reduces the loss of tungsten from the filament. This, in turn, allows to reach a high filament temperature and consequent higher luminance, higher color temperature, and longer operating life than a Standard Filament lamp of the same input power.

Parameters:

Name	Type	Description	Default
`value`	`FilamentType_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 type of Filament lamp Light Source. A Halogen lamp is a Filament lamp whose envelope contains halogen vapor, which reduces the loss of tungsten from the filament. This, in turn, allows to reach a high filament temperature and consequent higher luminance, higher color temperature, and longer operating life than a Standard Filament lamp of the same input power.

Returns:

Type	Description
`FilamentType_Type`	The value of the attribute

`resetType()` ¶

`hasType()` ¶

Checks whether the optional Type attribute is present.

This field records the type of Filament lamp Light Source. A Halogen lamp is a Filament lamp whose envelope contains halogen vapor, which reduces the loss of tungsten from the filament. This, in turn, allows to reach a high filament temperature and consequent higher luminance, higher color temperature, and longer operating life than a Standard Filament lamp of the same input power.

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`

Filament¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

fromJsonFile(path, validate=True) ¶

fromJsonString(json_string, validate=True) ¶

fromXmlFile(path, validate=True) ¶

fromXmlString(xml_string, validate=True) ¶

toXmlFile(filename, validate=True) ¶

toXmlString(validate=True) ¶

setType(value, validate=True) ¶

getType() ¶

resetType() ¶

hasType() ¶

setIlluminationWavelengthRange_List(value, validate=True) ¶

getIlluminationWavelengthRange_List() ¶

addToIlluminationWavelengthRange_List(value, validate=True) ¶

clearIlluminationWavelengthRange_List() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`fromJsonFile(path, validate=True)` ¶

`fromJsonString(json_string, validate=True)` ¶

`fromXmlFile(path, validate=True)` ¶

`fromXmlString(xml_string, validate=True)` ¶

`toXmlFile(filename, validate=True)` ¶

`toXmlString(validate=True)` ¶

`setType(value, validate=True)` ¶

`getType()` ¶

`resetType()` ¶

`hasType()` ¶

`setIlluminationWavelengthRange_List(value, validate=True)` ¶

`getIlluminationWavelengthRange_List()` ¶

`addToIlluminationWavelengthRange_List(value, validate=True)` ¶

`clearIlluminationWavelengthRange_List()` ¶