7.1.3 Waveform tracing

traceSignals( func [, *args][, **kwargs]): Enables signal tracing to a VCD file for waveform viewing. func is a function that returns an instance. traceSignals() calls func under its control and passes *args and **kwargs to the call. In this way, it finds the hierarchy and the signals to be traced.
The return value is the same as would be returned by the call func(*args, **kwargs). The top-level instance name and the basename of the VCD output filename is func.func_name by default. If the VCD file exists already, it will be moved to a backup file by attaching a timestamp to it, before creating the new file.

The traceSignals callable has the following attribute:

name: This attribute is used to overwrite the default top-level instance name and the basename of the VCD output filename.

About this document