cut  1.2.2-pre1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
comms.maladapter.MalAdapter Class Reference

Convenience class to avoid boilerplate code when using MAL Interface. More...

Inheritance diagram for comms.maladapter.MalAdapter:

Public Member Functions

def __init__ (self, uri, interface_class)
 Initializator for the MalAdapter. More...
 
def __del__ (self)
 
def get_interface (self)
 
def getInterface (self)
 
def get_mal (self)
 
def getMal (self)
 
def get_factory (self)
 
def getFactory (self)
 
def isConnected (self)
 
def setConnected (self, state)
 
def setConnection (self, newValue)
 Connection Logic ##. More...
 
def connection_listener (self, status)
 

Public Attributes

 factory
 

Static Public Attributes

 connectionChanged = Signal(bool)
 "Connection" Property ## More...
 
 connected
 

Detailed Description

Convenience class to avoid boilerplate code when using MAL Interface.

The MalAdapter provides a convenience base class to avoid boilerplate code when connecting to MAL Interfaces. The developer creates a new class that inherits from MalAdapter, and the only pending task, is to develop Slots that provide access to Methods in the Interface.

MalAdapter also provides the connected Property, with the connectionChanged(bool) Signal. Please of this Signal to program event based changed for your applications.

Constructor & Destructor Documentation

◆ __init__()

def comms.maladapter.MalAdapter.__init__ (   self,
  uri,
  interface_class 
)

Initializator for the MalAdapter.

   The MalAdapter provides a convinience base class to avoid boilerplate code when
   connecting to MAL Interfaces.
   The developer needs

   :param interface_class
   :param uri: URI of the MAL Reply Request Endpoint

◆ __del__()

def comms.maladapter.MalAdapter.__del__ (   self)

Member Function Documentation

◆ connection_listener()

def comms.maladapter.MalAdapter.connection_listener (   self,
  status 
)

◆ get_factory()

def comms.maladapter.MalAdapter.get_factory (   self)

◆ get_interface()

def comms.maladapter.MalAdapter.get_interface (   self)

◆ get_mal()

def comms.maladapter.MalAdapter.get_mal (   self)

◆ getFactory()

def comms.maladapter.MalAdapter.getFactory (   self)

◆ getInterface()

def comms.maladapter.MalAdapter.getInterface (   self)

◆ getMal()

def comms.maladapter.MalAdapter.getMal (   self)

◆ isConnected()

def comms.maladapter.MalAdapter.isConnected (   self)

◆ setConnected()

def comms.maladapter.MalAdapter.setConnected (   self,
  state 
)

◆ setConnection()

def comms.maladapter.MalAdapter.setConnection (   self,
  newValue 
)

Connection Logic ##.

Member Data Documentation

◆ connected

comms.maladapter.MalAdapter.connected
static
Initial value:
= Property(bool, _connected,
isConnected, setConnected,
notify=connectionChanged)

◆ connectionChanged

comms.maladapter.MalAdapter.connectionChanged = Signal(bool)
static

"Connection" Property ##

◆ factory

comms.maladapter.MalAdapter.factory

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