util.scheduler.Scheduler.Scheduler Class Reference

Inheritance diagram for util.scheduler.Scheduler.Scheduler:

Collaboration diagram for util.scheduler.Scheduler.Scheduler:

Public Member Functions
def	__init__ (self, appGlobals)
def	loadTasks (self, directory)
def	storeTasks (self)
def	start (self)
def	stop (self)
def	isStarted (self)
def	tasksAreLoaded (self)
def	insertTask (self, task, name, id=None)
def	getTasksCount (self)
def	getTasks (self)
def	getTaskByName (self, taskName)
def	removeTaskById (self, taskId)
def	removeTaskByName (self, taskName)
def	removeTask (self, taskId)
def	clear (self)
def	setOnTaskAddedCallback (self, funct)
def	setOnTaskRemovedCallback (self, funct)
def	setOnTasksLoadedCallback (self, funct)
def	setOnTasksUnloadedCallback (self, funct)

Private Member Functions
def	__setStarted (self, value)
def	__setTasksLoaded (self, value)
def	__generateSingleId (self, baseString=None)
def	__generateSingleName (self, taskName)
def	__tasksCheckerLoop (self)

Private Attributes
	__started
	__startedMutex
	__tasksToExecuteStack
	__tasksToExecuteStackMutex
	__appGlobals
	__onTaskAddedCallback
	__onTaskRemovedCallback
	__onTasksLoaded
	__onTasksUnloaded
	__tasksDirectory
	__tasksLoaded
	__tasksLoadedMutex
	__onTasksLoadedCallback
	__onTasksUnloadedCallback

Detailed Description

Scheduler task manager.

Constructor & Destructor Documentation

__init__()

def util.scheduler.Scheduler.Scheduler.__init__	(		self,
			appGlobals
	)

Constructor.

Member Function Documentation

__generateSingleId()

def util.scheduler.Scheduler.Scheduler.__generateSingleId (   self,   baseString = None  )

private

Generate a single id.
@baseString: Base string. (default None)
@return: The single id.

__generateSingleName()

def util.scheduler.Scheduler.Scheduler.__generateSingleName (   self,   taskName  )

private

This method generate a single task name from the taskName argument.
@param taskName: Base task name.
@return: A single task name.
If the taskName is already not existing in the scheduler, the method
return it.

__setStarted()

def util.scheduler.Scheduler.Scheduler.__setStarted (   self,   value  )

private

Set the started flag of the scheduler.
@param value: True or False.

__setTasksLoaded()

def util.scheduler.Scheduler.Scheduler.__setTasksLoaded (   self,   value  )

private

Set if the tasks are loaded or not.
@param value: True or False

__tasksCheckerLoop()

def util.scheduler.Scheduler.Scheduler.__tasksCheckerLoop (   self )

private

Loop of the tasks checker.

clear()

def util.scheduler.Scheduler.Scheduler.clear

(

self

)

Clear the scheduler.

getTaskByName()

def util.scheduler.Scheduler.Scheduler.getTaskByName	(		self,
			taskName
	)

Get a task by its name.
@param taskName: Task name.
@return: The task object.

getTasks()

def util.scheduler.Scheduler.Scheduler.getTasks

(

self

)

Get the tasks contained in the scheduler.
@return: A list of Task objects.

getTasksCount()

def util.scheduler.Scheduler.Scheduler.getTasksCount

(

self

)

Get the number of tasks contained in the scheduler.
@return: An integer.

insertTask()

def util.scheduler.Scheduler.Scheduler.insertTask	(		self,
			task,
			name,
			id = None
	)

Insert a task in the scheduler.
@param task: Task object.
@return: The task identifier and the task name or None None if fail.

isStarted()

def util.scheduler.Scheduler.Scheduler.isStarted

(

self

)

Get if the scheduler is started or not.
@return: True or False.

loadTasks()

