Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 1.69 KB

README.md

File metadata and controls

46 lines (37 loc) · 1.69 KB
Raw

MSFSM

Simple yet powerful C++ finite state machine library.

Requirements

  • State is represented by a pointer
  • Concise syntax understandable for average C++11 programmer
  • Entry/exit actions
  • Allows both per-FSM and per-state variables
  • Transitions and guards expressed as C++ code (if/else, function calls, ...)
  • FSM can react to custom events represented by arbitrary types
  • Events can contain an arbitrary payload that can be used in the handling code
  • No memory allocation during state changes (like in Boost Statechart)
  • No need to increase limits of other libraries (like BOOST_MPL_LIMIT_VECTOR_SIZE needed by Boost MSM)
  • No "advanced" template magic. Light template usage (understandable to me) is allowed :)
  • Allows multiple instances of the same state machine (as opposed to tinyfsm)
  • Compile-time enforcement of passing additional data when transitioning to selected states (e.g., error code must be specified when entering an error state).
  • Supports nested state machines

Installation

MSFSM is a header-only library. Just copy msfsm.hpp to your project and include it.

Documentation

Documentation Status

Documentation (not complete yet) is available via readthedocs.org. You can also look at several examples, which cover most of the provided functionality.