ButtonToSwitch-4.5.0/docs/_button_to_switch_8h_source.html

#ifndef _BUTTONTOSWITCH_H_

#define _BUTTONTOSWITCH_H_


#include <Arduino.h>

#include <stdint.h>


//===========================>> BEGIN General use constant definitions

#define _HwMinDbncTime 20   //Documented minimum wait time for a MPB signal to stabilize

#define _StdPollDelay 10

#define _MinSrvcTime 100

#define _InvalidPinNum 0xFF // Value to give as "yet to be defined", the "Valid pin number" range and characteristics are development platform and environment related


/*---------- DbncdMPBttn complete status related constants, argument structs, information packing and unpacking BEGIN -------*/

const uint8_t IsOnBitPos {0};

const uint8_t IsEnabledBitPos{1};

const uint8_t PilotOnBitPos{2};

const uint8_t WrnngOnBitPos{3};

const uint8_t IsVoidedBitPos{4};

const uint8_t IsOnScndryBitPos{5};

const uint8_t OtptCurValBitPos{16};

//===========================>> END General use constant definitions


#ifndef MPBOTPTS_T

    #define MPBOTPTS_T


    struct MpbOtpts_t{

        bool isOn;

        bool isEnabled;

        bool pilotOn;

        bool wrnngOn;

        bool isVoided;

        bool isOnScndry;

        uint16_t otptCurVal;

    };


#endif

/*---------------- DbncdMPBttn complete status related constants, argument structs, information packing and unpacking END -------*/


// Definition workaround to let a function/method return value to be a function pointer

typedef void (*fncPtrType)();

typedef  fncPtrType (*ptrToTrnFnc)();


/* Definition workaround to let a function/method return value to be a function pointer

 to a function that receives a void* argument and returns no values: void (funcName*)(void*)

 The resulting **fncVdPtrPrmPtrType** type then defines a pointer to a function of the described properties and signature*/

typedef void (*fncVdPtrPrmPtrType)(void*);

typedef fncVdPtrPrmPtrType (*ptrToTrnFncVdPtr)(void*);

//===========================>> BEGIN General use function prototypes

MpbOtpts_t otptsSttsUnpkg(uint32_t pkgOtpts);

unsigned long int findMCD(unsigned long int a, unsigned long int b);

//===========================>> END General use function prototypes


//==========================================================>> Classes declarations BEGIN


class DbncdMPBttn{

    static DbncdMPBttn** _mpbsInstncsLstPtr;

    static unsigned long int _updTimerPeriod;

/*

 * This is the callback function to be executed by the TimerOne managed timer INT.

 *

 * The callback function duties:

 * - Verify for a valid **_mpbsInstncsLstPtr**, if it's nullptr something failed, correct it by disabling the timer

 * - Save the **current time** for reference and traverse the list till the end (nullptr).

 * - For each MPB in the list verify the _updTmrAttchd == true

 * - If _updTmrAttchd == true -> verify the ("current time" - _lstPollTime) >= _pollPeriodMs. If the condition is true:

 *  - Execute the objects mpbPollCallback()

 *  - Set _lstPollTime = "current time" *

 */

    static void _ISRMpbsRfrshCb();


protected:

    enum fdaDmpbStts {

        stOffNotVPP,

        stOffVPP,

        stOn,

        stOnVRP,

        stDisabled

    };

    const unsigned long int _stdMinDbncTime {_HwMinDbncTime};


    uint8_t _mpbttnPin{};

    bool _pulledUp{};

    bool _typeNO{};

    unsigned long int _dbncTimeOrigSett{};


    bool _beginDisabled{false};

    unsigned long int _dbncRlsTimerStrt{0};

    unsigned long int _dbncRlsTimeTempSett{0};

    unsigned long int _dbncTimerStrt{0};

    unsigned long int _dbncTimeTempSett{0};

    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOff{nullptr};   // _fVPPWhnTrnOff

    void* _fnVdPtrPrmWhnTrnOffArgPtr{nullptr};  // _fVPPWhnTrnOffArgPtr

    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOn{nullptr};    // _fVPPWhnTrnOn

    void* _fnVdPtrPrmWhnTrnOnArgPtr{nullptr};   // _fVPPWhnTrnOnArgPtr

    void (*_fnWhnTrnOff)() {nullptr};

    void (*_fnWhnTrnOn)() {nullptr};


    bool _isEnabled{true};

    volatile bool _isOn{false};

    bool _isOnDisabled{false};

    volatile bool _isPressed{false};

    unsigned long int _lstPollTime{0};

    fdaDmpbStts _mpbFdaState {stOffNotVPP};

    DbncdMPBttn* _mpbInstnc{nullptr};

    volatile bool _outputsChange {false};

    uint32_t _outputsChangeCnt{0};

    unsigned long int _pollPeriodMs{0};

    bool _prssRlsCcl{false};

    unsigned long int _strtDelay {0};

    bool _sttChng {true};

    bool _updTmrAttchd{false};

    volatile bool _validDisablePend{false};

    volatile bool _validEnablePend{false};

    volatile bool _validPressPend{false};

    volatile bool _validReleasePend{false};


   void clrSttChng();

    const bool getIsPressed() const;

    virtual void mpbPollCallback();

    virtual uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    void _popMpb(DbncdMPBttn** &DMpbTmrUpdLst, DbncdMPBttn* mpbToPop);

    void _pushMpb(DbncdMPBttn** &DMpbTmrUpdLst, DbncdMPBttn* mpbToPush);

    void _setIsEnabled(const bool &newEnabledValue);

    void _setLstPollTime(const unsigned long int &newLstPollTIme);

    void setSttChng();

    void _turnOff();

    void _turnOn();

    virtual void updFdaState();

    bool updIsPressed();

    unsigned long int _updTmrsMCDCalc();

    virtual bool updValidPressesStatus();


public:

    DbncdMPBttn();

    DbncdMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0);

    DbncdMPBttn(const DbncdMPBttn& other);

    virtual ~DbncdMPBttn();

    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus(bool clrIsOn = true);

    void disable();

    void enable();

    bool end();

    const unsigned long int getCurDbncTime() const;

    fncPtrType getFnWhnTrnOff();

    fncPtrType getFnWhnTrnOn();

    fncVdPtrPrmPtrType getFVPPWhnTrnOff();

    void* getFVPPWhnTrnOffArgPtr();

    fncVdPtrPrmPtrType getFVPPWhnTrnOn();

    void* getFVPPWhnTrnOnArgPtr();

    const bool getIsEnabled() const;

    const bool getIsOn () const;

    const bool getIsOnDisabled() const;

    const unsigned long int getLstPollTime();

    const uint32_t getOtptsSttsPkgd();

    const bool getOutputsChange() const;

    const unsigned long int getPollPeriodMs();

    unsigned long int getStrtDelay();

    bool getUpdTmrAttchd();

    bool init(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0);

    bool pause();

    void resetDbncTime();

    void resetFda();

    bool resume();

    void setBeginDisabled(const bool &newBeginDisabled = false);

    bool setDbncTime(const unsigned long int &newDbncTime);

    void setFnWhnTrnOffPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOnPtr(void (*newFnWhnTrnOn)());

    void setFVPPWhnTrnOff(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void* argPtr = nullptr);

    void setFVPPWhnTrnOffArgPtr(void* newFVPPWhnTrnOffArgPtr);

    void setFVPPWhnTrnOn(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void* argPtr = nullptr);

    void setFVPPWhnTrnOnArgPtr(void* newFVPPWhnTrnOnArgPtr);

    void setIsOnDisabled(const bool &newIsOnDisabled);

    void setOutputsChange(bool newOutputsChange);


};


