LRT14  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator
Repeating Class Reference

Container for a repeating automation routine. More...

#include <Repeating.h>

Inheritance diagram for Repeating:
Collaboration diagram for Repeating:

Public Member Functions

 Repeating (const char *name, Automation *routine, int times=0, bool queueIfBlocked=false, bool restartable=false)
 Creates a repeating routine.
 
virtual bool Start ()
 Starts the task.
 
virtual bool Abort ()
 Aborts the task.
 
virtual bool Run ()
 Runs one cycle of the task.
 
virtual void AllocateResources ()
 Calls AllocateResource() on resources used in by this task.
 
- Public Member Functions inherited from Automation
 Automation (const char *name, bool requiresAbortCycles=false, bool queueIfBlocked=false, bool restartable=false)
 Creates an automation routine.
 
bool Update ()
 Updates the task for one cycle, including calling Run().
 
bool StartAutomation (Event *trigger=NULL)
 Tries to start this task.
 
bool AbortAutomation (Event *trigger=NULL)
 Tries to aborts this task.
 
void ContinueAutomation (Event *trigger)
 Sets the task to continue.
 
bool CheckResources ()
 Allocates resources used by this task. Checks if this task is blocked.
 
void DeallocateResources ()
 Clears all resources allocated by this task.
 
bool IsRestartable ()
 Gets whether a task can be restarted (started again when already running).
 
bool QueueIfBlocked ()
 Gets whether a task should continue to be started if blocked.
 
bool RequiresAbortCycles ()
 Gets whether a task requires running cycles before aborting.
 
const char * GetName ()
 Gets the name of the automation routine.
 

Protected Member Functions

virtual bool Repeat ()
 Checks whether the the routine can be repeated this cycle.
 
virtual bool FinishRepeat ()
 Checks if the routine is done repeating.
 
- Protected Member Functions inherited from Automation
bool AllocateResource (ControlResource::Enum resource)
 Allocates a resource to be used.
 
bool Aborting ()
 Gets whether this task is aborting (abort event fired and requires abort cycles).
 
bool Continued ()
 Returns whether this task has been continued.
 
EventGetStartEvent ()
 Returns the event that started this task.
 
EventGetAbortEvent ()
 Returns the event that aborted this task.
 
EventGetContinueEvent ()
 Returns the event that continued this task.
 

Additional Inherited Members

- Static Public Member Functions inherited from Automation
static bool GetAllocation (ControlResource::Enum resource)
 Gets the task that allocated a resource.
 

Detailed Description

Container for a repeating automation routine.

Constructor & Destructor Documentation

Repeating::Repeating ( const char *  name,
Automation routine,
int  times = 0,
bool  queueIfBlocked = false,
bool  restartable = false 
)

Creates a repeating routine.

Parameters
namethe name of the routine
routinethe routine to repeat
timesthe number of times to repeat, or 0 if the routine should be repeated until aborted
queueIfBlockedwhether the routine should be queued if blocked
restartablewhether the routine can be restarted

Member Function Documentation

bool Repeating::Abort ( )
virtual

Aborts the task.

Returns
true if task can be aborted, false otherwise

Implements Automation.

Here is the call graph for this function:

bool Repeating::FinishRepeat ( )
protectedvirtual

Checks if the routine is done repeating.

Returns
if the routine is done repeating

Here is the caller graph for this function:

bool Repeating::Repeat ( )
protectedvirtual

Checks whether the the routine can be repeated this cycle.

Returns
whether the routine can be repeated

Here is the caller graph for this function:

bool Repeating::Run ( )
virtual

Runs one cycle of the task.

Returns
true if completed, false otherwise

Implements Automation.

Here is the call graph for this function:

bool Repeating::Start ( )
virtual

Starts the task.

Returns
true if task is able to start, false otherwise

Implements Automation.

Here is the call graph for this function:


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