EMRALD_Model Schema

txt

EMRALD_Model

EMRALD model schema version 3.3

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Cannot be instantiated	Yes	Unknown status	Unknown identifiability	Forbidden	Allowed	none	EMRALD_JsonSchemaV3_4.json

EMRALD_Model Type

object (EMRALD_Model)

all of

Main_Model

EMRALD_Model Definitions

Definitions group Model

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/Model"}

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`	Optional	cannot be null	EMRALD_Model
desc	`string`	Optional	cannot be null	EMRALD_Model
emraldVersion	`number`	Required	cannot be null	EMRALD_Model
version	`number`	Required	cannot be null	EMRALD_Model
versionHistory	`array`	Required	cannot be null	EMRALD_Model
filename	`string`	Optional	cannot be null	EMRALD_Model
DiagramList	`array`	Required	cannot be null	EMRALD_Model
ExtSimList	`array`	Required	cannot be null	EMRALD_Model
StateList	`array`	Required	cannot be null	EMRALD_Model
ActionList	`array`	Required	cannot be null	EMRALD_Model
EventList	`array`	Required	cannot be null	EMRALD_Model
LogicNodeList	`array`	Required	cannot be null	EMRALD_Model
VariableList	`array`	Required	cannot be null	EMRALD_Model
templates	`array`	Optional	cannot be null	EMRALD_Model
multiThreadInfo	`object`	Optional	cannot be null	EMRALD_Model
changeLog	`array`	Optional	cannot be null	EMRALD_Model
group	`object`	Optional	cannot be null	EMRALD_Model

id

Temporary, only used internally for some identification or uniqueness needs

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:

json

"EMRALD_Model"

name

Name of the EMRALD model

name

is optional
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

desc

description of the EMRALD model

desc

is optional
Type: string
cannot be null
defined in: EMRALD_Model

desc Type

string

emraldVersion

Version of the EMRALD model schema

emraldVersion

is required
Type: number
cannot be null
defined in: EMRALD_Model

emraldVersion Type

number

version

Version of the users model

version

is required
Type: number
cannot be null
defined in: EMRALD_Model

version Type

number

versionHistory

The user's model version history and change descriptions

versionHistory

is required
Type: object[] (VersionHistory)
cannot be null
defined in: EMRALD_Model

versionHistory Type

object[] (VersionHistory)

filename

Name of the original file that was opened to help distinguish between different versions of the model.

filename

is optional
Type: string
cannot be null
defined in: EMRALD_Model

filename Type

string

DiagramList

All the diagrams for the model

DiagramList

is required
Type: object[] (Diagram)
cannot be null
defined in: EMRALD_Model

DiagramList Type

object[] (Diagram)

ExtSimList

All the external simulation links for the mdoel

ExtSimList

is required
Type: object[] (ExtSim)
cannot be null
defined in: EMRALD_Model

ExtSimList Type

object[] (ExtSim)

StateList

All of the states for the different diagrams of the model

StateList

is required
Type: object[] (State)
cannot be null
defined in: EMRALD_Model

StateList Type

object[] (State)

ActionList

All the actions that can be used in the model

ActionList

is required
Type: object[] (Action)
cannot be null
defined in: EMRALD_Model

ActionList Type

object[] (Action)

EventList

All the events that are used in the model.

EventList

is required
Type: object[] (Event)
cannot be null
defined in: EMRALD_Model

EventList Type

object[] (Event)

LogicNodeList

All the logic nodes to make the logic trees in the model

LogicNodeList

is required
Type: object[] (LogicNode)
cannot be null
defined in: EMRALD_Model

LogicNodeList Type

object[] (LogicNode)

VariableList

All the variables used in the model

VariableList

is required
Type: object[] (Variable)
cannot be null
defined in: EMRALD_Model

VariableList Type

object[] (Variable)

templates

Templates available to make new diagrams in the model. These are basically small models all on their own.

templates

is optional
Type: object[] (Main_Model)
cannot be null
defined in: EMRALD_Model

templates Type

object[] (Main_Model)

multiThreadInfo

multiThreadInfo

is optional
Type: object (Details)
cannot be null
defined in: EMRALD_Model

multiThreadInfo Type

object (Details)

changeLog

Type of the diagram.

changeLog

is optional
Type: object[] (ChangeLogItems)
cannot be null
defined in: EMRALD_Model

changeLog Type

object[] (ChangeLogItems)

group

What catagory grouping this item belongs to. Used to indicate a group for and EMRALD model template.

group

is optional
Type: object (Details)
cannot be null
defined in: EMRALD_Model

group Type

object (Details)

Definitions group MainModel

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MainModel"}

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`	Optional	cannot be null	EMRALD_Model
desc	`string`	Optional	cannot be null	EMRALD_Model
emraldVersion	`number`	Required	cannot be null	EMRALD_Model
version	`number`	Required	cannot be null	EMRALD_Model
versionHistory	`array`	Required	cannot be null	EMRALD_Model
filename	`string`	Optional	cannot be null	EMRALD_Model
DiagramList	`array`	Required	cannot be null	EMRALD_Model
ExtSimList	`array`	Required	cannot be null	EMRALD_Model
StateList	`array`	Required	cannot be null	EMRALD_Model
ActionList	`array`	Required	cannot be null	EMRALD_Model
EventList	`array`	Required	cannot be null	EMRALD_Model
LogicNodeList	`array`	Required	cannot be null	EMRALD_Model
VariableList	`array`	Required	cannot be null	EMRALD_Model
templates	`array`	Optional	cannot be null	EMRALD_Model
multiThreadInfo	`object`	Optional	cannot be null	EMRALD_Model
changeLog	`array`	Optional	cannot be null	EMRALD_Model
group	`object`	Optional	cannot be null	EMRALD_Model

id

Temporary, only used internally for some identification or uniqueness needs

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:

json

"EMRALD_Model"

name

Name of the EMRALD model

name

is optional
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

desc

description of the EMRALD model

desc

is optional
Type: string
cannot be null
defined in: EMRALD_Model

desc Type

string

emraldVersion

Version of the EMRALD model schema

emraldVersion

is required
Type: number
cannot be null
defined in: EMRALD_Model

emraldVersion Type

number

version

Version of the users model

version

is required
Type: number
cannot be null
defined in: EMRALD_Model

version Type

number

versionHistory

The user's model version history and change descriptions

versionHistory

is required
Type: object[] (VersionHistory)
cannot be null
defined in: EMRALD_Model

versionHistory Type

object[] (VersionHistory)

filename

Name of the original file that was opened to help distinguish between different versions of the model.

filename

is optional
Type: string
cannot be null
defined in: EMRALD_Model

filename Type

string

DiagramList

All the diagrams for the model

DiagramList

is required
Type: object[] (Diagram)
cannot be null
defined in: EMRALD_Model

DiagramList Type

object[] (Diagram)

ExtSimList

All the external simulation links for the mdoel

ExtSimList

is required
Type: object[] (ExtSim)
cannot be null
defined in: EMRALD_Model

ExtSimList Type

object[] (ExtSim)

StateList

All of the states for the different diagrams of the model

StateList

is required
Type: object[] (State)
cannot be null
defined in: EMRALD_Model

StateList Type

object[] (State)

ActionList

All the actions that can be used in the model

ActionList

