doc/pvauthor_html/classPVAuthorEngineFactory.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>pvauthor_engine: PVAuthorEngineFactory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>PVAuthorEngineFactory Class Reference</h1><!-- doxytag: class="PVAuthorEngineFactory" -->
<p><code>#include &lt;<a class="el" href="pvauthorenginefactory_8h_source.html">pvauthorenginefactory.h</a>&gt;</code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF <br class="typebreak"/>
<a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVAuthorEngineFactory.html#a40dc8745f5505b2108e7ee512731e419">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 class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVAuthorEngineFactory.html#a1805af93005f5c056bbeb284fb70993a">DeleteAuthor</a> (<a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a> *aAuthor)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classPVAuthorEngineFactory.html">PVAuthorEngineFactory</a> Class</p>
<p><a class="el" href="classPVAuthorEngineFactory.html">PVAuthorEngineFactory</a> 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>
<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 class="anchor" id="a40dc8745f5505b2108e7ee512731e419"></a><!-- doxytag: member="PVAuthorEngineFactory::CreateAuthor" ref="a40dc8745f5505b2108e7ee512731e419" args="(PVCommandStatusObserver *aCmdStatusObserver, PVErrorEventObserver *aErrorEventObserver, PVInformationalEventObserver *aInfoEventObserver)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static OSCL_IMPORT_REF <a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a>* PVAuthorEngineFactory::CreateAuthor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPVCommandStatusObserver.html">PVCommandStatusObserver</a> *&nbsp;</td>
          <td class="paramname"> <em>aCmdStatusObserver</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classPVErrorEventObserver.html">PVErrorEventObserver</a> *&nbsp;</td>
          <td class="paramname"> <em>aErrorEventObserver</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classPVInformationalEventObserver.html">PVInformationalEventObserver</a> *&nbsp;</td>
          <td class="paramname"> <em>aInfoEventObserver</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates an instance of a pvAuthor engine. If the creation fails, this function will leave.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aCmdStatusObserver</em>&nbsp;</td><td>The observer for command status </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aErrorEventObserver</em>&nbsp;</td><td>The observer for unsolicited error events </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aInfoEventObserver</em>&nbsp;</td><td>The observer for unsolicited informational events </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to an author or leaves if instantiation fails </dd></dl>

</div>
</div>
<a class="anchor" id="a1805af93005f5c056bbeb284fb70993a"></a><!-- doxytag: member="PVAuthorEngineFactory::DeleteAuthor" ref="a1805af93005f5c056bbeb284fb70993a" args="(PVAuthorEngineInterface *aAuthor)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static OSCL_IMPORT_REF bool PVAuthorEngineFactory::DeleteAuthor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a> *&nbsp;</td>
          <td class="paramname"> <em>aAuthor</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<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.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aAuthor</em>&nbsp;</td><td>The author to be deleted. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A status code indicating success or failure. </dd></dl>

</div>
</div>
<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></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small>
<address style="align: left;"><small>Posting Version: CORE_9.005.1.1 </small>
</small></address>
</body>
</html>