summaryrefslogtreecommitdiff
path: root/libs/msm/doc/HTML/pt01.html
blob: bad3ad9ce7001857c8d44477c27618fc293d1cbc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<html><head>
      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   <title>Part&nbsp;I.&nbsp;User' guide</title><link rel="stylesheet" href="boostbook.css" type="text/css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.75.2"><link rel="home" href="index.html" title="Meta State Machine (MSM)"><link rel="up" href="index.html" title="Meta State Machine (MSM)"><link rel="prev" href="pr01.html" title="Preface"><link rel="next" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Founding idea"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Part&nbsp;I.&nbsp;User' guide</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="pr01.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr></div><div class="part" title="Part&nbsp;I.&nbsp;User' guide"><div class="titlepage"><div><div><h1 class="title"><a name="d0e96"></a>Part&nbsp;I.&nbsp;User' guide</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="ch01.html">1. Founding idea</a></span></dt><dt><span class="chapter"><a href="ch02.html">2. UML Short Guide</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch02.html#d0e111">What are state machines?</a></span></dt><dt><span class="sect1"><a href="ch02s02.html">Concepts</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch02s02.html#d0e121">State machine, state, transition, event </a></span></dt><dt><span class="sect2"><a href="ch02s02.html#d0e151">Submachines, orthogonal regions, pseudostates </a></span></dt><dt><span class="sect2"><a href="ch02s02.html#d0e194">
                        History </a></span></dt><dt><span class="sect2"><a href="ch02s02.html#d0e208">Completion transitions / anonymous
                        transitions</a></span></dt><dt><span class="sect2"><a href="ch02s02.html#d0e220"> Internal transitions </a></span></dt><dt><span class="sect2"><a href="ch02s02.html#d0e226">
                        Conflicting transitions </a></span></dt></dl></dd><dt><span class="sect1"><a href="ch02s03.html">State machine glossary</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. Tutorial</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch03.html#d0e315">Design</a></span></dt><dt><span class="sect1"><a href="ch03s02.html">Basic front-end</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch03s02.html#d0e334">A simple example</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e348">Transition table</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e396">Defining states with entry/exit actions</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e409">What do you actually do inside actions / guards?</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e461">Defining a simple state machine</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e519">Defining a submachine</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e554">Orthogonal regions, terminate state, event deferring</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e645">History</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e690">Completion (anonymous) transitions</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e717">Internal transitions</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e819">more row types</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e852">Explicit entry / entry and exit pseudo-state / fork</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e1041">Flags</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e1095">Event Hierarchy</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e1116">Customizing a state machine / Getting more speed</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e1165">Choosing the initial event</a></span></dt><dt><span class="sect2"><a href="ch03s02.html#d0e1178"> Containing state machine (deprecated)</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch03s03.html">Functor front-end</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch03s03.html#d0e1217"> Transition table </a></span></dt><dt><span class="sect2"><a href="ch03s03.html#d0e1250">Defining states with entry/exit actions</a></span></dt><dt><span class="sect2"><a href="ch03s03.html#d0e1269">What do you actually do inside actions / guards (Part 2)?</a></span></dt><dt><span class="sect2"><a href="ch03s03.html#d0e1281">Defining a simple state machine</a></span></dt><dt><span class="sect2"><a href="ch03s03.html#d0e1289">Anonymous transitions</a></span></dt><dt><span class="sect2"><a href="ch03s03.html#d0e1315">Internal
                        transitions</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch03s04.html">eUML (experimental)</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch03s04.html#d0e1394">Transition table</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1435">A simple example: rewriting only our transition table</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1466">Defining events, actions and states with entry/exit actions</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1579">Wrapping up a simple state machine and first complete examples</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1627">Defining a submachine</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1643">
                        Attributes / Function call</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1743">Orthogonal regions, flags, event deferring</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1855">
                        Customizing a state machine / Getting
                        more speed</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1890">Completion / Anonymous transitions</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1908">Internal transitions</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e1939">Other state types</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e2003">Helper functions</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e2106">Phoenix-like STL support</a></span></dt><dt><span class="sect2"><a href="ch03s04.html#d0e2159">Writing actions with Boost.Phoenix (in development)</a></span></dt></dl></dd><dt><span class="sect1"><a href="ch03s05.html">Back-end</a></span></dt><dd><dl><dt><span class="sect2"><a href="ch03s05.html#d0e2218">Creation </a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2227">Starting and stopping a state
                        machine</a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2246">Event dispatching</a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2255">Active state(s)</a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2269">Serialization</a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2322">Base state type </a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2348">Visitor</a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2391">Flags</a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2404">Getting a state</a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2417"> State machine constructor with arguments </a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2457">Trading run-time speed for
                        better compile-time / multi-TU compilation</a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2539">Compile-time state machine analysis </a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2583"> Enqueueing events for later
                        processing </a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2603"> Customizing the message queues </a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2618">Policy definition with Boost.Parameter </a></span></dt><dt><span class="sect2"><a href="ch03s05.html#d0e2626">Choosing when to switch active
                        states </a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch04.html">4.  Performance / Compilers</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch04.html#d0e2707">Speed</a></span></dt><dt><span class="sect1"><a href="ch04s02.html">Executable size</a></span></dt><dt><span class="sect1"><a href="ch04s03.html">Supported compilers</a></span></dt><dt><span class="sect1"><a href="ch04s04.html"> Limitations </a></span></dt><dt><span class="sect1"><a href="ch04s05.html"> Compilers corner </a></span></dt></dl></dd><dt><span class="chapter"><a href="ch05.html">5. Questions &amp; Answers, tips</a></span></dt><dt><span class="chapter"><a href="ch06.html">6. Internals</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch06.html#d0e2920">Backend: Run To Completion</a></span></dt><dt><span class="sect1"><a href="ch06s02.html">Frontend / Backend
                    interface</a></span></dt><dt><span class="sect1"><a href="ch06s03.html"> Generated state ids </a></span></dt><dt><span class="sect1"><a href="ch06s04.html">Metaprogramming tools</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch07.html">7. Acknowledgements</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch07.html#d0e3215">MSM v2</a></span></dt><dt><span class="sect1"><a href="ch07s02.html"> MSM v1</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch08.html">8. Version history</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch08.html#d0e3262">From V2.21 to V2.22 (Boost 1.48)</a></span></dt><dt><span class="sect1"><a href="ch08s02.html">From V2.20 to V2.21 (Boost 1.47)</a></span></dt><dt><span class="sect1"><a href="ch08s03.html">From V2.12 to V2.20 (Boost 1.46)</a></span></dt><dt><span class="sect1"><a href="ch08s04.html">From V2.10 to V2.12  (Boost 1.45)</a></span></dt><dt><span class="sect1"><a href="ch08s05.html">From V2.0 to V2.12  (Boost 1.44)</a></span></dt></dl></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="pr01.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Preface&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;1.&nbsp;Founding idea</td></tr></table></div></body></html>