EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
eoArchive Class Reference

the base Archive More...

#include <eoArchive.h>

Inheritance diagram for eoArchive:
Collaboration diagram for eoArchive:

Public Member Functions

virtual eoArchiveoperator& (char *obj)
 
virtual eoArchiveoperator& (char const *obj)
 
virtual eoArchiveoperator& (uint32_t &obj)
 
virtual eoArchiveoperator& (int32_t &obj)
 
virtual eoArchiveoperator& (uint16_t &obj)
 
virtual eoArchiveoperator& (int16_t &obj)
 
virtual eoArchiveoperator& (uint8_t &obj)
 
virtual eoArchiveoperator& (int8_t &obj)
 
virtual eoArchiveoperator& (double &obj)
 
virtual eoArchiveoperator& (bool &obj)
 
virtual eoArchiveoperator& (eoISerialize *obj)
 
virtual eoArchiveoperator& (eoISerialize &obj)
 
virtual uint8_t Open (const char *strBuf)
 
virtual void Close ()
 
virtual void startBlock (const char *BlockName)
 
virtual void indent ()
 
virtual void startBlock ()
 
virtual void endBlock ()
 

Public Attributes

bool isStoring
 Flag signalising storing.
 
char identifier [32]
 String indentifier of the archive.
 

Protected Attributes

eoHeaderh
 Header information with the versioning.
 
uint8_t level
 Actual level of the serialisation stream.
 
uint8_t state
 Statemaschine indicator.
 
bool isName
 Flag to signalise if name set.
 

Detailed Description

the base Archive

abstract class describing Archive Operations, for storing the & operator has been overloaded.

Member Function Documentation

◆ Close()

virtual void eoArchive::Close ( )
virtual

Closing the Serialisation stream.

Reimplemented in eoArchiveTXT.

◆ endBlock()

virtual void eoArchive::endBlock ( )
virtual

End a block in serialisation stream.

Reimplemented in eoArchiveTXT.

◆ indent()

virtual void eoArchive::indent ( )
virtual

Make an empty line indent.

Reimplemented in eoArchiveTXT.

◆ Open()

virtual uint8_t eoArchive::Open ( const char *  strBuf)
virtual

Opens the StreamBuffer/file

Parameters
strBuffile/stream buffer
Returns
eoReturn

Reimplemented in eoArchiveTXT.

◆ operator&() [1/12]

virtual eoArchive& eoArchive::operator & ( char *  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [2/12]

virtual eoArchive& eoArchive::operator & ( char const *  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [3/12]

virtual eoArchive& eoArchive::operator & ( uint32_t &  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [4/12]

virtual eoArchive& eoArchive::operator & ( int32_t &  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [5/12]

virtual eoArchive& eoArchive::operator & ( uint16_t &  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [6/12]

virtual eoArchive& eoArchive::operator & ( int16_t &  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [7/12]

virtual eoArchive& eoArchive::operator & ( uint8_t &  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [8/12]

virtual eoArchive& eoArchive::operator & ( int8_t &  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [9/12]

virtual eoArchive& eoArchive::operator & ( double &  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [10/12]

virtual eoArchive& eoArchive::operator & ( bool &  obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [11/12]

virtual eoArchive& eoArchive::operator & ( eoISerialize obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ operator&() [12/12]

virtual eoArchive& eoArchive::operator & ( eoISerialize obj)
virtual

Overloaded & operator to add an object to the archive.

Parameters
objObejct to be add.

Reimplemented in eoArchiveTXT.

◆ startBlock() [1/2]

virtual void eoArchive::startBlock ( const char *  BlockName)
virtual

Start a block in serialisation stream.

Parameters
BlockNamename of the block.

Reimplemented in eoArchiveTXT.

◆ startBlock() [2/2]

virtual void eoArchive::startBlock ( )
virtual

Start a block in serialisation stream.

Reimplemented in eoArchiveTXT.