State Schema

EMRALD_Model#/definitions/State

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*

State Type

object (State)

State 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
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:

"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