//==========================================================>>


class DbncdDlydMPBttn: public DbncdMPBttn{

public:

    DbncdDlydMPBttn();

    DbncdDlydMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    DbncdDlydMPBttn(const DbncdDlydMPBttn& other);

     virtual ~DbncdDlydMPBttn();

    bool init(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    void setStrtDelay(const unsigned long int &newStrtDelay);

};


//==========================================================>>


class LtchMPBttn: public DbncdDlydMPBttn{

protected:

    enum fdaLmpbStts {

        stOffNotVPP,

        stOffVPP,

        stOnNVRP,

        stOnVRP,

        stLtchNVUP,

        stLtchdVUP,

        stOffVUP,

        stOffNVURP,

        stOffVURP,

        stDisabled

    };

    bool _isLatched{false};

    fdaLmpbStts _mpbFdaState {stOffNotVPP};

    bool _trnOffASAP{true};

    volatile bool _validUnlatchPend{false};

    volatile bool _validUnlatchRlsPend{false};


    virtual void mpbPollCallback();

    virtual void stDisabled_In(){};

    virtual void stDisabled_Out(){};

    virtual void stLtchNVUP_Do(){};

    virtual void stOffNotVPP_In(){};

    virtual void stOffNotVPP_Out(){};

    virtual void stOffNVURP_Do(){};

    virtual void stOffVPP_Out(){};

    virtual void stOffVURP_Out(){};

    virtual void stOnNVRP_Do(){};

    virtual void updFdaState();

    virtual void updValidUnlatchStatus() = 0;

public:

    LtchMPBttn();

    LtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    LtchMPBttn(const LtchMPBttn& other);

    virtual ~LtchMPBttn();

    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus(bool clrIsOn = true);

    const bool getIsLatched() const;

    bool getTrnOffASAP();

    const bool getUnlatchPend() const;

    const bool getUnlatchRlsPend() const;

    void setTrnOffASAP(const bool &newVal);

    void setUnlatchPend(const bool &newVal);

    void setUnlatchRlsPend(const bool &newVal);

    bool unlatch();

};


//==========================================================>>


class TgglLtchMPBttn: public LtchMPBttn{

protected:

    virtual void stOffNVURP_Do();

    virtual void updValidUnlatchStatus();


public:

    TgglLtchMPBttn();

    TgglLtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    TgglLtchMPBttn(const TgglLtchMPBttn& other);

    virtual ~TgglLtchMPBttn();

};


//==========================================================>>


class TmLtchMPBttn: public LtchMPBttn{

protected:

    bool _tmRstbl {true};

    unsigned long int _srvcTime {};

    unsigned long int _srvcTimerStrt{0};


    virtual void stOffNotVPP_Out();

    virtual void stOffVPP_Out();

    virtual void updValidUnlatchStatus();


public:

    TmLtchMPBttn();

    TmLtchMPBttn(const uint8_t &mpbttnPin, const unsigned long int &svcTime, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    TmLtchMPBttn(const TmLtchMPBttn &other);

    virtual ~TmLtchMPBttn();

    void clrStatus(bool clrIsOn = true);

    const unsigned long int getSrvcTime() const;

    bool setSrvcTime(const unsigned long int &newSrvcTime);

    void setTmerRstbl(const bool &newIsRstbl);

};


//==========================================================>>


class HntdTmLtchMPBttn: public TmLtchMPBttn{

protected:

    unsigned int _wrnngPrctg {0};


    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOffPilot{nullptr};  // _fVPPWhnTrnOffPilot

    void* _fnVdPtrPrmWhnTrnOffPilotArgPtr{nullptr}; // _fVPPWhnTrnOffPilotArgPtr

    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOnPilot{nullptr};   // _fVPPWhnTrnOnPilot

    void* _fnVdPtrPrmWhnTrnOnPilotArgPtr{nullptr};  // _fVPPWhnTrnOnPilotArgPtr

    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOffWrnng{nullptr};  // _fVPPWhnTrnOffWrnng

    void* _fnVdPtrPrmWhnTrnOffWrnngArgPtr{nullptr}; // _fVPPWhnTrnOffWrnngArgPtr

    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOnWrnng{nullptr};   // _fVPPWhnTrnOnWrnng

    void* _fnVdPtrPrmWhnTrnOnWrnngArgPtr{nullptr};  // _fVPPWhnTrnOnWrnngArgPtr

    void (*_fnWhnTrnOffPilot)() {nullptr};

    void (*_fnWhnTrnOffWrnng)() {nullptr};

    void (*_fnWhnTrnOnPilot)() {nullptr};

    void (*_fnWhnTrnOnWrnng)() {nullptr};

    bool _keepPilot{false};

    volatile bool _pilotOn{false};

    unsigned long int _wrnngMs{0};

    volatile bool _wrnngOn {false};


    bool _validWrnngSetPend{false};

    bool _validWrnngResetPend{false};

    bool _validPilotSetPend{false};

    bool _validPilotResetPend{false};


    virtual void mpbPollCallback();

    uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    virtual void stDisabled_In();

    virtual void stLtchNVUP_Do();

    virtual void stOffNotVPP_In();

    virtual void stOffVPP_Out();

    virtual void stOnNVRP_Do();

    void _turnOffPilot();

    void _turnOffWrnng();

    void _turnOnPilot();

    void _turnOnWrnng();

    bool updPilotOn();

    bool updWrnngOn();

public:

    HntdTmLtchMPBttn();

   HntdTmLtchMPBttn(const uint8_t &mpbttnPin, const unsigned long int &svcTime, const unsigned int &wrnngPrctg = 0, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    HntdTmLtchMPBttn(const HntdTmLtchMPBttn &other);

    ~HntdTmLtchMPBttn();

    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus(bool clrIsOn = true);

    fncPtrType getFnWhnTrnOffPilot();

    fncPtrType getFnWhnTrnOffWrnng();

    fncPtrType getFnWhnTrnOnPilot();

    fncPtrType getFnWhnTrnOnWrnng();

    fncVdPtrPrmPtrType getFVPPWhnTrnOffPilot();

    void* getFVPPWhnTrnOffPilotArgPtr();

    fncVdPtrPrmPtrType getFVPPWhnTrnOnPilot();

    void* getFVPPWhnTrnOnPilotArgPtr();

    fncVdPtrPrmPtrType getFVPPWhnTrnOffWrnng();

    void* getFVPPWhnTrnOffWrnngArgPtr();

    fncVdPtrPrmPtrType getFVPPWhnTrnOnWrnng();

    void* getFVPPWhnTrnOnWrnngArgPtr();

    const bool getPilotOn() const;

    const bool getWrnngOn() const;

    void setFnWhnTrnOffPilotPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOffWrnngPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOnPilotPtr(void(*newFnWhnTrnOn)());

    void setFnWhnTrnOnWrnngPtr(void(*newFnWhnTrnOn)());

    void setFVPPWhnTrnOffPilot(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void* argPtr = nullptr);

    void setFVPPWhnTrnOffPilotArgPtr(void* newFVPPWhnTrnOffArgPtr);

    void setFVPPWhnTrnOnPilot(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void* argPtr = nullptr);

    void setFVPPWhnTrnOnPilotArgPtr(void* newFVPPWhnTrnOnArgPtr);

    void setFVPPWhnTrnOffWrnng(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void* argPtr = nullptr);

    void setFVPPWhnTrnOffWrnngArgPtr(void* newFVPPWhnTrnOffArgPtr);

    void setFVPPWhnTrnOnWrnng(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void* argPtr = nullptr);

    void setFVPPWhnTrnOnWrnngArgPtr(void* newFVPPWhnTrnOnArgPtr);

    void setKeepPilot(const bool &newKeepPilot);

    bool setSrvcTime(const unsigned long int &newSvcTime);

    bool setWrnngPrctg (const unsigned int &newWrnngPrctg);

};


//==========================================================>>


class XtrnUnltchMPBttn: public LtchMPBttn{

protected:

