Represents a schedulable task. More...

#include <TaskSched.h>

Public Types
typedef void(*	TaskCallback) (Task *)

typedef void(*	VoidCallback) ()

Public Member Functions
	Task (TaskCallback func, unsigned long interval=5000, bool enabled=false, int iterations=0, const char *name="Unk", bool runImmediately=false)
	Constructs a new Task. More...

	Task (VoidCallback func, unsigned long interval=5000, bool enabled=false, int iterations=0, const char *name="Unk", bool runImmediately=false)

bool	isFirstIteration ()
	return true if this is the first iteration More...

bool	isLastIteration ()
	return true if this is the last iteration More...

bool	fRunImmediately ()
	return true if the run immediately flag is set More...

void	restart ()
	restart the task with the original parameters, Enable is not restored More...

void	enable ()
	enable the task More...

void	disable ()
	disable the task More...

bool	isEnabled () const
	return true if task is enabled More...

void	setCallback (const TaskCallback &callback)
	Sets a new callback function for the task. More...

void	setCallback (const VoidCallback &callback)
	Sets a new callback function for the task. More...

void	setName (String)
	give the task a new name More...

void	showInit ()
	display stuff More...

String	getName () const
	return string containing name of task More...

unsigned long	getIterationCount () const
	return the iteration count, that is the number of iterations that the task has been run More...

void	setInterval (unsigned long newInterval)
	function to set a new interval More...

void	setIterations (unsigned long newIterations)
	function to set a new iterations value More...

void	setImmediately (bool)
	function to set the run immediately flag More...

String	showTaskInfo () const
	function that displays task info More...

unsigned long	getInterval (void) const
	return the task interval More...

bool	getRunImmediately (void) const
	return the run immediately flag More...

unsigned long	getLastStartTime (void) const
	return the last start time flag More...

Static Public Member Functions
static String	formatMS (unsigned long milliseconds)
	return a string with a formatted time More...

Friends
class	Sched

Detailed Description

Represents a schedulable task.

Define a new Task.

Parameters

func	Function to be called at regular intervals.
interval	Time between calls to func, specified in milliseconds or seconds. If interval is a floating-point value, it's interpreted as seconds; otherwise, it's treated as milliseconds.
enabled	Flag to indicate whether the task should start in an enabled state (true) or disabled state (false).
iterations	Number of times the task will be executed. Set to 0 for infinite iterations.
name	A descriptive string name for the task.
runImmediately	Boolean flag determining whether to run the callback immediately (true) or wait for the interval to expire (false). Task* t = new Task(turnLedOn, 1000,true,20,"OnOff",true); Task t1(turnLedOn, 1000,false,100,"On1",false); Task t2(turnLedOn, 2000,false,2000,"On2",false); Output: 450 Task On2, Enabled? 0, Diff 00:15.735, Interval 00:02.000, RI 1 450 Task On1, Enabled? 0, Diff 00:15.735, Interval 00:00.100, RI 0 450 Task On, Enabled? 1, Diff 00:01.721, Interval 00:01.000, RI 0 Task Represents a schedulable task. Definition: TaskSched.h:80 Task::Task Task(TaskCallback func, unsigned long interval=5000, bool enabled=false, int iterations=0, const char name="Unk", bool runImmediately=false) Constructs a new Task. Definition:* TaskSched.cpp:7

The Task class encapsulates a function to be called at regular intervals, along with parameters controlling its execution.

Definition at line 80 of file TaskSched.h.

Member Typedef Documentation

◆ TaskCallback

typedef void(* Task::TaskCallback) (Task *)

Definition at line 92 of file TaskSched.h.

◆ VoidCallback

typedef void(* Task::VoidCallback) ()

Definition at line 93 of file TaskSched.h.

Constructor & Destructor Documentation

◆ Task() [1/2]

Task::Task	(	TaskCallback	func,
		unsigned long	interval = `5000`,
		bool	enabled = `false`,
		int	iterations = `0`,
		const char *	name = `"Unk"`,
		bool	runImmediately = `false`
	)

Constructs a new Task.

Template Parameters

T	Type of the interval (can be integral or floating-point)

Parameters

func	Function to be called at regular intervals
interval	Time between calls to func (in milliseconds if integral, seconds if floating-point)
enabled	Flag to indicate whether the task should start in an enabled state
iterations	Number of times the task will be executed (0 for infinite)
name	A descriptive name for the task
runImmediately	Whether to run the callback immediately or wait for the interval

Returns: The first form returns a pointer to the task, the second does not.

