Content_stack.h

Go to the documentation of this file.

 
#ifndef CONTENT_STACK_H
#define CONTENT_STACK_H
#ifdef ARDUINO
    #include <Arduino.h>    // include Arduino-Library for platformIO-build 
#else
    #include <mockArduino.h>
    using namespace arduinoMocking;
    #include <cstring>
#endif
 
 
template<typename content_class, int MaxSize>
class Content_stack{
private:
    content_class elements[MaxSize]; 
 
    int size;                                                           
public: 
    Content_stack(): size(0) {}                                         
 
    ~Content_stack() {} 
 
    bool addElement(content_class element){                                          
        if (size >= MaxSize) {
            return false;}                                              // return false, if stacksize has reached maximum 
        elements[size] = element;
        size++;
        return true;                                                    // return true, if added successful 
    };
 
    bool deleteElement(int index=0){                                        
        if (index < 0 || index >= size) {
            return false;}                                              // return false, if index of element to delete is out of range 
        // delete element, slice remaining elements, reduce size by 1
        for (int i = index; i < size; ++i) {
            if (i==size-1) elements[i]=content_class();
            if (i<size-1) elements[i] = elements[i + 1];    
        }
        size--;
        return true;                                                    // return true, if deleted successfully
    };
 
 
 
    content_class* getElement(int index = 0){                             
        if (index >= size || size+index<0) {                            
            return nullptr;}  
 
        if (index<0){
            return &elements[size+index];                                // neg. index: return element indexed from end of stack (size)
        }
        return &elements[index];                                         // pos. index: return element indexed from beginning of stack (0)
    };
 
    bool empty(){
        bool retVal = (size == 0) ? true:false;
        return retVal;
    }          
 
    bool full(){
        bool retVal = (size == MaxSize) ? true:false;
        return retVal;
    }            
};
 
#endif // CONTENT_STACK_H