Real-Time Sequence Tools

niveristand.realtimesequencetools.run_py_as_rtseq(toplevelfunc, rtseq_params={})

Runs a Python function as an RT sequence in the VeriStand Engine.

Parameters

• toplevelfunc – the Python function to run.

• rtseq_params (Dict[str, niveristand.clientapi._datatypes.rtprimitives.DoubleValue]) – the parameters to be passed to the RT sequence.

Returns

The numeric value returned by the real-time sequence execution.

Return type

Union[float, None]

Raises

• TranslateError – if the function is not successfully translated.

• RunAbortedError – if this function calls generate_error with an action of Abort or Stop.

• RunFailedError – if this function calls generate_error with a Continue action.

niveristand.realtimesequencetools.save_py_as_rtseq(toplevelfunc, dest_folder)

Saves a Python function as an RT sequence that is compatible with the Stimulus Profile Editor.

Parameters

• toplevelfunc – the Python function you want to save.

• dest_folder[str] – the folder you want to save the sequence and all its dependencies in.

Returns

The full path to the main sequence file.

Raises

niveristand.errors.TranslateError – if the function is not successfully translated.