diff options
Diffstat (limited to 'classuscxml_1_1_null_data_model.html')
| -rw-r--r-- | classuscxml_1_1_null_data_model.html | 703 |
1 files changed, 703 insertions, 0 deletions
diff --git a/classuscxml_1_1_null_data_model.html b/classuscxml_1_1_null_data_model.html new file mode 100644 index 0000000..86942a4 --- /dev/null +++ b/classuscxml_1_1_null_data_model.html @@ -0,0 +1,703 @@ +<!-- HTML header for doxygen 1.8.8--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <!-- For Mobile Devices --> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> + <meta name="generator" content="Doxygen 1.8.10"/> + <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script> + <title>uSCXML: uscxml::NullDataModel Class Reference</title> + <!--<link href="tabs.css" rel="stylesheet" type="text/css"/>--> + <script type="text/javascript" src="dynsections.js"></script> + <link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</script> + <link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css" /> + <link href="customdoxygen.css" rel="stylesheet" type="text/css"/> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script> + <script type="text/javascript" src="doxy-boot.js"></script> + </head> + <body> + <nav class="navbar navbar-default" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <a class="navbar-brand">uSCXML 2.0.0</a> + </div> + </div> + </nav> + <div id="top"><!-- do not remove this div, it is closed by doxygen! --> + <div class="content" id="content"> + <div class="container"> + <div class="row"> + <div class="col-sm-12 panel " style="padding-bottom: 15px;"> + <div style="margin-bottom: 15px;"> +<!-- end header part --><!-- Generated by Doxygen 1.8.10 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><b>uscxml</b></li><li class="navelem"><a class="el" href="classuscxml_1_1_null_data_model.html">NullDataModel</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classuscxml_1_1_null_data_model-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">uscxml::NullDataModel Class Reference<div class="ingroups"><a class="el" href="group__extension.html">Extension Points</a> » <a class="el" href="group__datamodel.html">Data-Models</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>NULL data-model. +</p> + +<p><code>#include <<a class="el" href="_null_data_model_8h_source.html">NullDataModel.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for uscxml::NullDataModel:</div> +<div class="dyncontent"> +<div class="center"><iframe scrolling="no" frameborder="0" src="classuscxml_1_1_null_data_model__inherit__graph.svg" width="171" height="112"><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> +<div class="dynheader"> +Collaboration diagram for uscxml::NullDataModel:</div> +<div class="dyncontent"> +<div class="center"><iframe scrolling="no" frameborder="0" src="classuscxml_1_1_null_data_model__coll__graph.svg" width="204" height="203"><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:af734ae59f7eb866da2cc8343ea7c904a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#af734ae59f7eb866da2cc8343ea7c904a">addExtension</a> (<a class="el" href="classuscxml_1_1_data_model_extension.html">DataModelExtension</a> *ext)</td></tr> +<tr class="memdesc:af734ae59f7eb866da2cc8343ea7c904a"><td class="mdescLeft"> </td><td class="mdescRight">Register an extension to get data into and out of the data-model. <a href="#af734ae59f7eb866da2cc8343ea7c904a">More...</a><br /></td></tr> +<tr class="separator:af734ae59f7eb866da2cc8343ea7c904a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4fbcc763b142a726e99728612fd41e14"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a4fbcc763b142a726e99728612fd41e14">assign</a> (const std::string &location, const <a class="el" href="classuscxml_1_1_data.html">Data</a> &data, const std::map< std::string, std::string > &attr)</td></tr> +<tr class="memdesc:a4fbcc763b142a726e99728612fd41e14"><td class="mdescLeft"> </td><td class="mdescRight">Assign a data object to a location in the data-model. <a href="#a4fbcc763b142a726e99728612fd41e14">More...</a><br /></td></tr> +<tr class="separator:a4fbcc763b142a726e99728612fd41e14"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5bd75d4d182821341551a61b44928c1a"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classuscxml_1_1_data_model_impl.html">DataModelImpl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a5bd75d4d182821341551a61b44928c1a">create</a> (<a class="el" href="classuscxml_1_1_data_model_callbacks.html">DataModelCallbacks</a> *callbacks)</td></tr> +<tr class="memdesc:a5bd75d4d182821341551a61b44928c1a"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classuscxml_1_1_factory.html">Factory</a> wants to instantiate a new instance. <a href="#a5bd75d4d182821341551a61b44928c1a">More...</a><br /></td></tr> +<tr class="separator:a5bd75d4d182821341551a61b44928c1a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3b6921d450ab3cde110ab1080a2dff7a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a3b6921d450ab3cde110ab1080a2dff7a">evalAsBool</a> (const XERCESC_NS::DOMElement *scriptNode, const std::string &expr)</td></tr> +<tr class="memdesc:a3b6921d450ab3cde110ab1080a2dff7a"><td class="mdescLeft"> </td><td class="mdescRight">The boolean expression language consists of the In predicate only. <a href="#a3b6921d450ab3cde110ab1080a2dff7a">More...</a><br /></td></tr> +<tr class="separator:a3b6921d450ab3cde110ab1080a2dff7a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a24f70b4ae2d06df7231c97a139000e9a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a24f70b4ae2d06df7231c97a139000e9a">evalAsBool</a> (const std::string &expr)</td></tr> +<tr class="memdesc:a24f70b4ae2d06df7231c97a139000e9a"><td class="mdescLeft"> </td><td class="mdescRight">Evaluate a given expression as a boolean. <a href="#a24f70b4ae2d06df7231c97a139000e9a">More...</a><br /></td></tr> +<tr class="separator:a24f70b4ae2d06df7231c97a139000e9a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a15e1bd2dae8d3266a45e68eeb9d24f29"><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_null_data_model.html#a15e1bd2dae8d3266a45e68eeb9d24f29">evalAsData</a> (const std::string &content)</td></tr> +<tr class="memdesc:a15e1bd2dae8d3266a45e68eeb9d24f29"><td class="mdescLeft"> </td><td class="mdescRight">Return a string as an <em>evaluated</em> <a class="el" href="classuscxml_1_1_data.html">Data</a> object. <a href="#a15e1bd2dae8d3266a45e68eeb9d24f29">More...</a><br /></td></tr> +<tr class="separator:a15e1bd2dae8d3266a45e68eeb9d24f29"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5f2c60ffc37b83dd90f7fa73c4f361dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f2c60ffc37b83dd90f7fa73c4f361dc"></a> +virtual std::string </td><td class="memItemRight" valign="bottom"><b>evalAsString</b> (const std::string &expr)</td></tr> +<tr class="separator:a5f2c60ffc37b83dd90f7fa73c4f361dc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a800f024ceb4f32e73a02a95df811fec0"><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_null_data_model.html#a800f024ceb4f32e73a02a95df811fec0">getAsData</a> (const std::string &content)</td></tr> +<tr class="memdesc:a800f024ceb4f32e73a02a95df811fec0"><td class="mdescLeft"> </td><td class="mdescRight">Return a string as an <em>unevaluated</em> <a class="el" href="classuscxml_1_1_data.html">Data</a> object. <a href="#a800f024ceb4f32e73a02a95df811fec0">More...</a><br /></td></tr> +<tr class="separator:a800f024ceb4f32e73a02a95df811fec0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae6c1f3fabb69d64581d7555d2e3c17a8"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#ae6c1f3fabb69d64581d7555d2e3c17a8">getLength</a> (const std::string &expr)</td></tr> +<tr class="memdesc:ae6c1f3fabb69d64581d7555d2e3c17a8"><td class="mdescLeft"> </td><td class="mdescRight">Evaluate the given expression as something iterable and return its length. <a href="#ae6c1f3fabb69d64581d7555d2e3c17a8">More...</a><br /></td></tr> +<tr class="separator:ae6c1f3fabb69d64581d7555d2e3c17a8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7aec45a6ed50fe3e571bb1217c0177c8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7aec45a6ed50fe3e571bb1217c0177c8"></a> +virtual std::list< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a7aec45a6ed50fe3e571bb1217c0177c8">getNames</a> ()</td></tr> +<tr class="memdesc:a7aec45a6ed50fe3e571bb1217c0177c8"><td class="mdescLeft"> </td><td class="mdescRight">Return a list of names to be matched by the <code>datamodel</code> attribute in SCXML. <br /></td></tr> +<tr class="separator:a7aec45a6ed50fe3e571bb1217c0177c8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a13570d162301d71c9231128b511893c0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a13570d162301d71c9231128b511893c0">init</a> (const std::string &location, const <a class="el" href="classuscxml_1_1_data.html">Data</a> &data, const std::map< std::string, std::string > &attr)</td></tr> +<tr class="memdesc:a13570d162301d71c9231128b511893c0"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a variable / location in the data-model with a given data object. <a href="#a13570d162301d71c9231128b511893c0">More...</a><br /></td></tr> +<tr class="separator:a13570d162301d71c9231128b511893c0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a159a479c287fc132a582b594d3a86279"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a159a479c287fc132a582b594d3a86279">isDeclared</a> (const std::string &expr)</td></tr> +<tr class="memdesc:a159a479c287fc132a582b594d3a86279"><td class="mdescLeft"> </td><td class="mdescRight">Determine whether a given variable / location is declared. <a href="#a159a479c287fc132a582b594d3a86279">More...</a><br /></td></tr> +<tr class="separator:a159a479c287fc132a582b594d3a86279"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2ccda24cc29ebc0fc73d78d36e5bb0e9"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a2ccda24cc29ebc0fc73d78d36e5bb0e9">isValidSyntax</a> (const std::string &expr)</td></tr> +<tr class="memdesc:a2ccda24cc29ebc0fc73d78d36e5bb0e9"><td class="mdescLeft"> </td><td class="mdescRight">Determine whether a given string constitutes valid syntax in the data-model's language. <a href="#a2ccda24cc29ebc0fc73d78d36e5bb0e9">More...</a><br /></td></tr> +<tr class="separator:a2ccda24cc29ebc0fc73d78d36e5bb0e9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6e6cffe0f53376bf26fba7ec6fd28f36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e6cffe0f53376bf26fba7ec6fd28f36"></a> +size_t </td><td class="memItemRight" valign="bottom"><b>replaceExpressions</b> (std::string &content)</td></tr> +<tr class="separator:a6e6cffe0f53376bf26fba7ec6fd28f36"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7413c858708acd5d630e265784b0f503"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7413c858708acd5d630e265784b0f503"></a> +virtual void </td><td class="memItemRight" valign="bottom"><b>setCallbacks</b> (<a class="el" href="classuscxml_1_1_data_model_callbacks.html">DataModelCallbacks</a> *callbacks)</td></tr> +<tr class="separator:a7413c858708acd5d630e265784b0f503"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8da8933034c65579826446b76f72ae35"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a8da8933034c65579826446b76f72ae35">setEvent</a> (const <a class="el" href="classuscxml_1_1_event.html">Event</a> &event)</td></tr> +<tr class="memdesc:a8da8933034c65579826446b76f72ae35"><td class="mdescLeft"> </td><td class="mdescRight">Set the given event as <code>_event</code> in the data-model's global scope. <a href="#a8da8933034c65579826446b76f72ae35">More...</a><br /></td></tr> +<tr class="separator:a8da8933034c65579826446b76f72ae35"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a62bed489e7130ca2944e5cb1f7249edd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_null_data_model.html#a62bed489e7130ca2944e5cb1f7249edd">setForeach</a> (const std::string &item, const std::string &array, const std::string &index, uint32_t iteration)</td></tr> +<tr class="memdesc:a62bed489e7130ca2944e5cb1f7249edd"><td class="mdescLeft"> </td><td class="mdescRight">Set a given item to the object at a given index for one iteration. <a href="#a62bed489e7130ca2944e5cb1f7249edd">More...</a><br /></td></tr> +<tr class="separator:a62bed489e7130ca2944e5cb1f7249edd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af86eb40f46239c05af184876f6b224a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af86eb40f46239c05af184876f6b224a6"></a> +virtual bool </td><td class="memItemRight" valign="bottom"><b>validate</b> (const std::string &location, const std::string &schema)</td></tr> +<tr class="separator:af86eb40f46239c05af184876f6b224a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classuscxml_1_1_data_model_impl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuscxml_1_1_data_model_impl')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuscxml_1_1_data_model_impl.html">uscxml::DataModelImpl</a></td></tr> +<tr class="memitem:acc27a4123c53055a24000dfd9a9cbc57 inherit pub_methods_classuscxml_1_1_data_model_impl"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_data_model_impl.html#acc27a4123c53055a24000dfd9a9cbc57">replaceExpressions</a> (std::string &content)</td></tr> +<tr class="memdesc:acc27a4123c53055a24000dfd9a9cbc57 inherit pub_methods_classuscxml_1_1_data_model_impl"><td class="mdescLeft"> </td><td class="mdescRight">Experimental extension to have dynamic content in string literals. <a href="#acc27a4123c53055a24000dfd9a9cbc57">More...</a><br /></td></tr> +<tr class="separator:acc27a4123c53055a24000dfd9a9cbc57 inherit pub_methods_classuscxml_1_1_data_model_impl"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pro_attribs_classuscxml_1_1_data_model_impl"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classuscxml_1_1_data_model_impl')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classuscxml_1_1_data_model_impl.html">uscxml::DataModelImpl</a></td></tr> +<tr class="memitem:aa5aed42d77aac94ea28561aebf6ee7c8 inherit pro_attribs_classuscxml_1_1_data_model_impl"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5aed42d77aac94ea28561aebf6ee7c8"></a> +<a class="el" href="classuscxml_1_1_data_model_callbacks.html">DataModelCallbacks</a> * </td><td class="memItemRight" valign="bottom"><b>_callbacks</b></td></tr> +<tr class="separator:aa5aed42d77aac94ea28561aebf6ee7c8 inherit pro_attribs_classuscxml_1_1_data_model_impl"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="af734ae59f7eb866da2cc8343ea7c904a"></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::NullDataModel::addExtension </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classuscxml_1_1_data_model_extension.html">DataModelExtension</a> * </td> + <td class="paramname"><em>ext</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="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>This is currently unsupported </dd></dl> + +<p>Reimplemented from <a class="el" href="classuscxml_1_1_data_model_impl.html#a8137c81a64d3978fc5a13cefdfe9a57a">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a4fbcc763b142a726e99728612fd41e14"></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::NullDataModel::assign </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>location</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classuscxml_1_1_data.html">Data</a> & </td> + <td class="paramname"><em>data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::map< std::string, std::string > & </td> + <td class="paramname"><em>attr</em> </td> + </tr> + <tr> + <td></td> + <td>)</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"> +<p>There are different occurences in the SCXML IRP tests, e.g. </p><pre class="fragment">test147: +<data id="Var1" expr="0"/> + +test150: +<data id="Var3"> +[1,2,3] +</data> + +test277: +<data id="Var1" expr="return"/> +</pre> <dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">location</td><td>A variable or locatio to assign to. </td></tr> + <tr><td class="paramname">data</td><td>The <a class="el" href="classuscxml_1_1_data.html">Data</a> object with the respective data. </td></tr> + <tr><td class="paramname">attr</td><td>Additional attributes of the XML assign element. </td></tr> + </table> + </dd> +</dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#a653d26b931f5b014ee923492e59b86a8">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a5bd75d4d182821341551a61b44928c1a"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr< <a class="el" href="classuscxml_1_1_data_model_impl.html">DataModelImpl</a> > uscxml::NullDataModel::create </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classuscxml_1_1_data_model_callbacks.html">DataModelCallbacks</a> * </td> + <td class="paramname"><em>callbacks</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>This function will have to initialize the object. The actual constructor is called from within here. The only one who calls the constructor directly is the <a class="el" href="classuscxml_1_1_factory.html">Factory</a> for the prototype object.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">callbacks</td><td>The callbacks available to the datamodel </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A shared pointer with an initialized instance </dd></dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#ab495cc41fdc14950bd3ff830b71c6d57">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a3b6921d450ab3cde110ab1080a2dff7a"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool uscxml::NullDataModel::evalAsBool </td> + <td>(</td> + <td class="paramtype">const XERCESC_NS::DOMElement * </td> + <td class="paramname"><em>scriptNode</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>expr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>It has the form 'In(id)', where id is the id of a state in the enclosing state machine. The predicate must return 'true' if and only if that state is in the current state configuration. </p> + +</div> +</div> +<a class="anchor" id="a24f70b4ae2d06df7231c97a139000e9a"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual bool uscxml::NullDataModel::evalAsBool </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>expr</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"> +<p>This function is a subset of <a class="el" href="classuscxml_1_1_null_data_model.html#a15e1bd2dae8d3266a45e68eeb9d24f29" title="Return a string as an evaluated Data object. ">evalAsData()</a> but saves on creating and copying a <a class="el" href="classuscxml_1_1_data.html">Data</a> object. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">expr</td><td>An expression in the data-model's language. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Whether the expression evaluates as <code>true</code> </dd></dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#a7bf03276de0ee069a55981599d476b18">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a15e1bd2dae8d3266a45e68eeb9d24f29"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classuscxml_1_1_data.html">Data</a> uscxml::NullDataModel::evalAsData </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>content</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">content</td><td>A string with a literal, eppression or compound data-structure in the data-model's language. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>An evaluated structure representing the given compound or literal. </dd></dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#a041d1fdf8830f923d960ac4a6cf09e57">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a800f024ceb4f32e73a02a95df811fec0"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classuscxml_1_1_data.html">Data</a> uscxml::NullDataModel::getAsData </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>content</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><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">content</td><td>A string with a literal, eppression or compound data-structure in the data-model's language. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>An unevaluated structure representing the given compound or literal. </dd></dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#ac026678fef708090caba851bc9681dfc">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="ae6c1f3fabb69d64581d7555d2e3c17a8"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t uscxml::NullDataModel::getLength </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>expr</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">expr</td><td>Anything that possibly evaluates to an enumerable object. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The number of items in the enumerable object. </dd></dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#a355696d8b85c00a640232b158f93850f">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a13570d162301d71c9231128b511893c0"></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::NullDataModel::init </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>location</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classuscxml_1_1_data.html">Data</a> & </td> + <td class="paramname"><em>data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::map< std::string, std::string > & </td> + <td class="paramname"><em>attr</em> </td> + </tr> + <tr> + <td></td> + <td>)</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"> +<p>This is, semantically, very close to <a class="el" href="classuscxml_1_1_null_data_model.html#a4fbcc763b142a726e99728612fd41e14" title="Assign a data object to a location in the data-model. ">assign()</a> but does not assume the location to be declared first.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">location</td><td>A variable or locatio to assign to. </td></tr> + <tr><td class="paramname">data</td><td>The <a class="el" href="classuscxml_1_1_data.html">Data</a> object with the respective data. </td></tr> + <tr><td class="paramname">attr</td><td>Additional attributes of the XML data element. </td></tr> + </table> + </dd> +</dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#a99f0c2250174937e3408a5baf45b8035">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a159a479c287fc132a582b594d3a86279"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual bool uscxml::NullDataModel::isDeclared </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>expr</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">expr</td><td>The variable / location to check. </td></tr> + </table> + </dd> +</dl> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Is this still used? </dd></dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#a83a8684b45f509a1180fb41ebb42192e">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a2ccda24cc29ebc0fc73d78d36e5bb0e9"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual bool uscxml::NullDataModel::isValidSyntax </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>expr</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">expr</td><td>A string, supposedly containing an expression of the data-model. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Whether expr is in L(DM). </dd></dl> + +<p>Reimplemented from <a class="el" href="classuscxml_1_1_data_model_impl.html#a6758e7946232dce852814d71886b1078">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a8da8933034c65579826446b76f72ae35"></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::NullDataModel::setEvent </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classuscxml_1_1_event.html">Event</a> & </td> + <td class="paramname"><em>event</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">event</td><td>The event as it was dequeued from either the internal or external queue. </td></tr> + </table> + </dd> +</dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#a1d3ef74ba677d7224d7320d7980c757c">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<a class="anchor" id="a62bed489e7130ca2944e5cb1f7249edd"></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::NullDataModel::setForeach </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>item</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>array</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>index</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>iteration</em> </td> + </tr> + <tr> + <td></td> + <td>)</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">item</td><td>A variable or location to assign the current object to. </td></tr> + <tr><td class="paramname">array</td><td>An expression evalating to an enumerable object. </td></tr> + <tr><td class="paramname">index</td><td>A variable or location to set the current index at. </td></tr> + <tr><td class="paramname">iteration</td><td>The current iteration index. </td></tr> + </table> + </dd> +</dl> + +<p>Implements <a class="el" href="classuscxml_1_1_data_model_impl.html#a0a6504a4c62e5925854998ce750d1675">uscxml::DataModelImpl</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>plugins/datamodel/null/<a class="el" href="_null_data_model_8h_source.html">NullDataModel.h</a></li> +<li>plugins/datamodel/null/<a class="el" href="_null_data_model_8cpp.html">NullDataModel.cpp</a></li> +</ul> +</div><!-- contents --> +<!-- HTML footer for doxygen 1.8.8--> +<!-- start footer part --> +</div> +</div> +</div> +</div> +</div> +<!-- <hr class="footer"/><address class="footer"><small> +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> --> +</body> +</html> |