summaryrefslogtreecommitdiffstats
path: root/_lua_data_model_8h_source.html
diff options
context:
space:
mode:
authorStefan Radomski <github@mintwerk.de>2016-05-23 06:49:06 (GMT)
committerStefan Radomski <github@mintwerk.de>2016-05-23 06:49:06 (GMT)
commit1600d6e9c57259d608071aebd6d9fc3a506f0ea2 (patch)
tree3b290d09bf528fc0f191eb711e5e83046e8cabe7 /_lua_data_model_8h_source.html
parent7a5e2fa2511e1e27b5bd824cc401aaaecbc838f6 (diff)
downloaduscxml-1600d6e9c57259d608071aebd6d9fc3a506f0ea2.zip
uscxml-1600d6e9c57259d608071aebd6d9fc3a506f0ea2.tar.gz
uscxml-1600d6e9c57259d608071aebd6d9fc3a506f0ea2.tar.bz2
Updated documentation
Diffstat (limited to '_lua_data_model_8h_source.html')
-rw-r--r--_lua_data_model_8h_source.html14
1 files changed, 9 insertions, 5 deletions
diff --git a/_lua_data_model_8h_source.html b/_lua_data_model_8h_source.html
index f600adb..212eb49 100644
--- a/_lua_data_model_8h_source.html
+++ b/_lua_data_model_8h_source.html
@@ -128,7 +128,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classuscxml_1_1_lua_data_model.html">LuaDataModel</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">virtual</span> std::shared_ptr&lt;DataModelImpl&gt; <a class="code" href="classuscxml_1_1_lua_data_model.html#a97d212198d59ebd5e26fed65042463a2">create</a>(<a class="code" href="classuscxml_1_1_data_model_callbacks.html">DataModelCallbacks</a>* callbacks);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
-<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> addExtension(<a class="code" href="classuscxml_1_1_data_model_extension.html">DataModelExtension</a>* ext);</div>
+<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuscxml_1_1_lua_data_model.html#a3d99dd50bf50bfd589baaa1fc018a341">addExtension</a>(<a class="code" href="classuscxml_1_1_data_model_extension.html">DataModelExtension</a>* ext);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classuscxml_1_1_lua_data_model.html#a11cc56d5ae2f5e21fa31cb8b512dc6b6"> 57</a></span>&#160; <span class="keyword">virtual</span> std::list&lt;std::string&gt; <a class="code" href="classuscxml_1_1_lua_data_model.html#a11cc56d5ae2f5e21fa31cb8b512dc6b6">getNames</a>() {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; std::list&lt;std::string&gt; names;</div>
@@ -141,8 +141,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuscxml_1_1_lua_data_model.html#aa4e52fbeb039c2ed76dc58394b260d5e">setEvent</a>(<span class="keyword">const</span> <a class="code" href="classuscxml_1_1_event.html">Event</a>&amp; event);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="comment">// foreach</span></div>
-<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">virtual</span> uint32_t getLength(<span class="keyword">const</span> std::string&amp; expr);</div>
-<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> setForeach(<span class="keyword">const</span> std::string&amp; item,</div>
+<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="classuscxml_1_1_lua_data_model.html#a4f4581f16a704dab7adf2032e86f9952">getLength</a>(<span class="keyword">const</span> std::string&amp; expr);</div>
+<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuscxml_1_1_lua_data_model.html#a47f07d7e4ddf50b3f06bd4403c14aaf4">setForeach</a>(<span class="keyword">const</span> std::string&amp; item,</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">const</span> std::string&amp; array,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">const</span> std::string&amp; index,</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; uint32_t iteration);</div>
@@ -156,7 +156,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuscxml_1_1_lua_data_model.html#a0e4030feed63efaf6e0e07012b4fc212">assign</a>(<span class="keyword">const</span> std::string&amp; location, <span class="keyword">const</span> <a class="code" href="classuscxml_1_1_data.html">Data</a>&amp; data);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuscxml_1_1_lua_data_model.html#a387f5d60474bf5dbcd52e7a600dc0765">init</a>(<span class="keyword">const</span> std::string&amp; location, <span class="keyword">const</span> <a class="code" href="classuscxml_1_1_data.html">Data</a>&amp; data);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
-<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">virtual</span> std::string andExpressions(std::list&lt;std::string&gt;);</div>
+<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">virtual</span> std::string <a class="code" href="classuscxml_1_1_lua_data_model.html#a77f0f840033e50f3d06d9e8463edb1ad">andExpressions</a>(std::list&lt;std::string&gt;);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div>
@@ -174,9 +174,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* end of include guard: LUADATAMODEL_H_113E014C */</span><span class="preprocessor"></span></div>
<div class="ttc" id="classuscxml_1_1_lua_data_model_html_acb5af93dd9f860d6921c17455ec67cd8"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#acb5af93dd9f860d6921c17455ec67cd8">uscxml::LuaDataModel::evalAsData</a></div><div class="ttdeci">virtual Data evalAsData(const std::string &amp;expr)</div><div class="ttdoc">Return a string as an evaluated Data object. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:326</div></div>
<div class="ttc" id="namespaceuscxml_html"><div class="ttname"><a href="namespaceuscxml.html">uscxml</a></div><div class="ttdef"><b>Definition:</b> InterpreterIssue.cpp:33</div></div>
+<div class="ttc" id="classuscxml_1_1_lua_data_model_html_a3d99dd50bf50bfd589baaa1fc018a341"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#a3d99dd50bf50bfd589baaa1fc018a341">uscxml::LuaDataModel::addExtension</a></div><div class="ttdeci">virtual void addExtension(DataModelExtension *ext)</div><div class="ttdoc">Register an extension to get data into and out of the data-model. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:245</div></div>
<div class="ttc" id="classuscxml_1_1_lua_data_model_html_a00a3dec5c2c74d656ae144e812a2a8af"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#a00a3dec5c2c74d656ae144e812a2a8af">uscxml::LuaDataModel::isDeclared</a></div><div class="ttdeci">virtual bool isDeclared(const std::string &amp;expr)</div><div class="ttdoc">Determine whether a given variable / location is declared. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:423</div></div>
<div class="ttc" id="classuscxml_1_1_lua_data_model_html_a11cc56d5ae2f5e21fa31cb8b512dc6b6"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#a11cc56d5ae2f5e21fa31cb8b512dc6b6">uscxml::LuaDataModel::getNames</a></div><div class="ttdeci">virtual std::list&lt; std::string &gt; getNames()</div><div class="ttdoc">Return a list of names to be matched by the datamodel attribute in SCXML. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.h:57</div></div>
<div class="ttc" id="_data_model_impl_8h_html"><div class="ttname"><a href="_data_model_impl_8h.html">DataModelImpl.h</a></div></div>
+<div class="ttc" id="classuscxml_1_1_lua_data_model_html_a77f0f840033e50f3d06d9e8463edb1ad"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#a77f0f840033e50f3d06d9e8463edb1ad">uscxml::LuaDataModel::andExpressions</a></div><div class="ttdeci">virtual std::string andExpressions(std::list&lt; std::string &gt;)</div><div class="ttdoc">Concat the given terms into a conjunctive form. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:516</div></div>
<div class="ttc" id="classuscxml_1_1_data_model_extension_html"><div class="ttname"><a href="classuscxml_1_1_data_model_extension.html">uscxml::DataModelExtension</a></div><div class="ttdef"><b>Definition:</b> DataModelImpl.h:54</div></div>
<div class="ttc" id="classuscxml_1_1_data_model_impl_html"><div class="ttname"><a href="classuscxml_1_1_data_model_impl.html">uscxml::DataModelImpl</a></div><div class="ttdoc">Abstract base class for all data-model implementations. </div><div class="ttdef"><b>Definition:</b> DataModelImpl.h:69</div></div>
<div class="ttc" id="classuscxml_1_1_lua_data_model_html"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html">uscxml::LuaDataModel</a></div><div class="ttdoc">Lua data-model. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.h:49</div></div>
@@ -185,7 +187,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classuscxml_1_1_lua_data_model_html_a97d212198d59ebd5e26fed65042463a2"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#a97d212198d59ebd5e26fed65042463a2">uscxml::LuaDataModel::create</a></div><div class="ttdeci">virtual std::shared_ptr&lt; DataModelImpl &gt; create(DataModelCallbacks *callbacks)</div><div class="ttdoc">The Factory wants to instantiate a new instance. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:188</div></div>
<div class="ttc" id="classuscxml_1_1_lua_data_model_html_adbb91f4ff766238630440c6cef9e598c"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#adbb91f4ff766238630440c6cef9e598c">uscxml::LuaDataModel::isValidSyntax</a></div><div class="ttdeci">virtual bool isValidSyntax(const std::string &amp;expr)</div><div class="ttdoc">Determine whether a given string constitutes valid syntax in the data-model&#39;s language. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:351</div></div>
<div class="ttc" id="classuscxml_1_1_lua_data_model_html_ace03d51690c585927d52bda9374e47b5"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#ace03d51690c585927d52bda9374e47b5">uscxml::LuaDataModel::evalAsBool</a></div><div class="ttdeci">virtual bool evalAsBool(const std::string &amp;expr)</div><div class="ttdoc">Evaluate a given expression as a boolean. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:477</div></div>
+<div class="ttc" id="classuscxml_1_1_lua_data_model_html_a47f07d7e4ddf50b3f06bd4403c14aaf4"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#a47f07d7e4ddf50b3f06bd4403c14aaf4">uscxml::LuaDataModel::setForeach</a></div><div class="ttdeci">virtual void setForeach(const std::string &amp;item, const std::string &amp;array, const std::string &amp;index, uint32_t iteration)</div><div class="ttdoc">Set a given item to the object at a given index for one iteration. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:403</div></div>
<div class="ttc" id="classuscxml_1_1_event_html"><div class="ttname"><a href="classuscxml_1_1_event.html">uscxml::Event</a></div><div class="ttdef"><b>Definition:</b> Event.h:84</div></div>
+<div class="ttc" id="classuscxml_1_1_lua_data_model_html_a4f4581f16a704dab7adf2032e86f9952"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#a4f4581f16a704dab7adf2032e86f9952">uscxml::LuaDataModel::getLength</a></div><div class="ttdeci">virtual uint32_t getLength(const std::string &amp;expr)</div><div class="ttdoc">Evaluate the given expression as something iterable and return its length. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:365</div></div>
<div class="ttc" id="classuscxml_1_1_data_model_callbacks_html"><div class="ttname"><a href="classuscxml_1_1_data_model_callbacks.html">uscxml::DataModelCallbacks</a></div><div class="ttdoc">Callbacks available for every data-model. </div><div class="ttdef"><b>Definition:</b> DataModelImpl.h:44</div></div>
<div class="ttc" id="classuscxml_1_1_lua_data_model_html_a387f5d60474bf5dbcd52e7a600dc0765"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#a387f5d60474bf5dbcd52e7a600dc0765">uscxml::LuaDataModel::init</a></div><div class="ttdeci">virtual void init(const std::string &amp;location, const Data &amp;data)</div><div class="ttdoc">Initialize a variable / location in the data-model with a given data object. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:472</div></div>
<div class="ttc" id="classuscxml_1_1_lua_data_model_html_a6be27f1c53558dfe3b3871f31ece79a1"><div class="ttname"><a href="classuscxml_1_1_lua_data_model.html#a6be27f1c53558dfe3b3871f31ece79a1">uscxml::LuaDataModel::getAsData</a></div><div class="ttdeci">virtual Data getAsData(const std::string &amp;content)</div><div class="ttdoc">Return a string as an unevaluated Data object. </div><div class="ttdef"><b>Definition:</b> LuaDataModel.cpp:493</div></div>
@@ -199,7 +203,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div>
</div>
<!-- <hr class="footer"/><address class="footer"><small>
-Generated on Thu May 19 2016 14:56:46 for uSCXML by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Mon May 23 2016 08:47:44 for uSCXML by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address> -->