ifw-sup  1.0.0
Public Member Functions | List of all members
subsimCommands.SubsimCommands Class Reference

Class managing the interface with a subsystem simulato. More...

Public Member Functions

def __init__ (self, uri, timeout=60000)
 
def reset_buffer (self)
 Clean Setup buffer (message) More...
 
def size (self)
 Get size of buffer (message) More...
 
def get (self, index)
 Get size of buffer (message) More...
 
def set_config_reply_ok (self, cmdname, flag)
 Set reply flag (message) More...
 
def set_config_delay (self, cmdname, delay)
 Set delay (message) More...
 
def set_config_errmsg (self, cmdname, msg)
 Set error message. More...
 
def config (self)
 Execute config Command. More...
 
def cfgreply (self, cmd, flag)
 Execute cfgreply Command. More...
 
def cfgdelay (self, cmd, delay)
 Execute cfgdelay Command. More...
 
def cfgerrmsg (self, cmd, msg)
 Configure error message. More...
 
def get_status (self, *argv)
 Execute GetStatus Command. More...
 
def get_state (self)
 Execute GetState Command. More...
 
def init (self)
 Execute Init Command. More...
 
def enable (self)
 Execute Enable Command. More...
 
def disable (self)
 Execute Disable Command. More...
 
def reset (self)
 Execute Reset Command. More...
 
def stop (self)
 Execute Stop Command. More...
 
def setup (self)
 Execute Setup Command asynchronously. More...
 
def get_config (self)
 Execute Setup Command asynchronously. More...
 

Detailed Description

Class managing the interface with a subsystem simulato.

Constructor & Destructor Documentation

◆ __init__()

def subsimCommands.SubsimCommands.__init__ (   self,
  uri,
  timeout = 60000 
)

Member Function Documentation

◆ cfgdelay()

def subsimCommands.SubsimCommands.cfgdelay (   self,
  cmd,
  delay 
)

Execute cfgdelay Command.

   It changes the default delay per command.

◆ cfgerrmsg()

def subsimCommands.SubsimCommands.cfgerrmsg (   self,
  cmd,
  msg 
)

Configure error message.

   It changes the default error message per command.

◆ cfgreply()

def subsimCommands.SubsimCommands.cfgreply (   self,
  cmd,
  flag 
)

Execute cfgreply Command.

   It changes the default reply of a command.
       If the flag is true, the command returns succesfully.
       If the flag is false, the command returns with an error.

◆ config()

def subsimCommands.SubsimCommands.config (   self)

Execute config Command.

◆ disable()

def subsimCommands.SubsimCommands.disable (   self)

Execute Disable Command.

◆ enable()

def subsimCommands.SubsimCommands.enable (   self)

Execute Enable Command.

◆ get()

def subsimCommands.SubsimCommands.get (   self,
  index 
)

Get size of buffer (message)

◆ get_config()

def subsimCommands.SubsimCommands.get_config (   self)

Execute Setup Command asynchronously.

◆ get_state()

def subsimCommands.SubsimCommands.get_state (   self)

Execute GetState Command.

◆ get_status()

def subsimCommands.SubsimCommands.get_status (   self,
argv 
)

Execute GetStatus Command.

◆ init()

def subsimCommands.SubsimCommands.init (   self)

Execute Init Command.

◆ reset()

def subsimCommands.SubsimCommands.reset (   self)

Execute Reset Command.

◆ reset_buffer()

def subsimCommands.SubsimCommands.reset_buffer (   self)

Clean Setup buffer (message)

◆ set_config_delay()

def subsimCommands.SubsimCommands.set_config_delay (   self,
  cmdname,
  delay 
)

Set delay (message)

◆ set_config_errmsg()

def subsimCommands.SubsimCommands.set_config_errmsg (   self,
  cmdname,
  msg 
)

Set error message.

◆ set_config_reply_ok()

def subsimCommands.SubsimCommands.set_config_reply_ok (   self,
  cmdname,
  flag 
)

Set reply flag (message)

◆ setup()

def subsimCommands.SubsimCommands.setup (   self)

Execute Setup Command asynchronously.

◆ size()

def subsimCommands.SubsimCommands.size (   self)

Get size of buffer (message)

◆ stop()

def subsimCommands.SubsimCommands.stop (   self)

Execute Stop Command.


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