Inheritance diagram for rtshell.plan.MonitorCondition:
Public Member Functions | |
| def | __init__ |
Private Member Functions | |
| def | _check |
Private Attributes | |
| _callback | |
| _sleep_time | |
| _target | |
Detailed Description
A condition that monitors a state. This condition is delayed. This condition continuously monitors the state of a callback function. When the callback's return value matches a provided target value, the condition is satisfied. If this does not occur within an optional timeout (specified in ms), @ref PrecedingTimeoutError is set. Set timeout to None for no timeout. The callback will be called at the frequency specified, in Hertz. The callback will be passed all the arguments that get passed to @ref set_args. It should accept any arguments it needs, as well as *args and **kwargs.
Constructor & Destructor Documentation
| def rtshell.plan.MonitorCondition.__init__ | ( | self, | |
callback = None, |
|||
target = None, |
|||
freq = 100, |
|||
| args, | |||
| kwargs | |||
| ) |
Reimplemented from rtshell.plan.BasicCondition.
Member Function Documentation
| def rtshell.plan.MonitorCondition._check | ( | self | ) | [private] |
Member Data Documentation
rtshell::plan.MonitorCondition::_target [private] |
The documentation for this class was generated from the following file: