Uranium
Application Framework
Loading...
Searching...
No Matches
UM.Backend.Backend.Backend Class Reference

Base class for any backend communication (separate piece of software). More...

Inheritance diagram for UM.Backend.Backend.Backend:
UM.PluginObject.PluginObject

Public Member Functions

 __init__ (self)
 
 startEngine (self)
 Start the backend / engine.
 
 close (self)
 
 getLog (self)
 Get the logging messages of the backend connection.
 
 convertBytesToVerticeList (self, data)
 Convert byte array containing 3 floats per vertex.
 
 convertBytesToVerticeWithNormalsList (self, data)
 Convert byte array containing 6 floats per vertex.
 
 getEngineCommand (self)
 Get the command used to start the backend executable.
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
 __init__ (self)
 
 getPluginId (self)
 
 setPluginId (self, plugin_id)
 

Static Public Attributes

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

Protected Member Functions

 _backendLog (self, line)
 
 _runEngineProcess (self, command_list)
 Start the (external) backend process.
 
 _storeOutputToLogThread (self, handle)
 
 _storeStderrToLogThread (self, handle)
 
 _onSocketStateChanged (self, state)
 Private socket state changed handler.
 
 _logSocketState (self, state)
 Debug function created to provide more info for CURA-2127.
 
 _onMessageReceived (self)
 Private message handler.
 
 _onSocketError (self, error)
 Private socket error handler

 
 _createSocket (self, protocol_file)
 Creates a socket and attaches listeners.
 

Protected Attributes

 _supported_commands
 
 _message_handlers
 
 _socket
 
 _port
 
 _process
 
 _backend_log
 
 _backend_log_max_lines
 
 _createSocket
 
 _onSocketStateChanged
 
 _onMessageReceived
 
 _onSocketError
 
- Protected Attributes inherited from UM.PluginObject.PluginObject
 _plugin_id
 

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__()

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

Reimplemented from UM.PluginObject.PluginObject.

Member Function Documentation

◆ getLog()

UM.Backend.Backend.Backend.getLog (   self)

Get the logging messages of the backend connection.

Returns

◆ startEngine()

UM.Backend.Backend.Backend.startEngine (   self)

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: