Expand SerializeIF #656

Merged

mohr merged 17 commits from mueller/expand-serialize-if into development 2022-08-15 15:13:52 +02:00

Conversation 1 Commits 17 Files Changed 10 +269 -31

muellerr commented 2022-07-25 11:37:11 +02:00

Owner

Copy Link

1. Fix serialize.h composite include
2. Add various helper methods for deserializing/deserializing to big(network) endianness or native endianness. This avoids boilerplate code or re-implementing simple helpers over and over again
   • serializeBe: Calls serialize with big (network) endianness
3. Add default implementations for serialize and deSerialize which do not perform pointer arithmetic. There is usually no need to re-implement those on demand, their default implementation can be derived from the one performing pointer arithmetic

Also adds unit test module for the new API

1. Fix `serialize.h` composite include 2. Add various helper methods for deserializing/deserializing to big(network) endianness or native endianness. This avoids boilerplate code or re-implementing simple helpers over and over again - `serializeBe`: Calls serialize with big (network) endianness 3. Add default implementations for serialize and deSerialize which do not perform pointer arithmetic. There is usually no need to re-implement those on demand, their default implementation can be derived from the one performing pointer arithmetic Also adds unit test module for the new API

muellerr added 7 commits 2022-07-25 11:37:15 +02:00

default implementation of simple serialize/deserialize 42a1d6cccd

expand serialize IF further ddad97033d

added a few more methods 8e05fc0417

expand serializeIF tests f2bf4b463e

added unittests for new helpers b809f90e72

small fix 3708df2423

use Be instead of Ne, which could be confused 2a34c831b1

muellerr added 1 commit 2022-07-25 11:39:24 +02:00

Merge branch 'development' into mueller/expand-serialize-if 180210dc38

muellerr requested review from gaisser 2022-07-25 11:39:37 +02:00

muellerr requested review from mohr 2022-07-25 11:39:42 +02:00

muellerr added 1 commit 2022-07-25 14:40:01 +02:00

remove obsolete returns 380f1d0206

muellerr added 1 commit 2022-07-25 14:44:14 +02:00

add [[nodiscard]] and const specifiers f3af88ae40

muellerr added 1 commit 2022-07-25 14:44:45 +02:00

run afmt f80be9e9fa

muellerr added 1 commit 2022-07-25 15:08:07 +02:00

Merge branch 'development' into mueller/expand-serialize-if 8f07133e2c

gaisser added this to the v6.0.0 milestone 2022-07-25 15:23:59 +02:00

muellerr added 1 commit 2022-07-26 19:09:10 +02:00

Merge branch 'development' into mueller/expand-serialize-if e7d9979078

muellerr added 2 commits 2022-07-27 21:35:36 +02:00

adaption for SerializeIF ... dc31358d52

- Returns serialized and deserialized size now

update unittests b11cdf6184

muellerr commented 2022-07-28 12:42:22 +02:00

Author

Owner

Copy Link

I updated the methods to be able to return the serialized and deserialized size. I think this is still a very useful value to know.

On a sidenote:

If someone wants to use the new API, they have to prepend the regular method call with SerializeIF::. Example

auto foo FooWhichImplementsSerializeIF(...);
foo.SerializeIF::serialize(data, size);

This is relatively new for me. To make the regular foo.serialize(...) work, something like a base class is probably necessary, but I am not fully sure about that. From an API standpoint, I'd prefer it if one could just all .serialize. But this is probably a topic for another issue/PR

I updated the methods to be able to return the serialized and deserialized size. I think this is still a very useful value to know. On a sidenote: If someone wants to use the new API, they have to prepend the regular method call with `SerializeIF::`. Example ```cpp auto foo FooWhichImplementsSerializeIF(...); foo.SerializeIF::serialize(data, size); ``` This is relatively new for me. To make the regular `foo.serialize(...)` work, something like a base class is probably necessary, but I am not fully sure about that. From an API standpoint, I'd prefer it if one could just all `.serialize`. But this is probably a topic for another issue/PR

muellerr added a new dependency 2022-07-29 09:51:56 +02:00

#655 Refactor TMTC Stack, improve test framework

muellerr added a new dependency 2022-07-29 14:20:33 +02:00

#660 New UnsignedByte Field class

muellerr added 1 commit 2022-08-05 14:02:34 +02:00

Merge branch 'development' into mueller/expand-serialize-if cc56b00df3

muellerr added 1 commit 2022-08-15 14:34:09 +02:00

remove implicit machine endianness variants deeeef553b

gaisser approved these changes 2022-08-15 14:46:32 +02:00

gaisser left a comment

Owner

Copy Link

LGTM

LGTM

mohr added the

feature

label 2022-08-15 15:11:26 +02:00

mohr referenced this issue from a commit 2022-08-15 15:13:51 +02:00

Merge pull request 'Expand SerializeIF' (#656) from mueller/expand-serialize-if into development

mohr merged commit 57ce5d1f34 into development 2022-08-15 15:13:52 +02:00

mohr deleted branch mueller/expand-serialize-if 2022-08-15 15:13:52 +02:00

mohr refused to review 2022-08-15 15:14:02 +02:00

Sign in to join this conversation.

Reviewers

No reviewers

gaisser

Labels

Clear labels   

API Change

Changes the API, so Users need to adapted

  

Breaking API Change

Changes the API in a non backwards compatible way

  

bug

Something is not working

  

build

Issues related to the buildsystem, including CI

  

cosmetics

Small change most users won't notice

  

Documentation

Improvement of code documentation

  

duplicate

This issue or pull request already exists

  

feature

New feature

  

help wanted

Need some help

  

hotfix

Quick or important fix that is merged directly into master, causing a new revision

  

invalid

#worksforme

  

question

More information is needed

  

Refactor

Contains a refactoring of some code

  

Tests

Issues related to testing code

  

wontfix

This won't be fixed

No Label

API Change

Breaking API Change

bug

build

cosmetics

Documentation

duplicate

feature

help wanted

hotfix

invalid

question

Refactor

Tests

wontfix

Milestone

Clear milestone

No items

No Milestone

v6.0.0

Assignees

Clear assignees

No Assignees

2 Participants

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Blocks

#655 Refactor TMTC Stack, improve test framework

fsfw/fsfw

#660 New UnsignedByte Field class

fsfw/fsfw

Reference: fsfw/fsfw#656

No description provided.