is required
Type: object[] (Action)
cannot be null
defined in: EMRALD_Model

ActionList Type

object[] (Action)

EventList

All the events that are used in the model.

EventList

is required
Type: object[] (Event)
cannot be null
defined in: EMRALD_Model

EventList Type

object[] (Event)

LogicNodeList

All the logic nodes to make the logic trees in the model

LogicNodeList

is required
Type: object[] (LogicNode)
cannot be null
defined in: EMRALD_Model

LogicNodeList Type

object[] (LogicNode)

VariableList

All the variables used in the model

VariableList

is required
Type: object[] (Variable)
cannot be null
defined in: EMRALD_Model

VariableList Type

object[] (Variable)

templates

Templates available to make new diagrams in the model. These are basically small models all on their own.

templates

is optional
Type: object[] (Main_Model)
cannot be null
defined in: EMRALD_Model

templates Type

object[] (Main_Model)

multiThreadInfo

multiThreadInfo

is optional
Type: object (Details)
cannot be null
defined in: EMRALD_Model

multiThreadInfo Type

object (Details)

changeLog

Type of the diagram.

changeLog

is optional
Type: object[] (ChangeLogItems)
cannot be null
defined in: EMRALD_Model

changeLog Type

object[] (ChangeLogItems)

group

What catagory grouping this item belongs to. Used to indicate a group for and EMRALD model template.

group

is optional
Type: object (Details)
cannot be null
defined in: EMRALD_Model

group Type

object (Details)

Definitions group Diagram

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/Diagram"}

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`	Required	cannot be null	EMRALD_Model
diagramType	`string`	Required	cannot be null	EMRALD_Model
diagramTemplate	`string`	Optional	cannot be null	EMRALD_Model
diagramLabel	`string`	Required	cannot be null	EMRALD_Model
states	`array`	Required	cannot be null	EMRALD_Model
changeLog	`array`	Optional	cannot be null	EMRALD_Model
required	`boolean`	Optional	cannot be null	EMRALD_Model

id

Optional. Only used for internal processing needs.

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:

json

"Diagram"

name

Name of the diagram

name

is required
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

desc

description of the diagram

desc

is required
Type: string
cannot be null
defined in: EMRALD_Model

desc Type

string

diagramType

Type of the diagram. dtSingle - means you can only be in one state of the diagram at a time and states evaluate to a value. dtMulti - means you can be in multiple states at a time, but cant evaluate the diagram

diagramType

is required
Type: string
cannot be null
defined in: EMRALD_Model

diagramType Type

string

diagramType Constraints

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

Value	Explanation
`"dtSingle"`
`"dtMulti"`

diagramTemplate

name of template used to make this diagram

diagramTemplate

is optional
Type: string
cannot be null
defined in: EMRALD_Model

diagramTemplate Type

string

diagramLabel

Name of grouping in the UI for this diagram

diagramLabel

is required
Type: string
cannot be null
defined in: EMRALD_Model

diagramLabel Type

string

states

Names of the states used in this diagram

states

is required
Type: string[]
cannot be null
defined in: EMRALD_Model

states Type

string[]

changeLog

Type of the diagram.

changeLog

is optional
Type: object[] (ChangeLogItems)
cannot be null
defined in: EMRALD_Model

changeLog Type

object[] (ChangeLogItems)

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

Definitions group ExtSim

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/ExtSim"}

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
resourceName	`string`	Required	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:

json

"ExtSim"

name

referenace name in the model for the external simulation

name

is required
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

resourceName

name of resource type to connect to in MsgServer, not unique if more than one simulation of the same tool

resourceName

is required
Type: string
cannot be null
defined in: EMRALD_Model

resourceName Type

string

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

Definitions group State

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/State"}

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`	Required	cannot be null	EMRALD_Model
stateType	`string`	Required	cannot be null	EMRALD_Model
diagramName	`string`	Required	cannot be null	EMRALD_Model
immediateActions	`array`	Required	cannot be null	EMRALD_Model
events	`array`	Required	cannot be null	EMRALD_Model
eventActions	`array`	Required	cannot be null	EMRALD_Model
geometryInfo	`object`	Optional	cannot be null	EMRALD_Model
changeLog	`array`	Optional	cannot be null	EMRALD_Model
defaultSingleStateValue	`string`	Optional	cannot be null	EMRALD_Model
required	`boolean`	Optional	cannot be null	EMRALD_Model

id

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:

json

"State"

name

referenace name in the model for state

name

is required
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

desc

User entered description of the state

desc

is required
Type: string
cannot be null
defined in: EMRALD_Model

desc Type

string

stateType

Type of the state

stateType

is required
Type: string
cannot be null
defined in: EMRALD_Model

stateType Type

string

stateType Constraints

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

Value	Explanation
`"stStart"`
`"stKeyState"`
`"stStandard"`
`"stTerminal"`

diagramName

Diagram the state belongs to, A state can only be in one diagram.

diagramName

is required
Type: string
cannot be null
defined in: EMRALD_Model

diagramName Type

string

immediateActions

Array of name references for the immediate actions to be run when entering the state

immediateActions

is required
Type: string[]
cannot be null
defined in: EMRALD_Model

immediateActions Type

string[]

events

Array of name references to events. These event will be monitored for when in this state.

events

is required
Type: string[]
cannot be null
defined in: EMRALD_Model

events Type

string[]

eventActions

actions for the events in sibling "events" array. One to one relationship.

eventActions

is required
Type: object[] (EventActionItems)
cannot be null
defined in: EMRALD_Model

eventActions Type

object[] (EventActionItems)

geometryInfo

position for the GUI

geometryInfo

is optional
Type: object (GeometryInfo)
cannot be null
defined in: EMRALD_Model

geometryInfo Type

object (GeometryInfo)

changeLog

Type of the diagram.

changeLog

is optional
Type: object[] (ChangeLogItems)
cannot be null
defined in: EMRALD_Model

changeLog Type

object[] (ChangeLogItems)

defaultSingleStateValue

For single state diagrams. Boolean value for the diagram when evaluated in a logic tree. Ignore - removes that item from the logic calculation.

defaultSingleStateValue

is optional
Type: string
cannot be null
defined in: EMRALD_Model

defaultSingleStateValue Type

string

defaultSingleStateValue Constraints

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

Value	Explanation
`"True"`
`"False"`
`"Ignore"`

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

