Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r51660 - sandbox/msm/libs/msm/doc
From: christophe.j.henry_at_[hidden]
Date: 2009-03-09 10:36:47

Author: chenry
Date: 2009-03-09 10:36:46 EDT (Mon, 09 Mar 2009)
New Revision: 51660
URL: http://svn.boost.org/trac/boost/changeset/51660

Log:
minor fixes
Text files modified:
sandbox/msm/libs/msm/doc/index.html | 82 ++++++++++++++++++++-------------------
1 files changed, 43 insertions(+), 39 deletions(-)

Modified: sandbox/msm/libs/msm/doc/index.html
==============================================================================
--- sandbox/msm/libs/msm/doc/index.html (original)
+++ sandbox/msm/libs/msm/doc/index.html 2009-03-09 10:36:46 EDT (Mon, 09 Mar 2009)
@@ -6,7 +6,7 @@
 <META NAME="GENERATOR" CONTENT="OpenOffice.org 3.0 (Win32)">
 <META NAME="CREATED" CONTENT="20080922;21044300">
 <META NAME="CHANGEDBY" CONTENT="Christophe Henry">
- <META NAME="CHANGED" CONTENT="20090309;12175000">
+ <META NAME="CHANGED" CONTENT="20090309;15363300">
 <META NAME="Info 1" CONTENT="">
 <META NAME="Info 2" CONTENT="">
 <META NAME="Info 3" CONTENT="">
@@ -18,6 +18,7 @@
 <META NAME="CHANGEDBY" CONTENT="Christophe Henry">
 <META NAME="CHANGEDBY" CONTENT="Christophe Henry">
 <META NAME="CHANGEDBY" CONTENT="Christophe Henry">
+ <META NAME="CHANGEDBY" CONTENT="Christophe Henry">
 <META NAME="CHANGEDBY" CONTENT="xtoff">
 <META NAME="CHANGEDBY" CONTENT="xtoff">
 <META NAME="CHANGEDBY" CONTENT="xtoff">
@@ -41,8 +42,8 @@
</HEAD>
<BODY LANG="en-US" DIR="LTR">

-The Boost.Msm (Meta
-State Machine) library v1.10
+The Msm (Meta State
+Machine) library v1.20
Christophe Henry,

henry UNDERSCORE christophe AT hotmail DOT com
@@ -146,6 +147,10 @@
 default_base_state. No breaking change if no SMPtr policy chosen.
 <LI>Renamed SMPtr/NoSMPtr to sm_ptr / no_sm_ptr. Old names
 deprecated by still supported.
+ <LI>Added possibility to manually deactivate queuing of messages
+ and exception handling for more speed.
+ <LI>Added automatic deactivation of terminate/interrupt state
+ checking and deferred events if not used.
</UL>
Changes from 1.0 to 1.10
<UL>
@@ -1381,11 +1386,10 @@
</UL>
 

-Boost.Msm (almost) fully supports these features. Almost because
-there is currently one limitation, that it is only possible to
-explicitly enter a sub- composite and not exit it “upwards”
-this way. To exit, Msm just supports the two previously described
-methods.
+Msm (almost) fully supports these features. Almost because there
+is currently one limitation, that it is only possible to explicitly
+enter a sub- composite and not exit it “upwards” this
+way. To exit, Msm just supports the two previously described methods.
Sounds a bit complicated? Let's explain using an example were all
of the previously named methods are used:
 
@@ -1944,8 +1948,9 @@
in embedded systems, you need more speed and are ready to give up
some features in exchange.</CODE>
<CODE>A
-</CODE><CODE>process_event</CODE><CODE>
-is doing 5 different jobs:</CODE>
+</CODE><CODE>process_event</CODE><CODE>
+</CODE><CODE>is
+doing 5 different jobs:</CODE>
<UL>
 <LI><CODE>checking
 for terminate/interrupt states</CODE>
@@ -1972,36 +1977,35 @@
if not used. For the other two, if you want them out, you need to
help by indicating in your implementation that you want them out.
This is done with two simple typedefs, for example:</CODE>
-<CODE> </CODE><CODE>
- </CODE><CODE>//
-Concrete FSM implementation </CODE>
-
- struct
-player
-: public
-state_machine<player>
- {
- //
-no need for exception handling or message queue
- typedef
-int
-no_exception_thrown;
- typedef
-int
-no_message_queue;
-<CODE>
-</CODE><CODE>...</CODE><CODE>//
-rest of implementation</CODE>
+<CODE>//
+Concrete FSM implementation </CODE>
+
+struct
+player :
+public
+state_machine<player>
+{
+//
+no need for exception handling or message queue
+typedef
+int
+no_exception_thrown;
+typedef
+int
+no_message_queue;
+<CODE>...</CODE><CODE>//
+rest of implementation</CODE>
 

-<CODE>What
+<CODE>What
is the gain? It will depend on your compiler and target system, so
please refer to the performance page
(where an example is also provided). If you use none of these
-nice-to-haves, a </CODE><CODE>process_event</CODE><CODE>
-can execute up to 4 times faster. On my Q6600, an average transition
+nice-to-haves, a </CODE><CODE>process_event</CODE><CODE>
+</CODE><CODE>can
+execute up to 4 times faster. On my Q6600, an average transition
execution lasts 45ns with a full state machine, 10ns in the minimal
-case.</CODE>
+case.</CODE>
 

<H1 CLASS="western"><A NAME="8.Customizing states|outline"></A><CODE>Customizing
@@ -2304,9 +2308,9 @@

Question: Why do I get a very long compile error when I
define more than 20 rows in the transition table?
-Answer: Boost.Msm uses Boost.MPL behind the hood and this
-is the default maximum size. Please define the following 2 macros
-before including headers:
+Answer: Msm uses Boost.MPL under the hood and this is the
+default maximum size. Please define the following 2 macros before
+including headers:
<DIV ID="limit-vector-size" DIR="LTR">
 
 
@@ -2328,7 +2332,7 @@
in this chart, explicit entries, described in a <A HREF="#The many ways to enter a composite state|outline">previous
tutorial.</A>
Please have a look at the <A HREF="HarelWithEntry.cpp">source code
-implementation with Boost.Msm</A>.
+implementation with Msm</A>.
The biggest advantage of using this method is that the code is
very simple and easy to understand.
 
@@ -2483,7 +2487,7 @@
states visited in the life of a concrete machine and be able to
perform some coverage analysis, like “fired 65% of all possible
events and visited 80% of the states defined in the state machine”.
-To achieve this, Boost.Msm provides a few useful tools:
+To achieve this, Msm provides a few useful tools:
<UL>
 <LI>generate_state_set<transition
 table>: returns a mpl::set of all the states defined in

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk