aboutsummaryrefslogtreecommitdiff
path: root/doc/pv2way_html/pv__2way__interface_8h_source.html
blob: 09cb075578510890c447b01dd3e59fdd9c9b3a48 (plain)
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
157
158
159
160
161
162
163
164
165
166
<!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: pv_2way_interface.h Source File</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><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<h1>pv_2way_interface.h</h1><a href="pv__2way__interface_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">* ==============================================================================</span>
<a name="l00003"></a>00003 <span class="comment">*  Name        : pv_2way_interface.h</span>
<a name="l00004"></a>00004 <span class="comment">*  Part of     :</span>
<a name="l00005"></a>00005 <span class="comment">*  Interface   :</span>
<a name="l00006"></a>00006 <span class="comment">*  Description : Interface class and supporting definitions for the PV2Way SDK</span>
<a name="l00007"></a>00007 <span class="comment">*  Version     : (see RELEASE field in copyright header above)</span>
<a name="l00008"></a>00008 <span class="comment">*</span>
<a name="l00009"></a>00009 <span class="comment">* ==============================================================================</span>
<a name="l00010"></a>00010 <span class="comment">*/</span>
<a name="l00011"></a>00011 
<a name="l00012"></a>00012 <span class="preprocessor">#ifndef PV_2WAY_INTERFACE_H_INCLUDED</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define PV_2WAY_INTERFACE_H_INCLUDED</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015 
<a name="l00016"></a>00016 <span class="comment">//  INCLUDES</span>
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef PV_COMMON_TYPES_H_INCLUDED</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#include &quot;pv_common_types.h&quot;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#endif</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef OSCL_VECTOR_H_INCLUDED</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#include &quot;oscl_vector.h&quot;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#endif</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef PVT_COMMON_H_INCLUDED</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#include &quot;pvt_common.h&quot;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#endif</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef PVMF_NODE_INTERFACE_H_INCLUDED</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#include &quot;pvmf_node_interface.h&quot;</span>
<a name="l00031"></a>00031 <span class="preprocessor">#endif</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#ifndef PVLOGGER_ACCESSORIES_H_INCLUDED</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#include &quot;pvlogger_accessories.h&quot;</span>
<a name="l00035"></a>00035 <span class="preprocessor">#endif</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span>
<a name="l00037"></a>00037 <span class="preprocessor">#ifndef PV_ENGINE_TYPES_H_INCLUDED</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#include &quot;pv_engine_types.h&quot;</span>
<a name="l00039"></a>00039 <span class="preprocessor">#endif</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041 <span class="preprocessor">#ifndef PVT_2WAY_BASIC_TYPES_H_INCLUDED</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="pv__2way__basic__types_8h.html">pv_2way_basic_types.h</a>&quot;</span>
<a name="l00043"></a>00043 <span class="preprocessor">#endif</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span>
<a name="l00045"></a>00045 <span class="preprocessor">#ifndef PV_2WAY_H324M_TYPES_H_INCLUDED</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="pv__2way__h324m__types_8h.html">pv_2way_h324m_types.h</a>&quot;</span>
<a name="l00047"></a>00047 <span class="preprocessor">#endif</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span>
<a name="l00049"></a>00049 
<a name="l00050"></a>00050 <span class="comment">// CONSTANTS</span>
<a name="l00051"></a>00051 
<a name="l00052"></a>00052 <span class="comment">// DATA TYPES</span>
<a name="l00053"></a>00053 
<a name="l00054"></a>00054 <span class="comment">// CLASS DECLARATION</span>
<a name="l00055"></a>00055 
<a name="l00066"></a><a class="code" href="classCPV2WayInterface.html">00066</a> <span class="keyword">class </span><a class="code" href="classCPV2WayInterface.html">CPV2WayInterface</a>
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068     <span class="keyword">public</span>:
<a name="l00073"></a><a class="code" href="classCPV2WayInterface.html#a527bb1e253aff5c6fd77992be4dee838">00073</a>         <span class="keyword">virtual</span> <a class="code" href="classCPV2WayInterface.html#a527bb1e253aff5c6fd77992be4dee838">~CPV2WayInterface</a>() {};
<a name="l00074"></a>00074 
<a name="l00086"></a>00086         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#ac1f1b38a3d57f4f431bf0abd3739b388">GetSDKInfo</a>(PVSDKInfo &amp;aSDKInfo,
<a name="l00087"></a>00087                 OsclAny* aContextData = NULL) = 0;
<a name="l00088"></a>00088 
<a name="l00104"></a>00104         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a6b7de3d51dc52508fabc10dc90087e15">GetSDKModuleInfo</a>(PVSDKModuleInfo &amp;aSDKModuleInfo,
<a name="l00105"></a>00105                 OsclAny* aContextData = NULL) = 0;
<a name="l00106"></a>00106 
<a name="l00107"></a>00107 
<a name="l00131"></a>00131         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a3f925c1944bb84a32b92f797b33a700b">Init</a>(<a class="code" href="classPV2WayInitInfo.html">PV2WayInitInfo</a>&amp; aInitInfo,
<a name="l00132"></a>00132                 OsclAny* aContextData = NULL) = 0;
<a name="l00133"></a>00133 
<a name="l00153"></a>00153         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a9667ab6f87d960e3291a750441d7e2b3">Reset</a>(OsclAny* aContextData = NULL) = 0;
<a name="l00154"></a>00154 
<a name="l00176"></a>00176         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a76e71b906b59d40eb82099a12fafc6e7">AddDataSource</a>(<a class="code" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> aTrackId,
<a name="l00177"></a>00177                 PVMFNodeInterface&amp; aDataSource,
<a name="l00178"></a>00178                 OsclAny* aContextData = NULL) = 0;
<a name="l00179"></a>00179 
<a name="l00189"></a>00189         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#ab0328af85d59d6b26504f62990146f02">RemoveDataSource</a>(PVMFNodeInterface&amp; aDataSource,
<a name="l00190"></a>00190                 OsclAny* aContextData = NULL) = 0;
<a name="l00191"></a>00191 
<a name="l00213"></a>00213         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a06a813ed7b1989246f8cd77e60cf742b">AddDataSink</a>(<a class="code" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> aTrackId,
<a name="l00214"></a>00214                 PVMFNodeInterface&amp; aDataSink,
<a name="l00215"></a>00215                 OsclAny* aContextData = NULL) = 0;
<a name="l00216"></a>00216 
<a name="l00226"></a>00226         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a961f8ebbd4f25e7559c0f31880227502">RemoveDataSink</a>(PVMFNodeInterface&amp; aDataSink,
<a name="l00227"></a>00227                 OsclAny* aContextData = NULL) = 0;
<a name="l00228"></a>00228 
<a name="l00244"></a>00244         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a59cff4eff03845aa93df8691124e9385">Connect</a>(<span class="keyword">const</span> <a class="code" href="classPV2WayConnectOptions.html">PV2WayConnectOptions</a>&amp; aOptions,
<a name="l00245"></a>00245                 PVMFNodeInterface* aCommServer = NULL,
<a name="l00246"></a>00246                 OsclAny* aContextData = NULL) = 0;
<a name="l00247"></a>00247 
<a name="l00269"></a>00269         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a13a93403242eab4763835d66c6bc3ef2">Disconnect</a>(OsclAny* aContextData = NULL) = 0;
<a name="l00270"></a>00270 
<a name="l00282"></a>00282         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a791dd03ed115b0037c52e1ca2e375cf1">GetState</a>(<a class="code" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43">PV2WayState</a>&amp; aState,
<a name="l00283"></a>00283                 OsclAny* aContextData = NULL) = 0;
<a name="l00284"></a>00284 
<a name="l00297"></a>00297         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a5f41a487dcabd61ef7ad3cc3468f049e">Pause</a>(<a class="code" href="pv__2way__basic__types_8h.html#ac317ca49ff6a168a50adbda432171232">PV2WayDirection</a> aDirection,
<a name="l00298"></a>00298                 <a class="code" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> aTrackId,
<a name="l00299"></a>00299                 OsclAny* aContextData = NULL) = 0;
<a name="l00300"></a>00300 
<a name="l00314"></a>00314         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a1f7e2359a8a3678930e02a45566f7c9e">Resume</a>(<a class="code" href="pv__2way__basic__types_8h.html#ac317ca49ff6a168a50adbda432171232">PV2WayDirection</a> aDirection,
<a name="l00315"></a>00315                 <a class="code" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> aTrackId,
<a name="l00316"></a>00316                 OsclAny* aContextData = NULL) = 0;
<a name="l00317"></a>00317 
<a name="l00318"></a>00318 
<a name="l00338"></a>00338         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#aa53f5eba3cce928a716d7d12e82cc590">SetLogAppender</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aTag,
<a name="l00339"></a>00339                 OsclSharedPtr&lt;PVLoggerAppender&gt;&amp; aAppender,
<a name="l00340"></a>00340                 OsclAny* aContextData = NULL) = 0;
<a name="l00341"></a>00341 
<a name="l00342"></a>00342 
<a name="l00356"></a>00356         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#ad13f6c374394badf181cb235dfb888b0">RemoveLogAppender</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aTag,
<a name="l00357"></a>00357                 OsclSharedPtr&lt;PVLoggerAppender&gt;&amp; aAppender,
<a name="l00358"></a>00358                 OsclAny* aContextData = NULL) = 0;
<a name="l00359"></a>00359 
<a name="l00360"></a>00360 
<a name="l00379"></a>00379         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a6c2e1d10d98af47bbaaeb6a82fecb6a8">SetLogLevel</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aTag,
<a name="l00380"></a>00380                 int32 aLevel,
<a name="l00381"></a>00381                 <span class="keywordtype">bool</span> aSetSubtree = <span class="keyword">false</span>,
<a name="l00382"></a>00382                 OsclAny* aContextData = NULL) = 0;
<a name="l00383"></a>00383 
<a name="l00384"></a>00384 
<a name="l00400"></a>00400         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a2d330ea36479d66184753d3d418593b6">GetLogLevel</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aTag,
<a name="l00401"></a>00401                 int32&amp; aLogInfo,
<a name="l00402"></a>00402                 OsclAny* aContextData = NULL) = 0;
<a name="l00403"></a>00403 
<a name="l00416"></a>00416         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a37537c1aba8cc700d6f3267617a05286">QueryInterface</a>(<span class="keyword">const</span> PVUuid&amp; aUuid,
<a name="l00417"></a>00417                 PVInterface*&amp; aInterfacePtr,
<a name="l00418"></a>00418                 OsclAny* aContext = NULL) = 0;
<a name="l00419"></a>00419 
<a name="l00427"></a>00427         OSCL_IMPORT_REF <span class="keyword">virtual</span> PVCommandId <a class="code" href="classCPV2WayInterface.html#a2438d83d8d96c7354f06458e5b608984">CancelAllCommands</a>(OsclAny* aContextData = NULL) = 0;
<a name="l00428"></a>00428 };
<a name="l00429"></a>00429 
<a name="l00430"></a>00430 
<a name="l00431"></a>00431 
<a name="l00432"></a>00432 <span class="preprocessor">#endif //</span>
<a name="l00433"></a>00433 <span class="preprocessor"></span>
<a name="l00434"></a>00434 
</pre></div></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.005.1.1 </small>
</small></address>
</body>
</html>