| <!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>PVAuthorEngineFactory 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> <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> |
| <hr><h1>PVAuthorEngineFactory Class Reference</h1><code>#include <<a class="el" href="pvauthorenginefactory_8h-source.html">pvauthorenginefactory.h</a>></code> |
| <p> |
| <table border=0 cellpadding=0 cellspacing=0> |
| <tr><td></td></tr> |
| <tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> |
| <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a> * </td><td valign=bottom><a class="el" href="classPVAuthorEngineFactory.html#d0">CreateAuthor</a> (<a class="el" href="classPVCommandStatusObserver.html">PVCommandStatusObserver</a> *aCmdStatusObserver, <a class="el" href="classPVErrorEventObserver.html">PVErrorEventObserver</a> *aErrorEventObserver, <a class="el" href="classPVInformationalEventObserver.html">PVInformationalEventObserver</a> *aInfoEventObserver)</td></tr> |
| <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classPVAuthorEngineFactory.html#d1">DeleteAuthor</a> (<a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a> *aAuthor)</td></tr> |
| </table> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| PVAuthorEngineFactory Class |
| <p> |
| PVAuthorEngineFactory class is a singleton class which instantiates and provides access to pvAuthor engine. It returns an <a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a> reference, the interface class of the pvAuthor SDK. |
| <p> |
| The application is expected to contain and maintain a pointer to the <a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a> instance at all time that pvAuthor engine is active. |
| <p> |
| <hr><h2>Member Function Documentation</h2> |
| <a name="d0" doxytag="PVAuthorEngineFactory::CreateAuthor"></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_IMPORT_REF <a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a>* PVAuthorEngineFactory::CreateAuthor </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top"><a class="el" href="classPVCommandStatusObserver.html">PVCommandStatusObserver</a> * </td> |
| <td class="mdname" nowrap> <em>aCmdStatusObserver</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap><a class="el" href="classPVErrorEventObserver.html">PVErrorEventObserver</a> * </td> |
| <td class="mdname" nowrap> <em>aErrorEventObserver</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap><a class="el" href="classPVInformationalEventObserver.html">PVInformationalEventObserver</a> * </td> |
| <td class="mdname" nowrap> <em>aInfoEventObserver</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"><code> [static]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Creates an instance of a pvAuthor engine. If the creation fails, this function will leave.<dl compact><dt><b>Parameters: </b></dt><dd> |
| <table border=0 cellspacing=2 cellpadding=0> |
| <tr><td valign=top><em>aCmdStatusObserver</em> </td><td> |
| The observer for command status </td></tr> |
| <tr><td valign=top><em>aErrorEventObserver</em> </td><td> |
| The observer for unsolicited error events </td></tr> |
| <tr><td valign=top><em>aInfoEventObserver</em> </td><td> |
| The observer for unsolicited informational events </td></tr> |
| </table> |
| </dl><dl compact><dt><b>Returns: </b></dt><dd> |
| A pointer to an author or leaves if instantiation fails </dl> </td> |
| </tr> |
| </table> |
| <a name="d1" doxytag="PVAuthorEngineFactory::DeleteAuthor"></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_IMPORT_REF bool PVAuthorEngineFactory::DeleteAuthor </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top"><a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a> * </td> |
| <td class="mdname1" valign="top" nowrap> <em>aAuthor</em> </td> |
| <td class="md" valign="top">) </td> |
| <td class="md" nowrap><code> [static]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| This function allows the application to delete an instance of a pvAuthor and reclaim all allocated resources. An author can be deleted only in the idle state. An attempt to delete an author in any other state will fail and return false.<dl compact><dt><b>Parameters: </b></dt><dd> |
| <table border=0 cellspacing=2 cellpadding=0> |
| <tr><td valign=top><em>aAuthor</em> </td><td> |
| The author to be deleted. </td></tr> |
| </table> |
| </dl><dl compact><dt><b>Returns: </b></dt><dd> |
| A status code indicating success or failure. </dl> </td> |
| </tr> |
| </table> |
| <hr>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="pvauthorenginefactory_8h-source.html">pvauthorenginefactory.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> |