Definitions group Action

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/Action"}

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`	Required	cannot be null	EMRALD_Model
actType	`string`	Required	cannot be null	EMRALD_Model
mainItem	`boolean`	Required	cannot be null	EMRALD_Model
mutExcl	`boolean`	Optional	cannot be null	EMRALD_Model
newStates	`array`	Optional	cannot be null	EMRALD_Model
scriptCode	`string`	Optional	cannot be null	EMRALD_Model
variableName	`string`	Optional	cannot be null	EMRALD_Model
codeVariables	`array`	Optional	cannot be null	EMRALD_Model
useDistribution	`boolean`	Optional	cannot be null	EMRALD_Model
distType	`string`	Optional	cannot be null	EMRALD_Model
parameters	`array`	Optional	cannot be null	EMRALD_Model
sim3DMessage	`string`	Optional	cannot be null	EMRALD_Model
extSim	`string`	Optional	cannot be null	EMRALD_Model
sim3DVariable	`string`	Optional	cannot be null	EMRALD_Model
openSimVarParams	`boolean`	Optional	cannot be null	EMRALD_Model
sim3DModelRef	`string`	Optional	cannot be null	EMRALD_Model
sim3DConfigData	`string`	Optional	cannot be null	EMRALD_Model
simEndTime	`string`	Optional	cannot be null	EMRALD_Model
makeInputFileCode	`string`	Optional	cannot be null	EMRALD_Model
exePath	`string`	Optional	cannot be null	EMRALD_Model
ExeFromPreCode	`boolean`	Optional	cannot be null	EMRALD_Model
useProjPathExeWorkingDir	`boolean`	Optional	cannot be null	EMRALD_Model
processOutputFileCode	`string`	Optional	cannot be null	EMRALD_Model
formData	`object`	Optional	cannot be null	EMRALD_Model
template	`object`	Optional	cannot be null	EMRALD_Model
returnProcess	`string`	Optional	cannot be null	EMRALD_Model
changeLog	`array`	Optional	cannot be null	EMRALD_Model
raType	`string`	Optional	cannot be null	EMRALD_Model
updateVariables	`array`	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:

json

"Action"

name

referenace name in the model for the action

name

is required
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

desc

User entered description of the action

desc

is required
Type: string
cannot be null
defined in: EMRALD_Model

desc Type

string

actType

The type of action

actType

is required
Type: string
cannot be null
defined in: EMRALD_Model

actType Type

string

actType Constraints

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

Value	Explanation
`"atTransition"`
`"atCngVarVal"`
`"at3DSimMsg"`
`"atRunExtApp"`

mainItem

Is this a global item to show up in the global list, If false it showes up in local or all list.

mainItem

is required
Type: boolean
cannot be null
defined in: EMRALD_Model

mainItem Type

boolean

mutExcl

Optional. Only one action may be taken so the probability determines if this action is taken vs another in the EventAction list. If false then the probability is used to sample if this action occured and multiple or no actions could happen when the event is triggered.

mutExcl

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

mutExcl Type

boolean

newStates

Optional. If this is a transition action then these are the states that it could be transitioned to.

newStates

is optional
Type: object[] (NewState)
cannot be null
defined in: EMRALD_Model

newStates Type

object[] (NewState)

scriptCode

Optionsl. Script code to be executed if the action type has a script

scriptCode

is optional
Type: string
cannot be null
defined in: EMRALD_Model

scriptCode Type

string

variableName

Optional. For change var value actions, the result of the script is assigned to this variable name reference.

variableName

is optional
Type: string
cannot be null
defined in: EMRALD_Model

variableName Type

string

codeVariables

Optional. If action has a script, these are the variable name references for variables used in the script. All variables used in script must be in this list.

codeVariables

is optional
Type: string[]
cannot be null
defined in: EMRALD_Model

codeVariables Type

string[]

useDistribution

Optional. For action type atCngVarVal. When true, the new value is sampled from the distribution defined by distType and parameters instead of running scriptCode. Defaults to false (use code) when unset.

useDistribution

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

useDistribution Type

boolean

distType

Optional. For event type of etDistribution this is the type of distribution the user selected.

distType

is optional
Type: string
cannot be null
defined in: EMRALD_Model

distType Type

string

distType Constraints

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

Value	Explanation
`"dtNormal"`
`"dtExponential"`
`"dtWeibull"`
`"dtLogNormal"`
`"dtTriangular"`
`"dtGamma"`
`"dtGompertz"`
`"dtUniform"`
`"dtBeta"`

parameters

Optional. For action type atCngVarVal when useDistribution is true, this is the array of distribution parameters. The shape is shared with etDistribution events for convenience, but the timeRate field on each parameter is ignored for atCngVarVal (variable values are unitless raw numbers, not durations).

parameters

is optional
Type: object[] (EventDistributionParameter)
cannot be null
defined in: EMRALD_Model

parameters Type

object[] (EventDistributionParameter)

sim3DMessage

Optional. For action type at3DSimMsg, this is the message to be sent to the coupled external simulation.

sim3DMessage

is optional
Type: string
cannot be null
defined in: EMRALD_Model

sim3DMessage Type

string

extSim

Optional. For action type at3DSimMsg, this is the name of the coupled external sim to send the message to.

extSim

is optional
Type: string
cannot be null
defined in: EMRALD_Model

extSim Type

string

sim3DVariable

Optional. For action type at3DSimMsg and a sim3DMessage of atCompModify, this is the name of the variable in the external simulation to be modified by the message.

sim3DVariable

is optional
Type: string
cannot be null
defined in: EMRALD_Model

sim3DVariable Type

string

openSimVarParams

Optional. For action type at3DSimMsg with a sim3DMessage of type atOpenSim, this flag indicates that the JSON has the properties for sim3DModelRef, sim3DConfigData, and simEndTime.

openSimVarParams

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

openSimVarParams Type

boolean

sim3DModelRef

Optional. For action type at3DSimMsg with a sim3DMessage of type atOpenSim, this is the data defined by the user that is used by the external simulation on startup. Typically a path to a model it need to open.

sim3DModelRef

is optional
Type: string
cannot be null
defined in: EMRALD_Model

sim3DModelRef Type

string

sim3DConfigData

Optional. For action type at3DSimMsg with a sim3DMessage of type atOpenSim, this is the data defined by the user that is used by the external simulation on startup.

sim3DConfigData

is optional
Type: string
cannot be null
defined in: EMRALD_Model

sim3DConfigData Type

string

simEndTime

Optional. For action type at3DSimMsg with a sim3DMessage of type atOpenSim, this is the end simulation time defined by the user that is used by the external simulation on startup.

simEndTime

is optional
Type: string
cannot be null
defined in: EMRALD_Model

simEndTime Type

string

makeInputFileCode

Optional. For action type atRunExtApp. It is the C# script to be executed and the result strig passed as a parameter to the executable to be run.

makeInputFileCode

is optional
Type: string
cannot be null
defined in: EMRALD_Model

makeInputFileCode Type

string

exePath

Optional. For action type atRunExtApp. It is the path of the exe to be run. It can be relative to the location of the EMRALD model.

exePath

is optional
Type: string
cannot be null
defined in: EMRALD_Model

exePath Type

string

ExeFromPreCode

Optional. For action type atRunExtApp. When true, the preprocessor code return string determines the executable to run instead of exePath.

ExeFromPreCode

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

ExeFromPreCode Type

boolean

ExeFromPreCode Default Value

The default value is:

json

false

useProjPathExeWorkingDir

Optional. For action type atRunExtApp. When true, the executable working directory is the model project path instead of the executable directory.

useProjPathExeWorkingDir

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

useProjPathExeWorkingDir Type

boolean

useProjPathExeWorkingDir Default Value

The default value is:

json

false

processOutputFileCode

Optional. For action type atRunExtApp. It is the C# script to be executed after the accociated exe is ran. Typically it reads a result file and script typically returns a string list with +/-[StateName] to shift out or into a state because of the results..

processOutputFileCode

is optional
Type: string
cannot be null
defined in: EMRALD_Model

processOutputFileCode Type

string

formData

Form data used by the MAAP form

formData

is optional
Type: object (MAAPFormData)
cannot be null
defined in: EMRALD_Model

formData Type

object (MAAPFormData)

template

Optional. For action type atRunExtApp. It is used for custom app form.

template

is optional
Type: object (Details)
cannot be null
defined in: EMRALD_Model

template Type

object (Details)

returnProcess

Optional. For action type atRunExtApp. It is flag to indicate the type of return from the processOutputFileCode. If rtNone then it has no return, othrwise the C# script must return a List of strings with +/-[StateName] to shift out or into a state.

returnProcess

is optional
Type: string
cannot be null
defined in: EMRALD_Model

returnProcess Type

string

changeLog

Type of the diagram.

changeLog

is optional
Type: object[] (ChangeLogItems)
cannot be null
defined in: EMRALD_Model

changeLog Type

object[] (ChangeLogItems)

raType

String for the run application action, only for UI used. Options depend on the custom UI forms made. "code" means default user defined pre and post execution code is used.

raType

is optional
Type: string
cannot be null
defined in: EMRALD_Model

raType Type

string

updateVariables

Used for custom form, variables used in the form.

updateVariables

is optional
Type: array
cannot be null
defined in: EMRALD_Model

updateVariables Type

array

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

Definitions group Event

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/Event"}

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`	Required	cannot be null	EMRALD_Model
mainItem	`boolean`	Required	cannot be null	EMRALD_Model
evType	`string`	Required	cannot be null	EMRALD_Model
allItems	`boolean`	Optional	cannot be null	EMRALD_Model
triggerStates	`array`	Optional	cannot be null	EMRALD_Model
varNames	`array`	Optional	cannot be null	EMRALD_Model
ifInState	`boolean`	Optional	cannot be null	EMRALD_Model
evalEvOnStateEntry	`boolean`	Optional	cannot be null	EMRALD_Model
onSuccess	`boolean`	Optional	cannot be null	EMRALD_Model
triggerOnFalse	`boolean`	Optional	cannot be null	EMRALD_Model
logicTop	`string`	Optional	cannot be null	EMRALD_Model
lambda	Merged	Optional	cannot be null	EMRALD_Model
lambdaTimeRate	`string`	Optional	cannot be null	EMRALD_Model
useVariable	`boolean`	Optional	cannot be null	EMRALD_Model
onVarChange	`string`	Optional	cannot be null	EMRALD_Model
time	`string`	Optional	cannot be null	EMRALD_Model
timeVariableUnit	`string`	Optional	cannot be null	EMRALD_Model
fromSimStart	`boolean`	Optional	cannot be null	EMRALD_Model
extEventType	`string`	Optional	cannot be null	EMRALD_Model
variable	`string`	Optional	cannot be null	EMRALD_Model
code	`string`	Optional	cannot be null	EMRALD_Model
distType	`string`	Optional	cannot be null	EMRALD_Model
parameters	`array`	Optional	cannot be null	EMRALD_Model
persistent	`boolean`	Optional	cannot be null	EMRALD_Model
dfltTimeRate	`string`	Optional	cannot be null	EMRALD_Model
changeLog	`array`	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:

json

"Event"

name

referenace name in the event in the model.

name

is required
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

desc

User entered description of the event.

desc

is required
Type: string
cannot be null
defined in: EMRALD_Model

desc Type

string

mainItem

Is this a global item to show up in the global list, If false it showes up in local or all list.

mainItem

is required
Type: boolean
cannot be null
defined in: EMRALD_Model

mainItem Type

boolean

evType

Type of the event

evType

is required
Type: string
cannot be null
defined in: EMRALD_Model

evType Type

string

evType Constraints

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

Value	Explanation
`"etStateCng"`
`"etComponentLogic"`
`"etFailRate"`
`"etTimer"`
`"et3dSimEv"`
`"etDistribution"`
`"etVarCond"`

allItems

Optional. For event type etStateCng. Flag to indicate if all the items in the triggerStates need to occure as specified or just one of them.

allItems

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

allItems Type

boolean

triggerStates

Optional. For event type etStateCng. List of state name references as part of the criteria needed to trigger the event. These are the states that need to be entered or exited to tirgger the event.

triggerStates

is optional
Type: string[]
cannot be null
defined in: EMRALD_Model

triggerStates Type

string[]

varNames

Optional, Name references for all variables used in scripts if the event type uses scripts.

varNames

is optional
Type: string[]
cannot be null
defined in: EMRALD_Model

varNames Type

string[]

ifInState

Optional. For event type etStateCng, flag to indicate that event is triggired when entering or exiting states listed in triggerStates array. On Enter State/s or On Exit State/s

ifInState

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

ifInState Type

boolean

evalEvOnStateEntry

Optional. For event type etStateCng, flag to indicate that the event should be evaluated when entering the state so that it is triggered without something changing. Enter State/s or On Exit State/s becomes Enter State/s or already in and On Exit State/s or not in

evalEvOnStateEntry

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

evalEvOnStateEntry Type

boolean

onSuccess

Optional. For event type etStateCng, flag to indicate that event is triggering needs all the items or just one or rmore from the states listed in triggerStates array. checkbox - All Items

onSuccess

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

onSuccess Type

boolean

triggerOnFalse

Optional. For event type etComponentLogic, flag to indicate that event is triggered if logic tree evaluates to a False, otherwise it triggeres on true.

triggerOnFalse

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

triggerOnFalse Type

boolean

logicTop

Optional. For event type etComponentLogic, this is the logic tree name to be evaluated for triggering the event.

logicTop

is optional
Type: string
cannot be null
defined in: EMRALD_Model

logicTop Type

string

lambda

Optional. Parameter for a event with type of etFailRate. It is either a number or the name of a variable if useVariable is true

lambda

is optional
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

lambda Type

merged type (Details)

any of

lambdaTimeRate

Optional. arameter for a event with type of etFailRate. It is the lambda value time frequency.

lambdaTimeRate

is optional
Type: string
cannot be null
defined in: EMRALD_Model

lambdaTimeRate Type

string

useVariable

Optional. Indicates that variables can be used for the fields

useVariable

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

useVariable Type

boolean

onVarChange

Optional. When an event uses a variable and that variable changes, this tells the code how to update the event.

onVarChange

is optional
Type: string
cannot be null
defined in: EMRALD_Model

onVarChange Type

string

onVarChange Constraints

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

Value	Explanation
`"ocIgnore"`
`"ocResample"`
`"ocAdjust"`

time

Optional, For events of type etTimer. This is a time or variable that indicates the time for the event.

time

is optional
Type: string
cannot be null
defined in: EMRALD_Model

time Type

string

timeVariableUnit

Optional, For events of type etTimer. This is a time unit if a variable is used for the time. Example X min.

timeVariableUnit

is optional
Type: string
cannot be null
defined in: EMRALD_Model

timeVariableUnit Type

string

timeVariableUnit Constraints

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

Value	Explanation
`""`
`"trYears"`
`"trDays"`
`"trHours"`
`"trMinutes"`
`"trSeconds"`

fromSimStart

Optional, For time based events, is the time from the beginning of the simulation [true] or from when the state was entered.

fromSimStart

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

fromSimStart Type

boolean

extEventType

Optional. For events of type et3dSimEv. This the type of message being sent to the external simulation. See the external messeage JSON schema.

extEventType

is optional
Type: string
cannot be null
defined in: EMRALD_Model

