modelica / ssp-standard

Specification of System Structure and Parameterization (SSP)
Other
12 stars 8 forks source link

Maybe de-wrap annotations and potentially other collection elements. #14

Open pmai opened 1 year ago

pmai commented 1 year ago

FMI 3.0 did go to some lengths to de-wrap collections of elements, i.e. instead of

  <Connectors>
    <Connector ...>
    <Connector ...>
  </Connectors>

you would have

  <Connector ...>
  <Connector ...>

without a wrapper. While FMI 3.0 did this for many elements, it did not do so for the annotations.

For SSP we might or might not want to move in this direction,

The benefit is the reduced XML size and more readable content, since the wrapper is really for the most part redundant.

The disadvantage is that this would move SSP 2.0 much farther from 1.0, which while not fully backward compatible can probably still be read by the same parser (i.e. you can construct a 2.0 parser that easily reads 1.0, whereas with this structural change, you probably would maintain two separate parsers).

pmai commented 1 year ago

Personally I would not go for this for 2.0, due to the change impact, and our timeline constraints, and the need to also reflect this in SSP Traceability, ideally.

DagBruck commented 5 months ago

In general I think this is a desirable simplification, but not essential.