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

serialize tools more documentation

Browse Source
This commit is contained in:
Robin Müller
2019-11-02 23:30:12 +01:00
parent d47496db40
commit 46986f69e4
5 changed files with 35 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
serialize/SerializeIF.h
View File

@ -11,14 +11,14 @@
/**
* An interface for alle classes which require translation of objects data into data streams and vice-versa.
*
* If the target architecture is little endian (ARM), any data types created might
* 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.
* 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
* 3. @c memcpy can be used when data is little-endian. Otherwise, @c EndianSwapper has to be used.
* 3. @c memcpy can be used when data is in little-endian format. Otherwise, @c EndianSwapper has to be used in conjuction.
*
* When serializing for downlink, the packets are generally serialized assuming big endian data format
* like seen in TmPacketStored.cpp for example.