rtshell.plan.EventCondition Class Reference

Inheritance diagram for rtshell.plan.EventCondition:

List of all members.

Public Member Functions
def	__init__
def	cancel
def	set
Private Member Functions
def	_check
Private Attributes
	_event

---

Detailed Description

A condition that waits for an event.

This condition is delayed.

This condition waits on a @ref threading.Event object. It uses a separate
thread to perform the wait; it will sleep until its event is set. When the
event is set, it wakes up and notifies its executor, then exits. If the
event is not set within an optional timeout (specified in ms), @ref
PrecedingTimeoutError is set. Set timeout to None for no timeout.

Definition at line 412 of file plan.py.

---

Constructor & Destructor Documentation

def rtshell.plan.EventCondition.__init__	(		self,
			args,
			kwargs
	)

Definition at line 424 of file plan.py.

---

Member Function Documentation

def rtshell.plan.EventCondition._check

(

self

)

[private]

Definition at line 435 of file plan.py.

def rtshell.plan.EventCondition.cancel

(

self

)

Reimplemented from rtshell.plan.DelayedCondition.

Definition at line 428 of file plan.py.

def rtshell.plan.EventCondition.set

(

self

)

Definition at line 432 of file plan.py.

---

Member Data Documentation

rtshell::plan.EventCondition::_event [private]

Definition at line 424 of file plan.py.

---

The documentation for this class was generated from the following file:

• plan.py