LightPath_Type¶
Bases: NBOBaseClass
Represents the XML complex type LightPath.
This empty element refers to a LightSourceCoupling component used in this light path.
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 |
|---|---|
LightPath_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
|
LSID_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 |
|---|---|
LSID_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 |
setLightSourceSettings_List(value, validate=True)
¶
Sets the list of LightSourceSettings elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[LightSourceSettings]
|
The new list of LightSourceSettings elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getLightSourceSettings_List()
¶
Returns the list of LightSourceSettings elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[LightSourceSettings]
|
The list of LightSourceSettings elements |
addToLightSourceSettings_List(value, validate=True)
¶
Adds a new LightSourceSettings element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LightSourceSettings
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearLightSourceSettings_List()
¶
Clear the list of LightSourceSettings.
No description available in the XSD standard.
setLightSourceCouplingRef_List(value, validate=True)
¶
Sets the list of LightSourceCouplingRef elements.
This empty element refers to a LightSourceCoupling component used in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[LightSourceCouplingRef]
|
The new list of LightSourceCouplingRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getLightSourceCouplingRef_List()
¶
Returns the list of LightSourceCouplingRef elements.
This empty element refers to a LightSourceCoupling component used in this light path.
Returns:
| Type | Description |
|---|---|
List[LightSourceCouplingRef]
|
The list of LightSourceCouplingRef elements |
addToLightSourceCouplingRef_List(value, validate=True)
¶
Adds a new LightSourceCouplingRef element to this object.
This empty element refers to a LightSourceCoupling component used in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LightSourceCouplingRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearLightSourceCouplingRef_List()
¶
Clear the list of LightSourceCouplingRef.
This empty element refers to a LightSourceCoupling component used in this light path.
setExcitationFilterRef_List(value, validate=True)
¶
Sets the list of ExcitationFilterRef elements.
This empty element refers to an ExcitationFilter component used in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[ExcitationFilterRef]
|
The new list of ExcitationFilterRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getExcitationFilterRef_List()
¶
Returns the list of ExcitationFilterRef elements.
This empty element refers to an ExcitationFilter component used in this light path.
Returns:
| Type | Description |
|---|---|
List[ExcitationFilterRef]
|
The list of ExcitationFilterRef elements |
addToExcitationFilterRef_List(value, validate=True)
¶
Adds a new ExcitationFilterRef element to this object.
This empty element refers to an ExcitationFilter component used in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ExcitationFilterRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearExcitationFilterRef_List()
¶
Clear the list of ExcitationFilterRef.
This empty element refers to an ExcitationFilter component used in this light path.
setStandardDichroicRef_List(value, validate=True)
¶
Sets the list of StandardDichroicRef elements.
This empty element refers to a StandardDichroic component used in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[StandardDichroicRef]
|
The new list of StandardDichroicRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getStandardDichroicRef_List()
¶
Returns the list of StandardDichroicRef elements.
This empty element refers to a StandardDichroic component used in this light path.
Returns:
| Type | Description |
|---|---|
List[StandardDichroicRef]
|
The list of StandardDichroicRef elements |
addToStandardDichroicRef_List(value, validate=True)
¶
Adds a new StandardDichroicRef element to this object.
This empty element refers to a StandardDichroic component used in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
StandardDichroicRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearStandardDichroicRef_List()
¶
Clear the list of StandardDichroicRef.
This empty element refers to a StandardDichroic component used in this light path.
setEmissionFilterRef_List(value, validate=True)
¶
Sets the list of EmissionFilterRef elements.
This empty element refers to an EmissionFilter component used in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[EmissionFilterRef]
|
The new list of EmissionFilterRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getEmissionFilterRef_List()
¶
Returns the list of EmissionFilterRef elements.
This empty element refers to an EmissionFilter component used in this light path.
Returns:
| Type | Description |
|---|---|
List[EmissionFilterRef]
|
The list of EmissionFilterRef elements |
addToEmissionFilterRef_List(value, validate=True)
¶
Adds a new EmissionFilterRef element to this object.
This empty element refers to an EmissionFilter component used in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
EmissionFilterRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearEmissionFilterRef_List()
¶
Clear the list of EmissionFilterRef.
This empty element refers to an EmissionFilter component used in this light path.
setFilterSet_List(value, validate=True)
¶
Sets the list of FilterSet elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[FilterSe]
|
The new list of FilterSet elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getFilterSet_List()
¶
Returns the list of FilterSet elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[FilterSe]
|
The list of FilterSet elements |
addToFilterSet_List(value, validate=True)
¶
Adds a new FilterSet element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
FilterSet
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearFilterSet_List()
¶
Clear the list of FilterSet.
No description available in the XSD standard.
setGenericFilterRef_List(value, validate=True)
¶
Sets the list of GenericFilterRef elements.
This empty element refers to an additional Generic Filter component placed in this Light Path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[GenericFilterRef]
|
The new list of GenericFilterRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getGenericFilterRef_List()
¶
Returns the list of GenericFilterRef elements.
This empty element refers to an additional Generic Filter component placed in this Light Path.
Returns:
| Type | Description |
|---|---|
List[GenericFilterRef]
|
The list of GenericFilterRef elements |
addToGenericFilterRef_List(value, validate=True)
¶
Adds a new GenericFilterRef element to this object.
This empty element refers to an additional Generic Filter component placed in this Light Path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
GenericFilterRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearGenericFilterRef_List()
¶
Clear the list of GenericFilterRef.
This empty element refers to an additional Generic Filter component placed in this Light Path.
setLensSettings_List(value, validate=True)
¶
Sets the list of LensSettings elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[LensSettings]
|
The new list of LensSettings elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getLensSettings_List()
¶
Returns the list of LensSettings elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[LensSettings]
|
The list of LensSettings elements |
addToLensSettings_List(value, validate=True)
¶
Adds a new LensSettings element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LensSettings
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearLensSettings_List()
¶
Clear the list of LensSettings.
No description available in the XSD standard.
setMirroringDeviceSettings_List(value, validate=True)
¶
Sets the list of MirroringDeviceSettings elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[MirroringDeviceSettings]
|
The new list of MirroringDeviceSettings elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getMirroringDeviceSettings_List()
¶
Returns the list of MirroringDeviceSettings elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[MirroringDeviceSettings]
|
The list of MirroringDeviceSettings elements |
addToMirroringDeviceSettings_List(value, validate=True)
¶
Adds a new MirroringDeviceSettings element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
MirroringDeviceSettings
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearMirroringDeviceSettings_List()
¶
Clear the list of MirroringDeviceSettings.
No description available in the XSD standard.
setApertureRef_List(value, validate=True)
¶
Sets the list of ApertureRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[ApertureRef]
|
The new list of ApertureRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getApertureRef_List()
¶
Returns the list of ApertureRef elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[ApertureRef]
|
The list of ApertureRef elements |
addToApertureRef_List(value, validate=True)
¶
Adds a new ApertureRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ApertureRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearApertureRef_List()
¶
Clear the list of ApertureRef.
No description available in the XSD standard.
setOpticalAssemblyRef_List(value, validate=True)
¶
Sets the list of OpticalAssemblyRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[OpticalAssemblyRef]
|
The new list of OpticalAssemblyRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getOpticalAssemblyRef_List()
¶
Returns the list of OpticalAssemblyRef elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[OpticalAssemblyRef]
|
The list of OpticalAssemblyRef elements |
addToOpticalAssemblyRef_List(value, validate=True)
¶
Adds a new OpticalAssemblyRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
OpticalAssemblyRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearOpticalAssemblyRef_List()
¶
Clear the list of OpticalAssemblyRef.
No description available in the XSD standard.
setOpticalApertureSettingsGroup_List(value, validate=True)
¶
Sets the list of OpticalApertureSettingsGroup elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[OpticalApertureSettings_Type]
|
The new list of OpticalApertureSettingsGroup elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getOpticalApertureSettingsGroup_List()
¶
Returns the list of OpticalApertureSettingsGroup elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[OpticalApertureSettings_Type]
|
The list of OpticalApertureSettingsGroup elements |
addToOpticalApertureSettingsGroup_List(value, validate=True)
¶
Adds a new OpticalApertureSettingsGroup element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
OpticalApertureSettings_Type
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearOpticalApertureSettingsGroup_List()
¶
Clear the list of OpticalApertureSettingsGroup.
No description available in the XSD standard.
setPolarizationOpticsRef_List(value, validate=True)
¶
Sets the list of PolarizationOpticsRef elements.
This empty element refers to a PolarizationOptics component placed in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[PolarizationOpticsRef_Type]
|
The new list of PolarizationOpticsRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getPolarizationOpticsRef_List()
¶
Returns the list of PolarizationOpticsRef elements.
This empty element refers to a PolarizationOptics component placed in this light path.
Returns:
| Type | Description |
|---|---|
List[PolarizationOpticsRef_Type]
|
The list of PolarizationOpticsRef elements |
addToPolarizationOpticsRef_List(value, validate=True)
¶
Adds a new PolarizationOpticsRef element to this object.
This empty element refers to a PolarizationOptics component placed in this light path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PolarizationOpticsRef_Type
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearPolarizationOpticsRef_List()
¶
Clear the list of PolarizationOpticsRef.
This empty element refers to a PolarizationOptics component placed in this light path.
setPrismSettings_List(value, validate=True)
¶
Sets the list of PrismSettings elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[PrismSettings]
|
The new list of PrismSettings elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getPrismSettings_List()
¶
Returns the list of PrismSettings elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[PrismSettings]
|
The list of PrismSettings elements |
addToPrismSettings_List(value, validate=True)
¶
Adds a new PrismSettings element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PrismSettings
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearPrismSettings_List()
¶
Clear the list of PrismSettings.
No description available in the XSD standard.
setShutterSettings_List(value, validate=True)
¶
Sets the list of ShutterSettings elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[ShutterSettings]
|
The new list of ShutterSettings elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getShutterSettings_List()
¶
Returns the list of ShutterSettings elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[ShutterSettings]
|
The list of ShutterSettings elements |
addToShutterSettings_List(value, validate=True)
¶
Adds a new ShutterSettings element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ShutterSettings
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearShutterSettings_List()
¶
Clear the list of ShutterSettings.
No description available in the XSD standard.
setDetectorSettingsGroup_List(value, validate=True)
¶
Sets the list of DetectorSettingsGroup elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[DetectorSettings_Type]
|
The new list of DetectorSettingsGroup elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getDetectorSettingsGroup_List()
¶
Returns the list of DetectorSettingsGroup elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[DetectorSettings_Type]
|
The list of DetectorSettingsGroup elements |
addToDetectorSettingsGroup_List(value, validate=True)
¶
Adds a new DetectorSettingsGroup element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DetectorSettings_Type
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearDetectorSettingsGroup_List()
¶
Clear the list of DetectorSettingsGroup.
No description available in the XSD standard.
setConfocalScannerSettings_List(value, validate=True)
¶
Sets the list of ConfocalScannerSettings elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[ConfocalScannerSettings]
|
The new list of ConfocalScannerSettings elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getConfocalScannerSettings_List()
¶
Returns the list of ConfocalScannerSettings elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[ConfocalScannerSettings]
|
The list of ConfocalScannerSettings elements |
addToConfocalScannerSettings_List(value, validate=True)
¶
Adds a new ConfocalScannerSettings element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ConfocalScannerSettings
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearConfocalScannerSettings_List()
¶
Clear the list of ConfocalScannerSettings.
No description available in the XSD standard.
setAcoustoOpticalDeviceSettingsGroup_List(value, validate=True)
¶
Sets the list of AcoustoOpticalDeviceSettingsGroup elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[AcoustoOpticalDeviceSettings_Type]
|
The new list of AcoustoOpticalDeviceSettingsGroup elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getAcoustoOpticalDeviceSettingsGroup_List()
¶
Returns the list of AcoustoOpticalDeviceSettingsGroup elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[AcoustoOpticalDeviceSettings_Type]
|
The list of AcoustoOpticalDeviceSettingsGroup elements |
addToAcoustoOpticalDeviceSettingsGroup_List(value, validate=True)
¶
Adds a new AcoustoOpticalDeviceSettingsGroup element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AcoustoOpticalDeviceSettings_Type
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearAcoustoOpticalDeviceSettingsGroup_List()
¶
Clear the list of AcoustoOpticalDeviceSettingsGroup.
No description available in the XSD standard.
setElectroOpticalDeviceSettingsGroup_List(value, validate=True)
¶
Sets the list of ElectroOpticalDeviceSettingsGroup elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[ElectroOpticalDeviceSettings_Type]
|
The new list of ElectroOpticalDeviceSettingsGroup elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getElectroOpticalDeviceSettingsGroup_List()
¶
Returns the list of ElectroOpticalDeviceSettingsGroup elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[ElectroOpticalDeviceSettings_Type]
|
The list of ElectroOpticalDeviceSettingsGroup elements |
addToElectroOpticalDeviceSettingsGroup_List(value, validate=True)
¶
Adds a new ElectroOpticalDeviceSettingsGroup element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ElectroOpticalDeviceSettings_Type
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearElectroOpticalDeviceSettingsGroup_List()
¶
Clear the list of ElectroOpticalDeviceSettingsGroup.
No description available in the XSD standard.
setTIRFSettings_List(value, validate=True)
¶
Sets the list of TIRFSettings elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[TIRFSettings]
|
The new list of TIRFSettings elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getTIRFSettings_List()
¶
Returns the list of TIRFSettings elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[TIRFSettings]
|
The list of TIRFSettings elements |
addToTIRFSettings_List(value, validate=True)
¶
Adds a new TIRFSettings element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
TIRFSettings
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearTIRFSettings_List()
¶
Clear the list of TIRFSettings.
No description available in the XSD standard.
setLightPathMap(value, validate=True)
¶
Sets the value of the LightPathMap element.
This element holds a Map that records the order in which the different optical component associated with this Light Path are physically laid out.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LightPath_Type_InlineLightPathMap
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getLightPathMap()
¶
Returns the value of the LightPathMap element.
This element holds a Map that records the order in which the different optical component associated with this Light Path are physically laid out.
Returns:
| Type | Description |
|---|---|
LightPath_Type_InlineLightPathMap
|
The value of the element |
resetLightPathMap()
¶
Resets the LightPathMap element to an unset state.
This element holds a Map that records the order in which the different optical component associated with this Light Path are physically laid out.
hasLightPathMap()
¶
Checks whether the optional LightPathMap element is present.
This element holds a Map that records the order in which the different optical component associated with this Light Path are physically laid out.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setAnnotationRef_List(value, validate=True)
¶
Sets the list of AnnotationRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[AnnotationRef]
|
The new list of AnnotationRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getAnnotationRef_List()
¶
Returns the list of AnnotationRef elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[AnnotationRef]
|
The list of AnnotationRef elements |
addToAnnotationRef_List(value, validate=True)
¶
Adds a new AnnotationRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AnnotationRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearAnnotationRef_List()
¶
Clear the list of AnnotationRef.
No description available in the XSD standard.