    DbncdDlydMPBttn* _unLtchBttn {nullptr};

    bool _xtrnUnltchPRlsCcl {false};


    virtual void stOffNVURP_Do();

    virtual void updValidUnlatchStatus();


public:

    XtrnUnltchMPBttn();

    XtrnUnltchMPBttn(const uint8_t &mpbttnPin,  DbncdDlydMPBttn* unLtchBttn,

        const bool &pulledUp,  const bool &typeNO,  const unsigned long int &dbncTimeOrigSett,  const unsigned long int &strtDelay);

    XtrnUnltchMPBttn(const uint8_t &mpbttnPin,

        const bool &pulledUp,  const bool &typeNO,  const unsigned long int &dbncTimeOrigSett,  const unsigned long int &strtDelay);

    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus(bool clrIsOn = true);

};


//==========================================================>>


class DblActnLtchMPBttn: public LtchMPBttn{

protected:

    enum fdaDALmpbStts{

        stOffNotVPP,

        stOffVPP,

        stOnMPBRlsd,

        //--------

        stOnStrtScndMod,

        stOnScndMod,

        stOnEndScndMod,

        //--------

        stOnTurnOff,

        //--------

        stDisabled

    };

   volatile bool _isOnScndry{false};

    fdaDALmpbStts _mpbFdaState {stOffNotVPP};

    unsigned long _scndModActvDly {2000};

    unsigned long _scndModTmrStrt {0};

    bool _validScndModPend{false};


    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOffScndry{nullptr}; // _fVPPWhnTrnOffScndry

    void* _fnVdPtrPrmWhnTrnOffScndryArgPtr{nullptr};    // _fVPPWhnTrnOffScndryArgPtr

    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOnScndry{nullptr};  // _fVPPWhnTrnOnScndry

    void* _fnVdPtrPrmWhnTrnOnScndryArgPtr{nullptr}; // _fVPPWhnTrnOnScndryArgPtr

    void (*_fnWhnTrnOffScndry)() {nullptr};

    void (*_fnWhnTrnOnScndry)() {nullptr};


    virtual void mpbPollCallback();

    virtual uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    virtual void stDisabled_In(){};

   virtual void stOnEndScndMod_Out(){};

   virtual void stOnScndMod_Do() = 0;

    virtual void stOnStrtScndMod_In(){};

    virtual void _turnOffScndry();

    virtual void _turnOnScndry();

    virtual void updFdaState();

    virtual bool updValidPressesStatus();

   virtual void updValidUnlatchStatus();


public:

    DblActnLtchMPBttn();

   DblActnLtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

    ~DblActnLtchMPBttn();

   virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

   void clrStatus(bool clrIsOn = true);

    fncPtrType getFnWhnTrnOffScndry();

    fncPtrType getFnWhnTrnOnScndry();

    fncVdPtrPrmPtrType getFVPPWhnTrnOffScndry();

    void* getFVPPWhnTrnOffScndryArgPtr();

    fncVdPtrPrmPtrType getFVPPWhnTrnOnScndry();

    void* getFVPPWhnTrnOnScndryArgPtr();

   bool getIsOnScndry();

   unsigned long getScndModActvDly();

    void setFnWhnTrnOffScndryPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOnScndryPtr(void (*newFnWhnTrnOn)());

    void setFVPPWhnTrnOffScndry(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void* argPtr = nullptr);

    void setFVPPWhnTrnOffScndryArgPtr(void* newFVPPWhnTrnOffArgPtr);

    void setFVPPWhnTrnOnScndry(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void* argPtr = nullptr);

    void setFVPPWhnTrnOnScndryArgPtr(void* newFVPPWhnTrnOnArgPtr);

    bool setScndModActvDly(const unsigned long &newVal);

};


//==========================================================>>


class DDlydDALtchMPBttn: public DblActnLtchMPBttn{

protected:

   virtual void stOnEndScndMod_Out();

   virtual void stOnScndMod_Do();

   virtual void stOnStrtScndMod_In();

public:

    DDlydDALtchMPBttn();

   DDlydDALtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

   ~DDlydDALtchMPBttn();

   void clrStatus(bool clrIsOn = true);

};


//==========================================================>>


class SldrDALtchMPBttn: public DblActnLtchMPBttn{

protected:

    bool _autoSwpDirOnEnd{true};    // Changes slider direction automatically when reaches _otptValMax or _otptValMin

    bool _autoSwpDirOnPrss{false};// Changes slider direction each time it enters slider mode

    bool _curSldrDirUp{true};

    uint16_t _initOtptCurVal{};

    uint16_t _otptCurVal{};

    bool _otptCurValIsMax{false};

    bool _otptCurValIsMin{false};

    unsigned long _otptSldrSpd{1};

    uint16_t _otptSldrStpSize{0x01};

    uint16_t _otptValMax{0xFFFF};

    uint16_t _otptValMin{0x0000};


    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOffSldrMax{nullptr};    // _fVPPWhnTrnOffSldrMax

    void* _fnVdPtrPrmWhnTrnOffSldrMaxArgPtr{nullptr};   // _fVPPWhnTrnOffSldrMaxArgPtr

    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOnSldrMax{nullptr}; // _fVPPWhnTrnOnSldrMax

    void* _fnVdPtrPrmWhnTrnOnSldrMaxArgPtr{nullptr};    // _fVPPWhnTrnOnSldrMaxArgPtr

    void (*_fnWhnTrnOffSldrMax)() {nullptr};

    void (*_fnWhnTrnOnSldrMax)() {nullptr};


    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOffSldrMin{nullptr};    // _fVPPWhnTrnOffSldrMin

    void* _fnVdPtrPrmWhnTrnOffSldrMinArgPtr{nullptr};   // _fVPPWhnTrnOffSldrMinArgPtr

    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOnSldrMin{nullptr}; // _fVPPWhnTrnOnSldrMin

    void* _fnVdPtrPrmWhnTrnOnSldrMinArgPtr{nullptr};    // _fVPPWhnTrnOnSldrMinArgPtr

    void (*_fnWhnTrnOffSldrMin)() {nullptr};

    void (*_fnWhnTrnOnSldrMin)() {nullptr};


    virtual uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    bool _setSldrDir(const bool &newVal);

    void stOnEndScndMod_Out();

   virtual void stOnScndMod_Do();

    virtual void stOnStrtScndMod_In();

    void _turnOffSldrMax();

    void _turnOnSldrMax();

    void _turnOffSldrMin();

    void _turnOnSldrMin();


public:

    SldrDALtchMPBttn();

    SldrDALtchMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0, const uint16_t initVal = 0xFFFF);

