Google Git
Sign in
android / platform / external / opencore / refs/heads/froyo-release / . / doc / pvauthor_html / classPVEngineCommand.html
blob: 56037ff46be5f80e33de62929d5092bc976957d7 [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>PVEngineCommand 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>PVEngineCommand Class Reference</h1><code>#include &lt;<a class="el" href="pv__engine__types_8h-source.html">pv_engine_types.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="classPVEngineCommand.html#a0">PVEngineCommand</a> (int32 aCmdType, <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> aCmdId, OsclAny *aContextData=NULL, OsclAny *aParam1=NULL, OsclAny *aParam2=NULL, OsclAny *aParam3=NULL)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a1">PVEngineCommand</a> (const PVEngineCommand &amp;aCmd)</td></tr>
<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a2">GetCmdType</a> () const</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="classPVEngineCommand.html#a3">GetCmdId</a> () const</td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a4">GetContext</a> () const</td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a5">GetParam1</a> () const</td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a6">GetParam2</a> () const</td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a7">GetParam3</a> () const</td></tr>
<tr><td nowrap align=right valign=top>const PvmfMimeString &amp;&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a8">GetMimeType</a> () const</td></tr>
<tr><td nowrap align=right valign=top>PVUuid&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a9">GetUuid</a> () const</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a10">SetMimeType</a> (const PvmfMimeString &amp;aMimeType)</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#a11">SetUuid</a> (const PVUuid &amp;aUuid)</td></tr>
<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#m0">iCmdType</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="classPVEngineCommand.html#m1">iCmdId</a></td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#m2">iContextData</a></td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#m3">iParam1</a></td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#m4">iParam2</a></td></tr>
<tr><td nowrap align=right valign=top>OsclAny *&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#m5">iParam3</a></td></tr>
<tr><td nowrap align=right valign=top>OSCL_HeapString&lt; OsclMemAllocator &gt;&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#m6">iMimeType</a></td></tr>
<tr><td nowrap align=right valign=top>PVUuid&nbsp;</td><td valign=bottom><a class="el" href="classPVEngineCommand.html#m7">iUuid</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
PVEngineCommand Class
<p>
PVEngineCommand class is a data class to hold issued commands. The class is meant to be used inside the engine and not exposed to the interface layer or above.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="PVEngineCommand::PVEngineCommand"></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"> PVEngineCommand::PVEngineCommand </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aCmdType</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aCmdId</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>OsclAny *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aContextData</em> = NULL, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>OsclAny *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aParam1</em> = NULL, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>OsclAny *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aParam2</em> = NULL, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>OsclAny *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aParam3</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>
The constructor for PVEngineCommand which allows the data values to be set.<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>aCmdType</em>&nbsp;</td><td>
The command type value for this command. The value is an engine-specific 32-bit value. </td></tr>
<tr><td valign=top><em>aCmdId</em>&nbsp;</td><td>
The command ID assigned by the engine for this command. </td></tr>
<tr><td valign=top><em>aContextData</em>&nbsp;</td><td>
The pointer to the passed-in context data for this command.</td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
None </dl> </td>
</tr>
</table>
<a name="a1" doxytag="PVEngineCommand::PVEngineCommand"></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"> PVEngineCommand::PVEngineCommand </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const PVEngineCommand &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>aCmd</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>
The copy constructor for PVEngineCommand. Used mainly for Oscl_Vector.<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>aCmd</em>&nbsp;</td><td>
The reference to the source PVEngineCommand to copy the data values from.</td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
None </dl> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="PVEngineCommand::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__engine__types_8h.html#a0">PVCommandId</a> PVEngineCommand::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>
This function returns the stored command ID value.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
The PVCommandId value for this command. </dl> </td>
</tr>
</table>
<a name="a2" doxytag="PVEngineCommand::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"> int32 PVEngineCommand::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>
This function returns the stored command type value.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
The signed 32-bit command type value for this command. </dl> </td>
</tr>
</table>
<a name="a4" doxytag="PVEngineCommand::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"> OsclAny* PVEngineCommand::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>
This function returns the stored context data pointer.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
The pointer to the context data for this command </dl> </td>
</tr>
</table>
<a name="a8" doxytag="PVEngineCommand::GetMimeType"></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"> const PvmfMimeString&amp; PVEngineCommand::GetMimeType </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>
This function returns Mime type parameter for this command
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
The Mime type parameter for this command </dl> </td>
</tr>
</table>
<a name="a5" doxytag="PVEngineCommand::GetParam1"></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* PVEngineCommand::GetParam1 </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>
This function returns the first stored parameter pointer.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
The pointer to the first stored parameter for this command </dl> </td>
</tr>
</table>
<a name="a6" doxytag="PVEngineCommand::GetParam2"></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* PVEngineCommand::GetParam2 </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>
This function returns the second stored parameter pointer.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
The pointer to the second stored parameter for this command </dl> </td>
</tr>
</table>
<a name="a7" doxytag="PVEngineCommand::GetParam3"></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* PVEngineCommand::GetParam3 </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>
This function returns the third stored parameter pointer.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
The pointer to the third stored parameter for this command </dl> </td>
</tr>
</table>
<a name="a9" doxytag="PVEngineCommand::GetUuid"></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"> PVUuid PVEngineCommand::GetUuid </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>
This function returns Uuid parameter for this command
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
The Uuid parameter for this command </dl> </td>
</tr>
</table>
<a name="a10" doxytag="PVEngineCommand::SetMimeType"></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 PVEngineCommand::SetMimeType </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const PvmfMimeString &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>aMimeType</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>
This function stores Mime type parameter of this command </td>
</tr>
</table>
<a name="a11" doxytag="PVEngineCommand::SetUuid"></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 PVEngineCommand::SetUuid </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const PVUuid &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>aUuid</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>
This function stores the Uuid parameter of this command </td>
</tr>
</table>
<hr><h2>Field Documentation</h2>
<a name="m1" doxytag="PVEngineCommand::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__engine__types_8h.html#a0">PVCommandId</a> PVEngineCommand::iCmdId
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="m0" doxytag="PVEngineCommand::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"> int32 PVEngineCommand::iCmdType
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="m2" doxytag="PVEngineCommand::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* PVEngineCommand::iContextData
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="m6" doxytag="PVEngineCommand::iMimeType"></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"> OSCL_HeapString&lt;OsclMemAllocator&gt; PVEngineCommand::iMimeType
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="m3" doxytag="PVEngineCommand::iParam1"></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* PVEngineCommand::iParam1
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="m4" doxytag="PVEngineCommand::iParam2"></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* PVEngineCommand::iParam2
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="m5" doxytag="PVEngineCommand::iParam3"></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* PVEngineCommand::iParam3
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="m7" doxytag="PVEngineCommand::iUuid"></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"> PVUuid PVEngineCommand::iUuid
</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__engine__types_8h-source.html">pv_engine_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>