1
0
forked from fsfw/fsfw

Merge request check

This commit is contained in:
2020-01-16 19:07:53 +01:00
parent 9bdbc2c380
commit 1d1bb88a6f
10 changed files with 83 additions and 98 deletions

View File

@ -1,6 +1,6 @@
#include <framework/serialize/SerialBufferAdapter.h>
#include <cstring>
#include <framework/serviceinterface/ServiceInterfaceStream.h>
#include <cstring>
template<typename T>
SerialBufferAdapter<T>::SerialBufferAdapter(const uint8_t* buffer,

View File

@ -9,17 +9,16 @@
* 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<BUFFER_TYPE, MAX_BUFFER_LENGTH, LENGTH_FIELD_TYPE>.
* LENGTH_FIELD_TYPE specifies the data type of the buffer header containing the buffer size
* (defaults to 1 byte length field) that follows and MAX_BUFFER_LENGTH specifies
* the maximum allowed value for the buffer size.
*
* Can be used by SerialLinkedListAdapter by declaring
* as a linked element with SerializeElement<SerialFixedArrayListAdapter<...>>.
* The sequence of objects is defined in the constructor by using the setStart and setNext functions.
*
* 1. Buffers with a size header inside that class can be declared with
* SerialFixedArrayListAdapter<BUFFER_TYPE, MAX_BUFFER_LENGTH, LENGTH_FIELD_TYPE>.
* 2. MAX_BUFFER_LENGTH specifies the maximum allowed value for the buffer size.
* 3. LENGTH_FIELD_TYPE specifies the data type of the buffer header containing the buffer size
* (defaults to 1 byte length field) that follows
*
* @ingroup serialize
*/
template<typename BUFFER_TYPE, uint32_t MAX_SIZE, typename count_t = uint8_t>

View File

@ -19,7 +19,7 @@
* @details
* An alternative to the AutoSerializeAdapter functions
* - All object members with a datatype are declared as SerializeElement<element_type>
* inside the class implementing this adapter.
* members inside the class implementing this adapter.
* - The element type can also be a SerialBufferAdapter to de-/serialize buffers,
* with a known size, where the size can also be serialized
* - The element type can also be a SerialFixedArrayListAdapter to de-/serialize buffers
@ -29,14 +29,13 @@
* the setStart and setNext functions.
*
* - The serialization process is done by instantiating the class and
* calling the serialize after all SerializeElement entries have been set by
* using a constructor or setter functions. An additional size variable can be supplied
* calling serializ after all SerializeElement entries have been set by
* using the constructor or setter functions. An additional size variable can be supplied
* which is calculated/incremented automatically
* - The deserialization process is done by instantiating the class and supplying
* a buffer with the data which is converted into an object. The size of
* data to serialize can be supplied and is decremented in the function
*
*
* @ingroup serialize
*/
template<typename T, typename count_t = uint8_t>