diff options
Diffstat (limited to 'classuscxml_1_1_invoker_impl.html')
| -rw-r--r-- | classuscxml_1_1_invoker_impl.html | 110 |
1 files changed, 53 insertions, 57 deletions
diff --git a/classuscxml_1_1_invoker_impl.html b/classuscxml_1_1_invoker_impl.html index 9959de3..c6979cf 100644 --- a/classuscxml_1_1_invoker_impl.html +++ b/classuscxml_1_1_invoker_impl.html @@ -117,23 +117,21 @@ Inheritance diagram for uscxml::InvokerImpl:</div> <div class="dynheader"> Collaboration diagram for uscxml::InvokerImpl:</div> <div class="dyncontent"> -<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classuscxml_1_1_invoker_impl__coll__graph.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div> -</div> +<div class="center"><iframe scrolling="no" frameborder="0" src="classuscxml_1_1_invoker_impl__coll__graph.svg" width="384" height="127"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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: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:af47c5678ae7cba43e262227af96870a9"><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#af47c5678ae7cba43e262227af96870a9">create</a> (<a class="el" href="classuscxml_1_1_invoker_callbacks.html">InvokerCallbacks</a> *callbacks)=0</td></tr> +<tr class="memdesc:af47c5678ae7cba43e262227af96870a9"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classuscxml_1_1_factory.html">Factory</a> demands a new instance. <a href="#af47c5678ae7cba43e262227af96870a9">More...</a><br /></td></tr> +<tr class="separator:af47c5678ae7cba43e262227af96870a9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7d488de043b253e700b1bb25c808d7ed"><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#a7d488de043b253e700b1bb25c808d7ed">deserialize</a> (const <a class="el" href="classuscxml_1_1_data.html">Data</a> &encodedState)</td></tr> +<tr class="memdesc:a7d488de043b253e700b1bb25c808d7ed"><td class="mdescLeft"> </td><td class="mdescRight">Load a state from a <a class="el" href="classuscxml_1_1_data.html">Data</a> object. <a href="#a7d488de043b253e700b1bb25c808d7ed">More...</a><br /></td></tr> +<tr class="separator:a7d488de043b253e700b1bb25c808d7ed"><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> +<tr class="memdesc:ad3ced0fe6fab948510e357694fec4864"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classuscxml_1_1_invoker.html" title="Facade for invoker implementation. ">Invoker</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> <tr class="separator:ad3ced0fe6fab948510e357694fec4864"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a77254dc1e4f6c5755ea577280db5c9c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77254dc1e4f6c5755ea577280db5c9c4"></a> -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> @@ -141,9 +139,10 @@ virtual std::list< std::string > </td><td class="memItemRight" valign <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:a9ea613442d5052ca7425526e1c324382"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ea613442d5052ca7425526e1c324382"></a> +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_invoker_impl.html#a9ea613442d5052ca7425526e1c324382">serialize</a> ()</td></tr> +<tr class="memdesc:a9ea613442d5052ca7425526e1c324382"><td class="mdescLeft"> </td><td class="mdescRight">Save our state into a <a class="el" href="classuscxml_1_1_data.html">Data</a> object. <br /></td></tr> +<tr class="separator:a9ea613442d5052ca7425526e1c324382"><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> @@ -164,19 +163,15 @@ Protected Member Functions</h2></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> -<tr class="memitem:ae0820809fba6c83b448a9140b1c3b13c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0820809fba6c83b448a9140b1c3b13c"></a> -XERCESC_NS::DOMElement * </td><td class="memItemRight" valign="bottom"><b>_finalize</b></td></tr> -<tr class="separator:ae0820809fba6c83b448a9140b1c3b13c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abe0a02321739c356ff03eb6f100ebd83"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe0a02321739c356ff03eb6f100ebd83"></a> +<a class="el" href="classuscxml_1_1_invoker_callbacks.html">InvokerCallbacks</a> * </td><td class="memItemRight" valign="bottom"><b>_callbacks</b></td></tr> +<tr class="separator:abe0a02321739c356ff03eb6f100ebd83"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a342b4c5f3ef11fe1c06df1f6c26c6725"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a342b4c5f3ef11fe1c06df1f6c26c6725"></a> std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b></td></tr> <tr class="separator:a342b4c5f3ef11fe1c06df1f6c26c6725"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="inherit_header pro_attribs_classuscxml_1_1_event_handler_impl"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classuscxml_1_1_event_handler_impl')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classuscxml_1_1_event_handler_impl.html">uscxml::EventHandlerImpl</a></td></tr> -<tr class="memitem:af7069a12f5b67953f76c2eda8c1fc419 inherit pro_attribs_classuscxml_1_1_event_handler_impl"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7069a12f5b67953f76c2eda8c1fc419"></a> -<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> <h2 class="groupheader">Member Function Documentation</h2> -<a class="anchor" id="ac0b677a69ce22f9d455149f9a185a77f"></a> +<a class="anchor" id="af47c5678ae7cba43e262227af96870a9"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> @@ -186,8 +181,8 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< <tr> <td class="memname">virtual std::shared_ptr<<a class="el" href="classuscxml_1_1_invoker_impl.html">InvokerImpl</a>> uscxml::InvokerImpl::create </td> <td>(</td> - <td class="paramtype"><a class="el" href="classuscxml_1_1_interpreter_impl.html">InterpreterImpl</a> * </td> - <td class="paramname"><em>interpreter</em></td><td>)</td> + <td class="paramtype"><a class="el" href="classuscxml_1_1_invoker_callbacks.html">InvokerCallbacks</a> * </td> + <td class="paramname"><em>callbacks</em></td><td>)</td> <td></td> </tr> </table> @@ -199,13 +194,44 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< </div><div class="memdoc"> <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> + <tr><td class="paramname">callbacks</td><td>An object implementing the invoker callbacks. </td></tr> + </table> + </dd> +</dl> + +<p>Implemented in <a class="el" href="classuscxml_1_1_dir_mon_invoker.html#ac6a1737f9225ec6c1cd0a040a5b0f590">uscxml::DirMonInvoker</a>, and <a class="el" href="classuscxml_1_1_u_s_c_x_m_l_invoker.html#a86c25ad4f3e016b24219af5e815ce34b">uscxml::USCXMLInvoker</a>.</p> + +</div> +</div> +<a class="anchor" id="a7d488de043b253e700b1bb25c808d7ed"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void uscxml::InvokerImpl::deserialize </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classuscxml_1_1_data.html">Data</a> & </td> + <td class="paramname"><em>encodedState</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">encodedState</td><td>The state we returned somewhen else via serialize. </td></tr> </table> </dd> </dl> -<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">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_dir_mon_invoker.html#aa7f9ded1a03a2f6144b0a467bf23eca0">uscxml::DirMonInvoker</a>, and <a class="el" href="classuscxml_1_1_u_s_c_x_m_l_invoker.html#aab47a7d82206603f988a7534ddc1172e">uscxml::USCXMLInvoker</a>.</p> +<p>Reimplemented in <a class="el" href="classuscxml_1_1_u_s_c_x_m_l_invoker.html#ad223106c7281c8107adca7867ff23e01">uscxml::USCXMLInvoker</a>.</p> </div> </div> @@ -307,36 +333,6 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< </div> </div> -<a class="anchor" id="aa2888c20951790678e2998adb16e82d3"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">virtual void uscxml::InvokerImpl::setFinalize </td> - <td>(</td> - <td class="paramtype">XERCESC_NS::DOMElement * </td> - <td class="paramname"><em>finalize</em></td><td>)</td> - <td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">finalize</td><td>The finalize XMl element. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> <a class="anchor" id="a2cb2605ffd14b2e68ac234d2a60af8ba"></a> <div class="memitem"> <div class="memproto"> @@ -380,7 +376,7 @@ std::string </td><td class="memItemRight" valign="bottom"><b>_invokeId</b>< </div> </div> <!-- <hr class="footer"/><address class="footer"><small> -Generated on Mon Dec 12 2016 19:50:06 for uSCXML by  <a href="http://www.doxygen.org/index.html"> +Generated on Sun Apr 30 2017 22:52:20 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> --> |