TaskSched.h

Go to the documentation of this file.

#ifndef TASKSCHED_H
#define TASKSCHED_H
 
//#define DEBUGA 1
#include "Arduino.h"
//#include <list>
#define TASK_SECOND 1000
#define TASK_MINUTE 60*TASK_SECOND
 
#include <SimpleList.h>
class Task;
 
 
// was typedef std::function<void(Task *)> voidFuncTypeWith;
 
class InitialState {
public:
 
    unsigned long mInterval;
    bool mEnabled;
    bool mRunImmediately;
    unsigned long mIterations;
};
using savedInitial = InitialState;
 
class Task {
 
    private:
        void  runIt();
        // make Sched a friend so it can call a private method, runIt
        friend class Sched;
 
    public:
        // Function pointer types
        typedef void (*TaskCallback)(Task*);
        typedef void (*VoidCallback)();
        Task(TaskCallback func, unsigned long interval = 5000, bool enabled = false,
                int iterations = 0, const char* name = "Unk", bool runImmediately = false);
 
        // Constructor for callback without Task pointer
        Task(VoidCallback func, unsigned long interval = 5000, bool enabled = false,
                int iterations = 0, const char* name = "Unk", bool runImmediately = false);
 
    private:
        TaskCallback mProcWithTask;
        VoidCallback mProcVoid;
        bool mWithTaskPtr;
 
        unsigned long mInterval;
        bool mEnabled;
        unsigned long mIterations;
        String mName;
        bool mRunImmediately;
        unsigned long mIterationCount;
        bool doShow=true;
        unsigned long mLastStartTime;
        savedInitial mOrig;
    public:
        bool isFirstIteration();
        bool isLastIteration(); 
        bool fRunImmediately();
        void restart(); 
        void enable(); 
        void disable(); 
        bool isEnabled() const;
        void setCallback(const TaskCallback &callback);
        void setCallback(const VoidCallback &callback);
        void setName(String);
        void showInit();
        String getName() const;
        unsigned long getIterationCount() const;
        void setInterval(unsigned long newInterval);
        void setIterations(unsigned long newIterations);
        void setImmediately(bool);
        String showTaskInfo() const;
        unsigned long getInterval(void) const;
        bool getRunImmediately(void) const;
        unsigned long getLastStartTime(void) const;
        static String formatMS(unsigned long milliseconds);
};
class Sched
{
    public:
        unsigned long getSize();
        Sched();
        void begin();
        void addTask(Task *task);
        void enable();
        void disable();
        bool isEnabled();
        const SimpleList<Task *>& getTasks() const;
        void run();
 
    private:
        //SimpleList<Task*> tTasks;
        SimpleList<Task *> tTasks;
        bool mSchedEnabled;
};
 
 /* @param func    Function to be called.
 * @param interval      Time between calls to func in milliseconds.
 * If intval is passed as a floating point number, e. g. 4.5 then it is treated as if it were a number of seconds otherwise the interval is treated as if it were a number of millisconds
 * @param enabled   Flag to be set if the task should start in an enabled state.
 * @param iterations    Number of iterations the task will be run.  Set to zero for infinited iterations.
 * @param name   A String value of a name of the task.
 * @param runImmediately  A boolean flag that directs the scheduler to run the callback immediately rather than wait for the interval to expire. False says to wait for the interval to run the task.
*/
#endif