Google Git
Sign in
android / platform / external / opencore / refs/tags/android-2.2_r1.2 / . / doc / pvauthor_html / classCPVCmnInterfaceCmdMessage.html
blob: 44a0ec864d6ddbb151ae503b527e395214432ec5 [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>CPVCmnInterfaceCmdMessage 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>CPVCmnInterfaceCmdMessage Class Reference</h1><code>#include &lt;<a class="el" href="pv__interface__cmd__message_8h-source.html">pv_interface_cmd_message.h</a>&gt;</code>
<p>
<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="classCPVCmnInterfaceCmdMessage.html#a0">CPVCmnInterfaceCmdMessage</a> (int aType, OsclAny *aContextData)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a1">CPVCmnInterfaceCmdMessage</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a2">~CPVCmnInterfaceCmdMessage</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a>&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a3">GetCommandId</a> ()</td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a4">GetType</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a5">GetContextData</a> ()</td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a6">compare</a> (CPVCmnInterfaceCmdMessage *a, CPVCmnInterfaceCmdMessage *b) const</td></tr>
<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a7">GetPriority</a> () const</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a8">SetId</a> (<a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> aId)</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__engine__types_8h.html#a0">PVCommandId</a>&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#n0">iId</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#n1">iType</a></td></tr>
<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#n2">iPriority</a></td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#n3">iContextData</a></td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>class&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#l0">PVInterfaceProxy</a></td></tr>
<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#l1">operator&lt;</a> (const CPVCmnInterfaceCmdMessage &amp;a, const CPVCmnInterfaceCmdMessage &amp;b)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
CPVInterfaceCmdMessage Class
<p>
CPVInterfaceCmdMessage is the interface to the pv2way SDK, which allows initialization, control, and termination of a two-way terminal. The application is expected to contain and maintain a pointer to the CPV2WayInterface instance at all times that a call is active. The CPV2WayFactory factory class is to be used to create and delete instances of this class
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="CPVCmnInterfaceCmdMessage::CPVCmnInterfaceCmdMessage"></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"> CPVCmnInterfaceCmdMessage::CPVCmnInterfaceCmdMessage </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aType</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>OsclAny *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aContextData</em></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>
</td>
</tr>
</table>
<a name="a1" doxytag="CPVCmnInterfaceCmdMessage::CPVCmnInterfaceCmdMessage"></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"> CPVCmnInterfaceCmdMessage::CPVCmnInterfaceCmdMessage </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><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>
<a name="a2" doxytag="CPVCmnInterfaceCmdMessage::~CPVCmnInterfaceCmdMessage"></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"> virtual CPVCmnInterfaceCmdMessage::~CPVCmnInterfaceCmdMessage </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><code> [inline, virtual]</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>Member Function Documentation</h2>
<a name="a6" doxytag="CPVCmnInterfaceCmdMessage::compare"></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 CPVCmnInterfaceCmdMessage::compare </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">CPVCmnInterfaceCmdMessage *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>CPVCmnInterfaceCmdMessage *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The algorithm used in OsclPriorityQueue needs a compare function that returns true when A's priority is less than B's <dl compact><dt><b>Returns: </b></dt><dd>
true if A's priority is less than B's, else false </dl> </td>
</tr>
</table>
<a name="a3" doxytag="CPVCmnInterfaceCmdMessage::GetCommandId"></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__engine__types_8h.html#a0">PVCommandId</a> CPVCmnInterfaceCmdMessage::GetCommandId </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><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>
<a name="a5" doxytag="CPVCmnInterfaceCmdMessage::GetContextData"></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"> OsclAny* CPVCmnInterfaceCmdMessage::GetContextData </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><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>
<a name="a7" doxytag="CPVCmnInterfaceCmdMessage::GetPriority"></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"> int32 CPVCmnInterfaceCmdMessage::GetPriority </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>
<a name="a4" doxytag="CPVCmnInterfaceCmdMessage::GetType"></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 CPVCmnInterfaceCmdMessage::GetType </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><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>
<a name="a8" doxytag="CPVCmnInterfaceCmdMessage::SetId"></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 CPVCmnInterfaceCmdMessage::SetId </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a>&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>aId</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><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>Friends And Related Function Documentation</h2>
<a name="l1" doxytag="CPVCmnInterfaceCmdMessage::operator<"></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"> int32 operator&lt; </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const CPVCmnInterfaceCmdMessage &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const CPVCmnInterfaceCmdMessage &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>b</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l0" doxytag="CPVCmnInterfaceCmdMessage::PVInterfaceProxy"></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"> friend class PVInterfaceProxy<code> [friend]</code>
</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="n3" doxytag="CPVCmnInterfaceCmdMessage::iContextData"></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"> OsclAny* CPVCmnInterfaceCmdMessage::iContextData<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="CPVCmnInterfaceCmdMessage::iId"></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__engine__types_8h.html#a0">PVCommandId</a> CPVCmnInterfaceCmdMessage::iId<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="CPVCmnInterfaceCmdMessage::iPriority"></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"> int32 CPVCmnInterfaceCmdMessage::iPriority<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="n1" doxytag="CPVCmnInterfaceCmdMessage::iType"></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 CPVCmnInterfaceCmdMessage::iType<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__interface__cmd__message_8h-source.html">pv_interface_cmd_message.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>