NSFScheduledAction Class Reference

Represents an action or actions that can be scheduled for execution on a specified thread at a specified time. More...

Inheritance diagram for NSFScheduledAction:

Public Member Functions
	NSFScheduledAction (NSFString name, NSFVoidAction< NSFContext > action, NSFEventThread eventThread)
	Creates a scheduled action. More...
Public Member Functions inherited from NSFTimerAction
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...

Public Attributes
NSFVoidActions< NSFContext >	Actions = new NSFVoidActions<NSFContext>()
	Actions to be executed at the scheduled time. More...

Properties
NSFEventThread	EventThread [get]
	Gets the event thread that the actions will execute on. More...
Properties inherited from NSFTimerAction
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...

Additional Inherited Members
Protected Member Functions inherited from NSFTimerAction
	NSFTimerAction (NSFString name)
	Creates a timer action. More...

Detailed Description

Represents an action or actions that can be scheduled for execution on a specified thread at a specified time.

Use this class to encapsulate a delegate or delegates so that they can be scheduled with the NSFOSTimer. Actions execute on the specified event thread.

Constructor & Destructor Documentation

NSFScheduledAction	(	NSFString	name,
		NSFVoidAction< NSFContext >	action,
		NSFEventThread	eventThread
	)

Creates a scheduled action.

Parameters

name	The name of the scheduled action.
action	The action to execute.
eventThread	The thread on which the action will execute.

Use null or String.Empty for the name if no name is desired. The action will be logged in the trace if the name is anything other than null or String.Empty.

Member Data Documentation

NSFVoidActions<NSFContext> Actions = new NSFVoidActions<NSFContext>()

Actions to be executed at the scheduled time.

Property Documentation

NSFEventThread EventThread

get

Gets the event thread that the actions will execute on.