Skip to content

Commit

Permalink
Updating solution to use --no-expand
Browse files Browse the repository at this point in the history
  • Loading branch information
erikbosch committed Sep 6, 2023
1 parent cfd5e79 commit 9e8cb7a
Show file tree
Hide file tree
Showing 24 changed files with 2,035 additions and 7,619 deletions.
48 changes: 0 additions & 48 deletions Expanded-info.md

This file was deleted.

8 changes: 7 additions & 1 deletion docs/vspec2x.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The supported arguments might look like this

```
usage: vspec2x.py [-h] [-I dir] [-e EXTENDED_ATTRIBUTES] [-s] [--abort-on-unknown-attribute] [--abort-on-name-style]
[--format format] [--uuid] [--no-uuid] [-o overlays] [-u unit_file]
[--format format] [--uuid] [--no-uuid] [--no_expand] [-o overlays] [-u unit_file]
[-vt vspec_types_file] [-ot <types_output_file>]
[--json-all-extended-attributes] [--json-pretty]
[--yaml-all-extended-attributes] [-v version] [--all-idl-features] [--gqlfield GQLFIELD GQLFIELD]
Expand Down Expand Up @@ -68,6 +68,12 @@ This is currently the default behavior. From VSS 4.0 `--no-uuid` will be the def
Request the exporter to not output uuids.
From VSS 4.0 this will be the default behavior and then this parameter will be deprecated.

### --no-expand

By default all tools expand instance information so that instance information like "Row1" become a branch just like
any other branch. If this argument is used and the exporter supports it no expansion will take place.

This comment has been minimized.

Copy link
@BjoernAtBosch

BjoernAtBosch Sep 8, 2023

I would add a comma here for better readability:
"If this argument is used and the exporter supports it**,** no expansion will take place."

Instead instance information will be kept as additional information for the branch.

## Handling of Data Types

COVESA supports a number of pre-defined types, see [VSS documentation](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/data_types/).
Expand Down
3 changes: 3 additions & 0 deletions docs/vspec2x_arch.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ This will result in that e.g. `Vehicle.Cabin.Door` is expanded to the following
* `Vehicle.Cabin.Door.Row2.Left`
* `Vehicle.Cabin.Door.Row2.Right`

For some exporters expansion can be suppressed by using the `--no_expand` option.
Then instance information will be represented by other means in the resulting output.

## Expansion and Overlays

Sometimes an overlay only refers to a signal in a specific branch, like:
Expand Down
Loading

0 comments on commit 9e8cb7a

Please sign in to comment.