ReflectingMirror¶

Bases: MirroringDevice_Type

Represents the XML element ReflectingMirror.

This element describes a total reflection Mirror.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a ReflectingMirror.

Parameters:

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

Returns:

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

`setReflectance(value, validate=True)` ¶

Sets the value of the Reflectance attribute.

The field records the maximum amount of light this Mirror is capable of reflecting at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

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`

`getReflectance()` ¶

Returns the value of the Reflectance attribute.

The field records the maximum amount of light this Mirror is capable of reflecting at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

Returns:

Type	Description
`float`	The value of the attribute

`resetReflectance()` ¶

`hasReflectance()` ¶

Checks whether the Reflectance attribute is present.

The field records the maximum amount of light this Mirror is capable of reflecting at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

Returns:

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

`setReflectanceProfileFile(value, validate=True)` ¶

Sets the value of the ReflectanceProfileFile element.

No description available in the XSD standard.

Parameters:

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

`getReflectanceProfileFile()` ¶

Returns the value of the ReflectanceProfileFile element.

No description available in the XSD standard.

Returns:

Type	Description
`ReflectanceProfileFile`	The value of the element

`resetReflectanceProfileFile()` ¶

`hasReflectanceProfileFile()` ¶

Checks whether the optional ReflectanceProfileFile element is present.

No description available in the XSD standard.

Returns:

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

ReflectingMirror¶

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

setReflectance(value, validate=True) ¶

getReflectance() ¶

resetReflectance() ¶

hasReflectance() ¶

setReflectanceProfileFile(value, validate=True) ¶

getReflectanceProfileFile() ¶

resetReflectanceProfileFile() ¶

hasReflectanceProfileFile() ¶

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

`setReflectance(value, validate=True)` ¶

`getReflectance()` ¶

`resetReflectance()` ¶

`hasReflectance()` ¶

`setReflectanceProfileFile(value, validate=True)` ¶

`getReflectanceProfileFile()` ¶

`resetReflectanceProfileFile()` ¶

`hasReflectanceProfileFile()` ¶