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>CPVCmnCmdResp 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>CPVCmnCmdResp Class Reference</h1><code>#include <<a class="el" href="pv__common__types_8h-source.html">pv_common_types.h</a>></code> 10 <p> 11 <p>Inheritance diagram for CPVCmnCmdResp: 12 <p><center><img src="classCPVCmnCmdResp.png" usemap="#CPVCmnCmdResp_map" border="0" alt=""></center> 13 <map name="CPVCmnCmdResp_map"> 14 <area href="classCPVCmnInterfaceObserverMessage.html" alt="CPVCmnInterfaceObserverMessage" shape="rect" coords="0,0,218,24"> 15 </map> 16 <table border=0 cellpadding=0 cellspacing=0> 17 <tr><td></td></tr> 18 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 19 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a0">CPVCmnCmdResp</a> (<a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a> aType, <a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a> aId, void *aContext, <a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a> aStatus, void *aResponseData=NULL, int aResponseDataSize=0, <a class="el" href="pv__common__types_8h.html#a7">TPVCmnResponseType</a> aResponseType=NULL)</td></tr> 20 <tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a> </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a1">GetCmdType</a> () const</td></tr> 21 <tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a> </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a2">GetCmdId</a> () const</td></tr> 22 <tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a3">GetContext</a> () const</td></tr> 23 <tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a> </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a4">GetCmdStatus</a> () const</td></tr> 24 <tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a5">GetResponseData</a> () const</td></tr> 25 <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a6">GetResponseDataSize</a> () const</td></tr> 26 <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> 27 <tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a> </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n0">iCmdType</a></td></tr> 28 <tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a> </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n1">iCmdId</a></td></tr> 29 <tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n2">iContext</a></td></tr> 30 <tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a> </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n3">iStatus</a></td></tr> 31 <tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n4">iResponseData</a></td></tr> 32 <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n5">iResponseDataSize</a></td></tr> 33 </table> 34 <hr><h2>Constructor & Destructor Documentation</h2> 35 <a name="a0" doxytag="CPVCmnCmdResp::CPVCmnCmdResp"></a><p> 36 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 37 <tr> 38 <td class="md"> 39 <table cellpadding="0" cellspacing="0" border="0"> 40 <tr> 41 <td class="md" nowrap valign="top"> CPVCmnCmdResp::CPVCmnCmdResp </td> 42 <td class="md" valign="top">( </td> 43 <td class="md" nowrap valign="top"><a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a> </td> 44 <td class="mdname" nowrap> <em>aType</em>, </td> 45 </tr> 46 <tr> 47 <td></td> 48 <td></td> 49 <td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a> </td> 50 <td class="mdname" nowrap> <em>aId</em>, </td> 51 </tr> 52 <tr> 53 <td></td> 54 <td></td> 55 <td class="md" nowrap>void * </td> 56 <td class="mdname" nowrap> <em>aContext</em>, </td> 57 </tr> 58 <tr> 59 <td></td> 60 <td></td> 61 <td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a> </td> 62 <td class="mdname" nowrap> <em>aStatus</em>, </td> 63 </tr> 64 <tr> 65 <td></td> 66 <td></td> 67 <td class="md" nowrap>void * </td> 68 <td class="mdname" nowrap> <em>aResponseData</em> = NULL, </td> 69 </tr> 70 <tr> 71 <td></td> 72 <td></td> 73 <td class="md" nowrap>int </td> 74 <td class="mdname" nowrap> <em>aResponseDataSize</em> = 0, </td> 75 </tr> 76 <tr> 77 <td></td> 78 <td></td> 79 <td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a7">TPVCmnResponseType</a> </td> 80 <td class="mdname" nowrap> <em>aResponseType</em> = NULL</td> 81 </tr> 82 <tr> 83 <td></td> 84 <td class="md">) </td> 85 <td class="md" colspan="2"><code> [inline]</code></td> 86 </tr> 87 88 </table> 89 </td> 90 </tr> 91 </table> 92 <table cellspacing=5 cellpadding=0 border=0> 93 <tr> 94 <td> 95 96 </td> 97 <td> 98 99 <p> 100 Constructor for CPVCmnCmdResp </td> 101 </tr> 102 </table> 103 <hr><h2>Member Function Documentation</h2> 104 <a name="a2" doxytag="CPVCmnCmdResp::GetCmdId"></a><p> 105 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 106 <tr> 107 <td class="md"> 108 <table cellpadding="0" cellspacing="0" border="0"> 109 <tr> 110 <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a> CPVCmnCmdResp::GetCmdId </td> 111 <td class="md" valign="top">( </td> 112 <td class="mdname1" valign="top" nowrap> </td> 113 <td class="md" valign="top">) </td> 114 <td class="md" nowrap> const<code> [inline]</code></td> 115 </tr> 116 117 </table> 118 </td> 119 </tr> 120 </table> 121 <table cellspacing=5 cellpadding=0 border=0> 122 <tr> 123 <td> 124 125 </td> 126 <td> 127 128 <p> 129 <dl compact><dt><b>Returns: </b></dt><dd> 130 Returns the unique ID associated with a command of this type. </dl> </td> 131 </tr> 132 </table> 133 <a name="a4" doxytag="CPVCmnCmdResp::GetCmdStatus"></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"> <a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a> CPVCmnCmdResp::GetCmdStatus </td> 140 <td class="md" valign="top">( </td> 141 <td class="mdname1" valign="top" nowrap> </td> 142 <td class="md" valign="top">) </td> 143 <td class="md" nowrap> const<code> [inline]</code></td> 144 </tr> 145 146 </table> 147 </td> 148 </tr> 149 </table> 150 <table cellspacing=5 cellpadding=0 border=0> 151 <tr> 152 <td> 153 154 </td> 155 <td> 156 157 <p> 158 <dl compact><dt><b>Returns: </b></dt><dd> 159 Returns the completion status of the command </dl> </td> 160 </tr> 161 </table> 162 <a name="a1" doxytag="CPVCmnCmdResp::GetCmdType"></a><p> 163 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 164 <tr> 165 <td class="md"> 166 <table cellpadding="0" cellspacing="0" border="0"> 167 <tr> 168 <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a> CPVCmnCmdResp::GetCmdType </td> 169 <td class="md" valign="top">( </td> 170 <td class="mdname1" valign="top" nowrap> </td> 171 <td class="md" valign="top">) </td> 172 <td class="md" nowrap> const<code> [inline]</code></td> 173 </tr> 174 175 </table> 176 </td> 177 </tr> 178 </table> 179 <table cellspacing=5 cellpadding=0 border=0> 180 <tr> 181 <td> 182 183 </td> 184 <td> 185 186 <p> 187 <dl compact><dt><b>Returns: </b></dt><dd> 188 Returns the command type that is being completed. </dl> </td> 189 </tr> 190 </table> 191 <a name="a3" doxytag="CPVCmnCmdResp::GetContext"></a><p> 192 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 193 <tr> 194 <td class="md"> 195 <table cellpadding="0" cellspacing="0" border="0"> 196 <tr> 197 <td class="md" nowrap valign="top"> void* CPVCmnCmdResp::GetContext </td> 198 <td class="md" valign="top">( </td> 199 <td class="mdname1" valign="top" nowrap> </td> 200 <td class="md" valign="top">) </td> 201 <td class="md" nowrap> const<code> [inline]</code></td> 202 </tr> 203 204 </table> 205 </td> 206 </tr> 207 </table> 208 <table cellspacing=5 cellpadding=0 border=0> 209 <tr> 210 <td> 211 212 </td> 213 <td> 214 215 <p> 216 <dl compact><dt><b>Returns: </b></dt><dd> 217 Returns the opaque data that was passed in with the command. </dl> </td> 218 </tr> 219 </table> 220 <a name="a5" doxytag="CPVCmnCmdResp::GetResponseData"></a><p> 221 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 222 <tr> 223 <td class="md"> 224 <table cellpadding="0" cellspacing="0" border="0"> 225 <tr> 226 <td class="md" nowrap valign="top"> void* CPVCmnCmdResp::GetResponseData </td> 227 <td class="md" valign="top">( </td> 228 <td class="mdname1" valign="top" nowrap> </td> 229 <td class="md" valign="top">) </td> 230 <td class="md" nowrap> const<code> [inline]</code></td> 231 </tr> 232 233 </table> 234 </td> 235 </tr> 236 </table> 237 <table cellspacing=5 cellpadding=0 border=0> 238 <tr> 239 <td> 240 241 </td> 242 <td> 243 244 <p> 245 <dl compact><dt><b>Returns: </b></dt><dd> 246 Returns additional data asociated with the command. This is to be interpreted based on the command type and the return status </dl> </td> 247 </tr> 248 </table> 249 <a name="a6" doxytag="CPVCmnCmdResp::GetResponseDataSize"></a><p> 250 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 251 <tr> 252 <td class="md"> 253 <table cellpadding="0" cellspacing="0" border="0"> 254 <tr> 255 <td class="md" nowrap valign="top"> int CPVCmnCmdResp::GetResponseDataSize </td> 256 <td class="md" valign="top">( </td> 257 <td class="mdname1" valign="top" nowrap> </td> 258 <td class="md" valign="top">) </td> 259 <td class="md" nowrap> const<code> [inline]</code></td> 260 </tr> 261 262 </table> 263 </td> 264 </tr> 265 </table> 266 <table cellspacing=5 cellpadding=0 border=0> 267 <tr> 268 <td> 269 270 </td> 271 <td> 272 273 <p> 274 </td> 275 </tr> 276 </table> 277 <hr><h2>Field Documentation</h2> 278 <a name="n1" doxytag="CPVCmnCmdResp::iCmdId"></a><p> 279 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 280 <tr> 281 <td class="md"> 282 <table cellpadding="0" cellspacing="0" border="0"> 283 <tr> 284 <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a> CPVCmnCmdResp::iCmdId<code> [protected]</code> 285 </table> 286 </td> 287 </tr> 288 </table> 289 <table cellspacing=5 cellpadding=0 border=0> 290 <tr> 291 <td> 292 293 </td> 294 <td> 295 296 <p> 297 </td> 298 </tr> 299 </table> 300 <a name="n0" doxytag="CPVCmnCmdResp::iCmdType"></a><p> 301 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 302 <tr> 303 <td class="md"> 304 <table cellpadding="0" cellspacing="0" border="0"> 305 <tr> 306 <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a> CPVCmnCmdResp::iCmdType<code> [protected]</code> 307 </table> 308 </td> 309 </tr> 310 </table> 311 <table cellspacing=5 cellpadding=0 border=0> 312 <tr> 313 <td> 314 315 </td> 316 <td> 317 318 <p> 319 </td> 320 </tr> 321 </table> 322 <a name="n2" doxytag="CPVCmnCmdResp::iContext"></a><p> 323 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 324 <tr> 325 <td class="md"> 326 <table cellpadding="0" cellspacing="0" border="0"> 327 <tr> 328 <td class="md" nowrap valign="top"> void* CPVCmnCmdResp::iContext<code> [protected]</code> 329 </table> 330 </td> 331 </tr> 332 </table> 333 <table cellspacing=5 cellpadding=0 border=0> 334 <tr> 335 <td> 336 337 </td> 338 <td> 339 340 <p> 341 </td> 342 </tr> 343 </table> 344 <a name="n4" doxytag="CPVCmnCmdResp::iResponseData"></a><p> 345 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 346 <tr> 347 <td class="md"> 348 <table cellpadding="0" cellspacing="0" border="0"> 349 <tr> 350 <td class="md" nowrap valign="top"> void* CPVCmnCmdResp::iResponseData<code> [protected]</code> 351 </table> 352 </td> 353 </tr> 354 </table> 355 <table cellspacing=5 cellpadding=0 border=0> 356 <tr> 357 <td> 358 359 </td> 360 <td> 361 362 <p> 363 </td> 364 </tr> 365 </table> 366 <a name="n5" doxytag="CPVCmnCmdResp::iResponseDataSize"></a><p> 367 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 368 <tr> 369 <td class="md"> 370 <table cellpadding="0" cellspacing="0" border="0"> 371 <tr> 372 <td class="md" nowrap valign="top"> int CPVCmnCmdResp::iResponseDataSize<code> [protected]</code> 373 </table> 374 </td> 375 </tr> 376 </table> 377 <table cellspacing=5 cellpadding=0 border=0> 378 <tr> 379 <td> 380 381 </td> 382 <td> 383 384 <p> 385 </td> 386 </tr> 387 </table> 388 <a name="n3" doxytag="CPVCmnCmdResp::iStatus"></a><p> 389 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 390 <tr> 391 <td class="md"> 392 <table cellpadding="0" cellspacing="0" border="0"> 393 <tr> 394 <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a> CPVCmnCmdResp::iStatus<code> [protected]</code> 395 </table> 396 </td> 397 </tr> 398 </table> 399 <table cellspacing=5 cellpadding=0 border=0> 400 <tr> 401 <td> 402 403 </td> 404 <td> 405 406 <p> 407 </td> 408 </tr> 409 </table> 410 <hr>The documentation for this class was generated from the following file:<ul> 411 <li><a class="el" href="pv__common__types_8h-source.html">pv_common_types.h</a></ul> 412 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small> 413 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 414 </small></address> 415 </body> 416 </html> 417
