diff options
Diffstat (limited to 'classuscxml_1_1_invoker_impl.html')
| -rw-r--r-- | classuscxml_1_1_invoker_impl.html | 42 |
1 files changed, 15 insertions, 27 deletions
diff --git a/classuscxml_1_1_invoker_impl.html b/classuscxml_1_1_invoker_impl.html index 83c61e6..4d5b79b 100644 --- a/classuscxml_1_1_invoker_impl.html +++ b/classuscxml_1_1_invoker_impl.html @@ -106,7 +106,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <div class="contents"> <p>Abstract base class for all invokers. - <a href="classuscxml_1_1_invoker_impl.html#details">More...</a></p> +</p> <p><code>#include <<a class="el" href="_invoker_impl_8h_source.html">InvokerImpl.h</a>></code></p> <div class="dynheader"> @@ -122,20 +122,9 @@ Collaboration diagram for uscxml::InvokerImpl:</div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> -<tr class="memitem:aecfb2ec7b80503861bab5df193e70bec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aecfb2ec7b80503861bab5df193e70bec"></a> -virtual std::list< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#aecfb2ec7b80503861bab5df193e70bec">getNames</a> ()=0</td></tr> -<tr class="memdesc:aecfb2ec7b80503861bab5df193e70bec"><td class="mdescLeft"> </td><td class="mdescRight">Return a list of names for types we implement. <br /></td></tr> -<tr class="separator:aecfb2ec7b80503861bab5df193e70bec"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac0b677a69ce22f9d455149f9a185a77f"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classuscxml_1_1_invoker_impl.html">InvokerImpl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#ac0b677a69ce22f9d455149f9a185a77f">create</a> (<a class="el" href="classuscxml_1_1_interpreter_impl.html">InterpreterImpl</a> *interpreter)=0</td></tr> <tr class="memdesc:ac0b677a69ce22f9d455149f9a185a77f"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classuscxml_1_1_factory.html">Factory</a> demands a new instance. <a href="#ac0b677a69ce22f9d455149f9a185a77f">More...</a><br /></td></tr> <tr class="separator:ac0b677a69ce22f9d455149f9a185a77f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a90506f4474eee947aa8836daae177161"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#a90506f4474eee947aa8836daae177161">invoke</a> (const std::string &source, const <a class="el" href="classuscxml_1_1_event.html">Event</a> &invokeEvent)=0</td></tr> -<tr class="memdesc:a90506f4474eee947aa8836daae177161"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classuscxml_1_1_invoker.html" title="Facade for invoker implementation. ">Invoker</a>'s parent state became active at the end of a macro-step. <a href="#a90506f4474eee947aa8836daae177161">More...</a><br /></td></tr> -<tr class="separator:a90506f4474eee947aa8836daae177161"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6cc8d5143bc44bd26a438d6508e23002"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cc8d5143bc44bd26a438d6508e23002"></a> -virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#a6cc8d5143bc44bd26a438d6508e23002">uninvoke</a> ()=0</td></tr> -<tr class="memdesc:a6cc8d5143bc44bd26a438d6508e23002"><td class="mdescLeft"> </td><td class="mdescRight">The invokers's parent state was left at the end of a macro-step. <br /></td></tr> -<tr class="separator:a6cc8d5143bc44bd26a438d6508e23002"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad3ced0fe6fab948510e357694fec4864"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3ced0fe6fab948510e357694fec4864"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#ad3ced0fe6fab948510e357694fec4864">eventFromSCXML</a> (const <a class="el" href="classuscxml_1_1_event.html">Event</a> &event)=0</td></tr> <tr class="memdesc:ad3ced0fe6fab948510e357694fec4864"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classuscxml_1_1_interpreter.html" title="Central class to interpret and process SCXML documents. ">Interpreter</a> received an event from the SCXML <a class="el" href="classuscxml_1_1_interpreter.html" title="Central class to interpret and process SCXML documents. ">Interpreter</a>. <br /></td></tr> @@ -144,12 +133,23 @@ virtual void </td><td class="memItemRight" valign="bottom"><a class="el" hr virtual XERCESC_NS::DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#a77254dc1e4f6c5755ea577280db5c9c4">getFinalize</a> ()</td></tr> <tr class="memdesc:a77254dc1e4f6c5755ea577280db5c9c4"><td class="mdescLeft"> </td><td class="mdescRight">Return the finalize XML element associated with this invoker. <br /></td></tr> <tr class="separator:a77254dc1e4f6c5755ea577280db5c9c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aecfb2ec7b80503861bab5df193e70bec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aecfb2ec7b80503861bab5df193e70bec"></a> +virtual std::list< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#aecfb2ec7b80503861bab5df193e70bec">getNames</a> ()=0</td></tr> +<tr class="memdesc:aecfb2ec7b80503861bab5df193e70bec"><td class="mdescLeft"> </td><td class="mdescRight">Return a list of names for types we implement. <br /></td></tr> +<tr class="separator:aecfb2ec7b80503861bab5df193e70bec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a90506f4474eee947aa8836daae177161"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#a90506f4474eee947aa8836daae177161">invoke</a> (const std::string &source, const <a class="el" href="classuscxml_1_1_event.html">Event</a> &invokeEvent)=0</td></tr> +<tr class="memdesc:a90506f4474eee947aa8836daae177161"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classuscxml_1_1_invoker.html" title="Facade for invoker implementation. ">Invoker</a>'s parent state became active at the end of a macro-step. <a href="#a90506f4474eee947aa8836daae177161">More...</a><br /></td></tr> +<tr class="separator:a90506f4474eee947aa8836daae177161"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa2888c20951790678e2998adb16e82d3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#aa2888c20951790678e2998adb16e82d3">setFinalize</a> (XERCESC_NS::DOMElement *finalize)</td></tr> <tr class="memdesc:aa2888c20951790678e2998adb16e82d3"><td class="mdescLeft"> </td><td class="mdescRight">Set the finalize XML element associated with this invoker. <a href="#aa2888c20951790678e2998adb16e82d3">More...</a><br /></td></tr> <tr class="separator:aa2888c20951790678e2998adb16e82d3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2cb2605ffd14b2e68ac234d2a60af8ba"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#a2cb2605ffd14b2e68ac234d2a60af8ba">setInvokeId</a> (const std::string &invokeId)</td></tr> <tr class="memdesc:a2cb2605ffd14b2e68ac234d2a60af8ba"><td class="mdescLeft"> </td><td class="mdescRight">Set the invocation identifier as required when returning events. <a href="#a2cb2605ffd14b2e68ac234d2a60af8ba">More...</a><br /></td></tr> <tr class="separator:a2cb2605ffd14b2e68ac234d2a60af8ba"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6cc8d5143bc44bd26a438d6508e23002"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cc8d5143bc44bd26a438d6508e23002"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_invoker_impl.html#a6cc8d5143bc44bd26a438d6508e23002">uninvoke</a> ()=0</td></tr> +<tr class="memdesc:a6cc8d5143bc44bd26a438d6508e23002"><td class="mdescLeft"> </td><td class="mdescRight">The invokers's parent state was left at the end of a macro-step. <br /></td></tr> +<tr class="separator:a6cc8d5143bc44bd26a438d6508e23002"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classuscxml_1_1_event_handler_impl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuscxml_1_1_event_handler_impl')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuscxml_1_1_event_handler_impl.html">uscxml::EventHandlerImpl</a></td></tr> <tr class="memitem:a14286b0d059c5f269abdb9efeb084b7c inherit pub_methods_classuscxml_1_1_event_handler_impl"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classuscxml_1_1_data.html">Data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_event_handler_impl.html#a14286b0d059c5f269abdb9efeb084b7c">getDataModelVariables</a> ()=0</td></tr> <tr class="memdesc:a14286b0d059c5f269abdb9efeb084b7c inherit pub_methods_classuscxml_1_1_event_handler_impl"><td class="mdescLeft"> </td><td class="mdescRight">Export a <a class="el" href="classuscxml_1_1_data.html">Data</a> object for the `_x['name']` data-model namespace. <a href="#a14286b0d059c5f269abdb9efeb084b7c">More...</a><br /></td></tr> @@ -174,9 +174,7 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< <a class="el" href="classuscxml_1_1_interpreter_impl.html">InterpreterImpl</a> * </td><td class="memItemRight" valign="bottom"><b>_interpreter</b></td></tr> <tr class="separator:af7069a12f5b67953f76c2eda8c1fc419 inherit pro_attribs_classuscxml_1_1_event_handler_impl"><td class="memSeparator" colspan="2"> </td></tr> </table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>Abstract base class for all invokers. </p> -</div><h2 class="groupheader">Member Function Documentation</h2> +<h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ac0b677a69ce22f9d455149f9a185a77f"></a> <div class="memitem"> <div class="memproto"> @@ -198,15 +196,13 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< </tr> </table> </div><div class="memdoc"> - -<p><a class="el" href="classuscxml_1_1_factory.html">Factory</a> demands a new instance. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">interpreter</td><td>The imlementation of the associated <a class="el" href="classuscxml_1_1_interpreter.html" title="Central class to interpret and process SCXML documents. ">Interpreter</a> </td></tr> </table> </dd> </dl> -<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>We will eventually introduce callbacks and prevent complete access to the interpreter. </dd></dl> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>We will eventually introduce callbacks and prevent complete access to the interpreter. </dd></dl> <p>Implemented in <a class="el" href="classuscxml_1_1_u_s_c_x_m_l_invoker.html#aab47a7d82206603f988a7534ddc1172e">uscxml::USCXMLInvoker</a>.</p> @@ -255,8 +251,6 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< </tr> </table> </div><div class="memdoc"> - -<p>Return an event to the SCXML <a class="el" href="classuscxml_1_1_interpreter.html" title="Central class to interpret and process SCXML documents. ">Interpreter</a> instance. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">event</td><td>An event to enqueue at the interpreter's external queue. </td></tr> @@ -300,8 +294,6 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< </tr> </table> </div><div class="memdoc"> - -<p><a class="el" href="classuscxml_1_1_invoker.html" title="Facade for invoker implementation. ">Invoker</a>'s parent state became active at the end of a macro-step. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">source</td><td>The content of the invoke's <code>src</code> or evaluated <code>srcexpr</code> attribute </td></tr> @@ -335,8 +327,6 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< </tr> </table> </div><div class="memdoc"> - -<p>Set the finalize XML element associated with this invoker. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">finalize</td><td>The finalize XMl element. </td></tr> @@ -367,8 +357,6 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< </tr> </table> </div><div class="memdoc"> - -<p>Set the invocation identifier as required when returning events. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">invokeId</td><td>The invocation identifier. </td></tr> @@ -391,7 +379,7 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< </div> </div> <!-- <hr class="footer"/><address class="footer"><small> -Generated on Thu May 19 2016 14:56:47 for uSCXML by  <a href="http://www.doxygen.org/index.html"> +Generated on Mon May 23 2016 08:47:45 for uSCXML by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.10 </small></address> --> |