Add class restriction to getModelInstance (#9124)

OpenModelica · Jun 20, 2022 · d60a541 · d60a541
1 parent 0047718
commit d60a541
Show file tree

Hide file tree

Showing 13 changed files with 28 additions and 0 deletions.
diff --git a/OMCompiler/Compiler/Script/NFApi.mo b/OMCompiler/Compiler/Script/NFApi.mo
@@ -83,6 +83,7 @@ import NFPrefixes.{Variability};
 import NFSections.Sections;
 import Package = NFPackage;
 import Prefixes = NFPrefixes;
+import Restriction = NFRestriction;
 import Scalarize = NFScalarize;
 import SimplifyExp = NFSimplifyExp;
 import SimplifyModel = NFSimplifyModel;
@@ -930,6 +931,8 @@ algorithm
   cmt := SCodeUtil.getElementComment(InstNode.definition(node));
 
   json := JSON.addPair("name", dumpJSONNodePath(node), json);
+  json := JSON.addPair("restriction",
+    JSON.makeString(Restriction.toString(InstNode.restriction(node))), json);
 
   if not listEmpty(exts) then
     json := JSON.addPair("extends", dumpJSONExtends(exts), json);

diff --git a/doc/instanceAPI/getModelInstance.schema.json b/doc/instanceAPI/getModelInstance.schema.json
@@ -8,6 +8,10 @@
       "description": "The name of the class",
       "type": "string"
     },
+    "restriction": {
+      "description": "The kind of class",
+      "type": "string"
+    },
     "extends": {
       "description": "The extends clauses in the class instance",
       "type": "array",

diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceAnnotation1.mos b/testsuite/openmodelica/instance-API/GetModelInstanceAnnotation1.mos
@@ -19,6 +19,7 @@ getModelInstance(M, prettyPrint=true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"annotation\": {
 //     \"Icon\": {
 //       \"graphics\": [

diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceAnnotation2.mos b/testsuite/openmodelica/instance-API/GetModelInstanceAnnotation2.mos
@@ -19,6 +19,7 @@ getModelInstance(M, prettyPrint=true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"annotation\": {
 //     \"Icon\": {
 //       \"graphics\": [

diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceAttributes1.mos b/testsuite/openmodelica/instance-API/GetModelInstanceAttributes1.mos
@@ -19,6 +19,7 @@ getModelInstance(M, prettyPrint = true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"components\": [
 //     {
 //       \"name\": \"pi\",

diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceAttributes2.mos b/testsuite/openmodelica/instance-API/GetModelInstanceAttributes2.mos
@@ -34,9 +34,11 @@ getModelInstance(M, prettyPrint = true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"extends\": [
 //     {
 //       \"name\": \"A\",
+//       \"restriction\": \"model\",
 //       \"components\": [
 //         {
 //           \"name\": \"w\",
@@ -106,6 +108,7 @@ getModelInstance(M, prettyPrint = true);
 //       \"name\": \"c\",
 //       \"type\": {
 //         \"name\": \"C\",
+//         \"restriction\": \"connector\",
 //         \"components\": [
 //           {
 //             \"name\": \"e\",

diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceComment1.mos b/testsuite/openmodelica/instance-API/GetModelInstanceComment1.mos
@@ -17,6 +17,7 @@ getModelInstance(M, prettyPrint=true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"comment\": \"A class\"
 // }"
 // endResult
diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceConnection1.mos b/testsuite/openmodelica/instance-API/GetModelInstanceConnection1.mos
@@ -31,14 +31,17 @@ getModelInstance(M, prettyPrint = true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"extends\": [
 //     {
 //       \"name\": \"A\",
+//       \"restriction\": \"model\",
 //       \"components\": [
 //         {
 //           \"name\": \"c1\",
 //           \"type\": {
 //             \"name\": \"C\",
+//             \"restriction\": \"connector\",
 //             \"components\": [
 //               {
 //                 \"name\": \"e\",
@@ -67,6 +70,7 @@ getModelInstance(M, prettyPrint = true);
 //           \"name\": \"c2\",
 //           \"type\": {
 //             \"name\": \"C\",
+//             \"restriction\": \"connector\",
 //             \"components\": [
 //               {
 //                 \"name\": \"e\",
@@ -99,6 +103,7 @@ getModelInstance(M, prettyPrint = true);
 //       \"name\": \"c3\",
 //       \"type\": {
 //         \"name\": \"C\",
+//         \"restriction\": \"connector\",
 //         \"components\": [
 //           {
 //             \"name\": \"e\",

diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceDuplicate1.mos b/testsuite/openmodelica/instance-API/GetModelInstanceDuplicate1.mos
@@ -22,9 +22,11 @@ getModelInstance(B, prettyPrint = true);
 // true
 // "{
 //   \"name\": \"B\",
+//   \"restriction\": \"model\",
 //   \"extends\": [
 //     {
 //       \"name\": \"A\",
+//       \"restriction\": \"model\",
 //       \"components\": [
 //         {
 //           \"name\": \"x\",

diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceExp1.mos b/testsuite/openmodelica/instance-API/GetModelInstanceExp1.mos
@@ -23,6 +23,7 @@ getModelInstance(M, prettyPrint = true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"components\": [
 //     {
 //       \"name\": \"x\",
@@ -39,6 +40,7 @@ getModelInstance(M, prettyPrint = true);
 //       \"name\": \"a\",
 //       \"type\": {
 //         \"name\": \"A\",
+//         \"restriction\": \"model\",
 //         \"components\": [
 //           {
 //             \"name\": \"x\",

diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceExtends1.mos b/testsuite/openmodelica/instance-API/GetModelInstanceExtends1.mos
@@ -23,9 +23,11 @@ getModelInstance(M, prettyPrint=true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"extends\": [
 //     {
 //       \"name\": \"A\",
+//       \"restriction\": \"model\",
 //       \"components\": [
 //         {
 //           \"name\": \"x\",

diff --git a/testsuite/openmodelica/instance-API/GetModelInstanceReplaceable1.mos b/testsuite/openmodelica/instance-API/GetModelInstanceReplaceable1.mos
@@ -23,6 +23,7 @@ getModelInstance(M, prettyPrint = true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"components\": [
 //     {
 //       \"name\": \"x\",
@@ -39,6 +40,7 @@ getModelInstance(M, prettyPrint = true);
 //       \"name\": \"m\",
 //       \"type\": {
 //         \"name\": \"M\",
+//         \"restriction\": \"model\",
 //         \"components\": [
 //           {
 //             \"name\": \"x\",

diff --git a/testsuite/openmodelica/instance-API/test.mos b/testsuite/openmodelica/instance-API/test.mos
@@ -17,6 +17,7 @@ getModelInstance(M, prettyPrint=true);
 // true
 // "{
 //   \"name\": \"M\",
+//   \"restriction\": \"model\",
 //   \"annotation\": {
 //     \"kind\": \"call\",
 //     \"name\": \"fn\",