    ~SldrDALtchMPBttn();

   void clrStatus(bool clrIsOn = true);

   uint16_t getOtptCurVal();

   bool getOtptCurValIsMax();

   bool getOtptCurValIsMin();

    unsigned long getOtptSldrSpd();

    uint16_t getOtptSldrStpSize();

   uint16_t getOtptValMax();

    uint16_t getOtptValMin();

    bool getSldrDirUp();

    bool setOtptCurVal(const uint16_t &newVal);

    bool setOtptSldrSpd(const uint16_t &newVal);

    bool setOtptSldrStpSize(const uint16_t &newVal);

    bool setOtptValMax(const uint16_t &newVal);

    bool setOtptValMin(const uint16_t &newVal);

    bool setSldrDirDn();

    bool setSldrDirUp();

    void setSwpDirOnEnd(const bool &newVal);

    void setSwpDirOnPrss(const bool &newVal);

    bool swapSldrDir();

};


//==========================================================>>


class VdblMPBttn: public DbncdDlydMPBttn{

private:

   void setFrcdOtptWhnVdd(const bool &newVal);

   void setStOnWhnOtpFrcd(const bool &newVal);


protected:

    enum fdaVmpbStts{

        stOffNotVPP,

        stOffVPP,

        stOnNVRP,

        //--------

        stOnVVP,

        stOnVddNVUP,

        stOffVddNVUP,

        stOffVddVUP,

        stOffUnVdd,

        //--------

        stOnVRP,

        stOnTurnOff,

        stOff,

        //--------

        stDisabled

    };

    fdaVmpbStts _mpbFdaState {stOffNotVPP};


    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOffVdd{nullptr};    // _fVPPWhnTrnOffVdd

    void* _fnVdPtrPrmWhnTrnOffVddArgPtr{nullptr};   // _fVPPWhnTrnOffVddArgPtr

    fncVdPtrPrmPtrType _fnVdPtrPrmWhnTrnOnVdd{nullptr}; // _fVPPWhnTrnOnVdd

    void* _fnVdPtrPrmWhnTrnOnVddArgPtr{nullptr};    // _fVPPWhnTrnOnVddArgPtr

    void (*_fnWhnTrnOffVdd)() {nullptr};

    void (*_fnWhnTrnOnVdd)() {nullptr};

    bool _frcOtptLvlWhnVdd {true};

    bool _isVoided{false};

    bool _stOnWhnOtptFrcd{false};

    bool _validVoidPend{false};

    bool _validUnvoidPend{false};


    virtual void mpbPollCallback();

    uint32_t _otptsSttsPkg(uint32_t prevVal = 0);

    bool setVoided(const bool &newVoidValue);

    virtual void stDisabled_In();

    virtual void stDisabled_Out();

    virtual void stOffNotVPP_In(){};

    virtual void stOffVddNVUP_Do(){};   //This provides a setting point for calculating the _validUnvoidPend

    virtual void stOffVPP_Do(){};   // This provides a setting point for the voiding mechanism to be started

    void _turnOffVdd();

    void _turnOnVdd();

    virtual void updFdaState();

    virtual bool updVoidStatus() = 0;


public:

    VdblMPBttn();

    VdblMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0, const bool &isOnDisabled = false);

    virtual ~VdblMPBttn();

    void clrStatus(bool clrIsOn = true);

    fncPtrType getFnWhnTrnOffVdd();

    fncPtrType getFnWhnTrnOnVdd();

    bool getFrcOtptLvlWhnVdd();

    fncVdPtrPrmPtrType getFVPPWhnTrnOffVdd();

    void* getFVPPWhnTrnOffVddArgPtr();

    fncVdPtrPrmPtrType getFVPPWhnTrnOnVdd();

    void* getFVPPWhnTrnOnVddArgPtr();

    const bool getIsVoided() const;

    bool getStOnWhnOtpFrcd();

    void setFnWhnTrnOffVddPtr(void(*newFnWhnTrnOff)());

    void setFnWhnTrnOnVddPtr(void(*newFnWhnTrnOn)());

    void setFVPPWhnTrnOffVdd(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void* argPtr = nullptr);

    void setFVPPWhnTrnOffVddArgPtr(void* newFVPPWhnTrnOffArgPtr);

    void setFVPPWhnTrnOnVdd(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void* argPtr = nullptr);

    void setFVPPWhnTrnOnVddArgPtr(void* newFVPPWhnTrnOnArgPtr);

    bool setIsNotVoided();

    bool setIsVoided();

};


//==========================================================>>


class TmVdblMPBttn: public VdblMPBttn{

protected:

    unsigned long int _voidTime;

    unsigned long int _voidTmrStrt{0};


    virtual void stOffNotVPP_In();

    virtual void stOffVddNVUP_Do(); //This provides a setting point for calculating the _validUnvoidPend

    virtual void stOffVPP_Do(); // This provides a setting point for the voiding mechanism to be started

    bool updIsPressed();

    virtual bool updVoidStatus();


public:

    TmVdblMPBttn();

    TmVdblMPBttn(const uint8_t &mpbttnPin, unsigned long int voidTime, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0, const bool &isOnDisabled = false);

    virtual ~TmVdblMPBttn();

    virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

    void clrStatus();

    const unsigned long int getVoidTime() const;

    bool setVoidTime(const unsigned long int &newVoidTime);

};


//==========================================================>>


class SnglSrvcVdblMPBttn: public VdblMPBttn{

protected:

   virtual void stOffVddNVUP_Do();  //This provides the calculation for the _validUnvoidPend

   virtual bool updVoidStatus();


public:

    SnglSrvcVdblMPBttn();

    SnglSrvcVdblMPBttn(const uint8_t &mpbttnPin, const bool &pulledUp = true, const bool &typeNO = true, const unsigned long int &dbncTimeOrigSett = 0, const unsigned long int &strtDelay = 0);

   virtual ~SnglSrvcVdblMPBttn();

