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>PVCmdResponse 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>PVCmdResponse Class Reference</h1><code>#include <<a class="el" href="pv__engine__observer__message_8h-source.html">pv_engine_observer_message.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="classPVCmdResponse.html#a0">PVCmdResponse</a> (<a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> aId, OsclAny *aContext, PVMFStatus aStatus, OsclAny *aEventData=NULL, int32 aEventDataSize=0)</td></tr> 15 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPVCmdResponse.html#a1">PVCmdResponse</a> (<a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> aId, OsclAny *aContext, PVMFStatus aStatus, PVInterface *aEventExtInterface=NULL, OsclAny *aEventData=NULL, int32 aEventDataSize=0)</td></tr> 16 <tr><td nowrap align=right valign=top><a class="el" href="pv__engine__types_8h.html#a3">PVResponseType</a> </td><td valign=bottom><a class="el" href="classPVCmdResponse.html#a2">GetResponseType</a> () const</td></tr> 17 <tr><td nowrap align=right valign=top><a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVCmdResponse.html#a3">GetCmdId</a> () const</td></tr> 18 <tr><td nowrap align=right valign=top>OsclAny * </td><td valign=bottom><a class="el" href="classPVCmdResponse.html#a4">GetContext</a> () const</td></tr> 19 <tr><td nowrap align=right valign=top>PVMFStatus </td><td valign=bottom><a class="el" href="classPVCmdResponse.html#a5">GetCmdStatus</a> () const</td></tr> 20 <tr><td nowrap align=right valign=top>OsclAny * </td><td valign=bottom><a class="el" href="classPVCmdResponse.html#a6">GetResponseData</a> () const</td></tr> 21 <tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classPVCmdResponse.html#a7">GetResponseDataSize</a> () const</td></tr> 22 </table> 23 <hr><a name="_details"></a><h2>Detailed Description</h2> 24 PVCmdResponse Class 25 <p> 26 PVCmdResponse class is used to pass completion status on previously issued commands 27 <p> 28 <hr><h2>Constructor & Destructor Documentation</h2> 29 <a name="a0" doxytag="PVCmdResponse::PVCmdResponse"></a><p> 30 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 31 <tr> 32 <td class="md"> 33 <table cellpadding="0" cellspacing="0" border="0"> 34 <tr> 35 <td class="md" nowrap valign="top"> PVCmdResponse::PVCmdResponse </td> 36 <td class="md" valign="top">( </td> 37 <td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td> 38 <td class="mdname" nowrap> <em>aId</em>, </td> 39 </tr> 40 <tr> 41 <td></td> 42 <td></td> 43 <td class="md" nowrap>OsclAny * </td> 44 <td class="mdname" nowrap> <em>aContext</em>, </td> 45 </tr> 46 <tr> 47 <td></td> 48 <td></td> 49 <td class="md" nowrap>PVMFStatus </td> 50 <td class="mdname" nowrap> <em>aStatus</em>, </td> 51 </tr> 52 <tr> 53 <td></td> 54 <td></td> 55 <td class="md" nowrap>OsclAny * </td> 56 <td class="mdname" nowrap> <em>aEventData</em> = NULL, </td> 57 </tr> 58 <tr> 59 <td></td> 60 <td></td> 61 <td class="md" nowrap>int32 </td> 62 <td class="mdname" nowrap> <em>aEventDataSize</em> = 0</td> 63 </tr> 64 <tr> 65 <td></td> 66 <td class="md">) </td> 67 <td class="md" colspan="2"><code> [inline]</code></td> 68 </tr> 69 70 </table> 71 </td> 72 </tr> 73 </table> 74 <table cellspacing=5 cellpadding=0 border=0> 75 <tr> 76 <td> 77 78 </td> 79 <td> 80 81 <p> 82 Constructor for PVCmdResponse </td> 83 </tr> 84 </table> 85 <a name="a1" doxytag="PVCmdResponse::PVCmdResponse"></a><p> 86 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 87 <tr> 88 <td class="md"> 89 <table cellpadding="0" cellspacing="0" border="0"> 90 <tr> 91 <td class="md" nowrap valign="top"> PVCmdResponse::PVCmdResponse </td> 92 <td class="md" valign="top">( </td> 93 <td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td> 94 <td class="mdname" nowrap> <em>aId</em>, </td> 95 </tr> 96 <tr> 97 <td></td> 98 <td></td> 99 <td class="md" nowrap>OsclAny * </td> 100 <td class="mdname" nowrap> <em>aContext</em>, </td> 101 </tr> 102 <tr> 103 <td></td> 104 <td></td> 105 <td class="md" nowrap>PVMFStatus </td> 106 <td class="mdname" nowrap> <em>aStatus</em>, </td> 107 </tr> 108 <tr> 109 <td></td> 110 <td></td> 111 <td class="md" nowrap>PVInterface * </td> 112 <td class="mdname" nowrap> <em>aEventExtInterface</em> = NULL, </td> 113 </tr> 114 <tr> 115 <td></td> 116 <td></td> 117 <td class="md" nowrap>OsclAny * </td> 118 <td class="mdname" nowrap> <em>aEventData</em> = NULL, </td> 119 </tr> 120 <tr> 121 <td></td> 122 <td></td> 123 <td class="md" nowrap>int32 </td> 124 <td class="mdname" nowrap> <em>aEventDataSize</em> = 0</td> 125 </tr> 126 <tr> 127 <td></td> 128 <td class="md">) </td> 129 <td class="md" colspan="2"><code> [inline]</code></td> 130 </tr> 131 132 </table> 133 </td> 134 </tr> 135 </table> 136 <table cellspacing=5 cellpadding=0 border=0> 137 <tr> 138 <td> 139 140 </td> 141 <td> 142 143 <p> 144 Constructor with event extension interface </td> 145 </tr> 146 </table> 147 <hr><h2>Member Function Documentation</h2> 148 <a name="a3" doxytag="PVCmdResponse::GetCmdId"></a><p> 149 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 150 <tr> 151 <td class="md"> 152 <table cellpadding="0" cellspacing="0" border="0"> 153 <tr> 154 <td class="md" nowrap valign="top"> <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVCmdResponse::GetCmdId </td> 155 <td class="md" valign="top">( </td> 156 <td class="mdname1" valign="top" nowrap> </td> 157 <td class="md" valign="top">) </td> 158 <td class="md" nowrap> const<code> [inline]</code></td> 159 </tr> 160 161 </table> 162 </td> 163 </tr> 164 </table> 165 <table cellspacing=5 cellpadding=0 border=0> 166 <tr> 167 <td> 168 169 </td> 170 <td> 171 172 <p> 173 <dl compact><dt><b>Returns: </b></dt><dd> 174 Returns the unique ID associated with a command of this type. </dl> </td> 175 </tr> 176 </table> 177 <a name="a5" doxytag="PVCmdResponse::GetCmdStatus"></a><p> 178 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 179 <tr> 180 <td class="md"> 181 <table cellpadding="0" cellspacing="0" border="0"> 182 <tr> 183 <td class="md" nowrap valign="top"> PVMFStatus PVCmdResponse::GetCmdStatus </td> 184 <td class="md" valign="top">( </td> 185 <td class="mdname1" valign="top" nowrap> </td> 186 <td class="md" valign="top">) </td> 187 <td class="md" nowrap> const<code> [inline]</code></td> 188 </tr> 189 190 </table> 191 </td> 192 </tr> 193 </table> 194 <table cellspacing=5 cellpadding=0 border=0> 195 <tr> 196 <td> 197 198 </td> 199 <td> 200 201 <p> 202 <dl compact><dt><b>Returns: </b></dt><dd> 203 Returns the completion status of the command </dl> </td> 204 </tr> 205 </table> 206 <a name="a4" doxytag="PVCmdResponse::GetContext"></a><p> 207 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 208 <tr> 209 <td class="md"> 210 <table cellpadding="0" cellspacing="0" border="0"> 211 <tr> 212 <td class="md" nowrap valign="top"> OsclAny* PVCmdResponse::GetContext </td> 213 <td class="md" valign="top">( </td> 214 <td class="mdname1" valign="top" nowrap> </td> 215 <td class="md" valign="top">) </td> 216 <td class="md" nowrap> const<code> [inline]</code></td> 217 </tr> 218 219 </table> 220 </td> 221 </tr> 222 </table> 223 <table cellspacing=5 cellpadding=0 border=0> 224 <tr> 225 <td> 226 227 </td> 228 <td> 229 230 <p> 231 <dl compact><dt><b>Returns: </b></dt><dd> 232 Returns the opaque data that was passed in with the command. </dl> </td> 233 </tr> 234 </table> 235 <a name="a6" doxytag="PVCmdResponse::GetResponseData"></a><p> 236 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 237 <tr> 238 <td class="md"> 239 <table cellpadding="0" cellspacing="0" border="0"> 240 <tr> 241 <td class="md" nowrap valign="top"> OsclAny* PVCmdResponse::GetResponseData </td> 242 <td class="md" valign="top">( </td> 243 <td class="mdname1" valign="top" nowrap> </td> 244 <td class="md" valign="top">) </td> 245 <td class="md" nowrap> const<code> [inline]</code></td> 246 </tr> 247 248 </table> 249 </td> 250 </tr> 251 </table> 252 <table cellspacing=5 cellpadding=0 border=0> 253 <tr> 254 <td> 255 256 </td> 257 <td> 258 259 <p> 260 WILL BE DEPRECATED WHEN PVMFCmdResp REMOVES EVENT DATA <dl compact><dt><b>Returns: </b></dt><dd> 261 Returns additional data asociated with the command. This is to be interpreted based on the command issued and the return status </dl> </td> 262 </tr> 263 </table> 264 <a name="a7" doxytag="PVCmdResponse::GetResponseDataSize"></a><p> 265 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 266 <tr> 267 <td class="md"> 268 <table cellpadding="0" cellspacing="0" border="0"> 269 <tr> 270 <td class="md" nowrap valign="top"> int32 PVCmdResponse::GetResponseDataSize </td> 271 <td class="md" valign="top">( </td> 272 <td class="mdname1" valign="top" nowrap> </td> 273 <td class="md" valign="top">) </td> 274 <td class="md" nowrap> const<code> [inline]</code></td> 275 </tr> 276 277 </table> 278 </td> 279 </tr> 280 </table> 281 <table cellspacing=5 cellpadding=0 border=0> 282 <tr> 283 <td> 284 285 </td> 286 <td> 287 288 <p> 289 </td> 290 </tr> 291 </table> 292 <a name="a2" doxytag="PVCmdResponse::GetResponseType"></a><p> 293 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 294 <tr> 295 <td class="md"> 296 <table cellpadding="0" cellspacing="0" border="0"> 297 <tr> 298 <td class="md" nowrap valign="top"> <a class="el" href="pv__engine__types_8h.html#a3">PVResponseType</a> PVCmdResponse::GetResponseType </td> 299 <td class="md" valign="top">( </td> 300 <td class="mdname1" valign="top" nowrap> </td> 301 <td class="md" valign="top">) </td> 302 <td class="md" nowrap> const<code> [inline]</code></td> 303 </tr> 304 305 </table> 306 </td> 307 </tr> 308 </table> 309 <table cellspacing=5 cellpadding=0 border=0> 310 <tr> 311 <td> 312 313 </td> 314 <td> 315 316 <p> 317 WILL BE DEPRECATED SINCE IT IS NOT BEING USED. CURRENTLY RETURNS 0 <dl compact><dt><b>Returns: </b></dt><dd> 318 Returns the type of Response we get </dl> </td> 319 </tr> 320 </table> 321 <hr>The documentation for this class was generated from the following file:<ul> 322 <li><a class="el" href="pv__engine__observer__message_8h-source.html">pv_engine_observer_message.h</a></ul> 323 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small> 324 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 325 </small></address> 326 </body> 327 </html> 328
