Inheritance diagram for rtshell.plan.DelayedCondition:
Public Member Functions | |
| def | __init__ |
| def | __str__ |
| def | cancel |
| def | run |
| def | start |
| def | wait_for_exit |
Private Member Functions | |
| def | _check_timeout |
| def | _set_error |
Private Attributes | |
| _cancel_lock | |
| _cancelled | |
| _error | |
| _immediate | |
| _satisfied | |
| _start_time | |
| _timeout | |
Detailed Description
Base class for delayed conditions. Inheriting condition objects should implement the @ref check method, returning True or False appropriately. Delayed conditions start a separate thread, which they use to perform their condition check at an appropriate time. They use the reference to their owner to signal it that the condition has been met. If their condition is not met within an optional timeout (specified in ms), @ref PrecedingTimeoutError is set. Set the timeout to None for no timeout. Once a delayed condition is satisfied, you should ensure its thread has completed by calling @ref wait_for_exit.
Constructor & Destructor Documentation
| def rtshell.plan.DelayedCondition.__init__ | ( | self, | |
timeout = None, |
|||
| args, | |||
| kwargs | |||
| ) |
Member Function Documentation
| def rtshell.plan.DelayedCondition.__str__ | ( | self | ) |
Reimplemented from rtshell.plan.BasicCondition.
| def rtshell.plan.DelayedCondition._check_timeout | ( | self | ) | [private] |
| def rtshell.plan.DelayedCondition._set_error | ( | self, | |
| e | |||
| ) | [private] |
| def rtshell.plan.DelayedCondition.cancel | ( | self | ) |
Reimplemented from rtshell.plan.BasicCondition.
Reimplemented in rtshell.plan.EventCondition.
| def rtshell.plan.DelayedCondition.run | ( | self | ) |
| def rtshell.plan.DelayedCondition.start | ( | self | ) |
Reimplemented from rtshell.plan.BasicCondition.
| def rtshell.plan.DelayedCondition.wait_for_exit | ( | self | ) |
Wait for this condition's thread to exit.
Reimplemented from rtshell.plan.BasicCondition.
Member Data Documentation
rtshell::plan.DelayedCondition::_error [private] |
Reimplemented from rtshell.plan.BasicCondition.
Reimplemented from rtshell.plan.BasicCondition.
Reimplemented from rtshell.plan.BasicCondition.
rtshell::plan.DelayedCondition::_timeout [private] |
The documentation for this class was generated from the following file: