# Software Generator

The software generator converts the HFSM model into executable C++
code. It also optionally provides a generated test main which allows
for spawning events and viewing the response of the HFSM in a
terminal.

The Software Generator also checks the HFSM for consistency.

## Runtime Code Design

* Events are generated as enum classes
* The HFSM is designed to be integrated with other code which will
  generate events, run the HFSM execution loop (handle events) and
  pass any data to the HFSM / retrieve any data from the HFSM
  required.

## Consistency Checks

- [x] Local transitions must have events
- [x] Internal transitions must have events
- [x] Initial states must have exactly one transition
- [x] Initial state transitions cannot have guards or events
- [x] No two sibling states can have the same name
- [x] States cannot have more than one initial state
- [x] States must have an initial sub state selected
- [x] States should not have any transitions without an Event unless
  they contain an End State
- [x] Any substate containing an End State must have an End Transition
  (no event) leaving the state
- [x] States cannot have more than one End Transition
- [x] End Transitions cannot have guard conditions
- [x] Choice pseudostate transitions (out of the choice) cannot have
      events
- [x] Cannot have multiple events with similar names
  (e.g. capitalization difference)
- [x] Choice pseudostates must have a default (unguarded) transition
- [x] No two transitions out of a state should have the same Event /
      Guard combination
- [x] All complete states containing children must have an initial
  state configured and properly wired up to transition to one of their
  children
- [x] All leaf states must have a valid non-zero timer period (note:
  timer periods for non-leaf states are unused)
- [x] No substates (e.g. any state other than the root) should have
  `Includes` set.