mohr/fsfw
1
0
Fork 0
forked from fsfw/fsfw
Code Pull Requests Activity

Serialization documentation update

Browse Source
This commit is contained in:
Robin Müller
2019-12-08 22:57:03 +01:00
parent 3159ccbc40
commit 8168885dd9
6 changed files with 70 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
serialize/SerializeIF.h
View File

@ -4,17 +4,18 @@
#include <framework/returnvalues/HasReturnvaluesIF.h>
/**
* \defgroup serialize Serialization
* @defgroup serialize Serialization
* Contains serialisation services.
*/
/**
* An interface for alle classes which require translation of objects data into data streams and vice-versa.
*
* @brief An interface for alle classes which require
* translation of objects data into data streams and vice-versa.
* @details
* If the target architecture is little endian (e.g. ARM), any data types created might
* have the wrong endiness if they are to be used for the FSFW.
* There are three ways to retrieve data out of a buffer to be used in the FSFW to use regular aligned (big endian) data.
* This can also be applied to uint32_t and uint64_t:
* There are three ways to retrieve data out of a buffer to be used in the FSFW to use
* regular aligned (big endian) data. This can also be applied to uint32_t and uint64_t:
*
* 1. Use the @c AutoSerializeAdapter::deSerialize function with @c bigEndian = true
* 2. Perform a bitshift operation
@ -23,7 +24,7 @@
* When serializing for downlink, the packets are generally serialized assuming big endian data format
* like seen in TmPacketStored.cpp for example.
*
* \ingroup serialize
* @ingroup serialize
*/
class SerializeIF {
public: