Variable Schema

EMRALD_Model#/definitions/Variable

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	EMRALD_JsonSchemaV3_4.json*

Variable Type

object (Variable)

Variable Properties

Property	Type	Required	Nullable	Defined by
id	string	Optional	cannot be null	EMRALD_Model
objType	Not specified	Required	cannot be null	EMRALD_Model
name	string	Required	cannot be null	EMRALD_Model
desc	string	Optional	cannot be null	EMRALD_Model
varScope	string	Required	cannot be null	EMRALD_Model
value	Merged	Required	cannot be null	EMRALD_Model
docLink	string	Optional	cannot be null	EMRALD_Model
docType	string	Optional	cannot be null	EMRALD_Model
docPath	string	Optional	cannot be null	EMRALD_Model
pathMustExist	boolean	Optional	cannot be null	EMRALD_Model
type	string	Required	cannot be null	EMRALD_Model
accrualStatesData	array	Optional	cannot be null	EMRALD_Model
regExpLine	integer	Optional	cannot be null	EMRALD_Model
begPosition	integer	Optional	cannot be null	EMRALD_Model
numChars	integer	Optional	cannot be null	EMRALD_Model
regExpGroup	integer	Optional	cannot be null	EMRALD_Model
resetOnRuns	boolean	Optional	cannot be null	EMRALD_Model
resourceName	string	Optional	cannot be null	EMRALD_Model
sim3DId	string	Optional	cannot be null	EMRALD_Model
extSim	string	Optional	cannot be null	EMRALD_Model
WatchEventCriteria	string	Optional	cannot be null	EMRALD_Model
changeLog	array	Optional	cannot be null	EMRALD_Model
cumulativeStats	boolean	Optional	cannot be null	EMRALD_Model
monitorInSim	boolean	Optional	cannot be null	EMRALD_Model
canMonitor	boolean	Optional	cannot be null	EMRALD_Model
inVariable	boolean	Optional	cannot be null	EMRALD_Model
outVariable	boolean	Optional	cannot be null	EMRALD_Model
required	boolean	Optional	cannot be null	EMRALD_Model

id

Optional, internal use only.

id

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

id Type

string

objType

objType

• is required

• Type: unknown

• cannot be null

• defined in: EMRALD_Model

objType Type

unknown

objType Constraints

constant: the value of this property must be equal to:

"Variable"

name

referenace name in the model for the variable

name

• is required

• Type: string

• cannot be null

• defined in: EMRALD_Model

name Type

string

desc

User entered description of the variable

desc

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

desc Type

string

varScope

Context of use for the variable in the model.

varScope

• is required

• Type: string

• cannot be null

• defined in: EMRALD_Model

varScope Type

string

varScope Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"gtDocLink"
"gtAccrual"
"gtGlobal"
"gt3DSim"

value

The default value for the variable.

value

• is required

• Type: merged type (Details)

• cannot be null

• defined in: EMRALD_Model

value Type

merged type (Details)

any of

• Untitled number in EMRALD_Model

• Untitled string in EMRALD_Model

• Untitled boolean in EMRALD_Model

docLink

If the varScope is gtDocLink then this is the expression defining path in the document to the variable is linked to. XPath for XML, JSONPath for JSON, or a RegularExpression for txt

docLink

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

docLink Type

string

docType

If the varScope is gtDocLink then this the type of document the variable can be linked to. XML, JSON or PlainText using a regular expression

docType

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

docType Type

string

docType Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"dtXML"
"dtJSON"
"dtTextRegEx"

docPath

If the varScope is gtDocLink then this is the path to the document the variable is linked to.

docPath

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

docPath Type

string

pathMustExist

Flag, if true then the file in the docPath must exist when the simulation starts running. This is helpful to minimize errors.

pathMustExist

• is optional

• Type: boolean

• cannot be null

• defined in: EMRALD_Model

pathMustExist Type

boolean

type

This is the type of the variable, Bool, double, int, string

type

• is required

• Type: string

• cannot be null

• defined in: EMRALD_Model

type Type

string

type Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"bool"
"double"
"int"
"string"

accrualStatesData

Optional. If the variable varScope is gtAccrual, then these are the states used for calculating the variables value over time.

accrualStatesData

• is optional

• Type: object[] (accrualStatesDataItems)

• cannot be null

• defined in: EMRALD_Model

accrualStatesData Type

object[] (accrualStatesDataItems)

regExpLine

Optional. For variable varScope of gtDocLink, docType dtTxtRegExp, this is the regular expression string.

regExpLine

• is optional

• Type: integer

• cannot be null

• defined in: EMRALD_Model

regExpLine Type

integer

begPosition

Optional. For variable varScope of gtDocLink, docType dtTxtRegExp, this the start possition after the regular expression finds its match for reading or writing the value of the variable.

begPosition

• is optional

• Type: integer

• cannot be null

• defined in: EMRALD_Model

begPosition Type

integer

numChars

Optional. For variable varScope of gtDocLink, docType dtTxtRegExp, this how many characters to read for the value of the variable

numChars

• is optional

• Type: integer

• cannot be null

• defined in: EMRALD_Model

numChars Type

integer

regExpGroup

Optional. For variable varScope of gtDocLink, docType dtTxtRegExp, if this is defined, the value will be read from the given group within the user's regex expression

regExpGroup

• is optional

• Type: integer

• cannot be null

• defined in: EMRALD_Model

regExpGroup Type

integer

resetOnRuns

Optional, this specifies if the value of the variable is to be reset to the default value on each run or retain the value from the last run.

resetOnRuns

• is optional

• Type: boolean

• cannot be null

• defined in: EMRALD_Model

resetOnRuns Type

boolean

resourceName

Optional. If the variable varScope is gt3DSim, this is the name reference to the external simulation to link to for the value.

resourceName

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

resourceName Type

string

sim3DId

Optional. For variables of varScope gt3DSim, this is the external simulations name of the variable. It is used in sending a message to the external simulation.

sim3DId

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

sim3DId Type

string

extSim

Optional. For variables of varScope gt3DSim, this is the external simulation the variable is linked to.

extSim

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

extSim Type

string

WatchEventCriteria

Optional. For variables of varScope gt3DSim, an fParser boolean expression (e.g. '(valve_12 > 5) & (valve_12 < 10)') the external simulation must satisfy before reporting this variable. Sent in the initial coupling message. When omitted the variable is reported on every change.

WatchEventCriteria

• is optional

• Type: string

• cannot be null

• defined in: EMRALD_Model

WatchEventCriteria Type

string

changeLog

Type of the diagram.

changeLog

• is optional

• Type: object[] (ChangeLogItems)

• cannot be null

• defined in: EMRALD_Model

changeLog Type

object[] (ChangeLogItems)

cumulativeStats

Flag to indicate the user want to do cumulative statistics in the results.

cumulativeStats

• is optional

• Type: boolean

• cannot be null

• defined in: EMRALD_Model

cumulativeStats Type

boolean

monitorInSim

Flag to have the monitor variable check box checked in the solver by default.

monitorInSim

• is optional

• Type: boolean

• cannot be null

• defined in: EMRALD_Model

monitorInSim Type

boolean

canMonitor

Flag to indicate if the variable can be monitored in the solver. This removes it from the solver UI if false. Must be true if monitorInSim is true.

canMonitor

• is optional

• Type: boolean

• cannot be null

• defined in: EMRALD_Model

canMonitor Type

boolean

inVariable

Optional. Flag marking this variable as a simulation input - its value is supplied into a run (for example set by a coupled/external application or used as a run parameter).

inVariable

• is optional

• Type: boolean

• cannot be null

• defined in: EMRALD_Model

inVariable Type

boolean

outVariable

Optional. Flag marking this variable as a simulation output - its value is produced during a run and exposed to results or a coupled/external application.

outVariable

• is optional

• Type: boolean

• cannot be null

• defined in: EMRALD_Model

outVariable Type

boolean

required

If this is a template then it indicates the item must exist in the current model before using the template.

required

• is optional

• Type: boolean

• cannot be null

• defined in: EMRALD_Model

required Type

boolean