def util.scheduler.Scheduler.Scheduler.loadTasks	(		self,
			directory
	)

Load tasks from a directory.
@param directory: Directory where to search the task configurations.

removeTask()

def util.scheduler.Scheduler.Scheduler.removeTask	(		self,
			taskId
	)

Remove a task from the scheduler.
@param taskId: Task identifier.

removeTaskById()

def util.scheduler.Scheduler.Scheduler.removeTaskById	(		self,
			taskId
	)

Remove a task from the scheduler by its identifier.
@param taskId: Task identifier.

removeTaskByName()

def util.scheduler.Scheduler.Scheduler.removeTaskByName	(		self,
			taskName
	)

Remove a task from the scheduler by its name.
@param taskName: Task name.

setOnTaskAddedCallback()

def util.scheduler.Scheduler.Scheduler.setOnTaskAddedCallback	(		self,
			funct
	)

Set the on task added event callback.
@param funct: Function pointer.
Function prototype:
def onTaskAdded(self, task):
    pass

setOnTaskRemovedCallback()

def util.scheduler.Scheduler.Scheduler.setOnTaskRemovedCallback	(		self,
			funct
	)

Set the on task removed event callback.
@param funct: Function pointer.
Function prototype:
def onTaskRemoved(self, task):
    pass

setOnTasksLoadedCallback()

def util.scheduler.Scheduler.Scheduler.setOnTasksLoadedCallback	(		self,
			funct
	)

Set the on tasks loaded event callback.
@param funct: Function pointer.
Function prototype:
def onTasksLoaded(self):
    pass

setOnTasksUnloadedCallback()

def util.scheduler.Scheduler.Scheduler.setOnTasksUnloadedCallback	(		self,
			funct
	)

Set the on tasks unloaded event callback.
@param funct: Function pointer.
Function prototype:
def onTasksUnloaded(self):
    pass

start()

def util.scheduler.Scheduler.Scheduler.start

(

self

)

Start the scheduler.

stop()

def util.scheduler.Scheduler.Scheduler.stop

(

self

)

Stop the scheduler.

storeTasks()

def util.scheduler.Scheduler.Scheduler.storeTasks

(

self

)

Store tasks in a directory.

tasksAreLoaded()

def util.scheduler.Scheduler.Scheduler.tasksAreLoaded

(

self

)

Get if the tasks are loaded or not.
@return: True or False

Member Data Documentation

__appGlobals

util.scheduler.Scheduler.Scheduler.__appGlobals

private

__onTaskAddedCallback

util.scheduler.Scheduler.Scheduler.__onTaskAddedCallback

private

__onTaskRemovedCallback

util.scheduler.Scheduler.Scheduler.__onTaskRemovedCallback

private

__onTasksLoaded

util.scheduler.Scheduler.Scheduler.__onTasksLoaded

private

__onTasksLoadedCallback

util.scheduler.Scheduler.Scheduler.__onTasksLoadedCallback

private

__onTasksUnloaded

util.scheduler.Scheduler.Scheduler.__onTasksUnloaded

private

__onTasksUnloadedCallback

util.scheduler.Scheduler.Scheduler.__onTasksUnloadedCallback

private

__started

util.scheduler.Scheduler.Scheduler.__started

private

__startedMutex

util.scheduler.Scheduler.Scheduler.__startedMutex

private

__tasksDirectory

util.scheduler.Scheduler.Scheduler.__tasksDirectory

private

__tasksLoaded

util.scheduler.Scheduler.Scheduler.__tasksLoaded

private

__tasksLoadedMutex

util.scheduler.Scheduler.Scheduler.__tasksLoadedMutex

private

__tasksToExecuteStack

util.scheduler.Scheduler.Scheduler.__tasksToExecuteStack

private

__tasksToExecuteStackMutex

util.scheduler.Scheduler.Scheduler.__tasksToExecuteStackMutex

private

---

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

• util/scheduler/Scheduler.py