1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
<!-- 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: plugins/DataModelImpl.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File 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"><a class="el" href="dir_38c8d24aef3972a7f87b834274e76e31.html">plugins</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">DataModelImpl.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_data_model_impl_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef DATAMODELIMPL_H_5A33C087</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define DATAMODELIMPL_H_5A33C087</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "uscxml/config.h"</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="_common_8h.html">uscxml/Common.h</a>"</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="_invoker_8h.html">uscxml/plugins/Invoker.h</a>"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="_i_o_processor_8h.html">uscxml/plugins/IOProcessor.h</a>"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <xercesc/dom/DOM.hpp></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <list></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <memory></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span><a class="code" href="namespaceuscxml.html">uscxml</a> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>InterpreterImpl;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>DataModelImpl;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classuscxml_1_1_data_model_callbacks.html"> 44</a></span> <span class="keyword">class </span>USCXML_API <a class="code" href="classuscxml_1_1_data_model_callbacks.html">DataModelCallbacks</a> {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& getName() = 0;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& getSessionId() = 0;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::map<std::string, IOProcessor>& getIOProcessors() = 0;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isInState(<span class="keyword">const</span> std::string& stateId) = 0;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> XERCESC_NS::DOMDocument* getDocument() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::map<std::string, Invoker>& getInvokers() = 0;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> };</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classuscxml_1_1_data_model_extension.html"> 54</a></span> <span class="keyword">class </span>USCXML_API <a class="code" href="classuscxml_1_1_data_model_extension.html">DataModelExtension</a> {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classuscxml_1_1_data_model_extension.html">DataModelExtension</a>() : dm(NULL) {}</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> ~<a class="code" href="classuscxml_1_1_data_model_extension.html">DataModelExtension</a>() {}</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> std::string provides() = 0;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">virtual</span> <a class="code" href="classuscxml_1_1_data.html">Data</a> getValueOf(<span class="keyword">const</span> std::string& member) = 0;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setValueOf(<span class="keyword">const</span> std::string& member, <span class="keyword">const</span> <a class="code" href="classuscxml_1_1_data.html">Data</a>& data) = 0;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classuscxml_1_1_data_model_impl.html">DataModelImpl</a>* dm;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> };</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classuscxml_1_1_data_model_impl.html"> 69</a></span> <span class="keyword">class </span>USCXML_API <a class="code" href="classuscxml_1_1_data_model_impl.html">DataModelImpl</a> {</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">virtual</span> ~<a class="code" href="classuscxml_1_1_data_model_impl.html">DataModelImpl</a>() {}</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">virtual</span> std::shared_ptr<DataModelImpl> create(<a class="code" href="classuscxml_1_1_data_model_callbacks.html">DataModelCallbacks</a>* callbacks) = 0;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">virtual</span> std::list<std::string> getNames() = 0;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classuscxml_1_1_data_model_impl.html#a6758e7946232dce852814d71886b1078"> 95</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classuscxml_1_1_data_model_impl.html#a6758e7946232dce852814d71886b1078">isValidSyntax</a>(<span class="keyword">const</span> std::string& expr) {</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>; <span class="comment">// overwrite when datamodel supports it</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setEvent(<span class="keyword">const</span> <a class="code" href="classuscxml_1_1_event.html">Event</a>& event) = 0;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">size_t</span> replaceExpressions(std::string& content);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// foreach</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">virtual</span> uint32_t getLength(<span class="keyword">const</span> std::string& expr) = 0;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setForeach(<span class="keyword">const</span> std::string& item,</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">const</span> std::string& array,</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">const</span> std::string& index,</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  uint32_t iteration) = 0;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">virtual</span> <a class="code" href="classuscxml_1_1_data.html">Data</a> getAsData(<span class="keyword">const</span> std::string& content) = 0;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">virtual</span> <a class="code" href="classuscxml_1_1_data.html">Data</a> evalAsData(<span class="keyword">const</span> std::string& content) = 0;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> evalAsBool(<span class="keyword">const</span> std::string& expr) = 0;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isDeclared(<span class="keyword">const</span> std::string& expr) = 0;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> assign(<span class="keyword">const</span> std::string& location, <span class="keyword">const</span> <a class="code" href="classuscxml_1_1_data.html">Data</a>& data) = 0;</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> init(<span class="keyword">const</span> std::string& location, <span class="keyword">const</span> <a class="code" href="classuscxml_1_1_data.html">Data</a>& data) = 0;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <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="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">virtual</span> std::string andExpressions(std::list<std::string>) {</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordflow">return</span> <span class="stringliteral">""</span>;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  }</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  DataModelCallbacks* _callbacks;</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> };</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> }</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="preprocessor">#endif </span><span class="comment">/* end of include guard: DATAMODELIMPL_H_5A33C087 */</span><span class="preprocessor"></span></div>
<div class="ttc" id="_i_o_processor_8h_html"><div class="ttname"><a href="_i_o_processor_8h.html">IOProcessor.h</a></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="_invoker_8h_html"><div class="ttname"><a href="_invoker_8h.html">Invoker.h</a></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="_common_8h_html"><div class="ttname"><a href="_common_8h.html">Common.h</a></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_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_data_model_impl_html_a6758e7946232dce852814d71886b1078"><div class="ttname"><a href="classuscxml_1_1_data_model_impl.html#a6758e7946232dce852814d71886b1078">uscxml::DataModelImpl::isValidSyntax</a></div><div class="ttdeci">virtual bool isValidSyntax(const std::string &expr)</div><div class="ttdoc">Determine whether a given string constitutes valid syntax in the data-model's language. </div><div class="ttdef"><b>Definition:</b> DataModelImpl.h:95</div></div>
<div class="ttc" id="classuscxml_1_1_data_html"><div class="ttname"><a href="classuscxml_1_1_data.html">uscxml::Data</a></div><div class="ttdef"><b>Definition:</b> Data.h:44</div></div>
</div><!-- fragment --></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 Thu May 19 2016 10:34:09 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>
|
