OpticalAssembly_Type¶
Bases: ManufacturerSpec_Type
Represents the XML complex type OpticalAssembly.
This is a device that might include one or more Lenses, other Optics and Optics Holders. Optical Devices might be custom built or they might also be available as pre-assembled units. Such devices might be embedded within the Microscope Stand or exist as independent units. Examples include the Condenser and the Microscope Tube.
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 |
|---|---|
OpticalAssembly_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 |
setFilterRef_List(value, validate=True)
¶
Sets the list of FilterRef elements.
This refers to an available Filter, which is part of this Optical Assembly.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[FilterRef_Type]
|
The new list of FilterRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getFilterRef_List()
¶
Returns the list of FilterRef elements.
This refers to an available Filter, which is part of this Optical Assembly.
Returns:
| Type | Description |
|---|---|
List[FilterRef_Type]
|
The list of FilterRef elements |
addToFilterRef_List(value, validate=True)
¶
Adds a new FilterRef element to this object.
This refers to an available Filter, which is part of this Optical Assembly.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
FilterRef_Type
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearFilterRef_List()
¶
Clear the list of FilterRef.
This refers to an available Filter, which is part of this Optical Assembly.
setLensRef_List(value, validate=True)
¶
Sets the list of LensRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[LensRef]
|
The new list of LensRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getLensRef_List()
¶
Returns the list of LensRef elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[LensRef]
|
The list of LensRef elements |
addToLensRef_List(value, validate=True)
¶
Adds a new LensRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LensRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearLensRef_List()
¶
Clear the list of LensRef.
No description available in the XSD standard.
setMirroringDeviceRef_List(value, validate=True)
¶
Sets the list of MirroringDeviceRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[MirroringDeviceRef]
|
The new list of MirroringDeviceRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getMirroringDeviceRef_List()
¶
Returns the list of MirroringDeviceRef elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[MirroringDeviceRef]
|
The list of MirroringDeviceRef elements |
addToMirroringDeviceRef_List(value, validate=True)
¶
Adds a new MirroringDeviceRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
MirroringDeviceRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearMirroringDeviceRef_List()
¶
Clear the list of MirroringDeviceRef.
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.
setPolarizationOpticsRef_List(value, validate=True)
¶
Sets the list of PolarizationOpticsRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[PolarizationOpticsRef]
|
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.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[PolarizationOpticsRef]
|
The list of PolarizationOpticsRef elements |
addToPolarizationOpticsRef_List(value, validate=True)
¶
Adds a new PolarizationOpticsRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PolarizationOpticsRef
|
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.
No description available in the XSD standard.
setPrismRef_List(value, validate=True)
¶
Sets the list of PrismRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[PrismRef]
|
The new list of PrismRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getPrismRef_List()
¶
Returns the list of PrismRef elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[PrismRef]
|
The list of PrismRef elements |
addToPrismRef_List(value, validate=True)
¶
Adds a new PrismRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PrismRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearPrismRef_List()
¶
Clear the list of PrismRef.
No description available in the XSD standard.
setAnnotationRef(value, validate=True)
¶
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 |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
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 |