esbo_ds/fsfw
3
0
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests Releases Wiki Activity

first attempt to document and explain serialization tools for application developers

Browse Source
This commit is contained in:
Robin Müller
2019-10-17 00:23:46 +02:00
parent cd7e47ccbb
commit 743d8abeaf
3 changed files with 29 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
serialize/SerializeAdapter.h
View File

@ -7,7 +7,19 @@
#include <framework/serialize/SerializeIF.h>
#include <string.h>
/**
/**
* This adapter provides an interface to use the SerializeIF functions
* with arbitrary template objects to facilitate and simplify the serialization of classes
* with different multiple different data types into buffers vice-versa.
*
* Examples:
* A report class is converted into a TM buffer. The report class implements a serialize functions and calls
* the AutoSerializeAdapter::serialize function repeatedly on all object data fields.
* The getSerializedSize function is implemented by calling the
* AutoSerializeAdapter::getSerializedSize function repeatedly on all data fields.
*
* The AutoSerializeAdapter functions can also be used as an alternative to memcpy
* to retrieve data out of a buffer directly into a class variable with data type T while being able to specify endianness.
* \ingroup serialize
*/
template<typename T, int>