doc/pv2way_html/classCPV2WayProxyFactory.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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

<!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>pv2way_engine: CPV2WayProxyFactory 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>CPV2WayProxyFactory Class Reference</h1><!-- doxytag: class="CPV2WayProxyFactory" -->
<p><code>#include &lt;<a class="el" href="pv__2way__proxy__factory_8h_source.html">pv_2way_proxy_factory.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 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayProxyFactory.html#a6bc19c3664f8223523ee08dfa114bab0">Init</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayProxyFactory.html#ac5e6dd14637793f1460a3f55436731f8">Cleanup</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF <br class="typebreak"/>
<a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayProxyFactory.html#a2c65a26c3aea66356c9f0f13c5c58978">CreateTerminal</a> (<a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9">TPVTerminalType</a> aTerminalType, PVCommandStatusObserver *aCmdStatusObserver, PVInformationalEventObserver *aInfoEventObserver, PVErrorEventObserver *aErrorEventObserver)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayProxyFactory.html#a54d0b63279d63b879b68eb3d8b406d56">DeleteTerminal</a> (<a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> *terminal)</td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac5e6dd14637793f1460a3f55436731f8"></a><!-- doxytag: member="CPV2WayProxyFactory::Cleanup" ref="ac5e6dd14637793f1460a3f55436731f8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static OSCL_IMPORT_REF void CPV2WayProxyFactory::Cleanup </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a2c65a26c3aea66356c9f0f13c5c58978"></a><!-- doxytag: member="CPV2WayProxyFactory::CreateTerminal" ref="a2c65a26c3aea66356c9f0f13c5c58978" args="(TPVTerminalType aTerminalType, PVCommandStatusObserver *aCmdStatusObserver, PVInformationalEventObserver *aInfoEventObserver, PVErrorEventObserver *aErrorEventObserver)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static OSCL_IMPORT_REF <a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a>* CPV2WayProxyFactory::CreateTerminal </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9">TPVTerminalType</a>&nbsp;</td>
          <td class="paramname"> <em>aTerminalType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PVCommandStatusObserver *&nbsp;</td>
          <td class="paramname"> <em>aCmdStatusObserver</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PVInformationalEventObserver *&nbsp;</td>
          <td class="paramname"> <em>aInfoEventObserver</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PVErrorEventObserver *&nbsp;</td>
          <td class="paramname"> <em>aErrorEventObserver</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 terminal of a particular type. Initially, this will support 324m type terminals.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aTerminalType</em>&nbsp;</td><td>the type of terminal to be created. </td></tr>
    <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>aInfoEventObserver</em>&nbsp;</td><td>the observer for unsolicited informational events </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aErrorEventObserver</em>&nbsp;</td><td>the observer for unsolicited error events</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to a terminal or leaves if the type is invalid or the system is out of resources </dd></dl>

</div>
</div>
<a class="anchor" id="a54d0b63279d63b879b68eb3d8b406d56"></a><!-- doxytag: member="CPV2WayProxyFactory::DeleteTerminal" ref="a54d0b63279d63b879b68eb3d8b406d56" args="(CPV2WayInterface *terminal)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static OSCL_IMPORT_REF void CPV2WayProxyFactory::DeleteTerminal </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> *&nbsp;</td>
          <td class="paramname"> <em>terminal</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 terminal and reclaim all allocated resources. A terminal should be deleted only in the EIdle state. An attempt to delete a terminal in any other state will result in unpredictable behavior.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>terminal</em>&nbsp;</td><td>the terminal to be deleted. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a6bc19c3664f8223523ee08dfa114bab0"></a><!-- doxytag: member="CPV2WayProxyFactory::Init" ref="a6bc19c3664f8223523ee08dfa114bab0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static OSCL_IMPORT_REF void CPV2WayProxyFactory::Init </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__2way__proxy__factory_8h_source.html">pv_2way_proxy_factory.h</a></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV2Way Engine</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>