Public Member Functions | Private Member Functions | Private Attributes
rtshell.plan.Plan Class Reference

List of all members.

Public Member Functions

def __init__
def __str__
def cancel
def execute
def make

Private Member Functions

def _get_action_conditions
def _signal_complete

Private Attributes

 _cancel_lock
 _cancelled
 _complete_flag
 _immediates
 _laters

Detailed Description

A plan for changing the state of an RT System.

A plan has two sets of actions to perform. The first is stored in a sorted
list; it is all actions that are to be executed immediately.  The second
set is stored in a separate list, also sorted. This set contains actions
that will be executed at a later point in time, based on some condition.
Many of these will execute on their own threads.

To execute the plan, call it. A plan can be cancelled during execution with
the @ref cancel method. As immediate actions will all be executed before
@ref execute returns, this is mainly useful for stopping the delayed
actions after an error occurs.

Definition at line 488 of file plan.py.


Constructor & Destructor Documentation

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

Definition at line 503 of file plan.py.


Member Function Documentation

def rtshell.plan.Plan.__str__ (   self)

Definition at line 511 of file plan.py.

def rtshell.plan.Plan._get_action_conditions (   self,
  conds_source,
  action 
) [private]

Definition at line 626 of file plan.py.

def rtshell.plan.Plan._signal_complete (   self) [private]

Definition at line 638 of file plan.py.

def rtshell.plan.Plan.cancel (   self)
Cancel execution of this plan.

Definition at line 519 of file plan.py.

def rtshell.plan.Plan.execute (   self,
  args,
  kwargs 
)
Execute this plan.

Definition at line 524 of file plan.py.

def rtshell.plan.Plan.make (   self,
  rtsprofile,
  actions,
  conds_source,
  monitor_target 
)
Make a plan from a list of actions and an RTSProfile.

Definition at line 552 of file plan.py.


Member Data Documentation

Definition at line 503 of file plan.py.

Definition at line 503 of file plan.py.

Definition at line 503 of file plan.py.

Definition at line 503 of file plan.py.

Definition at line 503 of file plan.py.


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


rtshell
Author(s): Geoffrey Biggs
autogenerated on Fri Aug 28 2015 12:55:12