KSat/fsfw
15
4
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests 1 Releases Wiki Activity

Improvements of comments

Browse Source
This commit is contained in:
Steffen Gaisser 2020-08-25 15:06:53 +02:00
parent 6903a761ff
commit 1ae79ab99d
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
serialize/SerializeIF.h
View File

@ -27,17 +27,21 @@ public:
virtual ~SerializeIF() { virtual ~SerializeIF() {
} }
/** /**
* Function to serialize the object into a buffer with maxSize at the current size. * @brief
* Function to serialize the object into a buffer with maxSize. Size represents the written amount.
* If a part of the buffer has been used already, size must be set to the used amount of bytes.
* *
* @details
* Implementations of this function must increase the size variable and move the buffer pointer. * Implementations of this function must increase the size variable and move the buffer pointer.
* * MaxSize must be checked by implementations of this function
* and BUFFER_TOO_SHORT has to be returned if size would be larger than maxSize.
* *
* Custom implementations might use additional return values. * Custom implementations might use additional return values.
* *
* @param buffer Buffer to serialize into, will be set to the current write location * @param[in/out] buffer Buffer to serialize into, will be set to the current write location
* @param size Size that has been used in the buffer already, will be increase by the function * @param[in/out] size Size that has been used in the buffer already, will be increased by the function
* @param maxSize Max size of the buffer. * @param[in] maxSize The size of the buffer that is allowed to be used for serialize.
* @param streamEndianness Endianness of the serialized data according to SerializeIF::Endianness * @param[in] streamEndianness Endianness of the serialized data according to SerializeIF::Endianness
* @return * @return
* - @¢ BUFFER_TOO_SHORT The given buffer in is too short * - @¢ BUFFER_TOO_SHORT The given buffer in is too short
* - @c RETURN_FAILED Generic error * - @c RETURN_FAILED Generic error
@ -47,22 +51,25 @@ public:
size_t maxSize, Endianness streamEndianness) const = 0; size_t maxSize, Endianness streamEndianness) const = 0;
/** /**
* Gets the size of a object if it would be serialized in a buffer * Gets the size of a object if it would be serialized in a buffer.s
* @return Size of serialized object * @return Size of serialized object
*/ */
virtual size_t getSerializedSize() const = 0; virtual size_t getSerializedSize() const = 0;
/** /**
* @brief
* Deserializes a object from a given buffer of given size. * Deserializes a object from a given buffer of given size.
* *
* @details
* Buffer must be moved to the current read location by the implementation * Buffer must be moved to the current read location by the implementation
* of this function. Size must be decreased by the implementation. * of this function. Size must be decreased by the implementation.
* Implementations are not allowed to alter the buffer as indicated by const pointer.
* *
* Custom implementations might use additional return values. * Custom implementations might use additional return values.
* *
* @param buffer Buffer to deSerialize from. Will be moved by the function. * @param[in/out] buffer Buffer to deSerialize from. Will be moved by the function.
* @param size Remaining size of the buffer to read from. Will be decreased by function. * @param[in/out] size Remaining size of the buffer to read from. Will be decreased by function.
* @param streamEndianness Endianness as in according to SerializeIF::Endianness * @param[in] streamEndianness Endianness as in according to SerializeIF::Endianness
* @return * @return
* - @c STREAM_TOO_SHORT The input stream is too short to deSerialize the object * - @c STREAM_TOO_SHORT The input stream is too short to deSerialize the object
* - @c TOO_MANY_ELEMENTS The buffer has more inputs than expected * - @c TOO_MANY_ELEMENTS The buffer has more inputs than expected