LightGuide

Bases: LightSourceCoupling_Type

Represents the XML element LightGuide.

A Light Guide coupling between the Light Source and the Microscope Stand generally consists of a casing enclosing a medium (i.e., typically fiber optic) capable of transferring light from the illuminator to the back of the Microscope Stand.

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
LightGuide	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

setType(value, validate=True)

Sets the value of the Type attribute.

This field records the general category of Light Guide used in this case.

Parameters:

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

getType()

Returns the value of the Type attribute.

This field records the general category of Light Guide used in this case.

Returns:

Type	Description
LightGuideType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field records the general category of Light Guide used in this case.

hasType()

Checks whether the optional Type attribute is present.

This field records the general category of Light Guide used in this case.

Returns:

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

setRefractiveIndex(value, validate=True)

Sets the value of the RefractiveIndex attribute.

This field records the Refractive Index of the material used to construct this Light Guide.

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

getRefractiveIndex()

Returns the value of the RefractiveIndex attribute.

This field records the Refractive Index of the material used to construct this Light Guide.

Returns:

Type	Description
float	The value of the attribute

resetRefractiveIndex()

Resets the RefractiveIndex attribute to an unset state.

This field records the Refractive Index of the material used to construct this Light Guide.

hasRefractiveIndex()

Checks whether the RefractiveIndex attribute is present.

This field records the Refractive Index of the material used to construct this Light Guide.

Returns:

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

setNumericalAperture(value, validate=True)

Sets the value of the NumericalAperture attribute.

The Numerical Aperture (NA) of this device expressed as a floating-point (real) number. NA can be calculated from the Angular Aperture (alpha) using the following formula, NA

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

getNumericalAperture()

Returns the value of the NumericalAperture attribute.

The Numerical Aperture (NA) of this device expressed as a floating-point (real) number. NA can be calculated from the Angular Aperture (alpha) using the following formula, NA

Returns:

Type	Description
float	The value of the attribute

resetNumericalAperture()

Resets the NumericalAperture attribute to an unset state.

The Numerical Aperture (NA) of this device expressed as a floating-point (real) number. NA can be calculated from the Angular Aperture (alpha) using the following formula, NA

hasNumericalAperture()

Checks whether the NumericalAperture attribute is present.

The Numerical Aperture (NA) of this device expressed as a floating-point (real) number. NA can be calculated from the Angular Aperture (alpha) using the following formula, NA

Returns:

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

setAcceptanceAngle(value, validate=True)

Sets the value of the AcceptanceAngle attribute.

The angle within which the light beam produced by a Light Source may be coupled with the bound modes of this Light Guide.

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

getAcceptanceAngle()

Returns the value of the AcceptanceAngle attribute.

The angle within which the light beam produced by a Light Source may be coupled with the bound modes of this Light Guide.

Returns:

Type	Description
float	The value of the attribute

resetAcceptanceAngle()

Resets the AcceptanceAngle attribute to an unset state.

The angle within which the light beam produced by a Light Source may be coupled with the bound modes of this Light Guide.

hasAcceptanceAngle()

Checks whether the AcceptanceAngle attribute is present.

The angle within which the light beam produced by a Light Source may be coupled with the bound modes of this Light Guide.

Returns:

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

setAcceptanceAngleUnit(value, validate=True)

Sets the value of the AcceptanceAngleUnit attribute.

No description available in the XSD standard.

Parameters:

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

getAcceptanceAngleUnit()

Returns the value of the AcceptanceAngleUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsAngle_Type	The value of the attribute

resetAcceptanceAngleUnit()

Resets the AcceptanceAngleUnit attribute to an unset state.

No description available in the XSD standard.

hasAcceptanceAngleUnit()

Checks whether the optional AcceptanceAngleUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setGeometry(value, validate=True)

Sets the value of the Geometry attribute.

This field records the cross-section shape of this Light Guide.

Parameters:

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

getGeometry()

Returns the value of the Geometry attribute.

This field records the cross-section shape of this Light Guide.

Returns:

Type	Description
LightGuideGeometry_Type	The value of the attribute

resetGeometry()

Resets the Geometry attribute to an unset state.

This field records the cross-section shape of this Light Guide.

hasGeometry()

Checks whether the optional Geometry attribute is present.

This field records the cross-section shape of this Light Guide.

Returns:

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

setMaterialName(value, validate=True)

Sets the value of the MaterialName attribute.

This field records the chemical composition or the non-proprietary trade designation of the material used to construct this Light Guide.

Parameters:

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

getMaterialName()

Returns the value of the MaterialName attribute.

This field records the chemical composition or the non-proprietary trade designation of the material used to construct this Light Guide.

Returns:

Type	Description
LightGuideMaterialName_Type	The value of the attribute

resetMaterialName()

Resets the MaterialName attribute to an unset state.

This field records the chemical composition or the non-proprietary trade designation of the material used to construct this Light Guide.

hasMaterialName()

Checks whether the optional MaterialName attribute is present.

This field records the chemical composition or the non-proprietary trade designation of the material used to construct this Light Guide.

Returns:

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

setSingleMode(value, validate=True)

Sets the value of the SingleMode attribute.

This field records whether (True) this Light Guide is single-mode. If not (False), then the guide is assumend to be multi-modal.

Parameters:

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

getSingleMode()

Returns the value of the SingleMode attribute.

This field records whether (True) this Light Guide is single-mode. If not (False), then the guide is assumend to be multi-modal.

Returns:

Type	Description
boolean	The value of the attribute

resetSingleMode()

Resets the SingleMode attribute to an unset state.

This field records whether (True) this Light Guide is single-mode. If not (False), then the guide is assumend to be multi-modal.

hasSingleMode()

Checks whether the SingleMode attribute is present.

This field records whether (True) this Light Guide is single-mode. If not (False), then the guide is assumend to be multi-modal.

Returns:

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

setWaveguideMode(value, validate=True)

Sets the value of the WaveguideMode attribute.

This field records the transverse mode (or superposition of such modes) that are being imposed by this light guide onto the light wave traversing it. These modes generally follow different propagation constants.

Parameters:

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

getWaveguideMode()

Returns the value of the WaveguideMode attribute.

This field records the transverse mode (or superposition of such modes) that are being imposed by this light guide onto the light wave traversing it. These modes generally follow different propagation constants.

Returns:

Type	Description
LightGuideWaveguideMode_Type	The value of the attribute

resetWaveguideMode()

Resets the WaveguideMode attribute to an unset state.

This field records the transverse mode (or superposition of such modes) that are being imposed by this light guide onto the light wave traversing it. These modes generally follow different propagation constants.

hasWaveguideMode()

Checks whether the optional WaveguideMode attribute is present.

This field records the transverse mode (or superposition of such modes) that are being imposed by this light guide onto the light wave traversing it. These modes generally follow different propagation constants.

Returns:

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

setDiameter(value, validate=True)

Sets the value of the Diameter attribute.

This fields records the outer diameter of this Light Guide.

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

getDiameter()

Returns the value of the Diameter attribute.

This fields records the outer diameter of this Light Guide.

Returns:

Type	Description
float	The value of the attribute

resetDiameter()

Resets the Diameter attribute to an unset state.

This fields records the outer diameter of this Light Guide.

hasDiameter()

Checks whether the Diameter attribute is present.

This fields records the outer diameter of this Light Guide.

Returns:

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

setDiameterUnit(value, validate=True)

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
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

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

setWavelengthRange_List(value, validate=True)

Sets the list of WavelengthRange elements.

This element records a range of Wavelengths this component is designed for, according to the Manufacturer. Multiple of this element may be used.

Parameters:

Name	Type	Description	Default
value	List[WavelengthRange]	The new list of WavelengthRange elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getWavelengthRange_List()

Returns the list of WavelengthRange elements.

This element records a range of Wavelengths this component is designed for, according to the Manufacturer. Multiple of this element may be used.

Returns:

Type	Description
List[WavelengthRange]	The list of WavelengthRange elements

addToWavelengthRange_List(value, validate=True)

Adds a new WavelengthRange element to this object.

This element records a range of Wavelengths this component is designed for, according to the Manufacturer. Multiple of this element may be used.

Parameters:

Name	Type	Description	Default
value	WavelengthRange	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearWavelengthRange_List()

Clear the list of WavelengthRange.

This element records a range of Wavelengths this component is designed for, according to the Manufacturer. Multiple of this element may be used.