   virtual bool begin(const unsigned long int &pollDelayMs = _StdPollDelay);

};


//==========================================================>>


#endif   /*_BUTTONTOSWITCH_H_*/

DDlydDALtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncddMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:2345

DDlydDALtchMPBttn::~DDlydDALtchMPBttn
~DDlydDALtchMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:2341

DDlydDALtchMPBttn::DDlydDALtchMPBttn
DDlydDALtchMPBttn()
Default class constructor.
Definition ButtonToSwitch.cpp:2332

DblActnLtchMPBttn::setScndModActvDly
bool setScndModActvDly(const unsigned long &newVal)
Sets a new value for the scndModActvDly class attribute.
Definition ButtonToSwitch.cpp:2064

DblActnLtchMPBttn::setFnWhnTrnOnScndryPtr
void setFnWhnTrnOnScndryPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object enters the Secondary On State.
Definition ButtonToSwitch.cpp:2023

DblActnLtchMPBttn::getFVPPWhnTrnOnScndry
fncVdPtrPrmPtrType getFVPPWhnTrnOnScndry()
Returns a pointer to a function that is set to execute every time the object enters the Secondary Mod...
Definition ButtonToSwitch.cpp:1972

DblActnLtchMPBttn::getFnWhnTrnOnScndry
fncPtrType getFnWhnTrnOnScndry()
Returns the function that is set to execute every time the object enters the Secondary On State.
Definition ButtonToSwitch.cpp:1957

DblActnLtchMPBttn::setFVPPWhnTrnOnScndryArgPtr
void setFVPPWhnTrnOnScndryArgPtr(void *newFVPPWhnTrnOnArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:2056

DblActnLtchMPBttn::getFVPPWhnTrnOffScndryArgPtr
void * getFVPPWhnTrnOffScndryArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:1967

DblActnLtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncddMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:1942

DblActnLtchMPBttn::getIsOnScndry
bool getIsOnScndry()
Returns the current value of the isOnScndry attribute flag.
Definition ButtonToSwitch.cpp:1982

DblActnLtchMPBttn::DblActnLtchMPBttn
DblActnLtchMPBttn()
Abstract Class default constructor.
Definition ButtonToSwitch.cpp:1921

DblActnLtchMPBttn::setFVPPWhnTrnOnScndry
void setFVPPWhnTrnOnScndry(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the Secondary Mode On State.
Definition ButtonToSwitch.cpp:2047

DblActnLtchMPBttn::setFVPPWhnTrnOffScndry
void setFVPPWhnTrnOffScndry(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the Secondary Mode Off State.
Definition ButtonToSwitch.cpp:2030

DblActnLtchMPBttn::getScndModActvDly
unsigned long getScndModActvDly()
Returns the current value of the scndModActvDly class attribute.
Definition ButtonToSwitch.cpp:1987

DblActnLtchMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:1934

DblActnLtchMPBttn::getFVPPWhnTrnOnScndryArgPtr
void * getFVPPWhnTrnOnScndryArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:1977

DblActnLtchMPBttn::setFnWhnTrnOffScndryPtr
void setFnWhnTrnOffScndryPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object enters the Secondary Off State...
Definition ButtonToSwitch.cpp:2015

DblActnLtchMPBttn::getFnWhnTrnOffScndry
fncPtrType getFnWhnTrnOffScndry()
returns the function that is set to execute every time the object enters the Secondary Off State.
Definition ButtonToSwitch.cpp:1952

DblActnLtchMPBttn::setFVPPWhnTrnOffScndryArgPtr
void setFVPPWhnTrnOffScndryArgPtr(void *newFVPPWhnTrnOffArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:2039

DblActnLtchMPBttn::~DblActnLtchMPBttn
~DblActnLtchMPBttn()
Virtual destructor.
Definition ButtonToSwitch.cpp:1930

DblActnLtchMPBttn::getFVPPWhnTrnOffScndry
fncVdPtrPrmPtrType getFVPPWhnTrnOffScndry()
Returns a pointer to a function that is set to execute every time the object enters the Secondary Mod...
Definition ButtonToSwitch.cpp:1962

DbncdDlydMPBttn
Models a Debounced Delayed MPB (DD-MPB).
Definition ButtonToSwitch.h:598

DbncdDlydMPBttn::~DbncdDlydMPBttn
virtual ~DbncdDlydMPBttn()
Class destructor.
Definition ButtonToSwitch.cpp:918

DbncdDlydMPBttn::DbncdDlydMPBttn
DbncdDlydMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:901

DbncdDlydMPBttn::setStrtDelay
void setStrtDelay(const unsigned long int &newStrtDelay)
Sets a new value to the "Start Delay" strtDelay attribute.
Definition ButtonToSwitch.cpp:932

DbncdDlydMPBttn::init
bool init(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0, const unsigned long int &strtDelay=0)
see DbncdMPBttn::init(const uint8_t, const bool, const bool, const unsigned long int)
Definition ButtonToSwitch.cpp:922

DbncdMPBttn::setBeginDisabled
void setBeginDisabled(const bool &newBeginDisabled=false)
Sets the starting isDisabled state.
Definition ButtonToSwitch.cpp:537

DbncdMPBttn::getFnWhnTrnOn
fncPtrType getFnWhnTrnOn()
Returns the function that is set to execute every time the object enters the On State.
Definition ButtonToSwitch.cpp:252

DbncdMPBttn::setFVPPWhnTrnOff
void setFVPPWhnTrnOff(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the Off State.
Definition ButtonToSwitch.cpp:573

DbncdMPBttn::getPollPeriodMs
const unsigned long int getPollPeriodMs()
Returns the poll period time setting attribute's value.
Definition ButtonToSwitch.cpp:312

DbncdMPBttn::resetFda
void resetFda()
Resets the MPB behavior automaton to it's Initial or Start State
Definition ButtonToSwitch.cpp:488

DbncdMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
Clears and resets flags, timers and counters modified through the object's signals processing.
Definition ButtonToSwitch.cpp:192

DbncdMPBttn::getCurDbncTime
const unsigned long int getCurDbncTime() const
Returns the current debounce period time set for the object.
Definition ButtonToSwitch.cpp:242

DbncdMPBttn::enable
void enable()
Enables the input signal processing.
Definition ButtonToSwitch.cpp:221

DbncdMPBttn::pause
bool pause()
Pauses the software timer updating the computation of the object's internal flags value (object's sta...
Definition ButtonToSwitch.cpp:377

DbncdMPBttn::~DbncdMPBttn
virtual ~DbncdMPBttn()
Default virtual destructor.
Definition ButtonToSwitch.cpp:155

DbncdMPBttn::getFVPPWhnTrnOff
fncVdPtrPrmPtrType getFVPPWhnTrnOff()
Returns a pointer to a function that is set to execute every time the object enters the Off State.
Definition ButtonToSwitch.cpp:257

DbncdMPBttn::setIsOnDisabled
void setIsOnDisabled(const bool &newIsOnDisabled)
Sets the value of the isOnDisabled attribute.
Definition ButtonToSwitch.cpp:622

DbncdMPBttn::init
bool init(const uint8_t &mpbttnPin, const bool &pulledUp=true, const bool &typeNO=true, const unsigned long int &dbncTimeOrigSett=0)
Initializes an object instantiated by the default constructor.
Definition ButtonToSwitch.cpp:327

DbncdMPBttn::end
bool end()
Detaches the object from the timer that monitors the input pins, compute and updates the object's sta...
Definition ButtonToSwitch.cpp:226

DbncdMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
Attaches the instantiated object to a timer that monitors the input pins and updates the object statu...
Definition ButtonToSwitch.cpp:160

DbncdMPBttn::resetDbncTime
void resetDbncTime()
Resets the debounce process time of the object to the value used at instantiation.
Definition ButtonToSwitch.cpp:482

DbncdMPBttn::setFVPPWhnTrnOn
void setFVPPWhnTrnOn(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the On State.
Definition ButtonToSwitch.cpp:589

DbncdMPBttn::getFVPPWhnTrnOn
fncVdPtrPrmPtrType getFVPPWhnTrnOn()
Returns a pointer to a function that is set to execute every time the object enters the On State.
Definition ButtonToSwitch.cpp:267

DbncdMPBttn::DbncdMPBttn
DbncdMPBttn()
Default class constructor.
Definition ButtonToSwitch.cpp:99

DbncdMPBttn::disable
void disable()
Disables the input signal processing, ignoring the changes of its values.
Definition ButtonToSwitch.cpp:216

DbncdMPBttn::resume
bool resume()
Restarts the software timer updating the calculation of the object internal flags.
Definition ButtonToSwitch.cpp:496

DbncdMPBttn::getIsEnabled
const bool getIsEnabled() const
Returns the value of the isEnabled attribute flag, indicating the Enabled or Disabled status of the o...
Definition ButtonToSwitch.cpp:277

DbncdMPBttn::getLstPollTime
const unsigned long int getLstPollTime()
Returns the time stamp of the last state update for the object.
Definition ButtonToSwitch.cpp:297

DbncdMPBttn::getIsOnDisabled
const bool getIsOnDisabled() const
Returns the value of the isOnDisabled attribute.
Definition ButtonToSwitch.cpp:287

DbncdMPBttn::getFVPPWhnTrnOnArgPtr
void * getFVPPWhnTrnOnArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:272

DbncdMPBttn::setFVPPWhnTrnOnArgPtr
void setFVPPWhnTrnOnArgPtr(void *newFVPPWhnTrnOnArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:598

DbncdMPBttn::getFVPPWhnTrnOffArgPtr
void * getFVPPWhnTrnOffArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:262

DbncdMPBttn::setFnWhnTrnOffPtr
void setFnWhnTrnOffPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object enters the Off State.
Definition ButtonToSwitch.cpp:559

DbncdMPBttn::getOutputsChange
const bool getOutputsChange() const
Returns the value of the outputsChange attribute flag.
Definition ButtonToSwitch.cpp:307

DbncdMPBttn::getIsOn
const bool getIsOn() const
Returns the value of the isOn attribute flag.
Definition ButtonToSwitch.cpp:282

DbncdMPBttn::setFVPPWhnTrnOffArgPtr
void setFVPPWhnTrnOffArgPtr(void *newFVPPWhnTrnOffArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:582

DbncdMPBttn::getUpdTmrAttchd
bool getUpdTmrAttchd()
Returns the value of the Attached to the update timer attribute.
Definition ButtonToSwitch.cpp:322

DbncdMPBttn::setFnWhnTrnOnPtr
void setFnWhnTrnOnPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object enters the On State.
Definition ButtonToSwitch.cpp:566

DbncdMPBttn::getStrtDelay
unsigned long int getStrtDelay()
Returns the current value of strtDelay attribute.
Definition ButtonToSwitch.cpp:317

DbncdMPBttn::getOtptsSttsPkgd
const uint32_t getOtptsSttsPkgd()
Returns the relevant attribute flags values for the object state encoded as a 32 bits value.
Definition ButtonToSwitch.cpp:302

DbncdMPBttn::getFnWhnTrnOff
fncPtrType getFnWhnTrnOff()
Returns the function that is set to execute every time the object enters the Off State.
Definition ButtonToSwitch.cpp:247

DbncdMPBttn::setOutputsChange
void setOutputsChange(bool newOutputsChange)
Sets the value of the attribute flag indicating if a change took place in any of the output attribute...
Definition ButtonToSwitch.cpp:645

DbncdMPBttn::setDbncTime
bool setDbncTime(const unsigned long int &newDbncTime)
Sets the debounce process time.
Definition ButtonToSwitch.cpp:544

HntdTmLtchMPBttn::setSrvcTime
bool setSrvcTime(const unsigned long int &newSvcTime)
See TmLtchMPBttn::setSrvcTime(const unsigned long int)
Definition ButtonToSwitch.cpp:1631

HntdTmLtchMPBttn::getFVPPWhnTrnOffWrnng
fncVdPtrPrmPtrType getFVPPWhnTrnOffWrnng()
Returns a pointer to a function that is set to execute every time the object enters the Warning Off S...
Definition ButtonToSwitch.cpp:1464

HntdTmLtchMPBttn::getFVPPWhnTrnOffWrnngArgPtr
void * getFVPPWhnTrnOffWrnngArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:1469

HntdTmLtchMPBttn::getFnWhnTrnOnPilot
fncPtrType getFnWhnTrnOnPilot()
Returns the function that is set to execute every time the object's Pilot attribute flag enters the O...
Definition ButtonToSwitch.cpp:1434

HntdTmLtchMPBttn::getFVPPWhnTrnOnWrnngArgPtr
void * getFVPPWhnTrnOnWrnngArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:1479

HntdTmLtchMPBttn::getFVPPWhnTrnOnWrnng
fncVdPtrPrmPtrType getFVPPWhnTrnOnWrnng()
Returns a pointer to a function that is set to execute every time the object enters the Warning On St...
Definition ButtonToSwitch.cpp:1474

HntdTmLtchMPBttn::setFnWhnTrnOffWrnngPtr
void setFnWhnTrnOffWrnngPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object's Warning is reset.
Definition ButtonToSwitch.cpp:1535

HntdTmLtchMPBttn::setFVPPWhnTrnOnWrnngArgPtr
void setFVPPWhnTrnOnWrnngArgPtr(void *newFVPPWhnTrnOnArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:1616

HntdTmLtchMPBttn::getFnWhnTrnOffWrnng
fncPtrType getFnWhnTrnOffWrnng()
Returns the function that is set to execute every time the object's Warning attribute flag enters the...
Definition ButtonToSwitch.cpp:1429

HntdTmLtchMPBttn::setFVPPWhnTrnOffPilotArgPtr
void setFVPPWhnTrnOffPilotArgPtr(void *newFVPPWhnTrnOffArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:1565

HntdTmLtchMPBttn::getFVPPWhnTrnOnPilot
fncVdPtrPrmPtrType getFVPPWhnTrnOnPilot()
Returns a pointer to a function that is set to execute every time the object enters the Pilot On Stat...
Definition ButtonToSwitch.cpp:1454

HntdTmLtchMPBttn::getWrnngOn
const bool getWrnngOn() const
Returns the current value of the warningOn attribute flag.
Definition ButtonToSwitch.cpp:1489

HntdTmLtchMPBttn::setFnWhnTrnOnPilotPtr
void setFnWhnTrnOnPilotPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object's Pilot is set.
Definition ButtonToSwitch.cpp:1542

HntdTmLtchMPBttn::getPilotOn
const bool getPilotOn() const
Returns the current value of the pilotOn attribute flag.
Definition ButtonToSwitch.cpp:1484

HntdTmLtchMPBttn::setFVPPWhnTrnOffPilot
void setFVPPWhnTrnOffPilot(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the Pilot Off State.
Definition ButtonToSwitch.cpp:1556

HntdTmLtchMPBttn::getFVPPWhnTrnOffPilotArgPtr
void * getFVPPWhnTrnOffPilotArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:1449

HntdTmLtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
see DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:1407

HntdTmLtchMPBttn::getFnWhnTrnOffPilot
fncPtrType getFnWhnTrnOffPilot()
Returns the function that is set to execute every time the object's Pilot attribute flag enters the O...
Definition ButtonToSwitch.cpp:1424

HntdTmLtchMPBttn::setFVPPWhnTrnOnPilotArgPtr
void setFVPPWhnTrnOnPilotArgPtr(void *newFVPPWhnTrnOnArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:1582

HntdTmLtchMPBttn::HntdTmLtchMPBttn
HntdTmLtchMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:1368

HntdTmLtchMPBttn::setFnWhnTrnOnWrnngPtr
void setFnWhnTrnOnWrnngPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object's Wrnng is set.
Definition ButtonToSwitch.cpp:1549

HntdTmLtchMPBttn::getFVPPWhnTrnOnPilotArgPtr
void * getFVPPWhnTrnOnPilotArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:1459

HntdTmLtchMPBttn::setFVPPWhnTrnOffWrnng
void setFVPPWhnTrnOffWrnng(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the Warning Off State.
Definition ButtonToSwitch.cpp:1590

HntdTmLtchMPBttn::setWrnngPrctg
bool setWrnngPrctg(const unsigned int &newWrnngPrctg)
Sets the value for the percentage of service time for calculating the warningOn flag value.
Definition ButtonToSwitch.cpp:1643

HntdTmLtchMPBttn::getFnWhnTrnOnWrnng
fncPtrType getFnWhnTrnOnWrnng()
Returns the function that is set to execute every time the object's Warning attribute flag enters the...
Definition ButtonToSwitch.cpp:1439

HntdTmLtchMPBttn::setFVPPWhnTrnOffWrnngArgPtr
void setFVPPWhnTrnOffWrnngArgPtr(void *newFVPPWhnTrnOffArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:1599

HntdTmLtchMPBttn::getFVPPWhnTrnOffPilot
fncVdPtrPrmPtrType getFVPPWhnTrnOffPilot()
Returns a pointer to a function that is set to execute every time the object enters the Pilot Off Sta...
Definition ButtonToSwitch.cpp:1444

HntdTmLtchMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:1399

HntdTmLtchMPBttn::setFnWhnTrnOffPilotPtr
void setFnWhnTrnOffPilotPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object's Pilot is reset.
Definition ButtonToSwitch.cpp:1528

HntdTmLtchMPBttn::setFVPPWhnTrnOnWrnng
void setFVPPWhnTrnOnWrnng(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the Warning On State.
Definition ButtonToSwitch.cpp:1607

HntdTmLtchMPBttn::setFVPPWhnTrnOnPilot
void setFVPPWhnTrnOnPilot(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the Pilot On State.
Definition ButtonToSwitch.cpp:1573

HntdTmLtchMPBttn::setKeepPilot
void setKeepPilot(const bool &newKeepPilot)
Sets the configuration of the keepPilot service attribute.
Definition ButtonToSwitch.cpp:1624

HntdTmLtchMPBttn::~HntdTmLtchMPBttn
~HntdTmLtchMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:1395

LtchMPBttn::getIsLatched
const bool getIsLatched() const
Returns the value of the isLatched attribute flag, indicating the Latched or Unlatched condition of t...
Definition ButtonToSwitch.cpp:979

LtchMPBttn::unlatch
bool unlatch()
Sets the values of the flags needed to unlatch a latched MPB.
Definition ButtonToSwitch.cpp:1035

LtchMPBttn::getUnlatchRlsPend
const bool getUnlatchRlsPend() const
Returns the value of the "Valid Unlatch Release Pending" attribute.
Definition ButtonToSwitch.cpp:994

LtchMPBttn::getUnlatchPend
const bool getUnlatchPend() const
Returns the value of the "Valid Unlatch Pending" attribute.
Definition ButtonToSwitch.cpp:989

LtchMPBttn::~LtchMPBttn
virtual ~LtchMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:959

LtchMPBttn::setUnlatchPend
void setUnlatchPend(const bool &newVal)
Sets the value of the "Valid Unlatch Pending" attribute.
Definition ButtonToSwitch.cpp:1021

LtchMPBttn::setTrnOffASAP
void setTrnOffASAP(const bool &newVal)
Sets the value of the trnOffASAP attribute.
Definition ButtonToSwitch.cpp:1014

LtchMPBttn::getTrnOffASAP
bool getTrnOffASAP()
Returns the value of the trnOffASAP attribute flag.
Definition ButtonToSwitch.cpp:984

LtchMPBttn::setUnlatchRlsPend
void setUnlatchRlsPend(const bool &newVal)
Sets the value of the "Valid Unlatch Release Pending" attribute.
Definition ButtonToSwitch.cpp:1028

LtchMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:962

LtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:970

LtchMPBttn::LtchMPBttn
LtchMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:941

SldrDALtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
Definition ButtonToSwitch.cpp:2400

SldrDALtchMPBttn::setOtptSldrSpd
bool setOtptSldrSpd(const uint16_t &newVal)
Sets the output slider speed (otptSldrSpd) attribute.
Definition ButtonToSwitch.cpp:2471

SldrDALtchMPBttn::getOtptValMax
uint16_t getOtptValMax()
Returns the top output current value register setting.
Definition ButtonToSwitch.cpp:2436

SldrDALtchMPBttn::getOtptCurValIsMin
bool getOtptCurValIsMin()
Returns the result of comparing the Output Current Value to the Minimum value setting
Definition ButtonToSwitch.cpp:2420

SldrDALtchMPBttn::setSldrDirDn
bool setSldrDirDn()
Sets the value of the curSldrDirUp attribute to false.
Definition ButtonToSwitch.cpp:2554

SldrDALtchMPBttn::setOtptValMax
bool setOtptValMax(const uint16_t &newVal)
Sets the output current value register maximum value attribute (otptValMax attribute).
Definition ButtonToSwitch.cpp:2497

SldrDALtchMPBttn::swapSldrDir
bool swapSldrDir()
Inverts the current curSldrDirUp attribute value.
Definition ButtonToSwitch.cpp:2666

SldrDALtchMPBttn::~SldrDALtchMPBttn
~SldrDALtchMPBttn()
Virtual class destructor.
Definition ButtonToSwitch.cpp:2396

SldrDALtchMPBttn::setOtptCurVal
bool setOtptCurVal(const uint16_t &newVal)
Sets the output current value register.
Definition ButtonToSwitch.cpp:2458

SldrDALtchMPBttn::getOtptCurVal
uint16_t getOtptCurVal()
Returns the Output Current Value (otpCurVal) attribute.
Definition ButtonToSwitch.cpp:2409

SldrDALtchMPBttn::setSldrDirUp
bool setSldrDirUp()
Sets the value of the curSldrDirUp attribute to true.
Definition ButtonToSwitch.cpp:2559

SldrDALtchMPBttn::SldrDALtchMPBttn
SldrDALtchMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:2386

SldrDALtchMPBttn::getSldrDirUp
bool getSldrDirUp()
Returns the value of the curSldrDirUp attribute.
Definition ButtonToSwitch.cpp:2446

SldrDALtchMPBttn::setOtptSldrStpSize
bool setOtptSldrStpSize(const uint16_t &newVal)
Sets the output slider step size (otptSldrStpSize) attribute value.
Definition ButtonToSwitch.cpp:2484

SldrDALtchMPBttn::getOtptCurValIsMax
bool getOtptCurValIsMax()
Returns a boolean value indicating if the "Output Current Value" equals the maximum limit.
Definition ButtonToSwitch.cpp:2414

SldrDALtchMPBttn::setSwpDirOnPrss
void setSwpDirOnPrss(const bool &newVal)
Sets the value of the "Auto-Swap Direction On Press" (autoSwpDirOnPrss) attribute.
Definition ButtonToSwitch.cpp:2571

SldrDALtchMPBttn::setOtptValMin
bool setOtptValMin(const uint16_t &newVal)
Sets the output current value register minimum value attribute (otptValMin attribute).
Definition ButtonToSwitch.cpp:2516

SldrDALtchMPBttn::getOtptValMin
uint16_t getOtptValMin()
Returns the bottom output current value register setting.
Definition ButtonToSwitch.cpp:2441

SldrDALtchMPBttn::getOtptSldrSpd
unsigned long getOtptSldrSpd()
Returns the current setting for the Output Slider Speed value.
Definition ButtonToSwitch.cpp:2426

SldrDALtchMPBttn::getOtptSldrStpSize
uint16_t getOtptSldrStpSize()
Returns the current setting for the Output Slider Step Size value.
Definition ButtonToSwitch.cpp:2431

SldrDALtchMPBttn::setSwpDirOnEnd
void setSwpDirOnEnd(const bool &newVal)
Sets the value of the "Auto-Swap Direction on Ends" (autoSwpDirOnEnd) attribute.
Definition ButtonToSwitch.cpp:2564

SnglSrvcVdblMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:3262

SnglSrvcVdblMPBttn::~SnglSrvcVdblMPBttn
virtual ~SnglSrvcVdblMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:3258

SnglSrvcVdblMPBttn::SnglSrvcVdblMPBttn
SnglSrvcVdblMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:3246

TgglLtchMPBttn::TgglLtchMPBttn
TgglLtchMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:1236

TgglLtchMPBttn::~TgglLtchMPBttn
virtual ~TgglLtchMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:1251

TmLtchMPBttn::TmLtchMPBttn
TmLtchMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:1283

TmLtchMPBttn::getSrvcTime
const unsigned long int getSrvcTime() const
Returns the configured Service Time.
Definition ButtonToSwitch.cpp:1313

TmLtchMPBttn::setTmerRstbl
void setTmerRstbl(const bool &newIsRstbl)
Configures the timer for the Service Time to be reseted before it reaches unlatching time.
Definition ButtonToSwitch.cpp:1331

TmLtchMPBttn::setSrvcTime
bool setSrvcTime(const unsigned long int &newSrvcTime)
Sets a new value to the Service Time attribute.
Definition ButtonToSwitch.cpp:1318

TmLtchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
see DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:1306

TmLtchMPBttn::~TmLtchMPBttn
virtual ~TmLtchMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:1302

TmVdblMPBttn::TmVdblMPBttn
TmVdblMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:3159

TmVdblMPBttn::~TmVdblMPBttn
virtual ~TmVdblMPBttn()
Class virtual destructor.
Definition ButtonToSwitch.cpp:3168

TmVdblMPBttn::clrStatus
void clrStatus()
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:3180

TmVdblMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:3172

TmVdblMPBttn::getVoidTime
const unsigned long int getVoidTime() const
Returns the voidTime attribute current value.
Definition ButtonToSwitch.cpp:3187

TmVdblMPBttn::setVoidTime
bool setVoidTime(const unsigned long int &newVoidTime)
Sets a new value to the Void Time attribute.
Definition ButtonToSwitch.cpp:3192

VdblMPBttn::setIsVoided
bool setIsVoided()
Sets the value of the isVoided attribute flag to true.
Definition ButtonToSwitch.cpp:2900

VdblMPBttn::setFVPPWhnTrnOffVddArgPtr
void setFVPPWhnTrnOffVddArgPtr(void *newFVPPWhnTrnOffArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:2872

VdblMPBttn::getIsVoided
const bool getIsVoided() const
Returns the current value of the isVoided attribute flag.
Definition ButtonToSwitch.cpp:2807

VdblMPBttn::getFnWhnTrnOnVdd
fncPtrType getFnWhnTrnOnVdd()
Returns the function that is set to execute every time the object enters the Voided or "Voided On" St...
Definition ButtonToSwitch.cpp:2777

VdblMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:2763

VdblMPBttn::setFnWhnTrnOnVddPtr
void setFnWhnTrnOnVddPtr(void(*newFnWhnTrnOn)())
Sets the function that will be called to execute every time the object's isVoided attribute flag is s...
Definition ButtonToSwitch.cpp:2849

VdblMPBttn::setFVPPWhnTrnOffVdd
void setFVPPWhnTrnOffVdd(fncVdPtrPrmPtrType newFVPPWhnTrnOff, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the Voided Off State a....
Definition ButtonToSwitch.cpp:2863

VdblMPBttn::getFVPPWhnTrnOffVddArgPtr
void * getFVPPWhnTrnOffVddArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:2792

VdblMPBttn::setFVPPWhnTrnOnVddArgPtr
void setFVPPWhnTrnOnVddArgPtr(void *newFVPPWhnTrnOnArgPtr)
Sets a pointer to an argument to be passed to the function set to execute every time the object enter...
Definition ButtonToSwitch.cpp:2888

VdblMPBttn::~VdblMPBttn
virtual ~VdblMPBttn()
Default virtual destructor.
Definition ButtonToSwitch.cpp:2759

VdblMPBttn::VdblMPBttn
VdblMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:2749

VdblMPBttn::getFnWhnTrnOffVdd
fncPtrType getFnWhnTrnOffVdd()
Returns the function that is set to execute every time the object exits the Voided State.
Definition ButtonToSwitch.cpp:2772

VdblMPBttn::setFnWhnTrnOffVddPtr
void setFnWhnTrnOffVddPtr(void(*newFnWhnTrnOff)())
Sets the function that will be called to execute every time the object's isVoided attribute flag is r...
Definition ButtonToSwitch.cpp:2842

VdblMPBttn::getFrcOtptLvlWhnVdd
bool getFrcOtptLvlWhnVdd()
Returns the value of the frcOtptLvlWhnVdd attribute.
Definition ButtonToSwitch.cpp:2782

VdblMPBttn::getStOnWhnOtpFrcd
bool getStOnWhnOtpFrcd()
Returns the value of the frcOtptLvlWhnVdd attribute.
Definition ButtonToSwitch.cpp:2812

VdblMPBttn::getFVPPWhnTrnOnVdd
fncVdPtrPrmPtrType getFVPPWhnTrnOnVdd()
Returns a pointer to a function that is set to execute every time the object enters the Voided On Sta...
Definition ButtonToSwitch.cpp:2797

VdblMPBttn::getFVPPWhnTrnOnVddArgPtr
void * getFVPPWhnTrnOnVddArgPtr()
Returns a pointer to the argument to be passed to the function set to execute every time the object e...
Definition ButtonToSwitch.cpp:2802

VdblMPBttn::setFVPPWhnTrnOnVdd
void setFVPPWhnTrnOnVdd(fncVdPtrPrmPtrType newFVPPWhnTrnOn, void *argPtr=nullptr)
Sets a function to be executed every time the object enters the Voided On State a....
Definition ButtonToSwitch.cpp:2879

VdblMPBttn::setIsNotVoided
bool setIsNotVoided()
Sets the value of the isVoided attribute flag to false.
Definition ButtonToSwitch.cpp:2895

VdblMPBttn::getFVPPWhnTrnOffVdd
fncVdPtrPrmPtrType getFVPPWhnTrnOffVdd()
Returns a pointer to a function that is set to execute every time the object enters the Voided Off St...
Definition ButtonToSwitch.cpp:2787

XtrnUnltchMPBttn::clrStatus
void clrStatus(bool clrIsOn=true)
See DbncdMPBttn::clrStatus(bool)
Definition ButtonToSwitch.cpp:1878

XtrnUnltchMPBttn::XtrnUnltchMPBttn
XtrnUnltchMPBttn()
Default constructor.
Definition ButtonToSwitch.cpp:1846

XtrnUnltchMPBttn::begin
virtual bool begin(const unsigned long int &pollDelayMs=_StdPollDelay)
See DbncdMPBttn::begin(const unsigned long int)
Definition ButtonToSwitch.cpp:1862

MpbOtpts_t
Type to hold the complete set of output attribute flags from any DbncdMPBttn class and subclasses obj...
Definition ButtonToSwitch.h:78