GenericExcitationSource¶

Bases: LightSource_Type

Represents the XML element GenericExcitationSource.

The GenericExcitationSource element is used to represent a light source as a collection of key/value pairs, stored in a Map. One of the other light source elements should always be used in preference to this if possible.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a GenericExcitationSource.

Parameters:

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

Returns:

Type	Description
`GenericExcitationSource`	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

`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()` ¶

`setMap(value, validate=True)` ¶

Sets the value of the Map element.

This is a Mapping of key/value pairs used to store customized metadata that describes this element.

Parameters:

Name	Type	Description	Default
`value`	`Map_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getMap()` ¶

Returns the value of the Map element.

This is a Mapping of key/value pairs used to store customized metadata that describes this element.

Returns:

Type	Description
`Map_Type`	The value of the element

`resetMap()` ¶

`hasMap()` ¶

Checks whether the optional Map element is present.

This is a Mapping of key/value pairs used to store customized metadata that describes this element.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

GenericExcitationSource¶

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) ¶

setIlluminationWavelengthRange_List(value, validate=True) ¶

getIlluminationWavelengthRange_List() ¶

addToIlluminationWavelengthRange_List(value, validate=True) ¶

clearIlluminationWavelengthRange_List() ¶

setMap(value, validate=True) ¶

getMap() ¶

resetMap() ¶

hasMap() ¶

`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)` ¶

`setIlluminationWavelengthRange_List(value, validate=True)` ¶

`getIlluminationWavelengthRange_List()` ¶

`addToIlluminationWavelengthRange_List(value, validate=True)` ¶

`clearIlluminationWavelengthRange_List()` ¶

`setMap(value, validate=True)` ¶

`getMap()` ¶

`resetMap()` ¶

`hasMap()` ¶