extEventType Type

string

extEventType Constraints

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

Value	Explanation
`"etCompEv"`
`"etEndSim"`
`"etStatus"`

variable

Optional. For event type et3dSimEv and extEventType etCompEv. It is the reference name for the variable. If that variable is modified by the external code, then the script is executed to determine if the event is triggered.

variable

is optional
Type: string
cannot be null
defined in: EMRALD_Model

variable Type

string

code

Optional. For event type et3dSimEv and extEventType etCompEv. It is the reference name for the variable. If that variable is modified by the external code, then this code script is executed to determine if the event is triggered.

code

is optional
Type: string
cannot be null
defined in: EMRALD_Model

code Type

string

distType

Optional. For event type of etDistribution this is the type of distribution the user selected.

distType

is optional
Type: string
cannot be null
defined in: EMRALD_Model

distType Type

string

distType Constraints

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

Value	Explanation
`"dtNormal"`
`"dtExponential"`
`"dtWeibull"`
`"dtLogNormal"`
`"dtTriangular"`
`"dtGamma"`
`"dtGompertz"`
`"dtUniform"`
`"dtBeta"`

parameters

Optional. For event type of etDistribution this is an array of properties for the distribution calculation.

parameters

is optional
Type: object[] (EventDistributionParameter)
cannot be null
defined in: EMRALD_Model

parameters Type

object[] (EventDistributionParameter)

persistent

Optional. For event type of etFailRate, etDistribution, and etTimer. Sets the event value as being persistent, keeping the initial sampled time between state movements and only re-samples after it occurs.

persistent

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

persistent Type

boolean

dfltTimeRate

Optional, For events of type etTimer. This is a time unit if a variable is used for the time. Example X min.

dfltTimeRate

is optional
Type: string
cannot be null
defined in: EMRALD_Model

dfltTimeRate Type

string

dfltTimeRate Constraints

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

Value	Explanation
`""`
`"trYears"`
`"trDays"`
`"trHours"`
`"trMinutes"`
`"trSeconds"`

changeLog

Type of the diagram.

changeLog

is optional
Type: object[] (ChangeLogItems)
cannot be null
defined in: EMRALD_Model

changeLog Type

object[] (ChangeLogItems)

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

