SaveRestore Class Reference

Interface for classes that can save and restore data from a buffer. More...

#include <save_restore.h>

Inheritance diagram for SaveRestore:

Public Member Functions
virtual uint8_t *	save (uint8_t *buffer)
	This method is called when the object should save its state to the buffer. More...
virtual const uint8_t *	restore (const uint8_t *buffer)
	This method is called when the object should restore its state from the buffer. More...
virtual uint16_t	saveSize ()

Detailed Description

Interface for classes that can save and restore data from a buffer.

Definition at line 7 of file save_restore.h.

Member Function Documentation

restore()

virtual const uint8_t* SaveRestore::restore ( const uint8_t *  buffer )

inlinevirtual

This method is called when the object should restore its state from the buffer.

Parameters

buffer

The buffer the object should restore its state from.

Returns

The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

Reimplemented in TableObject, RouterObject, InterfaceObject, GroupObjectTableObject, DeviceObject, DataProperty, AssociationTableObject, ApplicationProgramObject, and AddressTableObject.

Definition at line 31 of file save_restore.h.

Here is the caller graph for this function:

save()

virtual uint8_t* SaveRestore::save ( uint8_t *  buffer )

inlinevirtual

This method is called when the object should save its state to the buffer.

Parameters

buffer

The buffer the object should save its state to.

Returns

The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

Reimplemented in TableObject, InterfaceObject, DeviceObject, DataProperty, and ApplicationProgramObject.

Definition at line 18 of file save_restore.h.

Here is the caller graph for this function:

saveSize()

virtual uint16_t SaveRestore::saveSize ( )

inlinevirtual

Returns

The maximum number of bytes the object needs to save its state.

Reimplemented in TableObject, InterfaceObject, DeviceObject, DataProperty, and ApplicationProgramObject.

Definition at line 39 of file save_restore.h.

Here is the caller graph for this function:

---

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

• src/knx/save_restore.h