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
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 )
setName ( value , validate = True )
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
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 )
addToLensRef_List ( value , validate = True )
setMirroringDeviceRef_List ( value , validate = True )
getMirroringDeviceRef_List ()
addToMirroringDeviceRef_List ( value , validate = True )
clearMirroringDeviceRef_List ()
setApertureRef_List ( value , validate = True )
addToApertureRef_List ( value , validate = True )
setPolarizationOpticsRef_List ( value , validate = True )
getPolarizationOpticsRef_List ()
addToPolarizationOpticsRef_List ( value , validate = True )
clearPolarizationOpticsRef_List ()
setPrismRef_List ( value , validate = True )
addToPrismRef_List ( value , validate = True )
setAnnotationRef ( value , validate = True )