Action executor objects. More...

Public Member Functions
def	__call__
def	__init__
def	__str__
def	action
def	action
def	add_callback
def	add_condition
def	cancel
def	complete
def	error
def	id
def	id_string
def	immediate
def	run
def	set
def	sort_order
def	wait_for_exit
Private Member Functions
def	_cancel_conditions
def	_do_callbacks
def	_execute_action
def	_reduce_conds
def	_start_conds
Private Attributes
	_action
	_args
	_callbacks
	_cancel_lock
	_cancelled
	_completed
	_completed_lock
	_conditions
	_err_lock
	_error
	_flag
	_id
	_kwargs
	_owner_flag

Detailed Description

Action executor objects.

An object for managing execution of an action.

This object is capable of executing an action immediately when it is
called, or delaying execution until a set of conditions is reached. Which
should occur is chosen automatically. If execution needs to be delayed, a
new thread will be started to manage it. This thread will sleep until all
pre-conditions for the action are met. Any number of condition objects can
be added.

Callbacks can be added to be executed after executing the action.

Definition at line 48 of file plan.py.

Constructor & Destructor Documentation

def rtshell.plan.ActionExecutor.__init__	(	self,
		action = `None`,
		owner_flag = `None`,
		args,
		kwargs
	)

Definition at line 61 of file plan.py.

Member Function Documentation

def rtshell.plan.ActionExecutor.__call__	(	self,
		args,
		kwargs
	)

Definition at line 85 of file plan.py.

def rtshell.plan.ActionExecutor.__str__ ( self )

Definition at line 76 of file plan.py.

def rtshell.plan.ActionExecutor._cancel_conditions ( self ) [private]

Definition at line 206 of file plan.py.

def rtshell.plan.ActionExecutor._do_callbacks ( self ) [private]

Definition at line 212 of file plan.py.

def rtshell.plan.ActionExecutor._execute_action ( self ) [private]

Definition at line 216 of file plan.py.

def rtshell.plan.ActionExecutor._reduce_conds ( self ) [private]

Definition at line 222 of file plan.py.

def rtshell.plan.ActionExecutor._start_conds ( self ) [private]

Definition at line 232 of file plan.py.

def rtshell.plan.ActionExecutor.action ( self )

The action object that will be executed.

Definition at line 120 of file plan.py.

def rtshell.plan.ActionExecutor.action	(	self,
		action
	)

Definition at line 125 of file plan.py.

def rtshell.plan.ActionExecutor.add_callback	(	self,
		callback
	)

Add a new callback to be executed after the action.

Definition at line 94 of file plan.py.

def rtshell.plan.ActionExecutor.add_condition	(	self,
		condition
	)

Add a new condition on the action's execution.

Definition at line 98 of file plan.py.

def rtshell.plan.ActionExecutor.cancel ( self )

Cancel this action.

Definition at line 102 of file plan.py.

def rtshell.plan.ActionExecutor.complete ( self )

Has this action completed yet?

Definition at line 129 of file plan.py.

def rtshell.plan.ActionExecutor.error ( self )

Any error that has occurred in this executor or one of its
conditions.

Definition at line 135 of file plan.py.

def rtshell.plan.ActionExecutor.id ( self )

ID of this action.

Definition at line 142 of file plan.py.

def rtshell.plan.ActionExecutor.id_string ( self )

ID of this action as a string.

Definition at line 147 of file plan.py.

def rtshell.plan.ActionExecutor.immediate ( self )

Tests if this executor can execute immediately.

If this executor has any conditions that are not immediate, the
executor itself is not immediate.

Definition at line 152 of file plan.py.

def rtshell.plan.ActionExecutor.run ( self )

Definition at line 177 of file plan.py.

def rtshell.plan.ActionExecutor.set ( self )

Notify this action executor that a condition may have been met.

Definition at line 108 of file plan.py.

def rtshell.plan.ActionExecutor.sort_order ( self )

The integer order for this action in plans.

Generally, all actions will have a sequence number. For those that
don't, this property will be negative. Actions should be executed in
the order of their sequence number, from smaller to bigger.

Definition at line 165 of file plan.py.

def rtshell.plan.ActionExecutor.wait_for_exit ( self )