Class managing the interface with a FCF DevMg.
More...
|
| def | __init__ (self, uri, timeout=60000, setup_obj=None) |
| | Class constructor. More...
|
| |
| def | cfgreply (self, cmd, flag) |
| |
| def | cfgdelay (self, cmd, delay) |
| |
| def | cfgerrmsg (self, cmd, msg) |
| |
| def | setup (self) |
| |
| def | get_config (self) |
| |
| def | help (self, func=None) |
| |
Class managing the interface with a FCF DevMg.
◆ __init__()
| def subsim_async_commands.SubsimAsyncCommands.__init__ |
( |
|
self, |
|
|
|
uri, |
|
|
|
timeout = 60000, |
|
|
|
setup_obj = None |
|
) |
| |
Class constructor.
- Parameters
-
| uri | service URI (CII endpoint). timeout (bool, optional): CII communication timeout. setup_obj (object, optional): Setup object instance. |
If a setup object is not provided it will use an internal one. This setup object store all settings for the Setup command. It is not relevant for other commands.
◆ cfgdelay()
| def subsim_async_commands.SubsimAsyncCommands.cfgdelay |
( |
|
self, |
|
|
|
cmd, |
|
|
|
delay |
|
) |
| |
Execute cfgdelay Command
It changes the default delay per command.
◆ cfgerrmsg()
| def subsim_async_commands.SubsimAsyncCommands.cfgerrmsg |
( |
|
self, |
|
|
|
cmd, |
|
|
|
msg |
|
) |
| |
Configure error message
It changes the default error message per command.
◆ cfgreply()
| def subsim_async_commands.SubsimAsyncCommands.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.
◆ get_config()
| def subsim_async_commands.SubsimAsyncCommands.get_config |
( |
|
self | ) |
|
Execute Setup Command asynchronously
◆ help()
| def subsim_async_commands.SubsimAsyncCommands.help |
( |
|
self, |
|
|
|
func = None |
|
) |
| |
Provides a text based help of the Command class functions.
Args:
func (str, optional): Name of the function from where to get the help
This method is to be used for the implementation of CLIs.
Functions are methods of the class.
If the parameter <func> is not provided then the help provides a list of
functions. Functions started with '_' are skipped.
◆ setup()
| def subsim_async_commands.SubsimAsyncCommands.setup |
( |
|
self | ) |
|
Execute Setup Command asynchronously
The documentation for this class was generated from the following file:
