rtshell.plan.BasicCondition Class Reference

Condition objects. More...

Inheritance diagram for rtshell.plan.BasicCondition:

List of all members.

Public Member Functions
def	__init__
def	__str__
def	cancel
def	error
def	immediate
def	satisfied
def	sequence
def	set_args
def	start
def	wait_for_exit
Private Attributes
	_args
	_desc
	_err_lock
	_error
	_executor
	_immediate
	_kwargs
	_sat_lock
	_satisfied
	_sequence

---

Detailed Description

Condition objects.

A simple condition specifying just a sequence ordering.

This condition is immediate.

All other condition types should inherit from this type, and must implement
the @ref start method.

Definition at line 242 of file plan.py.

---

Constructor & Destructor Documentation

def rtshell.plan.BasicCondition.__init__	(		self,
			executor = None,
			sequence = -1,
			desc = '',
			args,
			kwargs
	)

Reimplemented in rtshell.plan.MonitorCondition.

Definition at line 251 of file plan.py.

---

Member Function Documentation

def rtshell.plan.BasicCondition.__str__

(

self

)

Reimplemented in rtshell.plan.DelayedCondition, and rtshell.plan.SleepCondition.

Definition at line 262 of file plan.py.

def rtshell.plan.BasicCondition.cancel

(

self

)

Reimplemented in rtshell.plan.EventCondition, rtshell.plan.DelayedCondition, and rtshell.plan.SleepCondition.

Definition at line 265 of file plan.py.

def rtshell.plan.BasicCondition.error

(

self

)

Any error that has occurred in this condition.

Definition at line 281 of file plan.py.

def rtshell.plan.BasicCondition.immediate

(

self

)

Will this condition be satisfied immediately?

Definition at line 287 of file plan.py.

def rtshell.plan.BasicCondition.satisfied

(

self

)

Is this condition satisfied?

Definition at line 292 of file plan.py.

def rtshell.plan.BasicCondition.sequence

(

self

)

The sequence order of this condition.

Definition at line 298 of file plan.py.

def rtshell.plan.BasicCondition.set_args	(		self,
			args,
			kwargs
	)

Definition at line 268 of file plan.py.

def rtshell.plan.BasicCondition.start

(

self

)

Reimplemented in rtshell.plan.DelayedCondition, and rtshell.plan.SleepCondition.

Definition at line 272 of file plan.py.

def rtshell.plan.BasicCondition.wait_for_exit

(

self

)

Wait for this condition's thread to exit.

Reimplemented in rtshell.plan.DelayedCondition.

Definition at line 275 of file plan.py.

---

Member Data Documentation

rtshell::plan.BasicCondition::_args [private]

Definition at line 268 of file plan.py.

rtshell::plan.BasicCondition::_desc [private]

Definition at line 251 of file plan.py.

rtshell::plan.BasicCondition::_err_lock [private]

Definition at line 251 of file plan.py.

rtshell::plan.BasicCondition::_error [private]

Reimplemented in rtshell.plan.DelayedCondition.

Definition at line 251 of file plan.py.

rtshell::plan.BasicCondition::_executor [private]

Definition at line 251 of file plan.py.

rtshell::plan.BasicCondition::_immediate [private]

Reimplemented in rtshell.plan.DelayedCondition, and rtshell.plan.SleepCondition.

Definition at line 251 of file plan.py.

rtshell::plan.BasicCondition::_kwargs [private]

Definition at line 268 of file plan.py.

rtshell::plan.BasicCondition::_sat_lock [private]

Definition at line 251 of file plan.py.

rtshell::plan.BasicCondition::_satisfied [private]

Reimplemented in rtshell.plan.DelayedCondition, and rtshell.plan.SleepCondition.

Definition at line 251 of file plan.py.

rtshell::plan.BasicCondition::_sequence [private]

Definition at line 251 of file plan.py.

---

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

• plan.py