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

doc for dhb, serializeIF and SerializeAdapter

Browse Source
This commit is contained in:
Robin Müller
2019-10-27 03:21:38 +01:00
parent 8f1517d276
commit 64f84d9d9f
6 changed files with 51 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
serialize/SerializeIF.h
View File

@ -11,10 +11,16 @@
/**
* An interface for alle classes which require translation of objects data into data streams and vice-versa.
*
* In the SOURCE mission , the target architecture is little endian,
* so any buffers must be deSerialized with bool bigEndian = false if
* the parameters are used in the FSFW.
* When serializing for downlink, the packets are generally serialized into big endian for the network when using a TC/UDP client
* If the target architecture is little endian (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:
*
* 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.
*
* When serializing for downlink, the packets are generally serialized assuming big endian data format
* like seen in TmPacketStored.cpp for example.
*
* \ingroup serialize