Skip to content

DichroicFilterWheel

Bases: FilterWheel_Type

Represents the XML element DichroicFilterWheel.

This element represents a circular holder for multiple individual Dichroics.

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
DichroicFilterWheel

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

setStandardDichroicRef_List(value, validate=True)

Sets the list of StandardDichroicRef elements.

No description available in the XSD standard.

Parameters:

Name Type Description Default
value List[StandardDichroicRef]

The new list of StandardDichroicRef elements

required
validate (boolean, optional)

If true, validates constraints on value. Default is true.

True

getStandardDichroicRef_List()

Returns the list of StandardDichroicRef elements.

No description available in the XSD standard.

Returns:

Type Description
List[StandardDichroicRef]

The list of StandardDichroicRef elements

addToStandardDichroicRef_List(value, validate=True)

Adds a new StandardDichroicRef element to this object.

No description available in the XSD standard.

Parameters:

Name Type Description Default
value StandardDichroicRef

The element to add

required
validate (boolean, optional)

If true, validates constraints on value. Default is true.

True

clearStandardDichroicRef_List()

Clear the list of StandardDichroicRef.

No description available in the XSD standard.