Table Of Contents
Table Of Contents

inet.simulation.build.CopyBinaryTask

class inet.simulation.build.CopyBinaryTask(simulation_project=None, name='copy binaries task', type='dynamic library', mode='release', task_result_class=BuildTaskResult, **kwargs)

Bases: inet.common.compile.BuildTask

Represents 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.

run(**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.KeyboardInterruptHandler or 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(**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.