qudi.core.LogicBase

class qudi.core.LogicBase(*args, **kwargs)[source]

Bases: qudi.core.module.Base

__init__(qudi_main_weakref: Any, name: str, config: Mapping[str, Any] | None = None, callbacks: Mapping[str, Callable] | None = None, **kwargs)

Initialize Base instance. Set up its state machine and initialize ConfigOption meta attributes from given config.

Parameters:

selfobject: The object being initialized.
namestr: Unique name for this module instance.
configurationdict: Parameters from the configuration file.
callbacksdict: Dictionary specifying functions to be run on state machine transitions.

Methods

`__init__`(qudi_main_weakref, name[, config, ...])	Initialize Base instance.
`blockSignals`(self, b)
`childEvent`(self, event)
`children`(self)
`connect`(...)
`connectNotify`(self, signal)
`connect_modules`(connections)	Connects given modules (values) to their respective Connector (keys).
`customEvent`(self, event)
`deleteLater`(self)
`disconnect`(...)
`disconnectNotify`(self, signal)
`disconnect_modules`()	Disconnects all Connector instances for this module.
`dumpObjectInfo`(self)
`dumpObjectTree`(self)
`dynamicPropertyNames`(self)
`emit`(self, arg__1, *args)
`event`(self, event)
`eventFilter`(self, watched, event)
`findChild`(self, arg__1[, arg__2])
`findChildren`(...)
`inherits`(self, classname)
`installEventFilter`(self, filterObj)
`isSignalConnected`(self, signal)
`isWidgetType`(self)
`isWindowType`(self)
`killTimer`(self, id)
`metaObject`(self)
`moveToThread`(self, thread)
`move_to_main_thread`()	Method that will move this module into the main/manager thread.
`objectName`(self)
`on_activate`()	Method called when module is activated.
`on_deactivate`()	Method called when module is deactivated.
`parent`(self)
`property`(self, name)
`receivers`(self, signal)
`registerUserData`()
`removeEventFilter`(self, obj)
`sender`(self)
`senderSignalIndex`(self)
`setObjectName`(self, name)
`setParent`(self, parent)
`setProperty`(self, name, value)
`signalsBlocked`(self)
`startTimer`(self, interval[, timerType])
`thread`(self)
`timerEvent`(self, event)
`tr`(self, arg__1[, arg__2, arg__3])

Attributes

`destroyed`
`is_module_threaded`	Returns whether the module shall be started in its own thread.
`log`	Returns the module logger instance
`module_base`	Read-only property returning the module base of this module instance ('hardware' 'logic' or 'gui')
`module_default_data_dir`	Read-only property returning the generic default directory in which to save data.
`module_name`	Read-only property returning the module name of this module instance as specified in the config.
`module_status_variables`
`module_thread`	Read-only property returning the current module QThread instance if the module is threaded.
`module_uuid`	Read-only property returning a unique uuid for this module instance.
`objectNameChanged`
`staticMetaObject`

__init__(qudi_main_weakref: Any, name: str, config: Mapping[str, Any] | None = None, callbacks: Mapping[str, Callable] | None = None, **kwargs)

Initialize Base instance. Set up its state machine and initialize ConfigOption meta attributes from given config.

Parameters:

selfobject: The object being initialized.
namestr: Unique name for this module instance.
configurationdict: Parameters from the configuration file.
callbacksdict: Dictionary specifying functions to be run on state machine transitions.

blockSignals(self, b: bool) → bool

childEvent(self, event: PySide2.QtCore.QChildEvent) → None

children(self) → List[PySide2.QtCore.QObject]

static connect(arg__1: PySide2.QtCore.QObject, arg__2: bytes, arg__3: Callable, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) → bool
static connect(self, arg__1: bytes, arg__2: Callable, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) → bool
static connect(self, arg__1: bytes, arg__2: PySide2.QtCore.QObject, arg__3: bytes, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) → bool
static connect(self, sender: PySide2.QtCore.QObject, signal: bytes, member: bytes, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) → PySide2.QtCore.QMetaObject.Connection
static connect(sender: PySide2.QtCore.QObject, signal: PySide2.QtCore.QMetaMethod, receiver: PySide2.QtCore.QObject, method: PySide2.QtCore.QMetaMethod, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) → PySide2.QtCore.QMetaObject.Connection
static connect(sender: PySide2.QtCore.QObject, signal: bytes, receiver: PySide2.QtCore.QObject, member: bytes, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) → PySide2.QtCore.QMetaObject.Connection

connectNotify(self, signal: PySide2.QtCore.QMetaMethod) → None

