util.scheduler.Task.Task Class Reference

Inheritance diagram for util.scheduler.Task.Task:

Collaboration diagram for util.scheduler.Task.Task:

Public Member Functions
def	__init__ (self, ruleType, weekMask, date, hoursBegin, hoursEnd, delay, command, arguments, data, storable=True)
def	isStorable (self)
def	getDescription (self)
def	getDictionary (self)
def	getNextExecuteTime (self)
def	execute (self, appGlobals)
def	load (filePath)
def	store (task, directory)

Static Public Attributes
	load
	store

Private Member Functions
def	__createMonthMask (self, month)
def	__getNextAllowedDay (self, day)

Private Attributes
	__data
	__storable
	__description
	__monthAtStart
	__monthMask
	__startTime
	__incrementTime
	__lastExecuteTime

Detailed Description

Class the create a scheduled task.

Constructor & Destructor Documentation

__init__()

def util.scheduler.Task.Task.__init__	(		self,
			ruleType,
			weekMask,
			date,
			hoursBegin,
			hoursEnd,
			delay,
			command,
			arguments,
			data,
			storable = True
	)

Constructor of the class.
@param ruleType: <SCH_LOOP_ABS|SCH_LOOP_REL|SCH_ONCE_ABS|SCH_ONCE_REL>
@param weekMask: Week mask. [True, True, True, True, True, True, True]
@param date: Date string as format [YYYY, MM, DD].
@param hoursBegin: Hours begin as format [HH, MM, SS]
@param hoursEnd: Hours end as format [HH, MM, SS]
@param delay: Delay as format [HH, MM, SS]
@param command: Command to execute as string.
@param arguments: Arguments of the command as tuple.
@param data: User data.
@param storable: Task is storable or not.

Member Function Documentation

__createMonthMask()

def util.scheduler.Task.Task.__createMonthMask (   self,   month  )

private

Create the month mask.
@param month: Month index of the year.
@return: The month mask.

__getNextAllowedDay()

def util.scheduler.Task.Task.__getNextAllowedDay (   self,   day  )

private

Get the next allowed day for executing the task.
@param day: Day index of the month.
@return: The number of day to skip.

execute()

def util.scheduler.Task.Task.execute	(		self,
			appGlobals
	)

Execute the task.

getDescription()

def util.scheduler.Task.Task.getDescription

(

self

)

Get the description object of the task.
@return: A TaskDescription object.

getDictionary()

def util.scheduler.Task.Task.getDictionary

(

self

)

Get the task informations.
@return: A dictionary.

getNextExecuteTime()

def util.scheduler.Task.Task.getNextExecuteTime

(

self

)

Get the next time date of task execute.
@return: The datetime value of the next execution.

isStorable()

def util.scheduler.Task.Task.isStorable

(

self

)

Get if the task is storable or not.
@return: True or False.

load()

def util.scheduler.Task.Task.load

(

filePath

)

Load a task.
@param filePath: Fle path of the task.
@return: The Task object or None.

store()

def util.scheduler.Task.Task.store	(		task,
			directory
	)

Store a task.
@param task: Task object to store.
@param directory: Directory where to store the task.
@return: The success of the storing.

Member Data Documentation

__data

util.scheduler.Task.Task.__data

private

__description

util.scheduler.Task.Task.__description

private

__incrementTime

util.scheduler.Task.Task.__incrementTime

private

__lastExecuteTime

util.scheduler.Task.Task.__lastExecuteTime

private

__monthAtStart

util.scheduler.Task.Task.__monthAtStart

private

__monthMask

util.scheduler.Task.Task.__monthMask

private

__startTime

util.scheduler.Task.Task.__startTime

private

__storable

util.scheduler.Task.Task.__storable

private

load

util.scheduler.Task.Task.load

static

store

util.scheduler.Task.Task.store

static

---

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

• util/scheduler/Task.py