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>CPVCmnInterfaceCmdMessage 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>CPVCmnInterfaceCmdMessage Class Reference</h1><code>#include <<a class="el" href="pv__interface__cmd__message_8h-source.html">pv_interface_cmd_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="classCPVCmnInterfaceCmdMessage.html#a0">CPVCmnInterfaceCmdMessage</a> (int aType, OsclAny *aContextData)</td></tr> 15<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a1">CPVCmnInterfaceCmdMessage</a> ()</td></tr> 16<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a2">~CPVCmnInterfaceCmdMessage</a> ()</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="classCPVCmnInterfaceCmdMessage.html#a3">GetCommandId</a> ()</td></tr> 18<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a4">GetType</a> ()</td></tr> 19<tr><td nowrap align=right valign=top>OsclAny * </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a5">GetContextData</a> ()</td></tr> 20<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a6">compare</a> (CPVCmnInterfaceCmdMessage *a, CPVCmnInterfaceCmdMessage *b) const</td></tr> 21<tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#a7">GetPriority</a> () const</td></tr> 22<tr><td nowrap align=right valign=top>void </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> 23<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> 24<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="classCPVCmnInterfaceCmdMessage.html#n0">iId</a></td></tr> 25<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#n1">iType</a></td></tr> 26<tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#n2">iPriority</a></td></tr> 27<tr><td nowrap align=right valign=top>OsclAny * </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#n3">iContextData</a></td></tr> 28<tr><td colspan=2><br><h2>Friends</h2></td></tr> 29<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#l0">PVInterfaceProxy</a></td></tr> 30<tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classCPVCmnInterfaceCmdMessage.html#l1">operator<</a> (const CPVCmnInterfaceCmdMessage &a, const CPVCmnInterfaceCmdMessage &b)</td></tr> 31</table> 32<hr><a name="_details"></a><h2>Detailed Description</h2> 33CPVInterfaceCmdMessage Class 34<p> 35CPVInterfaceCmdMessage 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 36<p> 37<hr><h2>Constructor & Destructor Documentation</h2> 38<a name="a0" doxytag="CPVCmnInterfaceCmdMessage::CPVCmnInterfaceCmdMessage"></a><p> 39<table width="100%" cellpadding="2" cellspacing="0" border="0"> 40 <tr> 41 <td class="md"> 42 <table cellpadding="0" cellspacing="0" border="0"> 43 <tr> 44 <td class="md" nowrap valign="top"> CPVCmnInterfaceCmdMessage::CPVCmnInterfaceCmdMessage </td> 45 <td class="md" valign="top">( </td> 46 <td class="md" nowrap valign="top">int </td> 47 <td class="mdname" nowrap> <em>aType</em>, </td> 48 </tr> 49 <tr> 50 <td></td> 51 <td></td> 52 <td class="md" nowrap>OsclAny * </td> 53 <td class="mdname" nowrap> <em>aContextData</em></td> 54 </tr> 55 <tr> 56 <td></td> 57 <td class="md">) </td> 58 <td class="md" colspan="2"><code> [inline]</code></td> 59 </tr> 60 61 </table> 62 </td> 63 </tr> 64</table> 65<table cellspacing=5 cellpadding=0 border=0> 66 <tr> 67 <td> 68 69 </td> 70 <td> 71 72<p> 73 </td> 74 </tr> 75</table> 76<a name="a1" doxytag="CPVCmnInterfaceCmdMessage::CPVCmnInterfaceCmdMessage"></a><p> 77<table width="100%" cellpadding="2" cellspacing="0" border="0"> 78 <tr> 79 <td class="md"> 80 <table cellpadding="0" cellspacing="0" border="0"> 81 <tr> 82 <td class="md" nowrap valign="top"> CPVCmnInterfaceCmdMessage::CPVCmnInterfaceCmdMessage </td> 83 <td class="md" valign="top">( </td> 84 <td class="mdname1" valign="top" nowrap> </td> 85 <td class="md" valign="top">) </td> 86 <td class="md" nowrap><code> [inline]</code></td> 87 </tr> 88 89 </table> 90 </td> 91 </tr> 92</table> 93<table cellspacing=5 cellpadding=0 border=0> 94 <tr> 95 <td> 96 97 </td> 98 <td> 99 100<p> 101 </td> 102 </tr> 103</table> 104<a name="a2" doxytag="CPVCmnInterfaceCmdMessage::~CPVCmnInterfaceCmdMessage"></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"> virtual CPVCmnInterfaceCmdMessage::~CPVCmnInterfaceCmdMessage </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><code> [inline, virtual]</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 </td> 130 </tr> 131</table> 132<hr><h2>Member Function Documentation</h2> 133<a name="a6" doxytag="CPVCmnInterfaceCmdMessage::compare"></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"> int CPVCmnInterfaceCmdMessage::compare </td> 140 <td class="md" valign="top">( </td> 141 <td class="md" nowrap valign="top">CPVCmnInterfaceCmdMessage * </td> 142 <td class="mdname" nowrap> <em>a</em>, </td> 143 </tr> 144 <tr> 145 <td></td> 146 <td></td> 147 <td class="md" nowrap>CPVCmnInterfaceCmdMessage * </td> 148 <td class="mdname" nowrap> <em>b</em></td> 149 </tr> 150 <tr> 151 <td></td> 152 <td class="md">) </td> 153 <td class="md" colspan="2"> const<code> [inline]</code></td> 154 </tr> 155 156 </table> 157 </td> 158 </tr> 159</table> 160<table cellspacing=5 cellpadding=0 border=0> 161 <tr> 162 <td> 163 164 </td> 165 <td> 166 167<p> 168The 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> 169true if A's priority is less than B's, else false </dl> </td> 170 </tr> 171</table> 172<a name="a3" doxytag="CPVCmnInterfaceCmdMessage::GetCommandId"></a><p> 173<table width="100%" cellpadding="2" cellspacing="0" border="0"> 174 <tr> 175 <td class="md"> 176 <table cellpadding="0" cellspacing="0" border="0"> 177 <tr> 178 <td class="md" nowrap valign="top"> <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> CPVCmnInterfaceCmdMessage::GetCommandId </td> 179 <td class="md" valign="top">( </td> 180 <td class="mdname1" valign="top" nowrap> </td> 181 <td class="md" valign="top">) </td> 182 <td class="md" nowrap><code> [inline]</code></td> 183 </tr> 184 185 </table> 186 </td> 187 </tr> 188</table> 189<table cellspacing=5 cellpadding=0 border=0> 190 <tr> 191 <td> 192 193 </td> 194 <td> 195 196<p> 197 </td> 198 </tr> 199</table> 200<a name="a5" doxytag="CPVCmnInterfaceCmdMessage::GetContextData"></a><p> 201<table width="100%" cellpadding="2" cellspacing="0" border="0"> 202 <tr> 203 <td class="md"> 204 <table cellpadding="0" cellspacing="0" border="0"> 205 <tr> 206 <td class="md" nowrap valign="top"> OsclAny* CPVCmnInterfaceCmdMessage::GetContextData </td> 207 <td class="md" valign="top">( </td> 208 <td class="mdname1" valign="top" nowrap> </td> 209 <td class="md" valign="top">) </td> 210 <td class="md" nowrap><code> [inline]</code></td> 211 </tr> 212 213 </table> 214 </td> 215 </tr> 216</table> 217<table cellspacing=5 cellpadding=0 border=0> 218 <tr> 219 <td> 220 221 </td> 222 <td> 223 224<p> 225 </td> 226 </tr> 227</table> 228<a name="a7" doxytag="CPVCmnInterfaceCmdMessage::GetPriority"></a><p> 229<table width="100%" cellpadding="2" cellspacing="0" border="0"> 230 <tr> 231 <td class="md"> 232 <table cellpadding="0" cellspacing="0" border="0"> 233 <tr> 234 <td class="md" nowrap valign="top"> int32 CPVCmnInterfaceCmdMessage::GetPriority </td> 235 <td class="md" valign="top">( </td> 236 <td class="mdname1" valign="top" nowrap> </td> 237 <td class="md" valign="top">) </td> 238 <td class="md" nowrap> const<code> [inline]</code></td> 239 </tr> 240 241 </table> 242 </td> 243 </tr> 244</table> 245<table cellspacing=5 cellpadding=0 border=0> 246 <tr> 247 <td> 248 249 </td> 250 <td> 251 252<p> 253 </td> 254 </tr> 255</table> 256<a name="a4" doxytag="CPVCmnInterfaceCmdMessage::GetType"></a><p> 257<table width="100%" cellpadding="2" cellspacing="0" border="0"> 258 <tr> 259 <td class="md"> 260 <table cellpadding="0" cellspacing="0" border="0"> 261 <tr> 262 <td class="md" nowrap valign="top"> int CPVCmnInterfaceCmdMessage::GetType </td> 263 <td class="md" valign="top">( </td> 264 <td class="mdname1" valign="top" nowrap> </td> 265 <td class="md" valign="top">) </td> 266 <td class="md" nowrap><code> [inline]</code></td> 267 </tr> 268 269 </table> 270 </td> 271 </tr> 272</table> 273<table cellspacing=5 cellpadding=0 border=0> 274 <tr> 275 <td> 276 277 </td> 278 <td> 279 280<p> 281 </td> 282 </tr> 283</table> 284<a name="a8" doxytag="CPVCmnInterfaceCmdMessage::SetId"></a><p> 285<table width="100%" cellpadding="2" cellspacing="0" border="0"> 286 <tr> 287 <td class="md"> 288 <table cellpadding="0" cellspacing="0" border="0"> 289 <tr> 290 <td class="md" nowrap valign="top"> void CPVCmnInterfaceCmdMessage::SetId </td> 291 <td class="md" valign="top">( </td> 292 <td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td> 293 <td class="mdname1" valign="top" nowrap> <em>aId</em> </td> 294 <td class="md" valign="top">) </td> 295 <td class="md" nowrap><code> [inline]</code></td> 296 </tr> 297 298 </table> 299 </td> 300 </tr> 301</table> 302<table cellspacing=5 cellpadding=0 border=0> 303 <tr> 304 <td> 305 306 </td> 307 <td> 308 309<p> 310 </td> 311 </tr> 312</table> 313<hr><h2>Friends And Related Function Documentation</h2> 314<a name="l1" doxytag="CPVCmnInterfaceCmdMessage::operator<"></a><p> 315<table width="100%" cellpadding="2" cellspacing="0" border="0"> 316 <tr> 317 <td class="md"> 318 <table cellpadding="0" cellspacing="0" border="0"> 319 <tr> 320 <td class="md" nowrap valign="top"> int32 operator< </td> 321 <td class="md" valign="top">( </td> 322 <td class="md" nowrap valign="top">const CPVCmnInterfaceCmdMessage & </td> 323 <td class="mdname" nowrap> <em>a</em>, </td> 324 </tr> 325 <tr> 326 <td></td> 327 <td></td> 328 <td class="md" nowrap>const CPVCmnInterfaceCmdMessage & </td> 329 <td class="mdname" nowrap> <em>b</em></td> 330 </tr> 331 <tr> 332 <td></td> 333 <td class="md">) </td> 334 <td class="md" colspan="2"><code> [friend]</code></td> 335 </tr> 336 337 </table> 338 </td> 339 </tr> 340</table> 341<table cellspacing=5 cellpadding=0 border=0> 342 <tr> 343 <td> 344 345 </td> 346 <td> 347 348<p> 349 </td> 350 </tr> 351</table> 352<a name="l0" doxytag="CPVCmnInterfaceCmdMessage::PVInterfaceProxy"></a><p> 353<table width="100%" cellpadding="2" cellspacing="0" border="0"> 354 <tr> 355 <td class="md"> 356 <table cellpadding="0" cellspacing="0" border="0"> 357 <tr> 358 <td class="md" nowrap valign="top"> friend class PVInterfaceProxy<code> [friend]</code> 359 </table> 360 </td> 361 </tr> 362</table> 363<table cellspacing=5 cellpadding=0 border=0> 364 <tr> 365 <td> 366 367 </td> 368 <td> 369 370<p> 371 </td> 372 </tr> 373</table> 374<hr><h2>Field Documentation</h2> 375<a name="n3" doxytag="CPVCmnInterfaceCmdMessage::iContextData"></a><p> 376<table width="100%" cellpadding="2" cellspacing="0" border="0"> 377 <tr> 378 <td class="md"> 379 <table cellpadding="0" cellspacing="0" border="0"> 380 <tr> 381 <td class="md" nowrap valign="top"> OsclAny* CPVCmnInterfaceCmdMessage::iContextData<code> [protected]</code> 382 </table> 383 </td> 384 </tr> 385</table> 386<table cellspacing=5 cellpadding=0 border=0> 387 <tr> 388 <td> 389 390 </td> 391 <td> 392 393<p> 394 </td> 395 </tr> 396</table> 397<a name="n0" doxytag="CPVCmnInterfaceCmdMessage::iId"></a><p> 398<table width="100%" cellpadding="2" cellspacing="0" border="0"> 399 <tr> 400 <td class="md"> 401 <table cellpadding="0" cellspacing="0" border="0"> 402 <tr> 403 <td class="md" nowrap valign="top"> <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> CPVCmnInterfaceCmdMessage::iId<code> [protected]</code> 404 </table> 405 </td> 406 </tr> 407</table> 408<table cellspacing=5 cellpadding=0 border=0> 409 <tr> 410 <td> 411 412 </td> 413 <td> 414 415<p> 416 </td> 417 </tr> 418</table> 419<a name="n2" doxytag="CPVCmnInterfaceCmdMessage::iPriority"></a><p> 420<table width="100%" cellpadding="2" cellspacing="0" border="0"> 421 <tr> 422 <td class="md"> 423 <table cellpadding="0" cellspacing="0" border="0"> 424 <tr> 425 <td class="md" nowrap valign="top"> int32 CPVCmnInterfaceCmdMessage::iPriority<code> [protected]</code> 426 </table> 427 </td> 428 </tr> 429</table> 430<table cellspacing=5 cellpadding=0 border=0> 431 <tr> 432 <td> 433 434 </td> 435 <td> 436 437<p> 438 </td> 439 </tr> 440</table> 441<a name="n1" doxytag="CPVCmnInterfaceCmdMessage::iType"></a><p> 442<table width="100%" cellpadding="2" cellspacing="0" border="0"> 443 <tr> 444 <td class="md"> 445 <table cellpadding="0" cellspacing="0" border="0"> 446 <tr> 447 <td class="md" nowrap valign="top"> int CPVCmnInterfaceCmdMessage::iType<code> [protected]</code> 448 </table> 449 </td> 450 </tr> 451</table> 452<table cellspacing=5 cellpadding=0 border=0> 453 <tr> 454 <td> 455 456 </td> 457 <td> 458 459<p> 460 </td> 461 </tr> 462</table> 463<hr>The documentation for this class was generated from the following file:<ul> 464<li><a class="el" href="pv__interface__cmd__message_8h-source.html">pv_interface_cmd_message.h</a></ul> 465<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small> 466<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 467</small></address> 468</body> 469</html> 470
