RTC Toolkit  2.0.0
Public Member Functions | Static Public Attributes | List of all members
comms.oldb.OldbClient Class Reference

Wrapper to wait for an OLDB Client connection to be ready using Qt signals. More...

Inheritance diagram for comms.oldb.OldbClient:

Public Member Functions

def __init__ (self, QObject parent=None)
 Initializes object and logge. More...
 
def sync_connect (self)
 Connects to OLDB synchronously. More...
 

Static Public Attributes

 connection_changed = Signal(int)
 
 connected = Signal(bool)
 
 disconnected = Signal(bool)
 
 error_detected = Signal(str)
 

Detailed Description

Wrapper to wait for an OLDB Client connection to be ready using Qt signals.

The developer calls OldbClient().sync_connect(), and when the OldbClient instance has been succesfully obtained, signals connection_changed(2) and connected(True) are emitted. This allows UI to wait for the OLDB Client connection.

In case of error, connection_changed(0), disconnected(True) and error_detected(str) are emitted.

While connecting, signal connection_changed(1) is emitted

IMPORTANT OldbClient().async_connect() is not usable at the moment due to limitation on CiiOldbFactory.get_instance. It is commented for the time being.

Constructor & Destructor Documentation

◆ __init__()

def comms.oldb.OldbClient.__init__ (   self,
QObject   parent = None 
)

Initializes object and logge.

Member Function Documentation

◆ sync_connect()

def comms.oldb.OldbClient.sync_connect (   self)

Connects to OLDB synchronously.

This method will block.

   Connected to the OLDB, and notifies using signals of the result of the
   connection attempt.

   @return CiiOldb reference or None if not succesfull
Note
This is a workaround. This should be moved to TaurusCiiAttribute implementation later. Also, a static method needs to be provided that can do the same.

Member Data Documentation

◆ connected

comms.oldb.OldbClient.connected = Signal(bool)
static

◆ connection_changed

comms.oldb.OldbClient.connection_changed = Signal(int)
static

◆ disconnected

comms.oldb.OldbClient.disconnected = Signal(bool)
static

◆ error_detected

comms.oldb.OldbClient.error_detected = Signal(str)
static

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