summaryrefslogtreecommitdiffstats
path: root/classuscxml_1_1_event.html
blob: d75c0f347525acc02b42b766348d35f2509af629 (plain)
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<!-- 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::Event 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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_event.html">Event</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classuscxml_1_1_event-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">uscxml::Event Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for uscxml::Event:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classuscxml_1_1_event__inherit__graph.svg" width="484" 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>
<div class="dynheader">
Collaboration diagram for uscxml::Event:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classuscxml_1_1_event__coll__graph.svg" width="116" height="216"><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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a28fb3b2b9b1737aedc2aedb0ae608e40"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28fb3b2b9b1737aedc2aedb0ae608e40"></a>
typedef std::map&lt; std::string, <a class="el" href="classuscxml_1_1_data.html">Data</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>namelist_t</b></td></tr>
<tr class="separator:a28fb3b2b9b1737aedc2aedb0ae608e40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a604b939a91e84d7dc6efd31adbf141f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a604b939a91e84d7dc6efd31adbf141f0"></a>
typedef std::multimap&lt; std::string, <a class="el" href="classuscxml_1_1_data.html">Data</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>params_t</b></td></tr>
<tr class="separator:a604b939a91e84d7dc6efd31adbf141f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94992319a971532f9673ae6f150291b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94992319a971532f9673ae6f150291b5"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>Type</b> { <b>INTERNAL</b> = 1, 
<b>EXTERNAL</b> = 2, 
<b>PLATFORM</b> = 3
 }<tr class="separator:a94992319a971532f9673ae6f150291b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
