blob: 869b0162b19611b486ee4de2317cfe129bde908c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CPVCmnCmdResp class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>CPVCmnCmdResp Class Reference</h1><code>#include &lt;<a class="el" href="pv__common__types_8h-source.html">pv_common_types.h</a>&gt;</code>
<p>
<p>Inheritance diagram for CPVCmnCmdResp:
<p><center><img src="classCPVCmnCmdResp.png" usemap="#CPVCmnCmdResp_map" border="0" alt=""></center>
<map name="CPVCmnCmdResp_map">
<area href="classCPVCmnInterfaceObserverMessage.html" alt="CPVCmnInterfaceObserverMessage" shape="rect" coords="0,0,218,24">
</map>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</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>
<tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a>&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a1">GetCmdType</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a>&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a2">GetCmdId</a> () const</td></tr>
<tr><td nowrap align=right valign=top>void *&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a3">GetContext</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a>&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a4">GetCmdStatus</a> () const</td></tr>
<tr><td nowrap align=right valign=top>void *&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a5">GetResponseData</a> () const</td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#a6">GetResponseDataSize</a> () const</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a>&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n0">iCmdType</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a>&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n1">iCmdId</a></td></tr>
<tr><td nowrap align=right valign=top>void *&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n2">iContext</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a>&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n3">iStatus</a></td></tr>
<tr><td nowrap align=right valign=top>void *&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n4">iResponseData</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnCmdResp.html#n5">iResponseDataSize</a></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="CPVCmnCmdResp::CPVCmnCmdResp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CPVCmnCmdResp::CPVCmnCmdResp </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aType</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aId</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>void *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aContext</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aStatus</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>void *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aResponseData</em> = NULL, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aResponseDataSize</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a7">TPVCmnResponseType</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aResponseType</em> = NULL</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor for CPVCmnCmdResp </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="CPVCmnCmdResp::GetCmdId"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a> CPVCmnCmdResp::GetCmdId </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Returns the unique ID associated with a command of this type. </dl> </td>
</tr>
</table>
<a name="a4" doxytag="CPVCmnCmdResp::GetCmdStatus"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a> CPVCmnCmdResp::GetCmdStatus </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Returns the completion status of the command </dl> </td>
</tr>
</table>
<a name="a1" doxytag="CPVCmnCmdResp::GetCmdType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a> CPVCmnCmdResp::GetCmdType </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Returns the command type that is being completed. </dl> </td>
</tr>
</table>
<a name="a3" doxytag="CPVCmnCmdResp::GetContext"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void* CPVCmnCmdResp::GetContext </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Returns the opaque data that was passed in with the command. </dl> </td>
</tr>
</table>
<a name="a5" doxytag="CPVCmnCmdResp::GetResponseData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void* CPVCmnCmdResp::GetResponseData </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Returns additional data asociated with the command. This is to be interpreted based on the command type and the return status </dl> </td>
</tr>
</table>
<a name="a6" doxytag="CPVCmnCmdResp::GetResponseDataSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int CPVCmnCmdResp::GetResponseDataSize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Field Documentation</h2>
<a name="n1" doxytag="CPVCmnCmdResp::iCmdId"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a2">TPVCmnCommandId</a> CPVCmnCmdResp::iCmdId<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n0" doxytag="CPVCmnCmdResp::iCmdType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a1">TPVCmnCommandType</a> CPVCmnCmdResp::iCmdType<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n2" doxytag="CPVCmnCmdResp::iContext"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void* CPVCmnCmdResp::iContext<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n4" doxytag="CPVCmnCmdResp::iResponseData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void* CPVCmnCmdResp::iResponseData<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n5" doxytag="CPVCmnCmdResp::iResponseDataSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int CPVCmnCmdResp::iResponseDataSize<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n3" doxytag="CPVCmnCmdResp::iStatus"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a3">TPVCmnCommandStatus</a> CPVCmnCmdResp::iStatus<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__common__types_8h-source.html">pv_common_types.h</a></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>