Definition at line 7 of file TaskSched.cpp.

     : mProcWithTask(func), mProcVoid(nullptr), mWithTaskPtr(true)
 {
     // Initialize other members...
             //mProc=func;
             mInterval=interval;
             mEnabled=enabled; 
             mIterations=iterations; 
             mName=name; 
             mRunImmediately=runImmediately;
             mOrig.mEnabled=enabled;
             mOrig.mInterval=mInterval;
             mOrig.mIterations=iterations;
             mOrig.mRunImmediately=runImmediately;
             mLastStartTime=millis();
             mIterationCount=0;
 }

References InitialState::mEnabled, InitialState::mInterval, InitialState::mIterations, and InitialState::mRunImmediately.

◆ Task() [2/2]

Task::Task	(	VoidCallback	func,
		unsigned long	interval = `5000`,
		bool	enabled = `false`,
		int	iterations = `0`,
		const char *	name = `"Unk"`,
		bool	runImmediately = `false`
	)

Definition at line 25 of file TaskSched.cpp.

     : mProcWithTask(nullptr), mProcVoid(func), mWithTaskPtr(false)
 {
     // Initialize other members...
             //mProc=func;
             mInterval=interval;
             mEnabled=enabled; 
             mIterations=iterations; 
             mName=name; 
             mRunImmediately=runImmediately;
             mOrig.mEnabled=enabled;
             mOrig.mInterval=interval;
             mOrig.mIterations=iterations;
             mOrig.mRunImmediately=runImmediately;
             mLastStartTime=millis();
             mIterationCount=0;
 }

References InitialState::mEnabled, InitialState::mInterval, InitialState::mIterations, and InitialState::mRunImmediately.

Member Function Documentation

◆ disable()

void Task::disable ( )

disable the task

Definition at line 66 of file TaskSched.cpp.

                    {
     mEnabled=false;
     mIterationCount=0;
     return;
 }

◆ enable()

void Task::enable ( )

enable the task

Definition at line 128 of file TaskSched.cpp.

                   {
     mEnabled=true;
     mLastStartTime=millis();
 #ifdef DEBUG
     Serial.printf("Enabling %s\n",mName.c_str());
 #endif
     return;
 }

◆ formatMS()

String Task::formatMS ( unsigned long milliseconds )

static

return a string with a formatted time

Returns

Definition at line 87 of file TaskSched.cpp.

                                                {
  
     int minutes = milliseconds / 60000;
     int seconds = (milliseconds % 60000) / 1000; 
     int ms = (milliseconds % 1000);
  
     char res[20];
     sprintf(res, "%02d:%02d.%03d", minutes, seconds, ms);
 #ifdef DEBUG
     Serial.printf("%s %d %s\n",__FILE__,__LINE__,res);
 #endif
  
     return String(res); 
 }

Referenced by showInit(), and showTaskInfo().

◆ fRunImmediately()

bool Task::fRunImmediately ( )

return true if the run immediately flag is set

Returns

◆ getInterval()

unsigned long Task::getInterval ( void ) const

return the task interval

Returns

Definition at line 183 of file TaskSched.cpp.

 {
     return mInterval;
 }

Referenced by showTaskInfo().

◆ getIterationCount()

unsigned long Task::getIterationCount ( ) const

return the iteration count, that is the number of iterations that the task has been run

Returns

Definition at line 193 of file TaskSched.cpp.

 {
     return mIterationCount;
 }

◆ getLastStartTime()

unsigned long Task::getLastStartTime ( void ) const

return the last start time flag

Returns

Definition at line 188 of file TaskSched.cpp.

 {
     return mLastStartTime;
 }

Referenced by showTaskInfo().

◆ getName()

String Task::getName ( ) const

return string containing name of task

Returns

Definition at line 50 of file TaskSched.cpp.

 {
     return mName;
 }

Referenced by Sched::addTask(), Sched::run(), and showTaskInfo().

◆ getRunImmediately()

bool Task::getRunImmediately ( void ) const

return the run immediately flag

Returns

Definition at line 178 of file TaskSched.cpp.

 {
     return mRunImmediately;
 }

Referenced by showTaskInfo().

◆ isEnabled()

bool Task::isEnabled ( ) const

return true if task is enabled

Returns

Definition at line 124 of file TaskSched.cpp.

                            {
     return mEnabled;
 }

Referenced by Sched::run(), and showTaskInfo().

◆ isFirstIteration()

bool Task::isFirstIteration ( )

return true if this is the first iteration

Returns

Definition at line 43 of file TaskSched.cpp.

                             {
     if(mIterationCount == 0) {
         return true;
     }
     return false;
 }

◆ isLastIteration()

bool Task::isLastIteration ( )

return true if this is the last iteration

Returns

