|
|
Boost-Commit : |
From: ahd6974-boostorg_at_[hidden]
Date: 2008-01-06 08:49:32
Author: andreas_huber69
Date: 2008-01-06 08:49:31 EST (Sun, 06 Jan 2008)
New Revision: 42527
URL: http://svn.boost.org/trac/boost/changeset/42527
Log:
Various doc updates.
Binary files modified:
trunk/libs/statechart/doc/reference.pdf
Text files modified:
trunk/libs/statechart/doc/acknowledgments.html | 16
trunk/libs/statechart/doc/configuration.html | 27 -
trunk/libs/statechart/doc/faq.html | 7
trunk/libs/statechart/doc/future_and_history.html | 13
trunk/libs/statechart/doc/reference.html | 538 +++++++++++++++++++--------------------
5 files changed, 286 insertions(+), 315 deletions(-)
Modified: trunk/libs/statechart/doc/acknowledgments.html
==============================================================================
--- trunk/libs/statechart/doc/acknowledgments.html (original)
+++ trunk/libs/statechart/doc/acknowledgments.html 2008-01-06 08:49:31 EST (Sun, 06 Jan 2008)
@@ -88,21 +88,21 @@
Philippe David, Peter Dimov, Reece Dunn, John Fuller, Jeff Garland, Eugene
Gladyshev, David A. Greene, Douglas Gregor, Gustavo Guerra, Aleksey
Gurtovoy, Federico J. Fernández, Iain K. Hanson, David B. Held,
- Jürgen Hunold, Oliver Kowalke, Simon Meiklejohn, Jiang Miao, Johan
- Nilsson, Matthieu Paindavoine, Chris Paulse, Yuval Ronen, Chris Russell,
- Rob Stewart, Kwee Heong Tan, Marcin Tustin, Vincent N. Virgilio, Gang Wang,
- Steven Watanabe and Scott Woods.</p>
+ Jürgen Hunold, Sean Kelly, Oliver Kowalke, Simon Meiklejohn, Jiang
+ Miao, Johan Nilsson, Matthieu Paindavoine, Chris Paulse, Yuval Ronen, Chris
+ Russell, Rob Stewart, Kwee Heong Tan, Marcin Tustin, Vincent N. Virgilio,
+ Gang Wang, Steven Watanabe and Scott Woods.</p>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
- <p>Revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->03 December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38512" --></p>
+ <p>Revised 05 January, 2008</p>
+
+ <p><i>Copyright © 2003-2008 <a href="contact.html">Andreas Huber
+ Dönni</a></i></p>
- <p><i>Copyright © 2003-<!--webbot bot="Timestamp" s-type="EDITED" s-format="%Y" startspan -->2006<!--webbot bot="Timestamp" endspan i-checksum="770" -->
- Andreas Huber Dönni</i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file LICENSE_1_0.txt or
Modified: trunk/libs/statechart/doc/configuration.html
==============================================================================
--- trunk/libs/statechart/doc/configuration.html (original)
+++ trunk/libs/statechart/doc/configuration.html 2008-01-06 08:49:31 EST (Sun, 06 Jan 2008)
@@ -42,12 +42,6 @@
<dd><a href="#ApplicationDefinedMacros">Application Defined
Macros</a></dd>
-
- <dt><a href="#CompilerSpecificConfiguration">Compiler-specific
- configuration</a></dt>
-
- <dd><a href="#Intel70">Intel 7.0 (Win32, MS Visual Studio 6 std
- library)</a></dd>
</dl>
<h1><a id="GeneralConfiguration" name="GeneralConfiguration">General
@@ -158,29 +152,14 @@
technology such violations may or may not manifest themselves in link-time
errors.</p>
- <h1><a id="CompilerSpecificConfiguration" name=
- "CompilerSpecificConfiguration">Compiler-specific configuration</a></h1>
-
- <h2><a id="Intel70" name="Intel70">Intel 7.0 (Win32, MS Visual Studio 6 std
- library)</a></h2>
-
- <p>By default, this compiler has argument dependent lookup disabled. ADL
- must be enabled to compile the library without errors. To enable ADL,
- <code>/Qoption,c,--arg_dep_lookup</code> must be added to the compiler
- command line. See <a href=
- "../../../boost/config/compiler/intel.hpp"><boost/config/compiler/intel.hpp></a>
- for more information.</p>
- <hr>
-
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
- <p>Revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->03 December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38512" --></p>
+ <p>Revised 05 January, 2008</p>
- <p><i>Copyright © 2003-<!--webbot bot="Timestamp" s-type="EDITED" s-format="%Y" startspan -->2006<!--webbot bot="Timestamp" endspan i-checksum="770" -->
- Andreas Huber Dönni</i></p>
+ <p><i>Copyright © 2003-2008 <a href="contact.html">Andreas Huber
+ Dönni</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file LICENSE_1_0.txt or
Modified: trunk/libs/statechart/doc/faq.html
==============================================================================
--- trunk/libs/statechart/doc/faq.html (original)
+++ trunk/libs/statechart/doc/faq.html 2008-01-06 08:49:31 EST (Sun, 06 Jan 2008)
@@ -768,11 +768,10 @@
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
- <p>Revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->15 November, 2007<!--webbot bot="Timestamp" endspan i-checksum="38512" --></p>
+ <p>Revised 05 January, 2008</p>
- <p><i>Copyright © 2003-<!--webbot bot="Timestamp" s-type="EDITED" s-format="%Y" startspan -->2007<!--webbot bot="Timestamp" endspan i-checksum="770" -->
- Andreas Huber Dönni</i></p>
+ <p><i>Copyright © 2003-2008 <a href="contact.html">Andreas Huber
+ Dönni</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file LICENSE_1_0.txt or
Modified: trunk/libs/statechart/doc/future_and_history.html
==============================================================================
--- trunk/libs/statechart/doc/future_and_history.html (original)
+++ trunk/libs/statechart/doc/future_and_history.html 2008-01-06 08:49:31 EST (Sun, 06 Jan 2008)
@@ -46,7 +46,8 @@
<ol>
<li>Implement a choice-point-like class, as discussed in
- this thread</li>
+ <a href="http://thread.gmane.org/gmane.comp.lib.boost.devel/164460">this
+ thread</a></li>
<li>Optimize state-entry and state-exit for speed and code-size</li>
@@ -148,6 +149,9 @@
<li>Added the FAQ item <a href="faq.html#AssertInStateDestructor">Why
do I get an assert when I access the state machine from a state
destructor?</a> (due to feedback from Jiang Miao)</li>
+ <li>Added defaults for the last two template parameters of <a href=
+ "reference.html#ClassTemplatein_state_reaction">in_state_reaction<></a>
+ (due to feedback from Sean Kelly)</li>
</ul>
<p>1.35.0</p>
@@ -680,11 +684,10 @@
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
- <p>Revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->09 April, 2007<!--webbot bot="Timestamp" endspan i-checksum="30014" --></p>
+ <p>Revised 05 January, 2008</p>
- <p><i>Copyright © 2003-<!--webbot bot="Timestamp" s-type="EDITED" s-format="%Y" startspan -->2007<!--webbot bot="Timestamp" endspan i-checksum="778" -->
- Andreas Huber Dönni</i></p>
+ <p><i>Copyright © 2003-2008 <a href="contact.html">Andreas Huber
+ Dönni</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file LICENSE_1_0.txt or
Modified: trunk/libs/statechart/doc/reference.html
==============================================================================
--- trunk/libs/statechart/doc/reference.html (original)
+++ trunk/libs/statechart/doc/reference.html 2008-01-06 08:49:31 EST (Sun, 06 Jan 2008)
@@ -190,27 +190,27 @@
<table border="3" cellpadding="2" width="100%" summary="Scheduler concept">
<tr>
- <td width="24%"><b>Expression</b></td>
+ <td><b>Expression</b></td>
- <td width="25%"><b>Type</b></td>
+ <td><b>Type</b></td>
- <td width="48%"><b>Result</b></td>
+ <td><b>Result</b></td>
</tr>
<tr>
- <td width="24%"><code>cpc.my_scheduler()</code></td>
+ <td><code>cpc.my_scheduler()</code></td>
- <td width="25%"><code>S &</code></td>
+ <td><code>S &</code></td>
- <td width="48%">A reference to the scheduler</td>
+ <td>A reference to the scheduler</td>
</tr>
<tr>
- <td width="24%"><code>cpc.my_handle()</code></td>
+ <td><code>cpc.my_handle()</code></td>
- <td width="25%"><code>S::processor_handle</code></td>
+ <td><code>S::processor_handle</code></td>
- <td width="48%">The handle identifying the
+ <td>The handle identifying the
<code>event_processor<></code> subtype object</td>
</tr>
</table>
@@ -241,57 +241,56 @@
<table border="3" cellpadding="2" width="100%" summary=
"FifoWorker concept">
<tr>
- <td width="36%"><b>Expression/Statement</b></td>
+ <td><b>Expression/Statement</b></td>
- <td width="10%"><b>Type</b></td>
+ <td><b>Type</b></td>
- <td width="52%"><b>Effects/Result</b></td>
+ <td><b>Effects/Result</b></td>
</tr>
<tr>
- <td width="36%"><code>F::work_item</code></td>
+ <td><code>F::work_item</code></td>
- <td width="10%"><code>boost::function0<<br>
- void ></code></td>
+ <td><code>boost::function0< void ></code></td>
- <td width="52%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="36%"><code>F()</code> or <code>F( false )</code></td>
+ <td><code>F()</code> or <code>F( false )</code></td>
- <td width="10%"><code>F</code></td>
+ <td><code>F</code></td>
- <td width="52%">Constructs a <b>non-blocking</b> (see below) object of
+ <td>Constructs a <b>non-blocking</b> (see below) object of
the FifoWorker type. In single-threaded builds the second expression is
not well-formed</td>
</tr>
<tr>
- <td width="36%"><code>F( true )</code></td>
+ <td><code>F( true )</code></td>
- <td width="10%"><code>F</code></td>
+ <td><code>F</code></td>
- <td width="52%">Constructs a <b>blocking</b> (see below) object of the
+ <td>Constructs a <b>blocking</b> (see below) object of the
FifoWorker type. Not well-formed in single-threaded builds</td>
</tr>
<tr>
- <td width="36%"><code>f.queue_work_item( w );</code></td>
+ <td><code>f.queue_work_item( w );</code></td>
- <td width="10%"> </td>
+ <td> </td>
- <td width="52%">Constructs and queues an object of type
+ <td>Constructs and queues an object of type
<code>F::work_item</code>, passing <code>w</code> as the only
argument</td>
</tr>
<tr>
- <td width="36%"><code>f.terminate();</code></td>
+ <td><code>f.terminate();</code></td>
- <td width="10%"> </td>
+ <td> </td>
- <td width="52%">Creates and queues an object of type
+ <td>Creates and queues an object of type
<code>F::work_item</code> that, when later executed in
<code>operator()()</code>, leads to a modification of internal state so
that <code>terminated()</code> henceforth returns
@@ -299,11 +298,11 @@
</tr>
<tr>
- <td width="36%"><code>cf.terminated();</code></td>
+ <td><code>cf.terminated();</code></td>
- <td width="10%"><code>bool</code></td>
+ <td><code>bool</code></td>
- <td width="52%"><code>true</code> if <code>terminate()</code> has been
+ <td><code>true</code> if <code>terminate()</code> has been
called and the resulting work item has been executed in
<code>operator()()</code>. Returns <code>false</code> otherwise<br>
<br>
@@ -312,11 +311,11 @@
</tr>
<tr>
- <td width="36%"><code>f( n );</code></td>
+ <td><code>f( n );</code></td>
- <td width="10%"><code>unsigned long</code></td>
+ <td><code>unsigned long</code></td>
- <td width="52%">
+ <td>
Enters a loop that, with each cycle, dequeues and calls
<code>operator()()</code> on the oldest work item in the queue.
@@ -347,11 +346,11 @@
</tr>
<tr>
- <td width="36%"><code>f();</code></td>
+ <td><code>f();</code></td>
- <td width="10%"><code>unsigned long</code></td>
+ <td><code>unsigned long</code></td>
- <td width="52%">Has exactly the same semantics as <code>f( n );</code>
+ <td>Has exactly the same semantics as <code>f( n );</code>
with <code>n == 0</code> (see above)</td>
</tr>
</table>
@@ -373,19 +372,19 @@
<table border="3" cellpadding="2" width="100%" summary=
"ExceptionTranslator concept">
<tr>
- <td width="299"><b>Expression</b></td>
+ <td><b>Expression</b></td>
- <td width="101"><b>Type</b></td>
+ <td><b>Type</b></td>
- <td width="1129"><b>Effects/Result</b></td>
+ <td><b>Effects/Result</b></td>
</tr>
<tr>
- <td width="299"><code>et( a, eh );</code></td>
+ <td><code>et( a, eh );</code></td>
- <td width="101"><code>result</code></td>
+ <td><code>result</code></td>
- <td width="1129">
+ <td>
<ol>
<li>Attempts to execute <code>return a();</code></li>
@@ -414,29 +413,29 @@
<table border="3" cellpadding="2" width="100%" summary="StateBase concept">
<tr>
- <td width="26%"><b>Expression</b></td>
+ <td><b>Expression</b></td>
- <td width="12%"><b>Type</b></td>
+ <td><b>Type</b></td>
- <td width="60%"><b>Result</b></td>
+ <td><b>Result</b></td>
</tr>
<tr>
- <td width="26%"><code>cs.outer_state_ptr()</code></td>
+ <td><code>cs.outer_state_ptr()</code></td>
- <td width="12%"><code>const S *</code></td>
+ <td><code>const S *</code></td>
- <td width="60%"><code>0</code> if <code>cs</code> is an <a href=
+ <td><code>0</code> if <code>cs</code> is an <a href=
"definitions.html#OutermostState">outermost state</a>, a pointer to the
direct outer state of <code>cs</code> otherwise</td>
</tr>
<tr>
- <td width="25%"><code>cs.dynamic_type()</code></td>
+ <td><code>cs.dynamic_type()</code></td>
- <td width="12%"><code>S::id_type</code></td>
+ <td><code>S::id_type</code></td>
- <td width="60%">A value unambiguously identifying the most-derived type
+ <td>A value unambiguously identifying the most-derived type
of <code>cs</code>. <code>S::id_type</code> values are comparable with
<code>operator==()</code> and <code>operator!=()</code>. An unspecified
collating order can be established with <code>std::less< S::id_type
@@ -446,12 +445,12 @@
</tr>
<tr>
- <td width="25%"><code>cs.custom_dynamic_type_ptr<<br>
+ <td><code>cs.custom_dynamic_type_ptr<<br>
Type >()</code></td>
- <td width="12%"><code>const Type *</code></td>
+ <td><code>const Type *</code></td>
- <td width="60%">A pointer to the custom type identifier or
+ <td>A pointer to the custom type identifier or
<code>0</code>. If <code>!= 0</code>, <code>Type</code> must match the
type of the previously set pointer. This function is only available if
<a href=
@@ -472,22 +471,22 @@
<table border="3" cellpadding="2" width="100%" summary=
"SimpleState concept">
<tr>
- <td width="28%"><b>Expression/Statement</b></td>
+ <td><b>Expression/Statement</b></td>
- <td width="29%"><b>Type</b></td>
+ <td><b>Type</b></td>
- <td width="42%"><b>Effects/Result/Notes</b></td>
+ <td><b>Effects/Result/Notes</b></td>
</tr>
<tr>
- <td width="28%"><code><a href=
+ <td><code><a href=
"#ClassTemplatesimple_state">simple_state</a><<br>
- S, C, I, h > * pB =<br>
- pS;</code></td>
+ S, C, I, h > * pB =<br>
+ pS;</code></td>
- <td width="29%"> </td>
+ <td> </td>
- <td width="42%"><code>simple_state< S, C, I, h ></code> must be
+ <td><code>simple_state< S, C, I, h ></code> must be
an unambiguous public base of <code>S</code>. See <code><a href=
"#ClassTemplatesimple_state">simple_state<></a></code>
documentation for the requirements and semantics of <code>C</code>,
@@ -495,22 +494,22 @@
</tr>
<tr>
- <td width="28%"><code>new S()</code></td>
+ <td><code>new S()</code></td>
- <td width="29%"><code>S *</code></td>
+ <td><code>S *</code></td>
- <td width="42%">Enters the state <code>S</code>. Certain functions must
+ <td>Enters the state <code>S</code>. Certain functions must
not be called from <code>S::S()</code>, see <a href=
"#ClassTemplatesimple_state"><code>simple_state<></code></a>
documentation for more information</td>
</tr>
<tr>
- <td width="28%"><code>pS->exit();</code></td>
+ <td><code>pS->exit();</code></td>
- <td width="29%"> </td>
+ <td> </td>
- <td width="42%">Exits the state <code>S</code> (first stage). The
+ <td>Exits the state <code>S</code> (first stage). The
definition of an <code>exit</code> member function within models of the
SimpleState concept is optional since <code>simple_state<></code>
already defines the following public member: <code>void exit()
@@ -521,17 +520,17 @@
</tr>
<tr>
- <td width="28%"><code>delete pS;</code></td>
+ <td><code>delete pS;</code></td>
- <td width="29%"> </td>
+ <td> </td>
- <td width="42%">Exits the state <code>S</code> (second stage)</td>
+ <td>Exits the state <code>S</code> (second stage)</td>
</tr>
<tr>
- <td width="28%"><code>S::reactions</code></td>
+ <td><code>S::reactions</code></td>
- <td width="29%">An <code>mpl::list<></code> that is either empty
+ <td>An <code>mpl::list<></code> that is either empty
or contains instantiations of the <code><a href=
"#ClassTemplatecustom_reaction">custom_reaction</a></code>,
<code><a href=
@@ -543,7 +542,7 @@
<code>typedef</code>ed directly, without wrapping it into an
<code>mpl::list<></code></td>
- <td width="42%">The declaration of a <code>reactions</code> member
+ <td>The declaration of a <code>reactions</code> member
<code>typedef</code> within models of the SimpleState concept is
optional since <code>simple_state<></code> already defines the
following public member: <code>typedef mpl::list<>
@@ -564,21 +563,20 @@
<table border="3" cellpadding="2" width="100%" summary="State concept">
<tr>
- <td width="28%"><b>Expression/Statement</b></td>
+ <td><b>Expression/Statement</b></td>
- <td width="29%"><b>Type</b></td>
+ <td><b>Type</b></td>
- <td width="42%"><b>Effects/Result/Notes</b></td>
+ <td><b>Effects/Result/Notes</b></td>
</tr>
<tr>
- <td width="28%"><code>state< S, C,
- I, h > *<br>
- pB = pS;</code></td>
+ <td><code>state< S, C, I, h > *<br>
+ pB = pS;</code></td>
- <td width="29%"> </td>
+ <td> </td>
- <td width="42%"><code>state< S, C, I, h ></code> must be an
+ <td><code>state< S, C, I, h ></code> must be an
unambiguous public base of <code>S</code>. See <code><a href=
"#ClassTemplatestate">state<></a></code> documentation for the
requirements and semantics of <code>C</code>, <code>I</code> and
@@ -586,11 +584,11 @@
</tr>
<tr>
- <td width="28%"><code>new S( mc )</code></td>
+ <td><code>new S( mc )</code></td>
- <td width="29%"><code>S *</code></td>
+ <td><code>S *</code></td>
- <td width="42%">Enters the state <code>S</code>. No restrictions exist
+ <td>Enters the state <code>S</code>. No restrictions exist
regarding the functions that can be called from <code>S::S()</code> (in
contrast to the constructors of models of the SimpleState concept).
<code>mc</code> must be forwarded to <code>state< S, C, I, h
@@ -610,29 +608,29 @@
<table border="3" cellpadding="2" width="100%" summary="Event concept">
<tr>
- <td width="28%"><b>Expression/Statement</b></td>
+ <td><b>Expression/Statement</b></td>
- <td width="29%"><b>Type</b></td>
+ <td><b>Type</b></td>
- <td width="42%"><b>Effects/Result/Notes</b></td>
+ <td><b>Effects/Result/Notes</b></td>
</tr>
<tr>
- <td width="28%"><code>const event<
+ <td><code>const event<
E > * pCB = pCE;</code></td>
- <td width="29%"> </td>
+ <td> </td>
- <td width="42%"><code>event< E ></code> must be an unambiguous
+ <td><code>event< E ></code> must be an unambiguous
public base of <code>E</code></td>
</tr>
<tr>
- <td width="28%"><code>new E( *pCE )</code></td>
+ <td><code>new E( *pCE )</code></td>
- <td width="29%"><code>E *</code></td>
+ <td><code>E *</code></td>
- <td width="42%">Makes a copy of <code>pE</code></td>
+ <td>Makes a copy of <code>pE</code></td>
</tr>
</table>
@@ -650,29 +648,29 @@
<table border="3" cellpadding="2" width="100%" summary=
"state_machine parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="51%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="18%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
- <td width="19%"><b>Default</b></td>
+ <td><b>Default</b></td>
</tr>
<tr>
- <td width="15%"><code>MostDerived</code></td>
+ <td><code>MostDerived</code></td>
- <td width="51%">The most-derived subtype of this class template</td>
+ <td>The most-derived subtype of this class template</td>
- <td width="18%"> </td>
+ <td> </td>
- <td width="19%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>InitialState</code></td>
+ <td><code>InitialState</code></td>
- <td width="51%">A model of the SimpleState
+ <td>A model of the SimpleState
or State concepts. The <code>Context</code>
argument passed to the <code><a href=
"#ClassTemplatesimple_state">simple_state<></a></code> or
@@ -682,34 +680,34 @@
"definitions.html#OutermostState">outermost state</a> of this state
machine</td>
- <td width="18%">The state that is entered when
+ <td>The state that is entered when
<code>state_machine<><br>
::initiate()</code> is called</td>
- <td width="19%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>Allocator</code></td>
+ <td><code>Allocator</code></td>
- <td width="51%">A model of the standard Allocator concept</td>
+ <td>A model of the standard Allocator concept</td>
- <td width="18%"><code>Allocator::rebind<>::other</code> is used
+ <td><code>Allocator::rebind<>::other</code> is used
to allocate and deallocate all <code>simple_state</code> subtype
objects and internal objects of dynamic storage duration</td>
- <td width="19%"><code>std::allocator< void ></code></td>
+ <td><code>std::allocator< void ></code></td>
</tr>
<tr>
- <td width="15%"><code>ExceptionTranslator</code></td>
+ <td><code>ExceptionTranslator</code></td>
- <td width="51%">A model of the ExceptionTranslator concept</td>
+ <td>A model of the ExceptionTranslator concept</td>
- <td width="18%">see <a href=
+ <td>see <a href=
"#ExceptionTranslator">ExceptionTranslator</a> concept</td>
- <td width="19%"><code>null_exception_translator</code></td>
+ <td><code>null_exception_translator</code></td>
</tr>
</table>
@@ -1220,29 +1218,29 @@
<table border="3" cellpadding="2" width="100%" summary=
"asynchronous_state_machine parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="51%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="18%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
- <td width="19%"><b>Default</b></td>
+ <td><b>Default</b></td>
</tr>
<tr>
- <td width="15%"><code>MostDerived</code></td>
+ <td><code>MostDerived</code></td>
- <td width="51%">The most-derived subtype of this class template</td>
+ <td>The most-derived subtype of this class template</td>
- <td width="18%"> </td>
+ <td> </td>
- <td width="19%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>InitialState</code></td>
+ <td><code>InitialState</code></td>
- <td width="51%">A model of the SimpleState
+ <td>A model of the SimpleState
or State concepts. The <code>Context</code>
argument passed to the <code><a href=
"#ClassTemplatesimple_state">simple_state<></a></code> or
@@ -1252,41 +1250,41 @@
"definitions.html#OutermostState">outermost state</a> of this state
machine</td>
- <td width="18%">The state that is entered when the state machine is
+ <td>The state that is entered when the state machine is
initiated through the <code>Scheduler</code> object</td>
- <td width="19%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>Scheduler</code></td>
+ <td><code>Scheduler</code></td>
- <td width="51%">A model of the Scheduler concept</td>
+ <td>A model of the Scheduler concept</td>
- <td width="18%">see Scheduler concept</td>
+ <td>see Scheduler concept</td>
- <td width="19%"><code>fifo_scheduler<></code></td>
+ <td><code>fifo_scheduler<></code></td>
</tr>
<tr>
- <td width="15%"><code>Allocator</code></td>
+ <td><code>Allocator</code></td>
- <td width="51%">A model of the standard Allocator concept</td>
+ <td>A model of the standard Allocator concept</td>
- <td width="18%"> </td>
+ <td> </td>
- <td width="19%"><code>std::allocator< void ></code></td>
+ <td><code>std::allocator< void ></code></td>
</tr>
<tr>
- <td width="15%"><code>ExceptionTranslator</code></td>
+ <td><code>ExceptionTranslator</code></td>
- <td width="51%">A model of the ExceptionTranslator concept</td>
+ <td>A model of the ExceptionTranslator concept</td>
- <td width="18%">see <a href=
+ <td>see <a href=
"#ExceptionTranslator">ExceptionTranslator</a> concept</td>
- <td width="19%"><code>null_exception_translator</code></td>
+ <td><code>null_exception_translator</code></td>
</tr>
</table>
@@ -1356,23 +1354,19 @@
<table border="3" cellpadding="2" width="100%" summary=
"event_processor parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="51%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="18%"><b>Semantics</b></td>
-
- <td width="19%"><b>Default</b></td>
+ <td><b>Semantics</b></td>
</tr>
<tr>
- <td width="15%"><code>Scheduler</code></td>
-
- <td width="51%">A model of the Scheduler concept</td>
+ <td><code>Scheduler</code></td>
- <td width="18%">see Scheduler concept</td>
+ <td>A model of the Scheduler concept</td>
- <td width="19%"> </td>
+ <td>see Scheduler concept</td>
</tr>
</table>
@@ -1493,33 +1487,33 @@
<table border="3" cellpadding="2" width="100%" summary=
"fifo_scheduler parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="28%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="26%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
- <td width="29%"><b>Default</b></td>
+ <td><b>Default</b></td>
</tr>
<tr>
- <td width="15%"><code>FifoWorker</code></td>
+ <td><code>FifoWorker</code></td>
- <td width="28%">A model of the FifoWorker concept</td>
+ <td>A model of the FifoWorker concept</td>
- <td width="26%">see FifoWorker concept</td>
+ <td>see FifoWorker concept</td>
- <td width="29%"><code>fifo_worker<></code></td>
+ <td><code>fifo_worker<></code></td>
</tr>
<tr>
- <td width="15%"><code>Allocator</code></td>
+ <td><code>Allocator</code></td>
- <td width="28%">A model of the standard Allocator concept</td>
+ <td>A model of the standard Allocator concept</td>
- <td width="26%"> </td>
+ <td> </td>
- <td width="29%"><code>std::allocator< void ></code></td>
+ <td><code>std::allocator< void ></code></td>
</tr>
</table>
@@ -1793,24 +1787,24 @@
<table border="3" cellpadding="2" width="100%" summary=
"exception_translator parameters">
<tr>
- <td width="12%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="30%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="35%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
- <td width="24%"><b>Default</b></td>
+ <td><b>Default</b></td>
</tr>
<tr>
- <td width="12%"><code>ExceptionEvent</code></td>
+ <td><code>ExceptionEvent</code></td>
- <td width="30%">A model of the Event concept</td>
+ <td>A model of the Event concept</td>
- <td width="35%">The type of event that is dispatched when an exception
+ <td>The type of event that is dispatched when an exception
is propagated into the framework</td>
- <td width="24%"><code>exception_thrown</code></td>
+ <td><code>exception_thrown</code></td>
</tr>
</table>
@@ -1951,29 +1945,29 @@
<table border="3" cellpadding="2" width="100%" summary=
"simple_state parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="51%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="18%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
- <td width="19%"><b>Default</b></td>
+ <td><b>Default</b></td>
</tr>
<tr>
- <td width="15%"><code>MostDerived</code></td>
+ <td><code>MostDerived</code></td>
- <td width="51%">The most-derived subtype of this class template</td>
+ <td>The most-derived subtype of this class template</td>
- <td width="18%"> </td>
+ <td> </td>
- <td width="19%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>Context</code></td>
+ <td><code>Context</code></td>
- <td width="51%">A most-derived direct or indirect subtype of the
+ <td>A most-derived direct or indirect subtype of the
<code>state_machine</code> or
<code><a href=
"#ClassTemplateasynchronous_state_machine">asynchronous_state_machine</a></code>
@@ -1983,16 +1977,16 @@
"#ClassTemplatesimple_state">simple_state<>::orthogonal</a></code>
class template. Must be a complete type</td>
- <td width="18%">Defines the states' position in the state
+ <td>Defines the states' position in the state
hierarchy</td>
- <td width="19%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>InnerInitial</code></td>
+ <td><code>InnerInitial</code></td>
- <td width="51%">An <code>mpl::list<></code> containing models of
+ <td>An <code>mpl::list<></code> containing models of
the SimpleState or <a href=
"#State">State</a> concepts or instantiations of the <code><a href=
"#ClassTemplateshallow_history">shallow_history</a></code> or
@@ -2010,22 +2004,22 @@
<code>MostDerived::orthogonal< 0 ></code> and
<code>MostDerived</code> are synonymous</td>
- <td width="18%">Defines the inner initial state for each orthogonal
+ <td>Defines the inner initial state for each orthogonal
region. By default, a state does not have inner states</td>
- <td width="19%"><i><code>unspecified</code></i></td>
+ <td><i><code>unspecified</code></i></td>
</tr>
<tr>
- <td width="15%"><code>historyMode</code></td>
+ <td><code>historyMode</code></td>
- <td width="51%">One of the values defined in the <code><a href=
+ <td>One of the values defined in the <code><a href=
"#Enumhistory_mode">history_mode</a></code> enumeration</td>
- <td width="18%">Defines whether the state saves shallow, deep or both
+ <td>Defines whether the state saves shallow, deep or both
histories upon exit</td>
- <td width="19%"><code>has_no_history</code></td>
+ <td><code>has_no_history</code></td>
</tr>
</table>
@@ -2762,17 +2756,17 @@
<table border="3" cellpadding="2" width="100%" summary=
"shallow_history parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="45%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="24%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
</tr>
<tr>
- <td width="15%"><code>DefaultState</code></td>
+ <td><code>DefaultState</code></td>
- <td width="45%">A model of the SimpleState
+ <td>A model of the SimpleState
or State concepts. The type passed as
<code>Context</code> argument to the <code><a href=
"#ClassTemplatesimple_state">simple_state<></a></code> or
@@ -2783,8 +2777,7 @@
"#ClassTemplatesimple_state">simple_state<></a></code> or
<code>state<></code> base</td>
- <td width="24%">The state that is entered if shallow history is not
- available</td>
+ <td>The state that is entered if shallow history is not available</td>
</tr>
</table>
@@ -2820,17 +2813,17 @@
<table border="3" cellpadding="2" width="100%" summary=
"deep_history parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="45%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="24%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
</tr>
<tr>
- <td width="15%"><code>DefaultState</code></td>
+ <td><code>DefaultState</code></td>
- <td width="45%">A model of the SimpleState
+ <td>A model of the SimpleState
or State concepts. The type passed as
<code>Context</code> argument to the <code><a href=
"#ClassTemplatesimple_state">simple_state<></a></code> or
@@ -2841,8 +2834,7 @@
"#ClassTemplatesimple_state">simple_state<></a></code> or
<code>state<></code> base</td>
- <td width="24%">The state that is entered if deep history is not
- available</td>
+ <td>The state that is entered if deep history is not available</td>
</tr>
</table>
@@ -2960,36 +2952,36 @@
<table border="3" cellpadding="2" width="100%" summary="event parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="51%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="18%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
- <td width="19%"><b>Default</b></td>
+ <td><b>Default</b></td>
</tr>
<tr>
- <td width="15%"><code>MostDerived</code></td>
+ <td><code>MostDerived</code></td>
- <td width="51%">The most-derived subtype of this class template</td>
+ <td>The most-derived subtype of this class template</td>
- <td width="18%"> </td>
+ <td> </td>
- <td width="19%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>Allocator</code></td>
+ <td><code>Allocator</code></td>
- <td width="51%">A model of the standard Allocator concept</td>
+ <td>A model of the standard Allocator concept</td>
- <td width="18%"><code>Allocator::rebind< MostDerived
+ <td><code>Allocator::rebind< MostDerived
>::other</code> is used to allocate and deallocate all event subtype
objects of dynamic storage duration, see <code><a href=
"#event::operatornew">operator new</a></code></td>
- <td width="19%"><code>std::allocator< void ></code></td>
+ <td><code>std::allocator< void ></code></td>
</tr>
</table>
@@ -3110,33 +3102,33 @@
<table border="3" cellpadding="2" width="100%" summary=
"transition parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="45%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="24%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
- <td width="16%"><b>Default</b></td>
+ <td><b>Default</b></td>
</tr>
<tr>
- <td width="15%"><code>Event</code></td>
+ <td><code>Event</code></td>
- <td width="45%">A model of the Event concept or
+ <td>A model of the Event concept or
the class <code>event_base</code></td>
- <td width="24%">The event triggering the transition. If <code><a href=
+ <td>The event triggering the transition. If <code><a href=
"#Classevent_base">event_base</a></code> is specified, the transition
is triggered by all models of the Event
concept</td>
- <td width="16%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>Destination</code></td>
+ <td><code>Destination</code></td>
- <td width="45%">A model of the SimpleState
+ <td>A model of the SimpleState
or State concepts or an instantiation of the
<code><a href=
"#ClassTemplateshallow_history">shallow_history</a></code> or
@@ -3145,35 +3137,35 @@
is defined) and <code>Destination</code> must have a common direct or
indirect context</td>
- <td width="24%">The destination state to make a transition to</td>
+ <td>The destination state to make a transition to</td>
- <td width="16%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>TransitionContext</code></td>
+ <td><code>TransitionContext</code></td>
- <td width="45%">A common context of the source and
+ <td>A common context of the source and
<code>Destination</code> state</td>
- <td width="24%">The state of which the transition action is a
+ <td>The state of which the transition action is a
member</td>
- <td width="16%"><i><code>unspecified</code></i></td>
+ <td><i><code>unspecified</code></i></td>
</tr>
<tr>
- <td width="15%"><code>pTransitionAction</code></td>
+ <td><code>pTransitionAction</code></td>
- <td width="45%">A pointer to a member function of
+ <td>A pointer to a member function of
<code>TransitionContext</code>. The member function must accept a
<code>const Event &</code> parameter and return
<code>void</code></td>
- <td width="24%">The transition action that is executed during the
+ <td>The transition action that is executed during the
transition. By default no transition action is executed</td>
- <td width="16%"><i><code>unspecified</code></i></td>
+ <td><i><code>unspecified</code></i></td>
</tr>
</table>
@@ -3228,52 +3220,52 @@
<table border="3" cellpadding="2" width="100%" summary=
"in_state_reaction parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="45%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="24%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
- <td width="16%"><b>Default</b></td>
+ <td><b>Default</b></td>
</tr>
<tr>
- <td width="15%"><code>Event</code></td>
+ <td><code>Event</code></td>
- <td width="45%">A model of the Event concept or
+ <td>A model of the Event concept or
the class <code>event_base</code></td>
- <td width="24%">The event triggering the in-state reaction. If
+ <td>The event triggering the in-state reaction. If
<code>event_base</code> is specified,
the in-state reaction is triggered by all models of the <a href=
"#Event">Event</a> concept</td>
- <td width="16%"> </td>
+ <td> </td>
</tr>
<tr>
- <td width="15%"><code>ReactionContext</code></td>
+ <td><code>ReactionContext</code></td>
- <td width="45%">Either the state defining the in-state reaction itself
+ <td>Either the state defining the in-state reaction itself
or one of it direct or indirect contexts</td>
- <td width="24%">The state of which the action is a member</td>
+ <td>The state of which the action is a member</td>
- <td width="16%"><i><code>unspecified</code></i></td>
+ <td><i><code>unspecified</code></i></td>
</tr>
<tr>
- <td width="15%"><code>pAction</code></td>
+ <td><code>pAction</code></td>
- <td width="45%">A pointer to a member function of
+ <td>A pointer to a member function of
<code>ReactionContext</code>. The member function must accept a
<code>const Event &</code> parameter and return
<code>void</code></td>
- <td width="24%">The action that is executed during the in-state
+ <td>The action that is executed during the in-state
reaction</td>
- <td width="16%"><i><code>unspecified</code></i></td>
+ <td><i><code>unspecified</code></i></td>
</tr>
</table>
@@ -3323,20 +3315,20 @@
<table border="3" cellpadding="2" width="100%" summary=
"termination parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="45%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="24%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
</tr>
<tr>
- <td width="15%"><code>Event</code></td>
+ <td><code>Event</code></td>
- <td width="45%">A model of the Event concept or
+ <td>A model of the Event concept or
the class <code>event_base</code></td>
- <td width="24%">The event triggering the termination. If <code><a href=
+ <td>The event triggering the termination. If <code><a href=
"#Classevent_base">event_base</a></code> is specified, the termination
is triggered by all models of the Event
concept</td>
@@ -3380,20 +3372,20 @@
<table border="3" cellpadding="2" width="100%" summary=
"deferral parameters">
<tr>
- <td width="15%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="45%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="24%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
</tr>
<tr>
- <td width="15%"><code>Event</code></td>
+ <td><code>Event</code></td>
- <td width="45%">A model of the Event concept or
+ <td>A model of the Event concept or
the class <code>event_base</code></td>
- <td width="24%">The event triggering the deferral. If <code><a href=
+ <td>The event triggering the deferral. If <code><a href=
"#Classevent_base">event_base</a></code> is specified, the deferral is
triggered by all models of the Event concept</td>
</tr>
@@ -3437,20 +3429,20 @@
<table border="3" cellpadding="2" width="100%" summary=
"custom_reaction parameters">
<tr>
- <td width="17%"><b>Template parameter</b></td>
+ <td><b>Template parameter</b></td>
- <td width="56%"><b>Requirements</b></td>
+ <td><b>Requirements</b></td>
- <td width="24%"><b>Semantics</b></td>
+ <td><b>Semantics</b></td>
</tr>
<tr>
- <td width="17%"><code>Event</code></td>
+ <td><code>Event</code></td>
- <td width="56%">A model of the Event concept or
+ <td>A model of the Event concept or
the class <code>event_base</code></td>
- <td width="24%">The event triggering the custom reaction. If
+ <td>The event triggering the custom reaction. If
<code>event_base</code> is specified,
the custom reaction is triggered by all models of the <a href=
"#Event">Event</a> concept</td>
@@ -3554,12 +3546,10 @@
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
- <p>Revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" --></p>
+ <p>Revised 06 January, 2008</p>
- <p><i>Copyright © 2003-<!--webbot bot="Timestamp" s-type="EDITED"
- s-format="%Y" -->
- Andreas Huber Dönni</i></p>
+ <p><i>Copyright © 2003-2008 <a href="contact.html">Andreas Huber
+ Dönni</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file LICENSE_1_0.txt or
Modified: trunk/libs/statechart/doc/reference.pdf
==============================================================================
Binary files. No diff available.
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