LightSourceCoupling_Type¶

Bases: ManufacturerSpec_Type

Represents the XML complex type LightSourceCoupling.

This element describes the device(s)/method(s) used to couple an available Light Source(s) with this Microscope Stand to transfer light to the specimen. A typical light Microscope has a Light Coupling device for each available Light Source.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a LightSourceCoupling_Type.

Parameters:

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

Returns:

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

`setID(value, validate=True)` ¶

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

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

`getID()` ¶

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
`LightSourceCouplingID_Type`	The value of the attribute

`resetID()` ¶

`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, validate=True)` ¶

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

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

`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

`setAttenuation(value, validate=True)` ¶

Sets the value of the Attenuation attribute.

This field reports a measure of the capacity of this Light Source Coupling device to attenuate the Illumination Power of the light passing through measured at the Peak Wavelength and expressed in dB/km.

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`

`getAttenuation()` ¶

Returns the value of the Attenuation attribute.

This field reports a measure of the capacity of this Light Source Coupling device to attenuate the Illumination Power of the light passing through measured at the Peak Wavelength and expressed in dB/km.

Returns:

Type	Description
`float`	The value of the attribute

`resetAttenuation()` ¶

`hasAttenuation()` ¶

Checks whether the Attenuation attribute is present.

This field reports a measure of the capacity of this Light Source Coupling device to attenuate the Illumination Power of the light passing through measured at the Peak Wavelength and expressed in dB/km.

Returns:

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

`setTransmittance(value, validate=True)` ¶

Sets the value of the Transmittance attribute.

The maximum amount of light this Light Source Coupling device is 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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getTransmittance()` ¶

Returns the value of the Transmittance attribute.

The maximum amount of light this Light Source Coupling device is 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

`resetTransmittance()` ¶

`hasTransmittance()` ¶

Checks whether the Transmittance attribute is present.

The maximum amount of light this Light Source Coupling device is capable of transmitting 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

`setCouplingLensRef(value, validate=True)` ¶

Sets the value of the CouplingLensRef element.

This is a reference to a Lens positioned at the connection between this Light Source coupling element and the Microscope Stand.

Parameters:

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

`getCouplingLensRef()` ¶

Returns the value of the CouplingLensRef element.

This is a reference to a Lens positioned at the connection between this Light Source coupling element and the Microscope Stand.

Returns:

Type	Description
`LensRef_Type`	The value of the element

`resetCouplingLensRef()` ¶

`hasCouplingLensRef()` ¶

Checks whether the optional CouplingLensRef element is present.

This is a reference to a Lens positioned at the connection between this Light Source coupling element and the Microscope Stand.

Returns:

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

`setAnnotationRef(value, validate=True)` ¶

Sets the value of the AnnotationRef element.

This is a simple multi-line comment or annotation describing this component.

Parameters:

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

`getAnnotationRef()` ¶

Returns the value of the AnnotationRef element.

This is a simple multi-line comment or annotation describing this component.

Returns:

Type	Description
`LightSourceCoupling_Type_InlineAnnotationRef`	The value of the element

`resetAnnotationRef()` ¶

`hasAnnotationRef()` ¶

Checks whether the optional AnnotationRef element is present.

This is a simple multi-line comment or annotation describing this component.

Returns:

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

LightSourceCoupling_Type¶

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

setID(value, validate=True) ¶

getID() ¶

resetID() ¶

hasID() ¶

setName(value, validate=True) ¶

getName() ¶

resetName() ¶

hasName() ¶

setAttenuation(value, validate=True) ¶

getAttenuation() ¶

resetAttenuation() ¶

hasAttenuation() ¶

setTransmittance(value, validate=True) ¶

getTransmittance() ¶

resetTransmittance() ¶

hasTransmittance() ¶

setCouplingLensRef(value, validate=True) ¶

getCouplingLensRef() ¶

resetCouplingLensRef() ¶

hasCouplingLensRef() ¶

setAnnotationRef(value, validate=True) ¶

getAnnotationRef() ¶

resetAnnotationRef() ¶

hasAnnotationRef() ¶

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

`setID(value, validate=True)` ¶

`getID()` ¶

`resetID()` ¶

`hasID()` ¶

`setName(value, validate=True)` ¶

`getName()` ¶

`resetName()` ¶

`hasName()` ¶

`setAttenuation(value, validate=True)` ¶

`getAttenuation()` ¶

`resetAttenuation()` ¶

`hasAttenuation()` ¶

`setTransmittance(value, validate=True)` ¶

`getTransmittance()` ¶

`resetTransmittance()` ¶

`hasTransmittance()` ¶

`setCouplingLensRef(value, validate=True)` ¶

`getCouplingLensRef()` ¶

`resetCouplingLensRef()` ¶

`hasCouplingLensRef()` ¶

`setAnnotationRef(value, validate=True)` ¶

`getAnnotationRef()` ¶

`resetAnnotationRef()` ¶

`hasAnnotationRef()` ¶