Uranium
Application Framework
UM.Backend.Backend.Backend Class Reference
Inheritance diagram for UM.Backend.Backend.Backend:
UM.PluginObject.PluginObject

Public Member Functions

def __init__ (self)
 
def setState (self, new_state)
 
def startEngine (self)
 
def close (self)
 
def getLog (self)
 
def getEngineCommand (self)
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
None __init__ (self, *args, **kwags)
 
str getId (self)
 
None setPluginId (self, str plugin_id)
 
None setMetaData (self, Dict[str, Any] metadata)
 
Dict[str, Any] getMetaData (self)
 
str getPluginId (self)
 
None setVersion (self, str version)
 
str getVersion (self)
 

Static Public Attributes

 processingProgress = Signal()
 
 backendStateChange = Signal()
 
 backendConnected = Signal()
 
 backendQuit = Signal()
 

Detailed Description

Base class for any backend communication (separate piece of software).
It makes use of the Socket class from libArcus for the actual communication bits.
The message_handlers dict should be filled with string (full name of proto message), function pairs.

Constructor & Destructor Documentation

◆ __init__()

def UM.Backend.Backend.Backend.__init__ (   self)

Reimplemented from UM.PluginObject.PluginObject.

Member Function Documentation

◆ getEngineCommand()

def UM.Backend.Backend.Backend.getEngineCommand (   self)
Get the command used to start the backend executable 

◆ getLog()

def UM.Backend.Backend.Backend.getLog (   self)
Get the logging messages of the backend connection.

◆ startEngine()

def UM.Backend.Backend.Backend.startEngine (   self)
:brief Start the backend / engine.
Runs the engine, this is only called when the socket is fully opened & ready to accept connections

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