Difference between revisions of "Transition Icon Properties"
(Created page with "Coming soon") |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[File:IconTransitionStraight.png|border|link=Transition_Icon_Properties]] [[File:IconTransitionCurved.png|border|link=Transition_Icon_Properties]] | |
| + | |||
| + | A Transition icon is used within a [[State_diagrams|State Diagram macro]] to represent a transition from one States icon to another. Each Transition icon has a condition that determines the logical flow of the user's program and optional functionality that is executed when the Transition has been activated. | ||
| + | |||
| + | |||
| + | ==Details== | ||
| + | {| style="margin:0px; text-align:center;" | ||
| + | |- | ||
| + | |[[File:IconTransitionStraight.png|border|link=Transition_Icon_Properties]] / [[File:IconTransitionCurved.png|border|link=Transition_Icon_Properties]] | ||
| + | |width="50px" |→ | ||
| + | |[[File:Properties_Transition.png]] | ||
| + | |} | ||
| + | |||
| + | Transitions are lines that connect two states in a state diagram. | ||
| + | |||
| + | These lines have an arrow at one end signifying the direction of program flow through the transition. | ||
| + | |||
| + | |||
| + | '''Display Name''' | ||
| + | |||
| + | The name of the icon that appears in the State icon in the State Diagram. | ||
| + | |||
| + | This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked. | ||
| + | |||
| + | |||
| + | '''Condition''' | ||
| + | |||
| + | Transitions have a condition which is an expression that evaluates to true (non-zero) or false (zero). | ||
| + | |||
| + | The condition is used during program execution to determine if the program flow should proceed along that transition. When the condition is true, the function of the Transition is executed and program control passes to the attached State icon. | ||
| + | |||
| + | |||
| + | Each transition leaving that state has its condition tested in turn to see which path the program flow should continue along. The order that these are checked is set in the State icon's property page. | ||
| + | |||
| + | |||
| + | The condition expression 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 (or remains in) that state icon. | ||
| + | |||
| + | This can be to call a macro, perform a calculation, delay program execution or execute some custom C code. | ||
| + | |||
| + | |||
| + | States will perform their optional function when program flow enters that state through a transition from another state. | ||
| + | |||
| + | |||
| + | This 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: | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |+ | ||
| + | |- | ||
| + | | [[Macro_Icon_Properties|Call macro]] | ||
| + | |- | ||
| + | | [[Calculation_Icon_Properties|Calculation]] | ||
| + | |- | ||
| + | | [[Delay_Icon_Properties|Delay]] | ||
| + | |- | ||
| + | | [[Code_Icon_Properties|Code]] | ||
| + | |} | ||
| + | |||
| + | |||
| + | ==Transition label== | ||
| + | Transitions have an optional label which can display the name of the transition, its condition, or its function. | ||
| + | |||
| + | The colour of a transition can be changed by right-clicking the transition and selecting "Set shape colour". | ||
| + | This sets the colour of its label. The colour of the transition line and arrow cannot be altered. | ||
| + | |||
| + | |||
| + | ==Entry State Transition== | ||
| + | The entry state icon includes a special transition leaving it which should point to the first state to be executed in the state diagram (after the entry state itself). | ||
| + | |||
| + | This transition is always connected to the enter state and cannot be deleted. | ||
| + | |||
| + | Also, it has no properties and so cannot have a label or code. | ||
| + | |||
| + | It is always executed as if its transition condition is true. | ||
| + | |||
| + | |||
| + | ==Simulation== | ||
| + | During program execution (simulation or ICD), the colour of the transition line changes to blue or orange when its condition is being evaluated – blue signifies the condition is false and the transition will be ignored, and orange signifies that the transition is true and the program flow with execute along this transition. | ||
| + | |||
| + | When the transition is executing, it changes to a thick orange line. | ||
| + | |||
| + | |||
| + | ==Example of a State Diagram== | ||
| + | |||
| + | [[File:State0.png|State Diagram Overview]] | ||
Latest revision as of 14:18, 12 June 2026
A Transition icon is used within a State Diagram macro to represent a transition from one States icon to another. Each Transition icon has a condition that determines the logical flow of the user's program and optional functionality that is executed when the Transition has been activated.
Contents
Details
| → |
|
Transitions are lines that connect two states in a state diagram.
These lines have an arrow at one end signifying the direction of program flow through the transition.
Display Name
The name of the icon that appears in the State icon in the State Diagram.
This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.
Condition
Transitions have a condition which is an expression that evaluates to true (non-zero) or false (zero).
The condition is used during program execution to determine if the program flow should proceed along that transition. When the condition is true, the function of the Transition is executed and program control passes to the attached State icon.
Each transition leaving that state has its condition tested in turn to see which path the program flow should continue along. The order that these are checked is set in the State icon's property page.
The condition expression 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 (or remains in) that state icon.
This can be to call a macro, perform a calculation, delay program execution or execute some custom C code.
States will perform their optional function when program flow enters that state through a transition from another state.
This 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 |
Transition label
Transitions have an optional label which can display the name of the transition, its condition, or its function.
The colour of a transition can be changed by right-clicking the transition and selecting "Set shape colour". This sets the colour of its label. The colour of the transition line and arrow cannot be altered.
Entry State Transition
The entry state icon includes a special transition leaving it which should point to the first state to be executed in the state diagram (after the entry state itself).
This transition is always connected to the enter state and cannot be deleted.
Also, it has no properties and so cannot have a label or code.
It is always executed as if its transition condition is true.
Simulation
During program execution (simulation or ICD), the colour of the transition line changes to blue or orange when its condition is being evaluated – blue signifies the condition is false and the transition will be ignored, and orange signifies that the transition is true and the program flow with execute along this transition.
When the transition is executing, it changes to a thick orange line.

