EepromAbstraction Class Reference

#include <EepromAbstraction.h>

Inheritance diagram for EepromAbstraction:

Public Member Functions
virtual bool	hasErrorOccurred ()
virtual uint8_t	read8 (EepromPosition position)=0
virtual void	write8 (EepromPosition position, uint8_t val)=0
virtual uint16_t	read16 (EepromPosition position)=0
virtual void	write16 (EepromPosition position, uint16_t val)=0
virtual uint32_t	read32 (EepromPosition position)=0
virtual void	write32 (EepromPosition position, uint32_t val)=0
virtual void	readIntoMemArray (uint8_t *memDest, EepromPosition romSrc, uint8_t len)=0
virtual void	writeArrayToRom (EepromPosition romDest, const uint8_t *memSrc, uint8_t len)=0
void	writeCharArrToRom (EepromPosition romDest, const char *memSrc, uint8_t len)
void	readCharArrIntoMemArray (char *memDest, EepromPosition romSrc, uint8_t len)

Detailed Description

Provides an abstraction on eeprom storage, to allow either on chip or external I2c based eeprom storage, or even No storage whatsoever. This helps no end with 32 bit boards that don't have eeprom! Most EEPROM implementions here only write if there are changes.

Member Function Documentation

hasErrorOccurred()

virtual bool EepromAbstraction::hasErrorOccurred ( )

inlinevirtual

Best efforts error flag that will clear once read.

Reimplemented in I2cAt24Eeprom, and MockEepromAbstraction.

read8()

virtual uint8_t EepromAbstraction::read8 ( EepromPosition position )

pure virtual

Read an 8 bit (byte) value at a specified position

Parameters

position

address at which to read

Implemented in ArduinoEEPROMAbstraction, AvrEeprom, I2cAt24Eeprom, and MockEepromAbstraction.

write8()

virtual void EepromAbstraction::write8 ( EepromPosition position, uint8_t val )

pure virtual

write an 8 bit (byte) value to the specified position

Parameters

position	the position at which to write
val	the new value

Implemented in ArduinoEEPROMAbstraction, AvrEeprom, I2cAt24Eeprom, and MockEepromAbstraction.

read16()

virtual uint16_t EepromAbstraction::read16 ( EepromPosition position )

pure virtual

read a 16 bit value at position at a specified position

Parameters

position

the position at which to read

Implemented in ArduinoEEPROMAbstraction, AvrEeprom, I2cAt24Eeprom, and MockEepromAbstraction.

write16()

virtual void EepromAbstraction::write16 ( EepromPosition position, uint16_t val )

pure virtual

write a 16 bit value to the specified position

Parameters

position	the position at which to write
val	the value to read

Implemented in ArduinoEEPROMAbstraction, AvrEeprom, I2cAt24Eeprom, and MockEepromAbstraction.

read32()

virtual uint32_t EepromAbstraction::read32 ( EepromPosition position )

pure virtual

read a 32 bit value at a specified position

Parameters

position

the position at which to read

Implemented in ArduinoEEPROMAbstraction, AvrEeprom, I2cAt24Eeprom, and MockEepromAbstraction.

write32()

virtual void EepromAbstraction::write32 ( EepromPosition position, uint32_t val )

pure virtual

write a 32 bit value to position

Parameters

position	the position at which to write
val	the value to write out.

Implemented in ArduinoEEPROMAbstraction, AvrEeprom, I2cAt24Eeprom, and MockEepromAbstraction.

readIntoMemArray()

virtual void EepromAbstraction::readIntoMemArray ( uint8_t * memDest, EepromPosition romSrc, uint8_t len )

pure virtual

Read an array of bytes from EEPROM into memory

Parameters

memDest	the memory where the EEPROM data should be copied to
romSrc	the source position in EEPROM storage
len	the length of the array

Implemented in ArduinoEEPROMAbstraction, AvrEeprom, I2cAt24Eeprom, and MockEepromAbstraction.

writeArrayToRom()

virtual void EepromAbstraction::writeArrayToRom ( EepromPosition romDest, const uint8_t * memSrc, uint8_t len )

pure virtual

Writes an array of bytes from memory to EEPROM storage

Parameters

romDest	the start position in eeprom storage that the array should be copied to
memSrc	the memory where the rom should be copied from
len	the length of the array

Implemented in ArduinoEEPROMAbstraction, AvrEeprom, I2cAt24Eeprom, and MockEepromAbstraction.

writeCharArrToRom()

void EepromAbstraction::writeCharArrToRom ( EepromPosition romDest, const char * memSrc, uint8_t len )

inline

Helper function that calls into writeArrayToRom but wraps it to take char* instead.

See also

writeArrayToRom

Parameters

romDest	the position in the ROM to write at
memSrc	the memory location to copy from
len	the length of the copy

readCharArrIntoMemArray()

void EepromAbstraction::readCharArrIntoMemArray ( char * memDest, EepromPosition romSrc, uint8_t len )

inline

Helper function that calls into readIntoMemArray but wraps it to take char* instead.

See also

readIntoMemArray

Parameters

memDest	the memory destination where the EEPROM data should be copied to
romSrc	the source position in EEPROM storage to read from
len	the length of the array to read

---

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

• src/EepromAbstraction.h