doc/pvauthor_html/classPVAsyncInformationalEvent.html


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

<!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>pvauthor_engine: PVAsyncInformationalEvent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>PVAsyncInformationalEvent Class Reference</h1><!-- doxytag: class="PVAsyncInformationalEvent" -->
<p><code>#include &lt;<a class="el" href="pv__engine__observer__message_8h_source.html">pv_engine_observer_message.h</a>&gt;</code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVAsyncInformationalEvent.html#acde06a99773d42f452df90e4f78ca882">PVAsyncInformationalEvent</a> (<a class="el" href="pv__engine__types_8h.html#a11755c9f630c2066f61382f19c2f9e60">PVEventType</a> aEventType, <a class="el" href="pv__engine__types_8h.html#a0c33c0578acec3116c269ae9c548978a">PVExclusivePtr</a> aEventData=NULL, uint8 *aLocalBuffer=NULL, int32 aLocalBufferSize=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVAsyncInformationalEvent.html#a1f97ba6d1fb659cf200d17a08fafdf3f">PVAsyncInformationalEvent</a> (<a class="el" href="pv__engine__types_8h.html#a11755c9f630c2066f61382f19c2f9e60">PVEventType</a> aEventType, OsclAny *aContext, PVInterface *aEventExtInterface, <a class="el" href="pv__engine__types_8h.html#a0c33c0578acec3116c269ae9c548978a">PVExclusivePtr</a> aEventData=NULL, uint8 *aLocalBuffer=NULL, int32 aLocalBufferSize=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVAsyncInformationalEvent.html#a301c5bee7effc82a3a22edcaa90d1297">~PVAsyncInformationalEvent</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="pv__engine__types_8h.html#a915d2539a1a25d7d22f55be58fa17fba">PVResponseType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVAsyncInformationalEvent.html#a739b3ba75ee8ba79eedc8c71f4ed6ac7">GetResponseType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="pv__engine__types_8h.html#a11755c9f630c2066f61382f19c2f9e60">PVEventType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVAsyncInformationalEvent.html#ae4d1304f8ea1d24c6998ca8aaac367ac">GetEventType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVAsyncInformationalEvent.html#a7224824a02f7d3015b4dd0cafbd67e53">GetEventData</a> (<a class="el" href="pv__engine__types_8h.html#a0c33c0578acec3116c269ae9c548978a">PVExclusivePtr</a> &amp;aPtr) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classPVAsyncInformationalEvent.html">PVAsyncInformationalEvent</a> Class</p>
<p><a class="el" href="classPVAsyncInformationalEvent.html">PVAsyncInformationalEvent</a> is used to pass unsolicited informational indications to the user. Additional information can be tagged based on the specific event </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acde06a99773d42f452df90e4f78ca882"></a><!-- doxytag: member="PVAsyncInformationalEvent::PVAsyncInformationalEvent" ref="acde06a99773d42f452df90e4f78ca882" args="(PVEventType aEventType, PVExclusivePtr aEventData=NULL, uint8 *aLocalBuffer=NULL, int32 aLocalBufferSize=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PVAsyncInformationalEvent::PVAsyncInformationalEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="pv__engine__types_8h.html#a11755c9f630c2066f61382f19c2f9e60">PVEventType</a>&nbsp;</td>
          <td class="paramname"> <em>aEventType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="pv__engine__types_8h.html#a0c33c0578acec3116c269ae9c548978a">PVExclusivePtr</a>&nbsp;</td>
          <td class="paramname"> <em>aEventData</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8 *&nbsp;</td>
          <td class="paramname"> <em>aLocalBuffer</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32&nbsp;</td>
          <td class="paramname"> <em>aLocalBufferSize</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor for <a class="el" href="classPVAsyncInformationalEvent.html">PVAsyncInformationalEvent</a> </p>

</div>
</div>
<a class="anchor" id="a1f97ba6d1fb659cf200d17a08fafdf3f"></a><!-- doxytag: member="PVAsyncInformationalEvent::PVAsyncInformationalEvent" ref="a1f97ba6d1fb659cf200d17a08fafdf3f" args="(PVEventType aEventType, OsclAny *aContext, PVInterface *aEventExtInterface, PVExclusivePtr aEventData=NULL, uint8 *aLocalBuffer=NULL, int32 aLocalBufferSize=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PVAsyncInformationalEvent::PVAsyncInformationalEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="pv__engine__types_8h.html#a11755c9f630c2066f61382f19c2f9e60">PVEventType</a>&nbsp;</td>
          <td class="paramname"> <em>aEventType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">OsclAny *&nbsp;</td>
          <td class="paramname"> <em>aContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PVInterface *&nbsp;</td>
          <td class="paramname"> <em>aEventExtInterface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="pv__engine__types_8h.html#a0c33c0578acec3116c269ae9c548978a">PVExclusivePtr</a>&nbsp;</td>
          <td class="paramname"> <em>aEventData</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8 *&nbsp;</td>
          <td class="paramname"> <em>aLocalBuffer</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32&nbsp;</td>
          <td class="paramname"> <em>aLocalBufferSize</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor with context and event extension interface </p>

</div>
</div>
<a class="anchor" id="a301c5bee7effc82a3a22edcaa90d1297"></a><!-- doxytag: member="PVAsyncInformationalEvent::~PVAsyncInformationalEvent" ref="a301c5bee7effc82a3a22edcaa90d1297" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PVAsyncInformationalEvent::~PVAsyncInformationalEvent </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7224824a02f7d3015b4dd0cafbd67e53"></a><!-- doxytag: member="PVAsyncInformationalEvent::GetEventData" ref="a7224824a02f7d3015b4dd0cafbd67e53" args="(PVExclusivePtr &amp;aPtr) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PVAsyncInformationalEvent::GetEventData </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="pv__engine__types_8h.html#a0c33c0578acec3116c269ae9c548978a">PVExclusivePtr</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>aPtr</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the opaque data asociated with the event. </dd></dl>

</div>
</div>
<a class="anchor" id="ae4d1304f8ea1d24c6998ca8aaac367ac"></a><!-- doxytag: member="PVAsyncInformationalEvent::GetEventType" ref="ae4d1304f8ea1d24c6998ca8aaac367ac" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="pv__engine__types_8h.html#a11755c9f630c2066f61382f19c2f9e60">PVEventType</a> PVAsyncInformationalEvent::GetEventType </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the Event type that has been received </dd></dl>

</div>
</div>
<a class="anchor" id="a739b3ba75ee8ba79eedc8c71f4ed6ac7"></a><!-- doxytag: member="PVAsyncInformationalEvent::GetResponseType" ref="a739b3ba75ee8ba79eedc8c71f4ed6ac7" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="pv__engine__types_8h.html#a915d2539a1a25d7d22f55be58fa17fba">PVResponseType</a> PVAsyncInformationalEvent::GetResponseType </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>WILL BE DEPRECATED SINCE IT IS NOT BEING USED. CURRENTLY RETURNING 0. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the type of Response we get </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__engine__observer__message_8h_source.html">pv_engine_observer_message.h</a></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>