Public Member Functions | Public Attributes | List of all members
task_executor.execution_schedule.ExecutionSchedule Class Reference
Inheritance diagram for task_executor.execution_schedule.ExecutionSchedule:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self)
 
def add_new_tasks (self, tasks)
 
def clear_schedule (self)
 
def execute_next_task (self)
 
def execution_delay_cb (self, event)
 
def get_current_task (self)
 
def get_execution_queue (self)
 
def get_execution_queue_length (self)
 
def get_schedulable_tasks (self)
 
def next_in_schedule (self)
 
def remove_task_with_id (self, task_id)
 
def remove_tasks (self, tasks)
 
def set_schedule (self, scheduled_tasks)
 
def task_complete (self, task)
 
def wait_for_execution_change (self, timeout)
 

Public Attributes

 current_task
 
 execution_change
 
 execution_delay_timer
 
 execution_queue
 
 tasks
 

Detailed Description

Definition at line 18 of file execution_schedule.py.

Constructor & Destructor Documentation

def task_executor.execution_schedule.ExecutionSchedule.__init__ (   self)

Definition at line 20 of file execution_schedule.py.

Member Function Documentation

def task_executor.execution_schedule.ExecutionSchedule.add_new_tasks (   self,
  tasks 
)
Add new tasks to be scheduled. 

Definition at line 27 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.clear_schedule (   self)
Removes all tasks from the execution queue and task list 

Definition at line 44 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.execute_next_task (   self)
Pops the head of the execution queue to the current task, removes this from schedulable tasks, and notifies the wait_for_execution_change method. 

Definition at line 64 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.execution_delay_cb (   self,
  event 
)

Definition at line 76 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.get_current_task (   self)
Get the next task for execution. 

Definition at line 145 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.get_execution_queue (   self)
Get the tasks which are queued for execution. 

Definition at line 35 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.get_execution_queue_length (   self)
Get the number of tasks which are queued for execution. 

Definition at line 39 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.get_schedulable_tasks (   self)
Get the tasks which are available to be scheduled. Does not include the task being executed. 

Definition at line 31 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.next_in_schedule (   self)
Checks whether the next action can be executed now (i.e. the current time is within its constraints). If not, delays execution suitably.

Definition at line 81 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.remove_task_with_id (   self,
  task_id 
)

Definition at line 49 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.remove_tasks (   self,
  tasks 
)

Definition at line 59 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.set_schedule (   self,
  scheduled_tasks 
)
Receive a list of tasks in order of execution, with their execution times set.
Returns true if the schedule was 

Definition at line 113 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.task_complete (   self,
  task 
)

Definition at line 105 of file execution_schedule.py.

def task_executor.execution_schedule.ExecutionSchedule.wait_for_execution_change (   self,
  timeout 
)
Blocks until current_task changes value 

Definition at line 150 of file execution_schedule.py.

Member Data Documentation

task_executor.execution_schedule.ExecutionSchedule.current_task

Definition at line 21 of file execution_schedule.py.

task_executor.execution_schedule.ExecutionSchedule.execution_change

Definition at line 22 of file execution_schedule.py.

task_executor.execution_schedule.ExecutionSchedule.execution_delay_timer

Definition at line 25 of file execution_schedule.py.

task_executor.execution_schedule.ExecutionSchedule.execution_queue

Definition at line 23 of file execution_schedule.py.

task_executor.execution_schedule.ExecutionSchedule.tasks

Definition at line 24 of file execution_schedule.py.


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


task_executor
Author(s): Nick Hawes
autogenerated on Tue Mar 17 2015 20:08:13