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

14
serialize/SerialFixedArrayListAdapter.h
View File

@ -5,18 +5,18 @@
#include <framework/serialize/SerialArrayListAdapter.h>
/**
* This adapter provides an interface for SerializeIF to serialize and deserialize
* buffers with a header containing the buffer length.
*
* Can be used by SerialLinkedListAdapter.
*
* @brief This adapter provides an interface for SerializeIF to serialize and deserialize
* buffers with a header containing the buffer length.
* @details
* Can be used by SerialLinkedListAdapter by using this type in
* SerializeElement<>
* Buffers with a size header inside that class can be declared with
* SerialFixedArrayListAdapter<uint8_t,MAX_BUFFER_LENGTH,typeOfMaxData>.
* SerialFixedArrayListAdapter<bufferType,MAX_BUFFER_LENGTH,typeOfMaxData>.
* typeOfMaxData specifies the data type of the buffer header containing the buffer size that follows
* and MAX_BUFFER_LENGTH specifies the maximum allowed value for the buffer size.
* The sequence of objects is defined in the constructor by using the setStart and setNext functions.
*
* \ingroup serialize
* @ingroup serialize
*/
template<typename T, uint32_t MAX_SIZE, typename count_t = uint8_t>
class SerialFixedArrayListAdapter : public FixedArrayList<T, MAX_SIZE, count_t>, public SerializeIF {