Descriptions of the meaning of Complex variable are lost in the simulation result file

[Francesco Casella]

Consider this simple test case

model M
  Complex z "Meaning of variable z";
equation
  z = Complex(time);
end M;

When you open the Variables Browser, the explanation of what z means, i.e. the content of the comment "Meaning of the variable z" is lost. You only see the comment of the two fields of record z, "Imaginary part of complex number", and "Real part of complex number", which are useful but a bit too generic.

This is due to the fact that currently only the comments of the scalar variables in the result are stored in the result file.

We should find a solution (possibly backwards compatible with the existing de-facto standard set by Dymola) where we can add this information.

In fact, this would also be useful in this other case

model M2
  M3 m "Description of what m actually is";
end M2;

model M3
  Real x "Meaning of variable x";
end M3;

If you simulate M2, the only description of component m that you see is its name, and the description of its variable x. This may be enough if the name m is chosen to be meaningful (as suggested by the helper windows of OMEdit when you drag-and-drop, BTW), but it would be nice to also be able to see the full comment string, in case the model developer wanted to be clearer.

Currently, the full description of m is only visible if you hover the cursor on the component icon in the diagram view (assuming it has one), but not in the variable browser window.

[Adeel Asghar]

This is due to the fact that currently only the comments of the scalar variables in the result are stored in the result file.

True. However, OMEdit reads it from the model_init.xml file and that also just stores the information of the scalar variables. Of course I can read the description through OMC but that might not be the optimal solution.