Components XML files are missing in openPASS 1.0

Until version 0.11 the folder "components" located in the Qt GUI part of openPASS contained all the components XML files: https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/tree/openPASS_0.11/gui/components?ref_type=tags

By removing the Qt GUI part in the version 1.0, this folder has been deleted and the components XML files are now missing. I suggest to simply copy the old components folder next to the components source code.

assigned to @gwendallucas

I'm not sure if these files should be part of opSimulation (or even the individual components) or if they should be part of the GUI. Any pros/cons?

I see three solutions:

1. Store the components XMl files in a components folder in opGUI repository:

Pros: the components XML files are necessary to generate a system in the GUI (static simulation), so it is good to have them in the opGUI repository

Cons:

• when maintaining an existing component in the opSimulation repository, or adding a new one, one should not forget to update or add the corresponding component XML file in the opGUI repository. This is a already the case for the new two-track components, which are currently missing, since there is no more dedicated location for the components XML files (it was usual to store them in the components folder of the old GUI)
• the folder can contain more XML components files than existing components: the user can build a system of components for which the source code does not exist, and therefore *.dll modules are missing (this was already the case in the version 0.11)

2. Store the components XMl files in opSimulation/sim/src/components in opSimulation repository (new folder)

Pros: the components source code is located in opSimulation, so it makes sense to me to store the XML files next to them. So when maintaining an existing component or adding a new one, it makes sense to update or add the corresponding XML file.

Cons: same argument as before regarding the possible inconsistency bewtween the XML files and the existing components

3. Store the components XMl files in their corresponding components folder in opSimulation/sim/src/components in opSimulation repository:
   When compiling opSimulation, all the components XML files should be gathered in a new folder "components" next to the modules folder

Pros:

• Same maintenance argument as before
• consitency ensured: for each XML component file used in the GUI, it exists a *.dll module

Despite the fact that component XMLs are only used by the GUI, the contents of these files are still (mainly) determined by the implementation of the component, resulting in a tight coupling. Thus option 3 would be my favorite.

There will be interesting aspects for future development like ensuring the compatibility between implementation, XML and the GUI :-) That's another input for a maybe necessary umbrella repo/project.

changed milestone to %Release v1.1.0

set weight to 1

changed milestone to %Release vX.X.X

Not yet done (components XML files neither in opSimulation nor in opGUI)

removed weight of 1

changed milestone to %Release v1.2.0

nearly done

mentioned in merge request !241 (merged)

Issue is now covered by MR !241 (merged)

done

closed