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

10
serialize/SerialLinkedListAdapter.h
View File

@ -17,12 +17,20 @@
* An alternative to the AutoSerializeAdapter functions to implement the conversion
* of object data to data streams or vice-versa, using linked lists.
*
* All object members with a datatype are declared as SerializeElement<element_type> inside the class.
* All object members with a datatype are declared as SerializeElement<element_type> inside the class
* implementing this adapter.
*
* Buffers with a size header inside that class can be declared with
* SerialFixedArrayListAdapter<uint8_t,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.
* Please note that a direct link from a linked element to a SerialFixedArrayListAdapter element is not possible and a
* helper needs to be used by calling <LinkedElement>.setNext(&linkHelper)
* and initialising the link helper as linkHelper(&SerialFixedArrayListAdapterElement).
*
* For buffers with no size header, declare
* SerializeElement<SerializeBufferAdapter<T>> and initialise the buffer adapter in the constructor.
*
* The sequence of objects is defined in the constructor by using the setStart and setNext functions.
*
* The serialization and deserialization process is done by instantiating the class and