Simulation Sets

Simulation Set

class mhrc.automation.simulation.SimulationSet(pscad, simset_name)

Simulation Set command object

Management

SimulationSet.name(name=None)

Get or set the name of the simulation set

Parameters:name (str) – New name of simulation set (optional) Returns:The name of the simulation set.

SimulationSet.depends_on(name=None)

Get or set the simulation set dependency

Parameters:name (str) – Name of simulation set dependency (optional) Returns:The name of the simulation set dependency.

Tasks

SimulationSet.list_tasks()

List projects included in the simulation set.

Returns:A list of the tasks (projects) included in the simulation set.

SimulationSet.add_tasks(*task_names)

Add one or more tasks (projects) to the simulation set.

Parameters:*name (str) – Names of tasks (projects) to add to the simulation set

SimulationSet.remove_tasks(*task_names)

Remove one or more tasks (projects) from the simulation set.

Parameters:*name (str) – Names of tasks (projects) to remove.

SimulationSet.task(task_name)

Retrieve a controller proxy for an individual simulation set task.

Parameters:task_name (str) – Name of task

Build & Run

SimulationSet.run(consumer=None)

Run the simulation set.

Parameters:consumer – handler for events generated by the build/run (optional).

Simulation Set Task

class mhrc.automation.task.Task(pscad, simset_name, task_name)

Task command object

Settings

Task.namespace()

Get the namespace

Returns:The namespace. Return type:str

Task.controlgroup(controlgroup=None)

Get or set the control group

Parameters:controlgroup (str) – The control group Returns:The control group.

Task.volley(volley=None)

Get or set the volley count

Parameters:volley (int) – The volley count Returns:The volley count.

Task.affinity(affinity=None)

Get or set the trace affinity

Parameters:affinity (int) – The trace affinity Returns:The trace affinity.