</table><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:af6b8dce19efd6dcc103072347625751f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6b8dce19efd6dcc103072347625751f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Event</b> (const std::string &amp;name, Type type=INTERNAL)</td></tr>
<tr class="separator:af6b8dce19efd6dcc103072347625751f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb6b837013f38950c4f843a2378da3e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb6b837013f38950c4f843a2378da3e5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
<tr class="separator:aeb6b837013f38950c4f843a2378da3e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8973c1505ec84e9ef3d5635da959b45"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8973c1505ec84e9ef3d5635da959b45"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>operator Data</b> ()</td></tr>
<tr class="separator:af8973c1505ec84e9ef3d5635da959b45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea147106cf2ea7afb4ca1090702575b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea147106cf2ea7afb4ca1090702575b0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>operator std::string</b> ()</td></tr>
<tr class="separator:aea147106cf2ea7afb4ca1090702575b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9415bc4db32c3e9eb2402f7ae53e254"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9415bc4db32c3e9eb2402f7ae53e254"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classuscxml_1_1_event.html">Event</a> &amp;other) const </td></tr>
<tr class="separator:ad9415bc4db32c3e9eb2402f7ae53e254"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee8d5bea5f45ca20326ec5b886ab7e30"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee8d5bea5f45ca20326ec5b886ab7e30"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;</b> (const <a class="el" href="classuscxml_1_1_event.html">Event</a> &amp;other) const </td></tr>
<tr class="separator:aee8d5bea5f45ca20326ec5b886ab7e30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f5eeafb9884159fd73bbc27eea370e3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f5eeafb9884159fd73bbc27eea370e3"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classuscxml_1_1_event.html">Event</a> &amp;other) const </td></tr>
<tr class="separator:a3f5eeafb9884159fd73bbc27eea370e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a28b90134ac420b44eb585da96c5c8ffb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28b90134ac420b44eb585da96c5c8ffb"></a>
static <a class="el" href="classuscxml_1_1_event.html">Event</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fromData</b> (const <a class="el" href="classuscxml_1_1_data.html">Data</a> &amp;data)</td></tr>
<tr class="separator:a28b90134ac420b44eb585da96c5c8ffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab04c94cbb138972025ec4976db497e17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab04c94cbb138972025ec4976db497e17"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><b>getParam</b> (const params_t &amp;params, const std::string &amp;name, <a class="el" href="classuscxml_1_1_data.html">Data</a> &amp;target)</td></tr>
<tr class="separator:ab04c94cbb138972025ec4976db497e17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5887a48b6adbe688196f78a9f3d5198"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5887a48b6adbe688196f78a9f3d5198"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><b>getParam</b> (const params_t &amp;params, const std::string &amp;name, std::list&lt; <a class="el" href="classuscxml_1_1_data.html">Data</a> &gt; &amp;target)</td></tr>
<tr class="separator:ab5887a48b6adbe688196f78a9f3d5198"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bc81f812f276b7c9ecae4f808b07439"><td class="memTemplParams" colspan="2"><a class="anchor" id="a7bc81f812f276b7c9ecae4f808b07439"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a7bc81f812f276b7c9ecae4f808b07439"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>getParam</b> (const params_t &amp;params, const std::string &amp;name, T &amp;target)</td></tr>
<tr class="separator:a7bc81f812f276b7c9ecae4f808b07439"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac66a13e865ee09471f2f05672a255e5a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac66a13e865ee09471f2f05672a255e5a"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><b>getParam</b> (const params_t &amp;params, const std::string &amp;name, bool &amp;target)</td></tr>
<tr class="separator:ac66a13e865ee09471f2f05672a255e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8d9541cf3f694f81fdeea4608d88810"><td class="memTemplParams" colspan="2"><a class="anchor" id="ad8d9541cf3f694f81fdeea4608d88810"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:ad8d9541cf3f694f81fdeea4608d88810"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>getParam</b> (const params_t &amp;params, const std::string &amp;name, std::list&lt; T &gt; &amp;target)</td></tr>
<tr class="separator:ad8d9541cf3f694f81fdeea4608d88810"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a98d229534eeb71dd75f32e9e3b7346f1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98d229534eeb71dd75f32e9e3b7346f1"></a>
<a class="el" href="classuscxml_1_1_data.html">Data</a>&#160;</td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
<tr class="separator:a98d229534eeb71dd75f32e9e3b7346f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb19f8392a4e7fcaaa45462ef3871645"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb19f8392a4e7fcaaa45462ef3871645"></a>
Type&#160;</td><td class="memItemRight" valign="bottom"><b>eventType</b></td></tr>
<tr class="separator:aeb19f8392a4e7fcaaa45462ef3871645"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9f0c5d691939c783d2d94f69880b940"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9f0c5d691939c783d2d94f69880b940"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>hideSendId</b></td></tr>
<tr class="separator:ab9f0c5d691939c783d2d94f69880b940"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6dca02cac88e34c494998cade441cc7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6dca02cac88e34c494998cade441cc7"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>invokeid</b></td></tr>
<tr class="separator:ab6dca02cac88e34c494998cade441cc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0108cece5dbfe7f162dd9655c772ac70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0108cece5dbfe7f162dd9655c772ac70"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
<tr class="separator:a0108cece5dbfe7f162dd9655c772ac70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28174010aa37d38b6a596bd4dfa74f83"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28174010aa37d38b6a596bd4dfa74f83"></a>
std::map&lt; std::string, <a class="el" href="classuscxml_1_1_data.html">Data</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>namelist</b></td></tr>
<tr class="separator:a28174010aa37d38b6a596bd4dfa74f83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0a5bfd1bebdecdb9f47bfb428bd13b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0a5bfd1bebdecdb9f47bfb428bd13b5"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>origin</b></td></tr>
<tr class="separator:af0a5bfd1bebdecdb9f47bfb428bd13b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b645c7ef4172f98ed199511623f48c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b645c7ef4172f98ed199511623f48c9"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>origintype</b></td></tr>
<tr class="separator:a4b645c7ef4172f98ed199511623f48c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6b3e134f6afa9e4a6b0715919ff25a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6b3e134f6afa9e4a6b0715919ff25a4"></a>
std::multimap&lt; std::string, <a class="el" href="classuscxml_1_1_data.html">Data</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>params</b></td></tr>
<tr class="separator:aa6b3e134f6afa9e4a6b0715919ff25a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae73a91aa5afa70145ce06af15123097b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae73a91aa5afa70145ce06af15123097b"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>raw</b></td></tr>
<tr class="separator:ae73a91aa5afa70145ce06af15123097b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f396694ad7a35865e87dd3c65ba67ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f396694ad7a35865e87dd3c65ba67ca"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>sendid</b></td></tr>
<tr class="separator:a2f396694ad7a35865e87dd3c65ba67ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa62ac8859da2d418e14f5bc7690bdd72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa62ac8859da2d418e14f5bc7690bdd72"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>uuid</b></td></tr>
<tr class="separator:aa62ac8859da2d418e14f5bc7690bdd72"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a0d632a5f96e25c4cd232181661dc3b86"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d632a5f96e25c4cd232181661dc3b86"></a>
USCXML_API std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (std::ostream &amp;os, const <a class="el" href="classuscxml_1_1_event.html">Event</a> &amp;event)</td></tr>
<tr class="separator:a0d632a5f96e25c4cd232181661dc3b86"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>messages/<a class="el" href="_event_8h_source.html">Event.h</a></li>
<li>messages/<a class="el" href="_event_8cpp.html">Event.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address> -->
</body>
</html>