LightSource_Type¶
Bases: ManufacturerSpec_Type
Represents the XML complex type LightSource.
This element describes one or more Light Source(s) available for this Instrument. An Instrument may have several Light Sources of different types (Laser, Light Emitting Diode, Filament, Arc etc.). A typical fluorescence Microscope has two Light Sources, one for Transmitted light and one for Fluorescence light.
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 |
|---|---|
LightSource_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
|
LightSourceID_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 |
|---|---|
LightSourceID_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, 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()
¶
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 |
setPurchaseDate(value, validate=True)
¶
Sets the value of the PurchaseDate attribute.
This field records the Date in which this Light Source was purchased.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getPurchaseDate()
¶
Returns the value of the PurchaseDate attribute.
This field records the Date in which this Light Source was purchased.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetPurchaseDate()
¶
Resets the PurchaseDate attribute to an unset state.
This field records the Date in which this Light Source was purchased.
hasPurchaseDate()
¶
Checks whether the PurchaseDate attribute is present.
This field records the Date in which this Light Source was purchased.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |
getPurchaseDateAllowedValues()
staticmethod
¶
Returns the allowed values for this attribut.
This field records the Date in which this Light Source was purchased.
Returns:
| Type | Description |
|---|---|
std::set< str,std::less< str >,std::allocator< str > >
|
The list of allowed values |
setIlluminationPowerReportingStatistic(value, validate=True)
¶
Sets the value of the IlluminationPowerReportingStatistic attribute.
This field reports the statistic used by the Manufacturer to report the nominal Illumination Power output emitted by this Light Source at Peak Wavelength.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LightSourceIlluminationPowerReportingStatistic_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getIlluminationPowerReportingStatistic()
¶
Returns the value of the IlluminationPowerReportingStatistic attribute.
This field reports the statistic used by the Manufacturer to report the nominal Illumination Power output emitted by this Light Source at Peak Wavelength.
Returns:
| Type | Description |
|---|---|
LightSourceIlluminationPowerReportingStatistic_Type
|
The value of the attribute |
resetIlluminationPowerReportingStatistic()
¶
Resets the IlluminationPowerReportingStatistic attribute to an unset state.
This field reports the statistic used by the Manufacturer to report the nominal Illumination Power output emitted by this Light Source at Peak Wavelength.
hasIlluminationPowerReportingStatistic()
¶
Checks whether the optional IlluminationPowerReportingStatistic attribute is present.
This field reports the statistic used by the Manufacturer to report the nominal Illumination Power output emitted by this Light Source at Peak Wavelength.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setIlluminationPowerReportingPosition(value, validate=True)
¶
Sets the value of the IlluminationPowerReportingPosition attribute.
This field records the Position where the reported Illumination Intensity value was obtained as reported by the Manufacturer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LightSourceIlluminationPowerReportingPosition_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getIlluminationPowerReportingPosition()
¶
Returns the value of the IlluminationPowerReportingPosition attribute.
This field records the Position where the reported Illumination Intensity value was obtained as reported by the Manufacturer.
Returns:
| Type | Description |
|---|---|
LightSourceIlluminationPowerReportingPosition_Type
|
The value of the attribute |
resetIlluminationPowerReportingPosition()
¶
Resets the IlluminationPowerReportingPosition attribute to an unset state.
This field records the Position where the reported Illumination Intensity value was obtained as reported by the Manufacturer.
hasIlluminationPowerReportingPosition()
¶
Checks whether the optional IlluminationPowerReportingPosition attribute is present.
This field records the Position where the reported Illumination Intensity value was obtained as reported by the Manufacturer.
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
|
AnnotationRef
|
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 |
|---|---|
AnnotationRef
|
The value of the element |
resetAnnotationRef()
¶
Resets the AnnotationRef element to an unset state.
This is a simple multi-line comment or annotation describing this component.
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 |