BeamSplitter
Bases: MirroringDevice_Type
Represents the XML element BeamSplitter.
This element describes a Mirror that reflects part of the light, regardless of wavelength.
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)
Populates this object from a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the JSON file |
required |
fromJsonString(json_string)
Populates this object from a JSON string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_string
|
string
|
The JSON content as a string |
required |
fromXmlFile(path)
Populates this object from a XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the XML file |
required |
fromXmlString(xml_string)
Populates this object from a XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml_string
|
string
|
The XML content as a string |
required |
toXmlFile(filename)
Serializes this object to an XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
string
|
The path to the output XML file |
required |
toXmlString()
Serializes this object to an XML string.
Returns:
| Type | Description |
|---|---|
string
|
A string containing the XML representation of this object |
setTransmittance(value)
Sets the value of the Transmittance attribute.
The field records the maximum amount of light this Beamsplitteris capable of transmitting 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 |
getTransmittance()
Returns the value of the Transmittance attribute.
The field records the maximum amount of light this Beamsplitteris capable of transmitting 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 |
setTransmittanceProfileFile(value)
Sets the value of the TransmittanceProfileFile attribute.
This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
getTransmittanceProfileFile()
Returns the value of the TransmittanceProfileFile attribute.
This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetTransmittanceProfileFile()
Resets the TransmittanceProfileFile attribute to an unset state.
This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.
hasTransmittanceProfileFile()
Checks whether the optional TransmittanceProfileFile attribute is present.
This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setTransmissionAngle(value)
Sets the value of the TransmissionAngle attribute.
The angle at which light is transmitted by this Beamsplitter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getTransmissionAngle()
Returns the value of the TransmissionAngle attribute.
The angle at which light is transmitted by this Beamsplitter.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetTransmissionAngle()
Resets the TransmissionAngle attribute to an unset state.
The angle at which light is transmitted by this Beamsplitter.
hasTransmissionAngle()
Checks whether the optional TransmissionAngle attribute is present.
The angle at which light is transmitted by this Beamsplitter.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setTransmissionAngleUnit(value)
Sets the value of the TransmissionAngleUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsAngle_Type
|
The value to set |
required |
getTransmissionAngleUnit()
Returns the value of the TransmissionAngleUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsAngle_Type
|
The value of the attribute |
resetTransmissionAngleUnit()
Resets the TransmissionAngleUnit attribute to an unset state.
No description available in the XSD standard.
hasTransmissionAngleUnit()
Checks whether the optional TransmissionAngleUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setReflectance(value)
Sets the value of the Reflectance attribute.
The field records the maximum amount of light this Beamsplitteris 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 |
getReflectance()
Returns the value of the Reflectance attribute.
The field records the maximum amount of light this Beamsplitteris 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 |
setTransmittanceProfileFile_List(value)
Sets the list of TransmittanceProfileFile elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[TransmittanceProfileFile]
|
The new list of TransmittanceProfileFile elements |
required |
getTransmittanceProfileFile_List()
Returns the list of TransmittanceProfileFile elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[TransmittanceProfileFile]
|
The list of TransmittanceProfileFile elements |
addToTransmittanceProfileFile_List(value)
Adds a new TransmittanceProfileFile element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
TransmittanceProfileFile
|
The element to add |
required |
clearTransmittanceProfileFile_List()
Clear the list of TransmittanceProfileFile.
No description available in the XSD standard.
setReflectanceProfileFile_List(value)
Sets the list of ReflectanceProfileFile elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[ReflectanceProfileFile]
|
The new list of ReflectanceProfileFile elements |
required |
getReflectanceProfileFile_List()
Returns the list of ReflectanceProfileFile elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[ReflectanceProfileFile]
|
The list of ReflectanceProfileFile elements |
addToReflectanceProfileFile_List(value)
Adds a new ReflectanceProfileFile element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ReflectanceProfileFile
|
The element to add |
required |
clearReflectanceProfileFile_List()
Clear the list of ReflectanceProfileFile.
No description available in the XSD standard.