microscope.abc.FloatingDeviceMixin Class Reference

Inheritance diagram for microscope.abc.FloatingDeviceMixin:

Public Member Functions
None	__init__ (self, int index, **kwargs)
str	get_id (self)

Detailed Description

A mixin for devices that 'float'.

Some SDKs handling multiple devices do not allow for explicit
selection of a specific device.  Instead, when the SDK is
initialised it assigns an index to each device.  However, this
index is only unique until the program ends and next time the
program runs the device might be assigned a different index.  This
means that it is not possible to request a specific device to the
SDK.  Instead, one connects to one of the available devices, then
initialises it, and only then can one check which one we got.

Floating devices are a problem in systems where there are multiple
devices of the same type but we only want to initialise a subset
of them.  Make sure that a device really is a floating device
before making use of this class.  Avoid it if possible.

This class is a mixin which enforces the implementation of a
`get_id` method, which typically returns the device serial number.

Args:
    index: the index of the device on a shared library.  This
        argument is added by the device_server program.

Definition at line 188 of file abc.py.

Constructor & Destructor Documentation

__init__()

None microscope.abc.FloatingDeviceMixin.__init__	(		self,
		int	index,
		**	kwargs
	)

Reimplemented in microscope.stages.linkam._LinkamBase, and microscope.stages.linkam.LinkamCMS.

Definition at line 214 of file abc.py.

    def __init__(self, index: int, **kwargs) -> None:
        super().__init__(**kwargs)
        self._index = index
 

Member Function Documentation

get_id()

str microscope.abc.FloatingDeviceMixin.get_id

(

self

)

Return a unique hardware identifier such as a serial number.

Reimplemented in microscope.cameras.andorsdk3.AndorSDK3, microscope.cameras.atmcd.AndorAtmcd, microscope.cameras.pvcam.PVCamera, microscope.stages.linkam._LinkamBase, and microscope.testsuite.devices.TestFloatingDevice.

Definition at line 219 of file abc.py.

    def get_id(self) -> str:
        """Return a unique hardware identifier such as a serial number."""
        pass
 
 

Referenced by microscope.cameras.atmcd.AndorAtmcd.initialize().

---

The documentation for this class was generated from the following file:

• F:/repos/BioImager/BioImager/PythonMicroscope/microscope/abc.py