microscope.testsuite.devices.TestFloatingDevice Class Reference

Inheritance diagram for microscope.testsuite.devices.TestFloatingDevice:

Public Member Functions
None	__init__ (self, str uid, **kwargs)
None	initialize (self)
int	get_index (self)
str	get_id (self)
Public Member Functions inherited from microscope.abc.FloatingDeviceMixin
Public Member Functions inherited from microscope.abc.Device
None	__del__ (self)
bool	get_is_enabled (self)
None	disable (self)
None	enable (self)
None	shutdown (self)
None	add_setting (self, name, dtype, get_func, set_func, values, typing.Optional[typing.Callable[[], bool]] readonly=None)
	get_setting (self, str name)
	get_all_settings (self)
None	set_setting (self, str name, value)
	describe_setting (self, str name)
	describe_settings (self)
	update_settings (self, incoming, bool init=False)

Protected Member Functions
None	_do_shutdown (self)
Protected Member Functions inherited from microscope.abc.Device
	_do_disable (self)
	_do_enable (self)

Protected Attributes
bool	_initialized = False
	_uid = uid
Protected Attributes inherited from microscope.abc.FloatingDeviceMixin
	_index = index
Protected Attributes inherited from microscope.abc.Device
dict	_settings = {}

Additional Inherited Members
Public Attributes inherited from microscope.abc.Device
bool	enabled = False

Detailed Description

Simple device with a UID after having been initialized.

Floating devices are devices where we can't specify which one to
get, we can only construct it and after initialisation check its
UID.  In this class for test units we can check which UID to get.

Definition at line 213 of file devices.py.

Constructor & Destructor Documentation

__init__()

None microscope.testsuite.devices.TestFloatingDevice.__init__	(		self,
		str	uid,
		**	kwargs )

Reimplemented from microscope.abc.FloatingDeviceMixin.

Definition at line 224 of file devices.py.

    def __init__(self, uid: str, **kwargs) -> None:
        super().__init__(**kwargs)
        self._initialized = False
        self._uid = uid
        self.initialize()
 

Member Function Documentation

_do_shutdown()

None microscope.testsuite.devices.TestFloatingDevice._do_shutdown ( self )

protected

Private method - actual shutdown of the device.

Users should be calling :meth:`shutdown` and not this method.
Concrete implementations should implement this method instead
of `shutdown`.

Reimplemented from microscope.abc.Device.

Definition at line 246 of file devices.py.

    def _do_shutdown(self) -> None:
        pass

get_id()

str microscope.testsuite.devices.TestFloatingDevice.get_id

(

self

)

Return a unique hardware identifier such as a serial number.

Reimplemented from microscope.abc.FloatingDeviceMixin.

Definition at line 238 of file devices.py.

    def get_id(self) -> str:
        if self._initialized:
            return self._uid
        else:
            raise microscope.IncompatibleStateError(
                "uid is not available until after initialisation"
            )
 

get_index()

int microscope.testsuite.devices.TestFloatingDevice.get_index

(

self

)

Expose private _index for testing purposes.

Definition at line 234 of file devices.py.

    def get_index(self) -> int:
        """Expose private _index for testing purposes."""
        return self._index
 

initialize()

None microscope.testsuite.devices.TestFloatingDevice.initialize

(

self

)

Initialize the device.

If devices have this method (not required, and many don't),
then they should call it as part of the initialisation, i.e.,
they should call it on their `__init__` method.

Reimplemented from microscope.abc.Device.

Definition at line 230 of file devices.py.

    def initialize(self) -> None:
        super().initialize()
        self._initialized = True
 

Member Data Documentation

_initialized

bool microscope.testsuite.devices.TestFloatingDevice._initialized = False

protected

Definition at line 226 of file devices.py.

_uid

microscope.testsuite.devices.TestFloatingDevice._uid = uid

protected

Definition at line 227 of file devices.py.

---

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

• BioImager/PythonMicroscope/microscope/testsuite/devices.py