NSFTimerAction Class Reference

Represents the base class functionality for implementing a timer action. More...

Inheritance diagram for NSFTimerAction:

Public Member Functions
bool	isScheduled ()
	Checks if the action is already scheduled. More...
void	schedule ()
	Schedules the action to execute at the previously designated delay and repeat times. More...
void	schedule (NSFTime delayTime)
	Schedules the action to execute after the specified delay time with zero repeat time. More...
void	schedule (NSFTime delayTime, NSFTime repeatTime)
	Schedules the action to execute at the specified times. More...
void	scheduleAbsoluteExecution ()
	Schedules the action to execute at its designated execution time. More...
void	scheduleAbsoluteExecution (NSFTime executionTime)
	Schedules the action to execute at the specified execution time. More...
void	scheduleAbsoluteExecution (NSFTime executionTime, NSFTime repeatTime)
	Schedules the action to execute at the specified execution time. More...
void	unschedule ()
	Unschedules the action. More...

Protected Member Functions
	NSFTimerAction (NSFString name)
	Creates a timer action. More...

Properties
NSFTime	DelayTime [get, set]
	Gets or sets the delay time of the action. More...
NSFTime	ExecutionTime [get, set]
	Gets or sets the execution time of the action. More...
NSFString	Name [get, set]
	Gets or sets the name of the action. More...
NSFTime	RepeatTime [get, set]
	Gets or sets the repeat time for periodic actions, 0 if non-periodic. More...
Properties inherited from INSFNamedObject
NSFString	Name [get]
	Gets the name of the object. More...

Detailed Description

Represents the base class functionality for implementing a timer action.

Timer actions must be short in duration and must not block, as they are called directly from the timer thread. Concrete timer actions in the framework are NSFEvent, NSFScheduledAction, and NSFOSSignal.

Constructor & Destructor Documentation

NSFTimerAction ( NSFString  name )

protected

Creates a timer action.

Member Function Documentation

bool isScheduled

(

)

Checks if the action is already scheduled.

Returns

True if scheduled, otherwise false

void schedule

(

)

Schedules the action to execute at the previously designated delay and repeat times.

void schedule

(

NSFTime

delayTime

)

Schedules the action to execute after the specified delay time with zero repeat time.

Parameters

delayTime

The delay time until the action executes.

void schedule	(	NSFTime	delayTime,
		NSFTime	repeatTime
	)

Schedules the action to execute at the specified times.

Parameters

delayTime	The delay time until the action executes.
repeatTime	The repeat time for periodic actions, 0 if non-periodic.

void scheduleAbsoluteExecution

(

)

Schedules the action to execute at its designated execution time.

void scheduleAbsoluteExecution

(

NSFTime

executionTime

)

Schedules the action to execute at the specified execution time.

Parameters

executionTime

The time the action executes.

void scheduleAbsoluteExecution	(	NSFTime	executionTime,
		NSFTime	repeatTime
	)

Schedules the action to execute at the specified execution time.

Parameters

executionTime	The time the action executes.
repeatTime	The repeat time for periodic actions, 0 if non-periodic.

void unschedule

(

)

Unschedules the action.

Property Documentation

NSFTime DelayTime

getset

Gets or sets the delay time of the action.

NSFTime ExecutionTime

getset

Gets or sets the execution time of the action.

NSFString Name

getset

Gets or sets the name of the action.

NSFTime RepeatTime

getset

Gets or sets the repeat time for periodic actions, 0 if non-periodic.