pafsim.executor

Module Contents

class pafsim.executor.Executor(conf: dict = None)

The Executor enables the simulation of comprehensive simulation configuration with nested Processing chains.

Construct an Executor object

Parameters:

conf (dict, optional) – The discrition of the simulation. Defaults to None.

update(conf: dict)

Updates the current configuration

Parameters:

conf (dict) – the dictionary to update with

Raises:

Exception – raises if the update fails

run(plot: bool = True, overwrite=True)

Starts with the execution of the defined processing components

Parameters:

plot (bool, optional) – Plots the data of all components. Defaults to False.

add(chain: pafsim.chain.ProcessingChain)

Adds a processing chain to the execution

Parameters:

chain (ProcessingChain) – Another chain to execute

getVectorById(name: str)

Get a test vector by its ID

Parameters:

name (str) – The ID of a test vector

Returns:

The Vector

Return type:

Vector

getChain(name: str) pafsim.chain.ProcessingChain

Get a registered ProcessingChain object by its name

Parameters:

name (str) – The name of the ProcessingChain

Returns:

The ProcessingChain object if it exists, otherwise None

Return type:

ProcessingChain