Conditional connectors not handled by OMEdit

[OpenModelica-TracImporter]

No description provided.

[adeas31]

See original ticket description on trac #2081.

See also #5913 and #7492

[casella]

@adrpo, I'm trying to figure out myself why this is so difficult. I tried a simple example case, see
TestConditionalConnectors.txt; I opened TestConditionalConnectors.Test1 and checked omedicommunication.log.

As I understand the problem is that currently OMEdit fetches display information from the class definitions

getElements(TestConditionalConnectors.Test1, useQuotes = true) 00:34:00:407
{{"co", "-", "TestConditionalConnectors.M1", "m1", "", "public", "false", "false", "false", "false", "unspecified", "none", "unspecified", "$Any", "{}"}} 00:34:00:407
#s#; 0.000000; 0.317000; 'getElements(TestConditionalConnectors.Test1, useQuotes = true)'

getElementAnnotations(TestConditionalConnectors.Test1) 00:34:00:407
{{Placement(true,0.0,0.0,-10.0,-10.0,10.0,10.0,0.0,-,-,-,-,-,-,)}} 00:34:00:408
#s#; 0.000000; 0.317000; 'getElementAnnotations(TestConditionalConnectors.Test1)'

getDiagramAnnotation(TestConditionalConnectors.Test1) 00:34:00:408
{} 00:34:00:408
#s#; 0.000000; 0.317000; 'getDiagramAnnotation(TestConditionalConnectors.Test1)'

countMessages() 00:34:00:409
(0,0,0) 00:34:00:409
#s#; 0.000000; 0.317000; 'countMessages()'

getElements(TestConditionalConnectors.M1, useQuotes = true) 00:34:00:409
{{"co", "-", "Boolean", "activateOutput", "", "public", "false", "false", "false", "false", "parameter", "none", "unspecified", "$Any", "{}"},{"co", "-", "TestConditionalConnectors.RealOutput", "y", "", "public", "false", "false", "false", "false", "unspecified", "none", "unspecified", "$Any", "{}"}} 00:34:00:409
#s#; 0.000000; 0.317000; 'getElements(TestConditionalConnectors.M1, useQuotes = true)'

getElementAnnotations(TestConditionalConnectors.M1) 00:34:00:409
{{},{Placement(true,100.0,2.0,-10.0,-10.0,10.0,10.0,0.0,100.0,1.77636e-15,-20.0,-20.0,20.0,20.0,0.0)}} 00:34:00:409
#s#; 0.000000; 0.317000; 'getElementAnnotations(TestConditionalConnectors.M1)'

getElements(TestConditionalConnectors.RealOutput, useQuotes = true) 00:34:00:410
{} 00:34:00:410
#s#; 0.000000; 0.317000; 'getElements(TestConditionalConnectors.RealOutput, useQuotes = true)'

getDiagramAnnotation(TestConditionalConnectors.RealOutput) 00:34:00:410
{-100.0,-100.0,100.0,100.0,true,-,-,, {Polygon(true, {0.0, 0.0}, 0.0, {0, 0, 127}, {255, 255, 255}, LinePattern.Solid, FillPattern.Solid, 0.25, {{-100.0, 50.0}, {0.0, 0.0}, {-100.0, -50.0}}, Smooth.None), Text(true, {0.0, 0.0}, 0.0, {0, 0, 127}, {0, 0, 0}, LinePattern.Solid, FillPattern.None, 0.25, {{30.0, 60.0}, {30.0, 110.0}}, "%name", 0.0, {-1, -1, -1}, "", {}, TextAlignment.Center)}} 00:34:00:411
#s#; 0.000000; 0.317000; 'getDiagramAnnotation(TestConditionalConnectors.RealOutput)'

but not from the actual instances. Specifically, it gets the information that TestConditionalConnectors.Test1 contains an instance of class TestConditionalConnectors.M1 named m1, but then it asks about elements of the class M1, not of the specific instance m1, which is were the information about the activation of conditional connectors is defined.

Do I understand correctly?

Is the problem that we should switch from gathering information about classes to gathering information about their instances?

[casella]

We need a plan to implement an "instance-based" mechanism in place of the current one, which will also solve other long-standing issues. @perost and @adeas31 will work on that, with input from @adrpo that has ideas how to do this.

[casella]

The current situation is that all conditional connectors are always shown. There were some cases where this did not happen, see #8172 and #8210, they were fixed in #8237.

Other cases are more involved, e.g. because of redeclared classes, see #8210, and cannot be easily fixed with the curent approach.

Eventually, once the new instantiation-based framework is established, #8237 should be reverted and the visibility attribute should be correctly evaluated in OMEdit based on the latest parameter value input.

[casella]

Additionally, we need to update the icons that depend on parameters dynamically.

[casella]

Prototype implementation available since PR #9230, start OMEdit with OMEdit --NAPI=true. Still doesn't show connections, but the conditional connectors are correctly updated.

MWE: TestConditionalConnectors.mo.txt, R1 has an activated thermal port, R2 hasn't. Changing the parameter useHeatPort of R2 immediately affects the status of the conditional connector shown on the diagram.

[niklwors]

@adeas31 I tried the prototype with our BRSL pumps library and for the pumps components. I now only see a blank diagram or OMedit crashes. Also the error appears: OMCompiler/Compiler/Script/NFApi.mo: 901:9-901:92]: Internal errorNFApi.buildInstanceTree got unknown class tree
I used the library Rexroth_Pumps/package.mo and then you can use e.g. the component Rexroth_Pumps.AxialPistonUnits.VariableUnits.A4VSO
There are three ports which should no be visible.

[adrpo]

@niklwors I suspect the getModelInstance API has some issues with some complex models for now. @perost will fix them when he comes back from the holidays. They have started with small models so they can do proper testing.

[casella]

@niklwors, thanks for reporting!

What we have now is just a demo. It shows we are on the right track, but is still far from being usable. Work on that will resume from mid-August.

[adeas31]

@niklwors please send your library to me. I will do some testing.

[niklwors]

@adeas31 Thank you, @adrpo can provide you with this information

[adeas31]

@niklwors several improvements are done. Can you please test this again and report.

[casella]

This functionality is now implemented for good in the new instance-based API, currently activated by running OMEdit --NAPI=true.

Please reopen this ticket if there are any problems which are specific of this feature.