CovertMark.handler module

class CovertMark.handler.CommandHandler(strategy_map)[source]

Bases: object

csv()[source]
current()[source]
delete()[source]
delresults()[source]
dispatch(command)[source]

Dispatch a user command or a sequence of commands to the correct methods.

Parameters:command (str) – a top-level command matching the name of a handler method, with parameter gathering handled by the handler method itself. This can also be a sequence of commands separated by “;”.
Returns:False if the command does not map to a handler method, True if otherwise handler successfully executed.
execute()[source]
exit()[source]
help()[source]
load()[source]
new()[source]
plot()[source]
results()[source]
save()[source]
score()[source]
set_procedure(procedure)[source]

Replace the current procedure. Used for parameterised execution.

Parameters:procedure – a valid CovertMark procedure.
Returns:True if procedure set successfully, False otherwise.
traces()[source]
wireshark()[source]
class CovertMark.handler.Commands[source]

Bases: object

cs = {'csv': <function CommandHandler.csv at 0x10c358ea0>, 'current': <function CommandHandler.current at 0x10c358ae8>, 'delete': <function CommandHandler.delete at 0x10c358950>, 'delresults': <function CommandHandler.delresults at 0x10c358d08>, 'execute': <function CommandHandler.execute at 0x10c358b70>, 'exit': <function CommandHandler.exit at 0x10c3587b8>, 'help': <function CommandHandler.help at 0x10c358840>, 'load': <function CommandHandler.load at 0x10c3589d8>, 'new': <function CommandHandler.new at 0x10c358a60>, 'plot': <function CommandHandler.plot at 0x10c358f28>, 'results': <function CommandHandler.results at 0x10c358c80>, 'save': <function CommandHandler.save at 0x10c358bf8>, 'score': <function CommandHandler.score at 0x10c358e18>, 'traces': <function CommandHandler.traces at 0x10c3588c8>, 'wireshark': <function CommandHandler.wireshark at 0x10c358d90>}
hs = {'csv': 'Generate and export full CSVs of results.', 'current': 'Display the current procedure.', 'delete': 'Select and delete traces.', 'delresults': 'Clear the currently stored results.', 'execute': 'Execute the current procedure.', 'exit': 'Exit this program.', 'help': 'Display this help information.', 'load': 'Load and execute an existing benchmark procedure in json.', 'new': 'Program a new benchmark procedure to replace the current procedure.', 'plot': 'Select and plot data from results.', 'results': 'List results from strategy runs in this session.', 'save': 'Save the current procedure to file.', 'score': 'Compute CovertMark scores for the current results.', 'traces': 'List all available traces.', 'wireshark': 'Get the Wireshark display filters for a result.'}
classmethod register(help_text)[source]