Base/abstract trigger class. More...
Public Member Functions | |
| def | __init__ (self, theConfig=CfgTrigger()) |
| Constructor for base trigger class. More... | |
| def | test (self, theSig) |
| Check if a report should be triggered for the supplied signal. More... | |
Public Attributes | |
| config | |
Detailed Description
Base/abstract trigger class.
A trigger determines when a particular state or signal should be reported. In the python logging API, a trigger is similar to a filter and is tested before constructing the message or moving forward on state/signal reporting. Usually, in logging some external process requests the log to happen, and the filter applies some logic to determine if the logging should be permitted.
Here, there is a continuously submitted state/signal and the choice must be made as to whether the state should be reported or not. A trigger uses the history of a state–or possible other externally derived states–to estalish when to "announce" or report a given piece of information. The announcer then pipes the message or announcement to the proper channel. In the python logging API, a trigger is similar to a filter is tested before constructing the message or moving forward on state/signal reporting. Usually, in logging some external process requests the log to happen, and the filter applies some logic to determine if the logging should be permitted. Here, there is a continuously submitted state/signal and the choice must be made as to whether the state should be reported or not.
Various triggers are possible, such as always report, report only on change, report if equal to some reference, etc. The role of the trigger is to provide a binary indication as to whether the state/signal should be reported.
Constructor & Destructor Documentation
◆ __init__()
| def __init__ | ( | self, | |
theConfig = CfgTrigger() |
|||
| ) |
Member Function Documentation
◆ test()
| def test | ( | self, | |
| theSig | |||
| ) |
Check if a report should be triggered for the supplied signal.
The base class is the worst trigger possible. Always false. There is no reporting. For the opposite, use the always trigger.
Reimplemented in whenDiffers, whenSimilar, whenFar, whenClose, onMatch, onChange, Falling, Rising, and Always.
Member Data Documentation
◆ config
| config |
The documentation for this class was generated from the following file:
- /home/pvela/python/perceiver/perceiver/reports/triggers.py
