Event Schema

EMRALD_Model#/definitions/Event

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

Event Type

object (Event)

Event Properties

Property	Type	Required	Nullable	Defined by
id	string	Optional	cannot be null	EMRALD_Model
objType	Not specified	Required	cannot be null	EMRALD_Model
name	string	Required	cannot be null	EMRALD_Model
desc	string	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:

"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

• Untitled string in EMRALD_Model

• Untitled number in EMRALD_Model

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