vss-tools icon indicating copy to clipboard operation
vss-tools copied to clipboard

Struct support - vspec2ddsidl

Open erikbosch opened this issue 2 years ago • 3 comments

This issues concerns struct support for vspec2ddsidl.

Required work:

  • Define/propose how it shall be handled (possibly in this PR)
  • Implement and test
  • Make sure that expected output format is described in documentation
  • If feasible, add at least one test case checking output

VSS Struct support is expected to be officially released for VSS 4.0, late April. To identify and manage remaining a work number of issues have been created to facilitate more detailed discussion and to identify volunteers for implementing/reviewing/testing.

@SebastianSchildt will check if the ones originally contributing vspec2ddsidl are interested

erikbosch avatar Feb 16 '23 10:02 erikbosch

I am willing to take up this feature addition. Is there any document or diagram which may help me briefly understand the flow of code in the py files.

happikin avatar Mar 29 '24 08:03 happikin

I am willing to take up this feature addition. Is there any document or diagram which may help me briefly understand the flow of code in the py files.

Great!

We do not have that much documentation, there is a little at:

  • https://github.com/COVESA/vss-tools/blob/master/docs/vspec2x.md#writing-your-own-generator
  • https://github.com/COVESA/vss-tools/blob/master/docs/vspec2x_arch.md

To get know a little about the general structure of exporters/tools you can look at the test case at https://github.com/COVESA/vss-tools/blob/master/tests/generators/example_generator.py

I did however notice that we already did some work on DDSIDL support in https://github.com/COVESA/vss-tools/pull/262, so this issue is not really up to date. Please check if the current level support fits your needs. I noticed that not all test cases have been updated to include DDSIDL struct support, I will do some edits and mention you so that you can get an overview of the current level of support.

erikbosch avatar Apr 02 '24 07:04 erikbosch

See #340 for an example on how DDSIDL struct support works as of today, that could help identifying improvement areas. If we think it is good enough we should close this issue

erikbosch avatar Apr 02 '24 08:04 erikbosch