Simulation AST: add reference enum for Var schema.

Signed-off-by: Timothy Rule (VM/EMT3) <Timothy.Rule@de.bosch.com>
boschglobal · Jan 17, 2025 · 0052899 · 0052899
1 parent f4180a2
commit 0052899
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 2 deletions.
diff --git a/code/go/dse/ast/Simulation.go b/code/go/dse/ast/Simulation.go
@@ -5,6 +5,9 @@ import ()
 const (
 	SimulationKindSimulation SimulationKind = "Simulation"
 )
+const (
+	VarReferenceUses VarReference = "uses"
+)
 
 type Model struct {
 	Arch      *string        `yaml:"arch,omitempty"`
@@ -53,9 +56,11 @@ type Uses struct {
 	Version *string `yaml:"version,omitempty"`
 }
 type Var struct {
-	Name  string `yaml:"name"`
-	Value string `yaml:"value"`
+	Name      string        `yaml:"name"`
+	Reference *VarReference `yaml:"reference,omitempty"`
+	Value     string        `yaml:"value"`
 }
+type VarReference string
 type Workflow struct {
 	Name string  `yaml:"name"`
 	Uses *string `yaml:"uses,omitempty"`

diff --git a/doc/content/schemas/yaml/Simulation.md b/doc/content/schemas/yaml/Simulation.md
@@ -100,13 +100,15 @@ uses:
 vars:
   - name: string
     value: string
+    reference: uses
 stacks:
   - name: string
     arch: linux-amd64
     stacked: true
     env:
       - name: string
         value: string
+        reference: uses
     models:
       - name: string
         model: string
@@ -117,12 +119,14 @@ stacks:
         env:
           - name: string
             value: string
+            reference: uses
         workflows:
           - name: string
             uses: string
             vars:
               - name: string
                 value: string
+                reference: uses
 
 ```
 
@@ -238,6 +242,7 @@ Defines an external resource used by the simulation.
 ```yaml
 name: string
 value: string
+reference: uses
 
 ```
 
@@ -249,6 +254,13 @@ A variable definition.
 |---|---|---|---|
 |name|string|true|A variable name.|
 |value|string|true|A coresponding variable value.|
+|reference|string|false|This value is derived from the specified reference (e.g. a downloaded file) The resouce name is specified in the value.|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|reference|uses|
 
 <h2 id="tocS_Stack">Stack</h2>
 
@@ -264,6 +276,7 @@ stacked: true
 env:
   - name: string
     value: string
+    reference: uses
 models:
   - name: string
     model: string
@@ -274,12 +287,14 @@ models:
     env:
       - name: string
         value: string
+        reference: uses
     workflows:
       - name: string
         uses: string
         vars:
           - name: string
             value: string
+            reference: uses
 
 ```
 
@@ -312,12 +327,14 @@ channels:
 env:
   - name: string
     value: string
+    reference: uses
 workflows:
   - name: string
     uses: string
     vars:
       - name: string
         value: string
+        reference: uses
 
 ```
 
@@ -345,6 +362,7 @@ uses: string
 vars:
   - name: string
     value: string
+    reference: uses
 
 ```
 

diff --git a/schemas/yaml/Simulation.yaml b/schemas/yaml/Simulation.yaml
@@ -182,6 +182,11 @@ components:
         value:
           type: string
           description: A coresponding variable value.
+        reference:
+          type: string
+          description: This value is derived from the specified reference (e.g. a downloaded file) The resouce name is specified in the value.
+          enum:
+            - uses
     Stack:
       type: object
       description: A stack definition which composes one or more models as a logical unit of the simulation.