Skip to content

Commit

Permalink
Add documentation for delete argument
Browse files Browse the repository at this point in the history
Signed-off-by: Erik Jaegervall <[email protected]>
  • Loading branch information
erikbosch committed Sep 3, 2024
1 parent 22c1a6a commit 73b57fb
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs-gen/content/rule_set/overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ In order to adopt the specification we realize that certain additions and modifi

The following features with the intended usage patterns are currently supported:
1. **Adding new nodes:** By adding nodes the standard catalog can be extended with proprietary concepts.
1. **Deleting nodes:** Deleting nodes not relevant for the vehicle.
1. **Changing the value of existing metadata:** The standard catalog defines metadata based on what is assumed to be an average vehicle.
Configurations may differ slightly (e.g. the instantiation of number of available seats), or special situations that require a (limited) modification of existing metadata.
1. **Adding new key/value pairs as additional metadata:**
Expand Down Expand Up @@ -114,6 +115,38 @@ Vehicle.Occupant.Row1.DriverSide.HeadPosition.Yaw:
unit: mm
```
### Deleting nodes
It is possible to delete nodes using the `delete` attribute.
You can delete indidvidual signals, branches, instances or a particular signal in a particular instance.
A few examples are shown below.

```YAML
# Removing IsChildLockActive for DriverSide on Second Row
Vehicle.Cabin.Door.Row2.DriverSide.IsChildLockActive:
datatype: boolean
type: sensor
delete: true
# Removing Window for all Door instances
Vehicle.Cabin.Door.Window:
delete: true
# Removing Vehicle.Speed
Vehicle.Speed:
delete: true
```

When using the `delete` argument vss-tools will print a summary on how many nodes that are removed.

```bash
Nodes deleted, given=6, overall=18
```

The number for `given` represents number of nodes (branches/sensors/actuators/attributes) explicitly removed.
The `overall` number represents total number, including child nodes for explicitly removed branches.
More detailed output is given in debug mode.

### Overlays in the standard catalog

With the feature of overlays, we introduced a new folder in the
Expand Down

0 comments on commit 73b57fb

Please sign in to comment.