hlcc 2.0.0-beta2+pre1
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
stdcmds_facade.StdCmdsFacade Class Reference
Inheritance diagram for stdcmds_facade.StdCmdsFacade:

Public Member Functions

def __init__ (self, str uri)
 Initializator for a new StdCmdsFacade.
 
def __del__ (self)
 
def init (self, result_slot=None, error_slot=None)
 StdCmds Slots ##.
 
def reset (self, result_slot=None, error_slot=None)
 This method executes the Reset command on the server.
 
def enable (self, result_slot=None, error_slot=None)
 This method executes the Enable command on the server.
 
def disable (self, result_slot=None, error_slot=None)
 This method executes the Disable command on the server.
 
def get_state (self, result_slot=None, error_slot=None)
 This method executes the GetState command on the server.
 
def get_status (self, result_slot=None, error_slot=None)
 This method executes the GetStatus command on the server.
 
def get_version (self, result_slot=None, error_slot=None)
 This method executes the GetVersion command on the server.
 
def stop (self, result_slot=None, error_slot=None)
 This method executes the Stop command on the server.
 
def exit (self, result_slot=None, error_slot=None)
 This method executes the Exit command on the server.
 
def set_log_level (self, str log_level, str logger, result_slot=None, error_slot=None)
 This method executes the SetLogLevel command on the server.
 
def thread_complete (self)
 Helper Methods ##.
 

Protected Attributes

 _status_ignore_flag
 
 _status_oldb_uri
 

Constructor & Destructor Documentation

◆ __init__()

def stdcmds_facade.StdCmdsFacade.__init__ (   self,
str  uri 
)

Initializator for a new StdCmdsFacade.

It inherits from MalAdapter, which provides all the connection logic ready to be used.

We mainly interact with MalAdapter through get_interface() get_mal() and get_factory(). We do not keep references to them.

This class exposes Slots that use the elt.cut.task.Task class to execute long-running operations in a separate thread. Each Slot is a method in the hellociiif interface.

Parameters
uriURI for the MAL reply request endpoint

◆ __del__()

def stdcmds_facade.StdCmdsFacade.__del__ (   self)

Member Function Documentation

◆ disable()

def stdcmds_facade.StdCmdsFacade.disable (   self,
  result_slot = None,
  error_slot = None 
)

This method executes the Disable command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ enable()

def stdcmds_facade.StdCmdsFacade.enable (   self,
  result_slot = None,
  error_slot = None 
)

This method executes the Enable command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ exit()

def stdcmds_facade.StdCmdsFacade.exit (   self,
  result_slot = None,
  error_slot = None 
)

This method executes the Exit command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ get_state()

def stdcmds_facade.StdCmdsFacade.get_state (   self,
  result_slot = None,
  error_slot = None 
)

This method executes the GetState command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ get_status()

def stdcmds_facade.StdCmdsFacade.get_status (   self,
  result_slot = None,
  error_slot = None 
)

This method executes the GetStatus command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ get_version()

def stdcmds_facade.StdCmdsFacade.get_version (   self,
  result_slot = None,
  error_slot = None 
)

This method executes the GetVersion command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ init()

def stdcmds_facade.StdCmdsFacade.init (   self,
  result_slot = None,
  error_slot = None 
)

StdCmds Slots ##.

This method executes the Init command on the server. It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ reset()

def stdcmds_facade.StdCmdsFacade.reset (   self,
  result_slot = None,
  error_slot = None 
)

This method executes the Reset command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ set_log_level()

def stdcmds_facade.StdCmdsFacade.set_log_level (   self,
str  log_level,
str  logger,
  result_slot = None,
  error_slot = None 
)

This method executes the SetLogLevel command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

log_level string Log Level logger string Logger to be affected by this command result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ stop()

def stdcmds_facade.StdCmdsFacade.stop (   self,
  result_slot = None,
  error_slot = None 
)

This method executes the Stop command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ thread_complete()

def stdcmds_facade.StdCmdsFacade.thread_complete (   self)

Helper Methods ##.

Print a thread message 'COMPLETE!'

Member Data Documentation

◆ _status_ignore_flag

stdcmds_facade.StdCmdsFacade._status_ignore_flag
protected

◆ _status_oldb_uri

stdcmds_facade.StdCmdsFacade._status_oldb_uri
protected

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