EEPROM-Cache.h

Go to the documentation of this file.

// Copyright © 2017-2025 Daniel Porrey. All Rights Reserved.
//
// This file is part of the EEPROM-Storage library.
//
// EEPROM-Storage library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// EEPROM-Storage library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with EEPROM-Storage library. If not,
// see http://www.gnu.org/licenses/.
//
#pragma once
#ifndef EEPROM_CACHE_H
#define EEPROM_CACHE_H
 
//
// Cross-compatable with Arduino, GNU C++ for tests, and Particle.
//
#if defined(ARDUINO) && ARDUINO >= 100
  #include <Arduino.h>
  #include <EEPROM.h>
#elif defined(PARTICLE)
  #include <Particle.h>
#endif
 
#include "EEPROM-Base.h"
 
template <typename T>
class EEPROMCache : public EEPROMBase<T>
{
  public:
    EEPROMCache(const uint address) : EEPROMBase<T>(address)
    {
      //
      // Read the current value from EEPROM.
      //
      this->restore();
    }
 
    EEPROMCache(const uint address, T value) : EEPROMBase<T>(address, value)
    {
      this->_value = value;
    }
    
    EEPROMCache<T>& operator = (T const& value)
    {
      this->set(value);
      return *this;
    }
 
    EEPROMCache<T>& operator = (EEPROMCache<T> const& item)
    {
      this->set(item.get());
      return *this;
    }
 
    T get() const
    {
      return this->_value;
    }
 
    T set(T const& value)
    {
      this->_value = value;
      return this->_value;
    }
 
    T restore()
    {
      //
      // Read the current value from EEPROM.
      //
      this->_value = this->read();
      return this->_value;
    }
 
    T commit()
    {
      this->write(this->_value);
      return this->_value;
    }
 
  protected:
    T _value; 
};
#endif