microscope.abc.Controller Class Reference

Inheritance diagram for microscope.abc.Controller:

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

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

Detailed Description

Device that controls multiple devices.

Controller devices usually control multiple stage devices,
typically a XY and Z stage, a filterwheel, and a light source.
Controller devices also include multi light source engines.

Each of the controlled devices requires a name.  The choice of
name and its documentation is left to the concrete class.

Shutting down a controller device must shutdown the controlled
devices.  Concrete classes should be careful to prevent that the
shutdown of a controlled device does not shutdown the controller
and the other controlled devices.  This might require that
controlled devices do nothing as part of their shutdown.

Definition at line 1322 of file abc.py.

Member Function Documentation

devices()

typing.Mapping[str, Device] microscope.abc.Controller.devices

(

self

)

Map of names to the controlled devices.

Reimplemented in microscope.controllers.coolled.CoolLED, microscope.controllers.lumencor.SpectraIIILightEngine, microscope.controllers.prior.ProScanIII, microscope.controllers.toptica.iChromeMLE, microscope.controllers.zaber._ZaberLEDController, microscope.controllers.zaber.ZaberDaisyChain, microscope.simulators.SimulatedController, and microscope.stages.ludl.ludlMC2000.

Definition at line 1342 of file abc.py.

    def devices(self) -> typing.Mapping[str, Device]:
        """Map of names to the controlled devices."""
        raise NotImplementedError()
 

References microscope.abc.Controller.devices(), microscope.controllers.coolled.CoolLED.devices(), microscope.controllers.lumencor.SpectraIIILightEngine.devices(), microscope.controllers.prior.ProScanIII.devices(), microscope.controllers.toptica.iChromeMLE.devices(), microscope.controllers.zaber._ZaberLEDController.devices(), microscope.controllers.zaber.ZaberDaisyChain.devices(), microscope.simulators.SimulatedController.devices(), and microscope.stages.ludl.ludlMC2000.devices().

Referenced by microscope.abc.Controller.devices().

---

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

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