1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3 <title>PVEngineAsyncEvent class Reference</title> 4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 </head><body> 6 <!-- Generated by Doxygen 1.2.18 --> 7 <center> 8 <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9 <hr><h1>PVEngineAsyncEvent Class Reference</h1><code>#include <<a class="el" href="pv__engine__types_8h-source.html">pv_engine_types.h</a>></code> 10 <p> 11 <table border=0 cellpadding=0 cellspacing=0> 12 <tr><td></td></tr> 13 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 14 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPVEngineAsyncEvent.html#a0">PVEngineAsyncEvent</a> (int32 aAsyncEventType)</td></tr> 15 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPVEngineAsyncEvent.html#a1">PVEngineAsyncEvent</a> (const PVEngineAsyncEvent &aAsyncEvent)</td></tr> 16 <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classPVEngineAsyncEvent.html#a2">GetAsyncEventType</a> () const</td></tr> 17 <tr><td colspan=2><br><h2>Data Fields</h2></td></tr> 18 <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classPVEngineAsyncEvent.html#m0">iAsyncEventType</a></td></tr> 19 </table> 20 <hr><a name="_details"></a><h2>Detailed Description</h2> 21 PVEngineAsyncEvent Class 22 <p> 23 PVEngineAsyncEvent 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. 24 <p> 25 <hr><h2>Constructor & Destructor Documentation</h2> 26 <a name="a0" doxytag="PVEngineAsyncEvent::PVEngineAsyncEvent"></a><p> 27 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 28 <tr> 29 <td class="md"> 30 <table cellpadding="0" cellspacing="0" border="0"> 31 <tr> 32 <td class="md" nowrap valign="top"> PVEngineAsyncEvent::PVEngineAsyncEvent </td> 33 <td class="md" valign="top">( </td> 34 <td class="md" nowrap valign="top">int32 </td> 35 <td class="mdname1" valign="top" nowrap> <em>aAsyncEventType</em> </td> 36 <td class="md" valign="top">) </td> 37 <td class="md" nowrap><code> [inline]</code></td> 38 </tr> 39 40 </table> 41 </td> 42 </tr> 43 </table> 44 <table cellspacing=5 cellpadding=0 border=0> 45 <tr> 46 <td> 47 48 </td> 49 <td> 50 51 <p> 52 The constructor for <a class="el" href="classPVEngineCommand.html">PVEngineCommand</a> which allows the data values to be set.<dl compact><dt><b>Parameters: </b></dt><dd> 53 <table border=0 cellspacing=2 cellpadding=0> 54 <tr><td valign=top><em>aCmdType</em> </td><td> 55 The command type value for this command. The value is an engine-specific 32-bit value. </td></tr> 56 <tr><td valign=top><em>aCmdId</em> </td><td> 57 The command ID assigned by the engine for this command. </td></tr> 58 <tr><td valign=top><em>aContextData</em> </td><td> 59 The pointer to the passed-in context data for this command.</td></tr> 60 </table> 61 </dl><dl compact><dt><b>Returns: </b></dt><dd> 62 None </dl> </td> 63 </tr> 64 </table> 65 <a name="a1" doxytag="PVEngineAsyncEvent::PVEngineAsyncEvent"></a><p> 66 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 67 <tr> 68 <td class="md"> 69 <table cellpadding="0" cellspacing="0" border="0"> 70 <tr> 71 <td class="md" nowrap valign="top"> PVEngineAsyncEvent::PVEngineAsyncEvent </td> 72 <td class="md" valign="top">( </td> 73 <td class="md" nowrap valign="top">const PVEngineAsyncEvent & </td> 74 <td class="mdname1" valign="top" nowrap> <em>aAsyncEvent</em> </td> 75 <td class="md" valign="top">) </td> 76 <td class="md" nowrap><code> [inline]</code></td> 77 </tr> 78 79 </table> 80 </td> 81 </tr> 82 </table> 83 <table cellspacing=5 cellpadding=0 border=0> 84 <tr> 85 <td> 86 87 </td> 88 <td> 89 90 <p> 91 The copy constructor for PVEngineAsyncEvent. Used mainly for Oscl_Vector.<dl compact><dt><b>Parameters: </b></dt><dd> 92 <table border=0 cellspacing=2 cellpadding=0> 93 <tr><td valign=top><em>aAsyncEvent</em> </td><td> 94 The reference to the source PVEngineAsyncEvent to copy the data values from.</td></tr> 95 </table> 96 </dl><dl compact><dt><b>Returns: </b></dt><dd> 97 None </dl> </td> 98 </tr> 99 </table> 100 <hr><h2>Member Function Documentation</h2> 101 <a name="a2" doxytag="PVEngineAsyncEvent::GetAsyncEventType"></a><p> 102 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 103 <tr> 104 <td class="md"> 105 <table cellpadding="0" cellspacing="0" border="0"> 106 <tr> 107 <td class="md" nowrap valign="top"> int32 PVEngineAsyncEvent::GetAsyncEventType </td> 108 <td class="md" valign="top">( </td> 109 <td class="mdname1" valign="top" nowrap> </td> 110 <td class="md" valign="top">) </td> 111 <td class="md" nowrap> const<code> [inline]</code></td> 112 </tr> 113 114 </table> 115 </td> 116 </tr> 117 </table> 118 <table cellspacing=5 cellpadding=0 border=0> 119 <tr> 120 <td> 121 122 </td> 123 <td> 124 125 <p> 126 This function returns the stored asynchronous event type value. 127 <p> 128 <dl compact><dt><b>Returns: </b></dt><dd> 129 The signed 32-bit event type value. </dl> </td> 130 </tr> 131 </table> 132 <hr><h2>Field Documentation</h2> 133 <a name="m0" doxytag="PVEngineAsyncEvent::iAsyncEventType"></a><p> 134 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 135 <tr> 136 <td class="md"> 137 <table cellpadding="0" cellspacing="0" border="0"> 138 <tr> 139 <td class="md" nowrap valign="top"> int32 PVEngineAsyncEvent::iAsyncEventType 140 </table> 141 </td> 142 </tr> 143 </table> 144 <table cellspacing=5 cellpadding=0 border=0> 145 <tr> 146 <td> 147 148 </td> 149 <td> 150 151 <p> 152 </td> 153 </tr> 154 </table> 155 <hr>The documentation for this class was generated from the following file:<ul> 156 <li><a class="el" href="pv__engine__types_8h-source.html">pv_engine_types.h</a></ul> 157 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small> 158 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 159 </small></address> 160 </body> 161 </html> 162
