MirroringDevice_Type

Bases: ManufacturerSpec_Type

Represents the XML complex type MirroringDevice.

This element describes a Mirror positioned in the Light Path for one or more Channels available for this Instrument. An Instrument may have several Mirrors of different types, such as Dichroic, Beamsplitter or Reflector. This element can be associated with an optional Optics Holder, such as a Filter Cube, Filter Turret, Filter Wheel, or Filter Slider.

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

setID(value)

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	MirrorID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
MirrorID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

setName(value)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	The value to set	required

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

setOpticsHolderPosition(value)

Sets the value of the OpticsHolderPosition attribute.

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getOpticsHolderPosition()

Returns the value of the OpticsHolderPosition attribute.

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

Returns:

Type	Description
string	The value of the attribute

resetOpticsHolderPosition()

Resets the OpticsHolderPosition attribute to an unset state.

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

hasOpticsHolderPosition()

Checks whether the optional OpticsHolderPosition attribute is present.

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

Returns:

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

setMirrorType(value)

Sets the value of the MirrorType attribute.

This field records the general category of this Mirror.

Parameters:

Name	Type	Description	Default
value	MirrorType_Type	The value to set	required

getMirrorType()

Returns the value of the MirrorType attribute.

This field records the general category of this Mirror.

Returns:

Type	Description
MirrorType_Type	The value of the attribute

resetMirrorType()

Resets the MirrorType attribute to an unset state.

This field records the general category of this Mirror.

hasMirrorType()

Checks whether the optional MirrorType attribute is present.

This field records the general category of this Mirror.

Returns:

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

setGeometry(value)

Sets the value of the Geometry attribute.

This field records the geometrical shape of the surface(s) of this Mirror.

Parameters:

Name	Type	Description	Default
value	MirrorGeometry_Type	The value to set	required

getGeometry()

Returns the value of the Geometry attribute.

This field records the geometrical shape of the surface(s) of this Mirror.

Returns:

Type	Description
MirrorGeometry_Type	The value of the attribute

resetGeometry()

Resets the Geometry attribute to an unset state.

This field records the geometrical shape of the surface(s) of this Mirror.

hasGeometry()

Checks whether the optional Geometry attribute is present.

This field records the geometrical shape of the surface(s) of this Mirror.

Returns:

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

setDiameter(value)

Sets the value of the Diameter attribute.

This field describes the Diameter of this optical element.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getDiameter()

Returns the value of the Diameter attribute.

This field describes the Diameter of this optical element.

Returns:

Type	Description
float	The value of the attribute

resetDiameter()

Resets the Diameter attribute to an unset state.

This field describes the Diameter of this optical element.

hasDiameter()

Checks whether the optional Diameter attribute is present.

This field describes the Diameter of this optical element.

Returns:

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

setDiameterUnit(value)

Sets the value of the DiameterUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getDiameterUnit()

Returns the value of the DiameterUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetDiameterUnit()

Resets the DiameterUnit attribute to an unset state.

No description available in the XSD standard.

hasDiameterUnit()

Checks whether the optional DiameterUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setRadiusOfCurvature(value)

Sets the value of the RadiusOfCurvature attribute.

The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getRadiusOfCurvature()

Returns the value of the RadiusOfCurvature attribute.

The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.

Returns:

Type	Description
float	The value of the attribute

resetRadiusOfCurvature()

Resets the RadiusOfCurvature attribute to an unset state.

The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.

hasRadiusOfCurvature()

Checks whether the optional RadiusOfCurvature attribute is present.

The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.

Returns:

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

setRadiusOfCurvatureUnit(value)

Sets the value of the RadiusOfCurvatureUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getRadiusOfCurvatureUnit()

Returns the value of the RadiusOfCurvatureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetRadiusOfCurvatureUnit()

Resets the RadiusOfCurvatureUnit attribute to an unset state.

No description available in the XSD standard.

hasRadiusOfCurvatureUnit()

Checks whether the optional RadiusOfCurvatureUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setAngleOfIncidence(value)

Sets the value of the AngleOfIncidence attribute.

This field records the optimal angle of incidence (AOI) for this Mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the Mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAngleOfIncidence()

Returns the value of the AngleOfIncidence attribute.

This field records the optimal angle of incidence (AOI) for this Mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the Mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

Returns:

Type	Description
float	The value of the attribute

resetAngleOfIncidence()

Resets the AngleOfIncidence attribute to an unset state.

This field records the optimal angle of incidence (AOI) for this Mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the Mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

hasAngleOfIncidence()

Checks whether the optional AngleOfIncidence attribute is present.

This field records the optimal angle of incidence (AOI) for this Mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the Mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

Returns:

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

setAngleOfIncidenceUnit(value)

Sets the value of the AngleOfIncidenceUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsAngle_Type	The value to set	required

getAngleOfIncidenceUnit()

Returns the value of the AngleOfIncidenceUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsAngle_Type	The value of the attribute

resetAngleOfIncidenceUnit()

Resets the AngleOfIncidenceUnit attribute to an unset state.

No description available in the XSD standard.

hasAngleOfIncidenceUnit()

Checks whether the optional AngleOfIncidenceUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setSubstrateType(value)

Sets the value of the SubstrateType attribute.

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getSubstrateType()

Returns the value of the SubstrateType attribute.

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

Returns:

Type	Description
string	The value of the attribute

resetSubstrateType()

Resets the SubstrateType attribute to an unset state.

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

hasSubstrateType()

Checks whether the optional SubstrateType attribute is present.

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

Returns:

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

setSubstrateMaterial(value)

Sets the value of the SubstrateMaterial attribute.

This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.

Parameters:

Name	Type	Description	Default
value	OpticalMaterialName_Type	The value to set	required

getSubstrateMaterial()

Returns the value of the SubstrateMaterial attribute.

This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.

Returns:

Type	Description
OpticalMaterialName_Type	The value of the attribute

resetSubstrateMaterial()

Resets the SubstrateMaterial attribute to an unset state.

This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.

hasSubstrateMaterial()

Checks whether the optional SubstrateMaterial attribute is present.

This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.

Returns:

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

setGlassCode(value)

Sets the value of the GlassCode attribute.

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getGlassCode()

Returns the value of the GlassCode attribute.

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

Returns:

Type	Description
string	The value of the attribute

resetGlassCode()

Resets the GlassCode attribute to an unset state.

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

hasGlassCode()

Checks whether the optional GlassCode attribute is present.

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

Returns:

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

setAnnotationRef(value)

Sets the value of the AnnotationRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The value to set	required

getAnnotationRef()

Returns the value of the AnnotationRef element.

No description available in the XSD standard.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

No description available in the XSD standard.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

No description available in the XSD standard.

Returns:

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