Sched Class Reference

This class runs the scheduled tasks. More...

#include <TaskSched.h>

Public Member Functions
unsigned long	getSize ()
	return the number of tasks in the run queue More...
	Sched ()
void	begin ()
void	addTask (Task *task)
void	enable ()
	enable the scheduler More...
void	disable ()
	disable the scheduler More...
bool	isEnabled ()
	return true if the scheduler is enabled More...
const SimpleList< Task * > &	getTasks () const
void	run ()
	called perodically to check if a task should be scheduled More...

Detailed Description

This class runs the scheduled tasks.

Task* t = new Task(turnLedOn, 1000,true,20,"OnOff",true);
Task t1(turnLedOn, 100,false,20,"On1",false);
Task t2(turnLedOn, 2.0,false,20,"On2",false);

It's kinda like the DTO in the Java world.

Definition at line 279 of file TaskSched.h.

Constructor & Destructor Documentation

Sched()

Sched::Sched

(

)

Constructor

Definition at line 238 of file TaskSched.cpp.

             {
}

Member Function Documentation

addTask()

void Sched::addTask

(

Task *

task

)

Example: 
 
Task* t = new Task(turnLedOn, 1000,true,20,"OnOff",true);
Task t1(dummy, 100, false, 20, "On1", * false);
Task t2(dummy, 2.0, false, 20, "On2", * false);
 
    scheduler.addTask(t);
    scheduler.addTask(&t1);
    scheduler.addTask(&t2);

Definition at line 244 of file TaskSched.cpp.

{
#ifdef DEBUG
    Serial.printf("add called for task, %s %x\n",task->getName().c_str(),task);
#endif
    tTasks.push_back(task);
    return;
};

References Task::getName(), and SimpleList< T >::push_back().

begin()

void Sched::begin

(

)

used to start the scheduling. A call to begin will also enable the scheduler.

Sched scheduler;  
    scheduler.begin();

Definition at line 241 of file TaskSched.cpp.

                  {
    this->mSchedEnabled=true;
}

disable()

void Sched::disable

(

)

disable the scheduler

Definition at line 256 of file TaskSched.cpp.

                    {
    this->mSchedEnabled=false;
}

enable()

void Sched::enable

(

)

enable the scheduler

Definition at line 253 of file TaskSched.cpp.

                   {
    this->mSchedEnabled=true;
}

getSize()

unsigned long Sched::getSize

(

)

return the number of tasks in the run queue

Returns

Definition at line 233 of file TaskSched.cpp.

{
    return tTasks.get_size();
}

References SimpleList< T >::get_size().

getTasks()

const SimpleList< Task * > & Sched::getTasks

(

)

const

brief

Definition at line 290 of file TaskSched.cpp.

{
    return tTasks;
}

isEnabled()

bool Sched::isEnabled

(

)

return true if the scheduler is enabled

Returns

Definition at line 259 of file TaskSched.cpp.

                      {
    return this->mSchedEnabled;
}

run()

void Sched::run

(

)

called perodically to check if a task should be scheduled

Definition at line 265 of file TaskSched.cpp.

{
    if(this->mSchedEnabled) {
#ifdef DEBUG
        //                Serial.println("Looking for tasks");
#endif
        for (auto it = tTasks.begin(); it != tTasks.end(); ++it) {
 //       for (it = tTasks.begin(); it != tTasks.end(); ++it){
            Task* currentTask = *it;
 
#ifdef DEBUGR
            Serial.printf("%s %d task=%x i=%d millis()=%ld Found name=%s, Is enabled? %d\n",__FILE__,__LINE__,currentTask,i++,millis(),currentTask->getName().c_str(),currentTask->isEnabled());
            currentTask->showInit();
#endif
            if(currentTask->isEnabled()) {
                currentTask->runIt(); 
            }
        }
    } else {
#ifdef DEBUG
        Serial.println("Not enabled");
#endif
    }
}

References SimpleList< T >::begin(), SimpleList< T >::end(), Task::getName(), Task::isEnabled(), and Task::showInit().

---

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

• TaskSched.h
• TaskSched.cpp