connect_modules(connections: Mapping[str, Any]) → None

Connects given modules (values) to their respective Connector (keys).

DO NOT CALL THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING!

customEvent(self, event: PySide2.QtCore.QEvent) → None

deleteLater(self) → None

destroyed: !! processed by numpydoc !!

static disconnect(arg__1: PySide2.QtCore.QMetaObject.Connection) → bool
static disconnect(arg__1: PySide2.QtCore.QObject, arg__2: bytes, arg__3: Callable) → bool
static disconnect(self, arg__1: bytes, arg__2: Callable) → bool
static disconnect(self, receiver: PySide2.QtCore.QObject, member: Optional[bytes] = None) → bool
static disconnect(self, signal: bytes, receiver: PySide2.QtCore.QObject, member: bytes) → bool
static disconnect(sender: PySide2.QtCore.QObject, signal: PySide2.QtCore.QMetaMethod, receiver: PySide2.QtCore.QObject, member: PySide2.QtCore.QMetaMethod) → bool
static disconnect(sender: PySide2.QtCore.QObject, signal: bytes, receiver: PySide2.QtCore.QObject, member: bytes) → bool

disconnectNotify(self, signal: PySide2.QtCore.QMetaMethod) → None

disconnect_modules() → None

Disconnects all Connector instances for this module.

DO NOT CALL THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING!

dumpObjectInfo(self) → None

dumpObjectTree(self) → None

dynamicPropertyNames(self) → List[PySide2.QtCore.QByteArray]

emit(self, arg__1: bytes, *args: None) → bool

event(self, event: PySide2.QtCore.QEvent) → bool

eventFilter(self, watched: PySide2.QtCore.QObject, event: PySide2.QtCore.QEvent) → bool

findChild(self, arg__1: type, arg__2: str = '') → object

findChildren(self, arg__1: type, arg__2: PySide2.QtCore.QRegExp) → Iterable
findChildren(self, arg__1: type, arg__2: PySide2.QtCore.QRegularExpression) → Iterable
findChildren(self, arg__1: type, arg__2: str = '') → Iterable

inherits(self, classname: bytes) → bool

installEventFilter(self, filterObj: PySide2.QtCore.QObject) → None

isSignalConnected(self, signal: PySide2.QtCore.QMetaMethod) → bool

isWidgetType(self) → bool

isWindowType(self) → bool

property is_module_threaded: bool: Returns whether the module shall be started in its own thread.

killTimer(self, id: int) → None

property log: Logger: Returns the module logger instance

metaObject(self) → PySide2.QtCore.QMetaObject

property module_base: str: Read-only property returning the module base of this module instance (‘hardware’ ‘logic’ or ‘gui’)

property module_default_data_dir: str: Read-only property returning the generic default directory in which to save data. Module implementations can overwrite this property with a custom path but should only do so with a very good reason.

property module_name: str: Read-only property returning the module name of this module instance as specified in the config.

property module_status_variables: Dict[str, Any]: !! processed by numpydoc !!

property module_thread: QThread | None: Read-only property returning the current module QThread instance if the module is threaded. Returns None otherwise.

property module_uuid: UUID: Read-only property returning a unique uuid for this module instance.

moveToThread(self, thread: PySide2.QtCore.QThread) → None

move_to_main_thread() → None: Method that will move this module into the main/manager thread.

objectName(self) → str

objectNameChanged: !! processed by numpydoc !!

abstract on_activate() → None: Method called when module is activated. Must be implemented by actual qudi module.

abstract on_deactivate() → None: Method called when module is deactivated. Must be implemented by actual qudi module.

parent(self) → PySide2.QtCore.QObject

property(self, name: bytes) → Any

receivers(self, signal: bytes) → int

static registerUserData() → int

removeEventFilter(self, obj: PySide2.QtCore.QObject) → None

sender(self) → PySide2.QtCore.QObject

senderSignalIndex(self) → int

setObjectName(self, name: str) → None

setParent(self, parent: PySide2.QtCore.QObject) → None

setProperty(self, name: bytes, value: Any) → bool

signalsBlocked(self) → bool

startTimer(self, interval: int, timerType: PySide2.QtCore.Qt.TimerType = PySide2.QtCore.Qt.TimerType.CoarseTimer) → int

staticMetaObject = <PySide2.QtCore.QMetaObject object>

thread(self) → PySide2.QtCore.QThread

timerEvent(self, event: PySide2.QtCore.QTimerEvent) → None

tr(self, arg__1: bytes, arg__2: bytes = b'', arg__3: int = -1) → str