doc/pvauthor_html/classPVEngineAsyncEvent.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

<!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: PVEngineAsyncEvent 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>PVEngineAsyncEvent Class Reference</h1><!-- doxytag: class="PVEngineAsyncEvent" -->
<p><code>#include &lt;<a class="el" href="pv__engine__types_8h_source.html">pv_engine_types.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="classPVEngineAsyncEvent.html#a20a2590222b5ec67d1085d9a0815830d">PVEngineAsyncEvent</a> (int32 aAsyncEventType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVEngineAsyncEvent.html#a787b5843e0834e1639df9fcf196d4e8c">PVEngineAsyncEvent</a> (const <a class="el" href="classPVEngineAsyncEvent.html">PVEngineAsyncEvent</a> &amp;aAsyncEvent)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVEngineAsyncEvent.html#a05216778c0a9b3ec37406045a2e1b08d">GetAsyncEventType</a> () const </td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVEngineAsyncEvent.html#afd1b33472ac42d2dba088009c82f98fd">iAsyncEventType</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classPVEngineAsyncEvent.html">PVEngineAsyncEvent</a> Class</p>
<p><a class="el" href="classPVEngineAsyncEvent.html">PVEngineAsyncEvent</a> class is a data class to hold asynchronous events generated by the engine. The class is meant to be used inside the engine and not exposed to the interface layer or above. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a20a2590222b5ec67d1085d9a0815830d"></a><!-- doxytag: member="PVEngineAsyncEvent::PVEngineAsyncEvent" ref="a20a2590222b5ec67d1085d9a0815830d" args="(int32 aAsyncEventType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PVEngineAsyncEvent::PVEngineAsyncEvent </td>
          <td>(</td>
          <td class="paramtype">int32&nbsp;</td>
          <td class="paramname"> <em>aAsyncEventType</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The constructor for <a class="el" href="classPVEngineCommand.html">PVEngineCommand</a> which allows the data values to be set.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aCmdType</em>&nbsp;</td><td>The command type value for this command. The value is an engine-specific 32-bit value. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aCmdId</em>&nbsp;</td><td>The command ID assigned by the engine for this command. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aContextData</em>&nbsp;</td><td>The pointer to the passed-in context data for this command.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="a787b5843e0834e1639df9fcf196d4e8c"></a><!-- doxytag: member="PVEngineAsyncEvent::PVEngineAsyncEvent" ref="a787b5843e0834e1639df9fcf196d4e8c" args="(const PVEngineAsyncEvent &amp;aAsyncEvent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PVEngineAsyncEvent::PVEngineAsyncEvent </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPVEngineAsyncEvent.html">PVEngineAsyncEvent</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>aAsyncEvent</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The copy constructor for <a class="el" href="classPVEngineAsyncEvent.html">PVEngineAsyncEvent</a>. Used mainly for Oscl_Vector.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aAsyncEvent</em>&nbsp;</td><td>The reference to the source <a class="el" href="classPVEngineAsyncEvent.html">PVEngineAsyncEvent</a> to copy the data values from.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None </dd></dl>

<p>References <a class="el" href="pv__engine__types_8h_source.html#l00249">iAsyncEventType</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a05216778c0a9b3ec37406045a2e1b08d"></a><!-- doxytag: member="PVEngineAsyncEvent::GetAsyncEventType" ref="a05216778c0a9b3ec37406045a2e1b08d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32 PVEngineAsyncEvent::GetAsyncEventType </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This function returns the stored asynchronous event type value.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The signed 32-bit event type value. </dd></dl>

<p>References <a class="el" href="pv__engine__types_8h_source.html#l00249">iAsyncEventType</a>.</p>

</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="afd1b33472ac42d2dba088009c82f98fd"></a><!-- doxytag: member="PVEngineAsyncEvent::iAsyncEventType" ref="afd1b33472ac42d2dba088009c82f98fd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32 <a class="el" href="classPVEngineAsyncEvent.html#afd1b33472ac42d2dba088009c82f98fd">PVEngineAsyncEvent::iAsyncEventType</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Referenced by <a class="el" href="pv__engine__types_8h_source.html#l00244">GetAsyncEventType()</a>, and <a class="el" href="pv__engine__types_8h_source.html#l00234">PVEngineAsyncEvent()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__engine__types_8h_source.html">pv_engine_types.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.002.1.1 </small>
</small></address>
</body>
</html>