inet.test.fingerprint.task.FingerprintUpdateTask¶
- class inet.test.fingerprint.task.FingerprintUpdateTask(action='Updating fingerprint', **kwargs)¶
Bases:
inet.test.simulation.SimulationUpdateTaskRepresents a self-contained operation that captures all necessary information in order to be run.
Initializes a new task object.
- Parameters:
name (string) – A human readable short description of the task, usually a noun.
action (string) – A human readable short description of the operation the task is carrying out, usually a verb.
task_result_class (string) – The Python class name of the produced task result object.
- rerun(**kwargs)¶
Runs the task again.
- Returns (
TaskResult): The task result.
- Returns (
- run(context=None, progress=None, index=0, count=1, print_run_start_separately=False, dry_run=False, keyboard_interrupt_handler=None, handle_exception=True, **kwargs)¶
Runs the task.
- Parameters:
dry_run (bool) – Specifies to skip the actual running of the task but do everything else.
keyboard_interrupt_handler (
inet.common.KeyboardInterruptHandleror None) – Provides a class that will handle keyboard interrupts. This allows seamless exit from running multiple tasks.handle_exception (bool) – Specifies if exceptions are caught and processed or passed to the caller.
- Returns (
TaskResult): The task result.
- run_protected(ingredients='tplx', sim_time_limit=None, output_stream=sys.stdout, **kwargs)¶
Runs the task in the protected environment wrapped by
run(). This method is expected to be overridden by derived classes. The default implementation simply returns a task result with “DONE” result code.- Parameters:
kwargs (dict) – Not used in this implementation.
- Returns (
TaskResult): The task result.