A generic logic interface class. More...
Inheritance diagram for generic_logic.GenericLogic:
Collaboration diagram for generic_logic.GenericLogic:
Public Member Functions | |
| def | __init__ (self, kwargs) |
| Initialzize a logic module. More... | |
| def | moveToThread (self, thread) |
| def | getModuleThread (self) |
| Get the thread associated to this module. More... | |
| def | getTaskRunner (self) |
| Get a reference to the task runner module registered in the manager. More... | |
 Public Member Functions inherited from core.module.BaseMixin | |
| def | __init__ (self, manager, name, config=None, callbacks=None, kwargs) |
| Initialise Base class object and set up its state machine. More... | |
| def | log (self) |
| Returns a logger object. | |
| def | is_module_threaded (self) |
| Returns whether the module shall be started in a thread. | |
| def | on_activate (self) |
| Method called when module is activated. More... | |
| def | on_deactivate (self) |
| Method called when module is deactivated. More... | |
| def | getStatusVariables (self) |
| Return a dict of variable names and their content representing the module state for saving. More... | |
| def | setStatusVariables (self, variableDict) |
| Give a module a dict of variable names and their content representing the module state. More... | |
| def | getConfiguration (self) |
| Return the configration dictionary for this module. More... | |
| def | get_connector (self, connector_name) |
| Return module connected to the given named connector. More... | |
| Public Member Functions inherited from core.module.ModuleMeta | |
| def | __new__ (cls, name, bases, attrs) |
| Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More... | |
Public Attributes | |
| taskLock | |
| Public Attributes inherited from core.module.BaseMixin | |
| module_state | |
| connectors | |
Detailed Description
A generic logic interface class.
Constructor & Destructor Documentation
◆ __init__()
| def generic_logic.GenericLogic.__init__ | ( | self, | |
| kwargs | |||
| ) |
Initialzize a logic module.
- Parameters
-
dict kwargs: dict of additional arguments
Member Function Documentation
◆ getModuleThread()
| def generic_logic.GenericLogic.getModuleThread | ( | self | ) |
Get the thread associated to this module.
- Returns
- QThread: thread with qt event loop associated with this module
◆ getTaskRunner()
| def generic_logic.GenericLogic.getTaskRunner | ( | self | ) |
Get a reference to the task runner module registered in the manager.
- Returns
- object: reference to task runner
If there isno registered task runner, an exception is raised.
The documentation for this class was generated from the following file:
- logic/generic_logic.py