Definitions group LogicNode

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/LogicNode"}

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`	Required	cannot be null	EMRALD_Model
gateType	`string`	Required	cannot be null	EMRALD_Model
compChildren	`array`	Required	cannot be null	EMRALD_Model
gateChildren	`array`	Required	cannot be null	EMRALD_Model
isRoot	`boolean`	Required	cannot be null	EMRALD_Model
changeLog	`array`	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:

json

"LogicNode"

name

referenace name in the logic node

name

is required
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

desc

User entered description of the logic node

desc

is required
Type: string
cannot be null
defined in: EMRALD_Model

desc Type

string

gateType

Gate type for the logic node

gateType

is required
Type: string
cannot be null
defined in: EMRALD_Model

gateType Type

string

gateType Constraints

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

Value	Explanation
`"gtAnd"`
`"gtOr"`
`"gtNot"`

compChildren

Array of component diagram names and state values to use in evaluating if not using the default value.

compChildren

is required
Type: object[] (CompChildItems)
cannot be null
defined in: EMRALD_Model

compChildren Type

object[] (CompChildItems)

gateChildren

Array of logic node names that are children of this gate.

gateChildren

is required
Type: string[]
cannot be null
defined in: EMRALD_Model

gateChildren Type

string[]

isRoot

Flag indicating that this is to be displayed as a tree top in the UI and can be used in an evaluate logic tree event.

isRoot

is required
Type: boolean
cannot be null
defined in: EMRALD_Model

isRoot Type

boolean

changeLog

Type of the diagram.

changeLog

is optional
Type: object[] (ChangeLogItems)
cannot be null
defined in: EMRALD_Model

changeLog Type

object[] (ChangeLogItems)

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

Definitions group Variable

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/Variable"}

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:

json

"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

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

Definitions group NewState

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/NewState"}

Property	Type	Required	Nullable	Defined by
toState	`string`	Required	cannot be null	EMRALD_Model
prob	`number`	Required	cannot be null	EMRALD_Model
failDesc	`string`	Required	cannot be null	EMRALD_Model
varProb	`string`	Optional	can be null	EMRALD_Model

toState

reference name of the state to transtion to.

toState

is required
Type: string
cannot be null
defined in: EMRALD_Model

toState Type

string

prob

probability that this state will be transtioned to.

prob

is required
Type: number
cannot be null
defined in: EMRALD_Model

prob Type

number

failDesc

The description from the user for output if tthis transition takes place.

failDesc

is required
Type: string
cannot be null
defined in: EMRALD_Model

failDesc Type

string

varProb

Optional, if used then the a variable is used for the probability. This is the name of that variable

varProb

is optional
Type: string
can be null
defined in: EMRALD_Model

varProb Type

string

Definitions group ChangeLog

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/ChangeLog"}

Property	Type	Required	Nullable	Defined by

Definitions group GeometryInfo

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/GeometryInfo"}

Property	Type	Required	Nullable	Defined by
x	`number`	Optional	cannot be null	EMRALD_Model
y	`number`	Optional	cannot be null	EMRALD_Model
width	`number`	Optional	cannot be null	EMRALD_Model
height	`number`	Optional	cannot be null	EMRALD_Model

x

x

is optional
Type: number
cannot be null
defined in: EMRALD_Model

x Type

number

y

y

is optional
Type: number
cannot be null
defined in: EMRALD_Model

y Type

number

width

width

is optional
Type: number
cannot be null
defined in: EMRALD_Model

width Type

number

height

height

is optional
Type: number
cannot be null
defined in: EMRALD_Model

height Type

number

Definitions group CompChild

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/CompChild"}

Property	Type	Required	Nullable	Defined by

Definitions group Group

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/Group"}

Property	Type	Required	Nullable	Defined by
name	`string`	Required	cannot be null	EMRALD_Model
subgroup	`array`	Optional	cannot be null	EMRALD_Model

name

Name of the group

name

is required
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

subgroup

Sub group tree path

subgroup

is optional
Type: object[] (Details)
cannot be null
defined in: EMRALD_Model

subgroup Type

object[] (Details)

Definitions group MultiThreadInfo

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MultiThreadInfo"}

Property	Type	Required	Nullable	Defined by
ToCopyForRefs	`array`	Optional	cannot be null	EMRALD_Model
AssignedTime	`string`	Optional	cannot be null	EMRALD_Model

ToCopyForRefs

ToCopyForRefs

is optional
Type: object[] (Details)
cannot be null
defined in: EMRALD_Model

ToCopyForRefs Type

object[] (Details)

AssignedTime

ISO 8601 date time when the multi-thread copy references were assigned.

AssignedTime

is optional
Type: string
cannot be null
defined in: EMRALD_Model

AssignedTime Type

string

Definitions group ToCopyForRef

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/ToCopyForRef"}

Property	Type	Required	Nullable	Defined by
ItemName	`string`	Optional	cannot be null	EMRALD_Model
ItemType	`string`	Optional	cannot be null	EMRALD_Model
RefPath	`string`	Optional	cannot be null	EMRALD_Model
ToCopy	`array`	Optional	can be null	EMRALD_Model
RelPath	`string`	Optional	cannot be null	EMRALD_Model
AdjRelRoot	`string`	Optional	cannot be null	EMRALD_Model

ItemName

ItemName

is optional
Type: string
cannot be null
defined in: EMRALD_Model

ItemName Type

string

ItemType

ItemType

is optional
Type: string
cannot be null
defined in: EMRALD_Model

ItemType Type

string

ItemType Constraints

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

Value	Explanation
`"itVar"`
`"itComp"`
`"itState"`
`"itEvent"`
`"itAction"`
`"itTreeNode"`
`"itTimer"`
`"itDiagram"`
`"itExtSim"`

RefPath

RefPath

is optional
Type: string
cannot be null
defined in: EMRALD_Model

RefPath Type

string

ToCopy

ToCopy

is optional
Type: string[]
can be null
defined in: EMRALD_Model

ToCopy Type

string[]

RelPath

RelPath

is optional
Type: string
cannot be null
defined in: EMRALD_Model

RelPath Type

string

AdjRelRoot

AdjRelRoot

is optional
Type: string
cannot be null
defined in: EMRALD_Model

AdjRelRoot Type

string

Definitions group EnIDType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/EnIDType"}

Property	Type	Required	Nullable	Defined by

Definitions group DiagramType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/DiagramType"}

Property	Type	Required	Nullable	Defined by

Definitions group StateType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/StateType"}

Property	Type	Required	Nullable	Defined by

Definitions group ActionType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/ActionType"}

Property	Type	Required	Nullable	Defined by

Definitions group EventType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/EventType"}

Property	Type	Required	Nullable	Defined by

Definitions group EventDistributionParameter

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/EventDistributionParameter"}

Property	Type	Required	Nullable	Defined by
name	`string`	Optional	cannot be null	EMRALD_Model
value	Merged	Optional	cannot be null	EMRALD_Model
timeRate	`string`	Optional	cannot be null	EMRALD_Model
useVariable	`boolean`	Optional	cannot be null	EMRALD_Model
variable	`string`	Optional	cannot be null	EMRALD_Model

name

For event type of etDistribution this is the name of the distribution parameter.

name

is optional
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

name Constraints

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

Value	Explanation
`"Mean"`
`"Standard Deviation"`
`"Minimum"`
`"Maximum"`
`"Rate"`
`"Shape"`
`"Scale"`
`"Peak"`
`"Alpha"`
`"Beta"`

value

Optional. The value of the parameter if the useVariable flag is false. Can be a number or a string if in scientific notation.

value

is optional
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

value Type

merged type (Details)

any of

timeRate

Optional, For events of type etTimer. This is a time unit if a variable is used for the time. Example X min.

timeRate

is optional
Type: string
cannot be null
defined in: EMRALD_Model

timeRate Type

string

timeRate Constraints

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

Value	Explanation
`""`
`"trYears"`
`"trDays"`
`"trHours"`
`"trMinutes"`
`"trSeconds"`

useVariable

Flag to use the variable string vs the value item for the property

useVariable

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

useVariable Type

boolean

variable

Optional. The reference name of the variable to use as the value of the parameter if the useVariable flag is true.

variable

is optional
Type: string
cannot be null
defined in: EMRALD_Model

variable Type

string

Definitions group VarChangeOptions

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/VarChangeOptions"}

Property	Type	Required	Nullable	Defined by

Definitions group TimeVariableUnit

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/TimeVariableUnit"}

Property	Type	Required	Nullable	Defined by

Definitions group ExtEventMsgType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/ExtEventMsgType"}

Property	Type	Required	Nullable	Defined by

Definitions group DistributionType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/DistributionType"}

Property	Type	Required	Nullable	Defined by

Definitions group GateType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/GateType"}

Property	Type	Required	Nullable	Defined by

Definitions group VarScope

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/VarScope"}

Property	Type	Required	Nullable	Defined by

Definitions group DocVarType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/DocVarType"}

Property	Type	Required	Nullable	Defined by

Definitions group VariableType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/VariableType"}

Property	Type	Required	Nullable	Defined by

Definitions group AccrualVarTableType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/AccrualVarTableType"}

Property	Type	Required	Nullable	Defined by

Definitions group StateEvalValue

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/StateEvalValue"}

Property	Type	Required	Nullable	Defined by

Definitions group EventDistributionParameterName

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/EventDistributionParameterName"}

Property	Type	Required	Nullable	Defined by

Definitions group MainItemType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MainItemType"}

Property	Type	Required	Nullable	Defined by

Definitions group VersionHistory

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/VersionHistory"}

Property	Type	Required	Nullable	Defined by
description	`string`	Optional	cannot be null	EMRALD_Model
version	`number`	Optional	cannot be null	EMRALD_Model

description

A description of the changes made to the model in this version

description

is optional
Type: string
cannot be null
defined in: EMRALD_Model

description Type

string

version

The version number

version

is optional
Type: number
cannot be null
defined in: EMRALD_Model

version Type

number

Definitions group CustomFormType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/CustomFormType"}

Property	Type	Required	Nullable	Defined by

Definitions group MAAPFormData

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPFormData"}

Property	Type	Required	Nullable	Defined by
exePath	`string`	Optional	cannot be null	EMRALD_Model
sourceElements	`array`	Optional	cannot be null	EMRALD_Model
parameters	`array`	Optional	cannot be null	EMRALD_Model
initiators	`array`	Optional	cannot be null	EMRALD_Model
inputBlocks	`array`	Optional	cannot be null	EMRALD_Model
fileRefs	`array`	Optional	cannot be null	EMRALD_Model
inputPath	`string`	Optional	cannot be null	EMRALD_Model
parameterPath	`string`	Optional	cannot be null	EMRALD_Model
possibleInitiators	`array`	Optional	cannot be null	EMRALD_Model
docLinkVariable	`string`	Optional	cannot be null	EMRALD_Model
output	`string`	Optional	cannot be null	EMRALD_Model
caType	Not specified	Required	cannot be null	EMRALD_Model
needsUpgrade	`boolean`	Optional	cannot be null	EMRALD_Model

exePath

The path to the MAAP executable on the user's machine

exePath

is optional
Type: string
cannot be null
defined in: EMRALD_Model

exePath Type

string

sourceElements

The contents of original .inp file parsed into JSON

sourceElements

is optional
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

sourceElements Type

an array of merged types (Details)

parameters

Source elements from the .inp file identified as parameters

parameters

is optional
Type: object[] (Details)
cannot be null
defined in: EMRALD_Model

parameters Type

object[] (Details)

initiators

Source elements from the .inp file identified as initiators

initiators

is optional
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

initiators Type

an array of merged types (Details)

inputBlocks

Source elements from the .inp file identified as input blocks (if blocks, when block, etc.)

inputBlocks

is optional
Type: object[] (MAAPConditionalBlockStatement)
cannot be null
defined in: EMRALD_Model

inputBlocks Type

object[] (MAAPConditionalBlockStatement)

fileRefs

The paths to other files referenced by the .inp and .par files

fileRefs

is optional
Type: string[]
cannot be null
defined in: EMRALD_Model

fileRefs Type

string[]

inputPath

The full path to the .inp file on the user's machine

inputPath

is optional
Type: string
cannot be null
defined in: EMRALD_Model

inputPath Type

string

parameterPath

The full path to the .par file on the user's machine

parameterPath

is optional
Type: string
cannot be null
defined in: EMRALD_Model

parameterPath Type

string

possibleInitiators

A list of possible initiators extracted from the .par file

possibleInitiators

is optional
Type: object[] (MAAPParameter)
cannot be null
defined in: EMRALD_Model

possibleInitiators Type

object[] (MAAPParameter)

docLinkVariable

The doc link variable used to store the results

docLinkVariable

is optional
Type: string
cannot be null
defined in: EMRALD_Model

docLinkVariable Type

string

output

The MAAP output variable to store in the doc link variable

output

is optional
Type: string
cannot be null
defined in: EMRALD_Model

output Type

string

caType

caType

is required
Type: unknown (CustomFormType)
cannot be null
defined in: EMRALD_Model

caType Type

unknown (CustomFormType)

caType Constraints

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

Value	Explanation
`"MAAP"`

needsUpgrade

needsUpgrade

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

needsUpgrade Type

boolean

Definitions group MAAPParameter

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPParameter"}

Property	Type	Required	Nullable	Defined by
flag	`object`	Optional	cannot be null	EMRALD_Model
index	`number`	Optional	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	Merged	Required	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model
name	`string`	Optional	cannot be null	EMRALD_Model
useVariable	`boolean`	Optional	cannot be null	EMRALD_Model
unit	`string`	Optional	cannot be null	EMRALD_Model
variable	`string`	Optional	cannot be null	EMRALD_Model
desc	`string`	Optional	cannot be null	EMRALD_Model

flag

flag

is optional
Type: object (Details)
cannot be null
defined in: EMRALD_Model

flag Type

object (Details)

index

index

is optional
Type: number
cannot be null
defined in: EMRALD_Model

index Type

number

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"parameter"

value

value

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

value Type

merged type (Details)

any of

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

name

name

is optional
Type: string
cannot be null
defined in: EMRALD_Model

name Type

string

useVariable

useVariable

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

useVariable Type

boolean

unit

unit

is optional
Type: string
cannot be null
defined in: EMRALD_Model

unit Type

string

variable

variable

is optional
Type: string
cannot be null
defined in: EMRALD_Model

variable Type

string

desc

desc

is optional
Type: string
cannot be null
defined in: EMRALD_Model

desc Type

string

Definitions group MAAPConditionalBlockStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPConditionalBlockStatement"}

Property	Type	Required	Nullable	Defined by
blockType	`string`	Required	cannot be null	EMRALD_Model
test	Merged	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	`array`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

blockType

blockType

is required
Type: string
cannot be null
defined in: EMRALD_Model

blockType Type

string

blockType Constraints

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

Value	Explanation
`"IF"`
`"WHEN"`

test

test

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

test Type

merged type (Details)

any of

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"conditional_block"

value

value

is required
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

value Type

an array of merged types (Details)

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPExpression

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPExpression"}

Property	Type	Required	Nullable	Defined by

Definitions group MAAPIsExpression

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPIsExpression"}

Property	Type	Required	Nullable	Defined by
target	Merged	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	Merged	Required	cannot be null	EMRALD_Model
useVariable	`boolean`	Optional	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

target

target

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

target Type

merged type (Details)

all of

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"is_expression"

value

value

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

value Type

merged type (Details)

any of

useVariable

useVariable

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

useVariable Type

boolean

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPVariable

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPVariable"}

Property	Type	Required	Nullable	Defined by

Definitions group MAAPCallExpression

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPCallExpression"}

Property	Type	Required	Nullable	Defined by
arguments	`array`	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	`object`	Required	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

arguments

arguments

is required
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

arguments Type

an array of merged types (Details)

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"call_expression"

value

value

is required
Type: object (Details)
cannot be null
defined in: EMRALD_Model

value Type

object (Details)

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPIdentifier

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPIdentifier"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	`string`	Required	cannot be null	EMRALD_Model
useVariable	`boolean`	Optional	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"identifier"

value

value

is required
Type: string
cannot be null
defined in: EMRALD_Model

value Type

string

useVariable

useVariable

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

useVariable Type

boolean

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPExpressionType

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPExpressionType"}

Property	Type	Required	Nullable	Defined by

Definitions group MAAPExpressionBlock

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPExpressionBlock"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	Merged	Required	cannot be null	EMRALD_Model
units	`string`	Optional	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"expression_block"

value

value

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

value Type

merged type (Details)

any of

units

units

is optional
Type: string
cannot be null
defined in: EMRALD_Model

units Type

string

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPPureExpression

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPPureExpression"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
left	Merged	Required	cannot be null	EMRALD_Model
op	`string`	Required	cannot be null	EMRALD_Model
right	Merged	Required	cannot be null	EMRALD_Model
useVariable	`boolean`	Optional	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"expression"

left

left

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

left Type

merged type (Details)

all of

op

op

is required
Type: string
cannot be null
defined in: EMRALD_Model

op Type

string

op Constraints

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

Value	Explanation
`"**"`
`"*"`
`"/"`
`">="`
`"<="`
`">"`
`"<"`
`"+"`
`"-"`
`"!="`
`"=="`

right

right

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

right Type

merged type (Details)

any of

useVariable

useVariable

is optional
Type: boolean
cannot be null
defined in: EMRALD_Model

useVariable Type

boolean

Definitions group MAAPExpressionOperator

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPExpressionOperator"}

Property	Type	Required	Nullable	Defined by

Definitions group MAAPParameterName

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPParameterName"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	`string`	Required	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"parameter_name"

value

value

is required
Type: string
cannot be null
defined in: EMRALD_Model

value Type

string

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPLiteral

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPLiteral"}

Property	Type	Required	Nullable	Defined by

Definitions group MAAPBooleanLiteral

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPBooleanLiteral"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	`boolean`	Required	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"boolean"

value

value

is required
Type: boolean
cannot be null
defined in: EMRALD_Model

value Type

boolean

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPNumericLiteral

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPNumericLiteral"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
units	`string`	Optional	cannot be null	EMRALD_Model
value	`number`	Required	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"number"

units

units

is optional
Type: string
cannot be null
defined in: EMRALD_Model

units Type

string

value

value

is required
Type: number
cannot be null
defined in: EMRALD_Model

value Type

number

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPTimerLiteral

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPTimerLiteral"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	`number`	Required	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"timer"

value

value

is required
Type: number
cannot be null
defined in: EMRALD_Model

value Type

number

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPSourceElement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPSourceElement"}

Property	Type	Required	Nullable	Defined by

Definitions group MAAPSensitivityStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPSensitivityStatement"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	`string`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"sensitivity"

value

value

is required
Type: string
cannot be null
defined in: EMRALD_Model

value Type

string

value Constraints

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

Value	Explanation
`"ON"`
`"OFF"`

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPTitleStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPTitleStatement"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	`string`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"title"

value

value

is required
Type: string
cannot be null
defined in: EMRALD_Model

value Type

string

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPFileStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPFileStatement"}

Property	Type	Required	Nullable	Defined by
fileType	`string`	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	`string`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

fileType

fileType

is required
Type: string
cannot be null
defined in: EMRALD_Model

fileType Type

string

fileType Constraints

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

Value	Explanation
`"PARAMETER FILE"`
`"INCLUDE"`
`"DOSE PARAMETER FILE"`

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"file"

value

value

is required
Type: string
cannot be null
defined in: EMRALD_Model

value Type

string

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPBlockStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPBlockStatement"}

Property	Type	Required	Nullable	Defined by
blockType	`string`	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	`array`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

blockType

blockType

is required
Type: string
cannot be null
defined in: EMRALD_Model

blockType Type

string

blockType Constraints

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

Value	Explanation
`"PARAMETER CHANGE"`
`"INITIATORS"`

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"block"

value

value

is required
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

value Type

an array of merged types (Details)

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPCommentArray

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPCommentArray"}

Property	Type	Required	Nullable	Defined by

Definitions group MAAPAliasStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPAliasStatement"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	`array`	Required	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"alias"

value

value

is required
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

value Type

an array of merged types (Details)

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPAsExpression

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPAsExpression"}

Property	Type	Required	Nullable	Defined by
target	Merged	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	Merged	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

target

target

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

target Type

merged type (Details)

all of

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"as_expression"

value

value

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

value Type

merged type (Details)

all of

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPPlotFilBody

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPPlotFilBody"}

Property	Type	Required	Nullable	Defined by
row	`array`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

row

row

is required
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

row Type

an array of merged types (Details)

comments

comments

is required
Type: string[]
cannot be null
defined in: EMRALD_Model

comments Type

string[]

Definitions group MAAPPlotFilStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPPlotFilStatement"}

Property	Type	Required	Nullable	Defined by
n	`number`	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	`array`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

n

n

is required
Type: number
cannot be null
defined in: EMRALD_Model

n Type

number

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"plotfil"

value

value

is required
Type: object[] (Details)
cannot be null
defined in: EMRALD_Model

value Type

object[] (Details)

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPUserEvtStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPUserEvtStatement"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	`array`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"user_evt"

value

value

is required
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

value Type

an array of merged types (Details)

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPActionStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPActionStatement"}

Property	Type	Required	Nullable	Defined by
index	`number`	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	`array`	Required	cannot be null	EMRALD_Model
comments	`array`	Optional	cannot be null	EMRALD_Model

index

index

is required
Type: number
cannot be null
defined in: EMRALD_Model

index Type

number

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"action"

value

value

is required
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

value Type

an array of merged types (Details)

comments

comments

is optional
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPFunctionStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPFunctionStatement"}

Property	Type	Required	Nullable	Defined by
name	`object`	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	Merged	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

name

name

is required
Type: object (Details)
cannot be null
defined in: EMRALD_Model

name Type

object (Details)

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"function"

value

value

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

value Type

merged type (Details)

any of

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPTimerStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPTimerStatement"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
value	`object`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"set_timer"

value

value

is required
Type: object (Details)
cannot be null
defined in: EMRALD_Model

value Type

object (Details)

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPLookupStatement

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPLookupStatement"}

Property	Type	Required	Nullable	Defined by
name	Merged	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	`array`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

name

name

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

name Type

merged type (Details)

all of

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"lookup_variable"

value

value

is required
Type: string[]
cannot be null
defined in: EMRALD_Model

value Type

string[]

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPAssignment

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPAssignment"}

Property	Type	Required	Nullable	Defined by
target	Merged	Required	cannot be null	EMRALD_Model
type	Not specified	Required	cannot be null	EMRALD_Model
value	Merged	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

target

target

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

target Type

merged type (Details)

any of

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"assignment"

value

value

is required
Type: merged type (Details)
cannot be null
defined in: EMRALD_Model

value Type

merged type (Details)

all of

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

Definitions group MAAPMultiPartExpression

Reference this group by using

json

{"$ref":"EMRALD_Model#/definitions/MAAPMultiPartExpression"}

Property	Type	Required	Nullable	Defined by
type	Not specified	Required	cannot be null	EMRALD_Model
op	`string`	Required	cannot be null	EMRALD_Model
value	`array`	Required	cannot be null	EMRALD_Model
comments	`array`	Required	cannot be null	EMRALD_Model

type

type

is required
Type: unknown
cannot be null
defined in: EMRALD_Model

type Type

unknown

type Constraints

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

json

"multi_expression"

op

op

is required
Type: string
cannot be null
defined in: EMRALD_Model

op Type

string

value

value

is required
Type: an array of merged types (Details)
cannot be null
defined in: EMRALD_Model

value Type

an array of merged types (Details)

comments

comments

is required
Type: string[][]
cannot be null
defined in: EMRALD_Model

comments Type

string[][]

EMRALD_Model Schema ​

EMRALD_Model Type ​

EMRALD_Model Definitions ​

Definitions group Model ​

id ​

id Type ​

objType ​

objType Type ​

objType Constraints ​

name ​

name Type ​

desc ​

desc Type ​

emraldVersion ​

emraldVersion Type ​

version ​

version Type ​

versionHistory ​

versionHistory Type ​

filename ​

filename Type ​

DiagramList ​

DiagramList Type ​

ExtSimList ​

ExtSimList Type ​

StateList ​

StateList Type ​

ActionList ​

ActionList Type ​

EventList ​

EventList Type ​

LogicNodeList ​

LogicNodeList Type ​

VariableList ​

VariableList Type ​

templates ​

templates Type ​

multiThreadInfo ​

multiThreadInfo Type ​

changeLog ​

changeLog Type ​

group ​

group Type ​

Definitions group MainModel ​

id ​

id Type ​

objType ​

objType Type ​

objType Constraints ​

name ​

name Type ​

desc ​

desc Type ​

emraldVersion ​

emraldVersion Type ​

version ​

version Type ​

versionHistory ​

versionHistory Type ​

filename ​

filename Type ​

DiagramList ​

DiagramList Type ​

ExtSimList ​

ExtSimList Type ​

StateList ​

StateList Type ​

ActionList ​

ActionList Type ​

EventList ​

EventList Type ​

LogicNodeList ​

LogicNodeList Type ​

VariableList ​

VariableList Type ​

templates ​

templates Type ​

multiThreadInfo ​

multiThreadInfo Type ​

changeLog ​

EMRALD_Model Schema

EMRALD_Model Type

EMRALD_Model Definitions

Definitions group Model

id

id Type

objType

objType Type

objType Constraints

name

name Type

desc

desc Type

emraldVersion

emraldVersion Type

version

version Type

versionHistory

versionHistory Type

filename

filename Type

DiagramList

DiagramList Type

ExtSimList

ExtSimList Type

StateList

StateList Type

ActionList

ActionList Type

EventList

EventList Type

LogicNodeList

LogicNodeList Type

VariableList

VariableList Type

templates

templates Type

multiThreadInfo

multiThreadInfo Type

changeLog

changeLog Type

group

group Type

Definitions group MainModel

id

id Type

objType

objType Type

objType Constraints

name

name Type

desc

desc Type

emraldVersion

emraldVersion Type

version

version Type

versionHistory

versionHistory Type

filename

filename Type

DiagramList

DiagramList Type

ExtSimList

ExtSimList Type

StateList

StateList Type

ActionList

ActionList Type

EventList

EventList Type

LogicNodeList

LogicNodeList Type

VariableList

VariableList Type

templates

templates Type

multiThreadInfo

multiThreadInfo Type

changeLog