Exit State Icon Properties

An Exit State icon is used within a State Diagram macro to represent a special State icon that exits this macro and returns program control to the macro that originally called this macro.

A State Diagram can include zero, one or several Exit State icons.

Details

→

Like a normal State icon, an Exit State icon has a display name (i.e. the text displayed on the state within the diagram) and an optional function. In addition, an Exit State may pass back a specific return value (if this State Diagram specifies a return type).

Display Name

The name of the icon that appears in the Exit State icon in the State Diagram.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

Function

The function is code that is executed when the program flow enters this Exit State icon.

This can be to call a macro, perform a calculation, delay program execution or execute some custom code.

States will perform their optional function when program flow enters that state through a transition from another state.

The function can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

Edit...

Click the "Edit..." button to change the details of the selected function. This button will be hidden if the function is set to "Do nothing" and will be labelled "Choose macro..." if the "Call Macro" function is chosen.

This will open another property window that is specific to the selected function. More details are here:

Call macro

Calculation

Delay

Code

Set return value

State Diagrams that specify a return type will enable this tick-box, which allows the Exit State to set the return value when it is executed and passed program control to the calling macro.

When ticked, this box will allow a value or variable to be specified in the "Return Value" box.

If left unticked, the return value will be the value of the local "Return" variable (assuming this macro specifies a return) in the same way that a normal macro can set its return value.

Return Value

The return value passed to the calling macro can be set here. This can be a literal value, an expression, or a variable of a compatible type to this macro's return type.

Clicking the down arrow to the right of the box will allow a global or local variable to be chosen from those available.

Example of a State Diagram