Definition at line 55 of file TaskSched.cpp.

                            {
 //    Serial.printf("count = %ld, Iter = %ld\n",mIterationCount,mIterations);
     if(mIterations <= 0) {
         return false;
     }
     if(mIterationCount >=mIterations-1) {
         return true;
     }
     return false;
 }

◆ restart()

void Task::restart ( )

restart the task with the original parameters, Enable is not restored

Definition at line 137 of file TaskSched.cpp.

                    {
     mInterval=mOrig.mInterval;
     mIterations=mOrig.mIterations;
     mEnabled=false;
     mIterationCount=0;
     mRunImmediately=mOrig.mRunImmediately;
 #ifdef DEBUG
     Serial.printf("Restarting %s\n",mName.c_str());
 #endif
     return;
 }

References InitialState::mInterval, InitialState::mIterations, and InitialState::mRunImmediately.

◆ setCallback() [1/2]

void Task::setCallback ( const TaskCallback & callback )

Sets a new callback function for the task.

Parameters

callback The new callback function

Definition at line 154 of file TaskSched.cpp.

                                                 {
     //mProc=func;
     mProcWithTask=func;
 }

◆ setCallback() [2/2]

void Task::setCallback ( const VoidCallback & callback )

Sets a new callback function for the task.

Parameters

callback The new callback function

Definition at line 149 of file TaskSched.cpp.

                                                 {
     //mProc=func;
     mProcVoid=func;
 }

◆ setImmediately()

void Task::setImmediately ( bool newImmediately )

function to set the run immediately flag

Definition at line 163 of file TaskSched.cpp.

 {
     mRunImmediately = newImmediately;
 }

◆ setInterval()

void Task::setInterval ( unsigned long newInterval )

function to set a new interval

Definition at line 173 of file TaskSched.cpp.

 {
     mInterval = newInterval;
 }

◆ setIterations()

void Task::setIterations ( unsigned long newIterations )

function to set a new iterations value

Definition at line 168 of file TaskSched.cpp.

 {
     mIterations = newIterations;
 }

◆ setName()

void Task::setName ( String newName )

give the task a new name

Definition at line 159 of file TaskSched.cpp.

                                  {
     mName=newName;
 }

◆ showInit()

void Task::showInit ( )

display stuff

Definition at line 72 of file TaskSched.cpp.

                     {
     if(!doShow) {
         return;
     }
     doShow=false; // only do it once
 #ifdef DEBUG
  
     res = Task::formatMS(mInterval);
     Serial.printf("%s %d showInit: Name: %s, interval: %s, enabled:%d, iterations:%ld %x\n",
             __FILE__,__LINE__,mName,res,mEnabled,mIterations,this);
 #endif
  
     return;
 }

References formatMS().

Referenced by Sched::run().

◆ showTaskInfo()

String Task::showTaskInfo ( ) const

function that displays task info

Returns: String containing info about this task.

Definition at line 102 of file TaskSched.cpp.

 {
  
     char buf[200];
     unsigned long diff = millis() - getLastStartTime();
     String sDiff= Task::formatMS(diff);
     String sInt= Task::formatMS(getInterval());
 #ifdef DEBUG
     Serial.printf("%s %d Task %s, Enabled? %d, Diff %s, Interval %s, RI %d\n",__FILE__,__LINE__,this->getName().c_str(),isEnabled(),sDiff.c_str(),sInt.c_str(),getRunImmediately());
     if(passedInterval >0) {
         Serial.printf("For float interval passed in %f, mInterval became %ld\n",passedInterval,mInterval);
     }
 #else
     sprintf(buf,"Task %s, Enabled? %d, Diff %s, Interval %s, RunIm %d\n",this->getName().c_str(),isEnabled(),sDiff.c_str(),sInt.c_str(),getRunImmediately());
     String ret(buf);
     return ret;
  
 #endif
  
     return "";
 }

References formatMS(), getInterval(), getLastStartTime(), getName(), getRunImmediately(), and isEnabled().

Friends And Related Function Documentation

◆ Sched

friend class Sched

friend

Definition at line 88 of file TaskSched.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ TaskCallback

◆ VoidCallback

Constructor & Destructor Documentation

◆ Task() [1/2]

◆ Task() [2/2]

Member Function Documentation

◆ disable()

◆ enable()

◆ formatMS()

◆ fRunImmediately()

◆ getInterval()

◆ getIterationCount()

◆ getLastStartTime()

◆ getName()

◆ getRunImmediately()

◆ isEnabled()

◆ isFirstIteration()

◆ isLastIteration()

◆ restart()

◆ setCallback() [1/2]

◆ setCallback() [2/2]

◆ setImmediately()

◆ setInterval()

◆ setIterations()

◆ setName()

◆ showInit()

◆ showTaskInfo()

Friends And Related Function Documentation

◆ Sched