libtcspc.WarningEvent

class libtcspc.WarningEvent[source]

Bases: EventType

Event indicating a non-fatal, recoverable issue detected by a processor.

Used to report problems that do not by themselves require stopping the stream, such as input format anomalies, dropped or out-of-order events, or other recoverable conditions.

Notes

The corresponding C++ event has the field message. Producers of warnings should also pass any received warning events through, so multiple warning-emitting processors can be chained ahead of a single handler such as Stop or StopWithError.

A value is constructed by giving all fields, e.g. WarningEvent().value(message="out of order"); read them back as attributes (inst.message).

Constructing and inspecting individual event values from Python is intended for debugging and learning only and is extremely slow; production graphs process events in compiled C++ and exchange bulk data via buckets.

See also

tcspc::warning_event

The underlying C++ event type.

Stop

Convert warnings into a normal end-of-processing.

StopWithError

Convert warnings into a terminating error.