User Tools

Site Tools


code:commercial:hse-state-machine-parser:faq

03 FAQ

Naming

  • The state machine parser will look for special named cases in the following VIs:
    • every Main.vi
    • VIs with State Machine in the name of their owning DQMH Modules or other libraries
  • The label of the outer case structure must be
    • HSE_STATE_MACHINE
  • The label of the inner case structure, in which transitions are defined must be one of
    • HSE_SM_TRANSITION
    • HSE_SM_POLL
  • The label of the transition (enum constant) in the inner case structure must be
    • State
  • The name of the transition (value of the transition enumerator) for an exception must be
    • Exception (which must lead to the state Error - Waiting For Action)
  • The name of the state that exits the state machine must be
    • Exiting
  • All labels must be visible!

Default cases

The state machine parser will ignore all Default cases - if you want a transition on your diagram, you need to create a case for it

Notes

Notes can be added to transitions and states, by adding #HSE_SM_NOTE at the beginning of a comment or the subdiagram label.

In HSE_SM_SELECT and HSE_SM_POLL case structures, the text of the subdiagram label will be used as the name of the transition and therefore not be added as notes.

Multiple values per case frame

If more than one state is allowed per frame in the transitions case structure, place a nested case structure labeled HSE_SM_SELECT. The text of the subdiagram labels will be used to document the transition.


Example output

code/commercial/hse-state-machine-parser/faq.txt · Last modified: 2025/11/05 11:34 by joerg.hampel