aboutsummaryrefslogtreecommitdiff
path: root/doc/pvauthor_html/pv__interface__cmd__message_8h_source.html
blob: 0e0b8c79fedb77271982d1420d4d399eac1b4826 (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
<!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: pv_interface_cmd_message.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_interface_cmd_message.h</h1><a href="pv__interface__cmd__message_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef PV_INTERFACE_CMD_MESSAGE_H_INCLUDED</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define PV_INTERFACE_CMD_MESSAGE_H_INCLUDED</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#ifndef PV_COMMON_TYPES_H_INCLUDED</span>
<a name="l00005"></a>00005 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="pv__common__types_8h.html">pv_common_types.h</a>&quot;</span>
<a name="l00006"></a>00006 <span class="preprocessor">#endif</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span>
<a name="l00008"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#a4f8f65f51c0d0ddf8a88e8adcfa8a472">00008</a> <span class="preprocessor">#ifndef PV_ENGINE_TYPES_H_INCLUDED</span>
<a name="l00009"></a>00009 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="pv__engine__types_8h.html">pv_engine_types.h</a>&quot;</span>
<a name="l00010"></a>00010 <span class="preprocessor">#endif</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span>
<a name="l00022"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#a7d878107767a9854a11c8a81e42909f2">00022</a> <span class="keyword">class </span><a class="code" href="classCPVCmnInterfaceCmdMessage.html">CPVCmnInterfaceCmdMessage</a>
<a name="l00023"></a>00023 {
<a name="l00024"></a>00024     <span class="keyword">public</span>:
<a name="l00025"></a>00025         <a class="code" href="classCPVCmnInterfaceCmdMessage.html#aab5c8c8661f5e020ee1062b381a8ee7a">CPVCmnInterfaceCmdMessage</a>(<span class="keywordtype">int</span> aType,
<a name="l00026"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#a73b77b56b48992b46702113126d66caf">00026</a>                                   OsclAny* aContextData) : <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a68c9bbeebc8509d16cf304c00e151d99">iId</a>(0),
<a name="l00027"></a>00027                 <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a9fedaab68484b1825fd567514efae7fa">iType</a>(aType),
<a name="l00028"></a>00028                 <a class="code" href="classCPVCmnInterfaceCmdMessage.html#acf61c1f7f7d49d156bc6a3d2f7ed782b">iPriority</a>(0),
<a name="l00029"></a>00029                 <a class="code" href="classCPVCmnInterfaceCmdMessage.html#aeffad6d8c56b60ff7b51d7a6fa23dee5">iContextData</a>(aContextData) {};
<a name="l00030"></a>00030 
<a name="l00031"></a>00031         <a class="code" href="classCPVCmnInterfaceCmdMessage.html#aab5c8c8661f5e020ee1062b381a8ee7a">CPVCmnInterfaceCmdMessage</a>() {};
<a name="l00032"></a>00032 
<a name="l00033"></a>00033         <span class="keyword">virtual</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a80a8af904114ce6567bb1d7389cef30c">~CPVCmnInterfaceCmdMessage</a>() {};
<a name="l00034"></a>00034 
<a name="l00035"></a>00035         <a class="code" href="pv__engine__types_8h.html#a92105868008db33057f5edd977e95f1e">PVCommandId</a> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a66a7fe054b327226dc66d3eeeef80f69">GetCommandId</a>()
<a name="l00036"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#af7cbc32475397a32f63947aba33d6b53">00036</a>         {
<a name="l00037"></a>00037             <span class="keywordflow">return</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a68c9bbeebc8509d16cf304c00e151d99">iId</a>;
<a name="l00038"></a>00038         }
<a name="l00039"></a>00039         <span class="keywordtype">int</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a7d878107767a9854a11c8a81e42909f2">GetType</a>()
<a name="l00040"></a>00040         {
<a name="l00041"></a>00041             <span class="keywordflow">return</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a9fedaab68484b1825fd567514efae7fa">iType</a>;
<a name="l00042"></a>00042         }
<a name="l00043"></a>00043         OsclAny *<a class="code" href="classCPVCmnInterfaceCmdMessage.html#a73b77b56b48992b46702113126d66caf">GetContextData</a>()
<a name="l00044"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#a7fc49db4aeed61445aeb06840ab1b6d5">00044</a>         {
<a name="l00045"></a>00045             <span class="keywordflow">return</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#aeffad6d8c56b60ff7b51d7a6fa23dee5">iContextData</a>;
<a name="l00046"></a>00046         }
<a name="l00047"></a>00047 
<a name="l00053"></a>00053         <span class="keywordtype">int</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#af7cbc32475397a32f63947aba33d6b53">compare</a>(<a class="code" href="classCPVCmnInterfaceCmdMessage.html">CPVCmnInterfaceCmdMessage</a>* a, <a class="code" href="classCPVCmnInterfaceCmdMessage.html">CPVCmnInterfaceCmdMessage</a>* b)<span class="keyword"> const</span>
<a name="l00054"></a>00054 <span class="keyword">        </span>{
<a name="l00055"></a>00055             <span class="keywordflow">if</span> (a-&gt;<a class="code" href="classCPVCmnInterfaceCmdMessage.html#a7fc49db4aeed61445aeb06840ab1b6d5">GetPriority</a>() &lt; b-&gt;<a class="code" href="classCPVCmnInterfaceCmdMessage.html#a7fc49db4aeed61445aeb06840ab1b6d5">GetPriority</a>())
<a name="l00056"></a>00056                 <span class="keywordflow">return</span> 1;
<a name="l00057"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#a68c9bbeebc8509d16cf304c00e151d99">00057</a>             <span class="keywordflow">else</span> <span class="comment">//if no priority, use fifo order.</span>
<a name="l00058"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#a9fedaab68484b1825fd567514efae7fa">00058</a>                 <span class="keywordflow">return</span> (a-&gt;<a class="code" href="classCPVCmnInterfaceCmdMessage.html#a66a7fe054b327226dc66d3eeeef80f69">GetCommandId</a>() &gt; b-&gt;<a class="code" href="classCPVCmnInterfaceCmdMessage.html#a66a7fe054b327226dc66d3eeeef80f69">GetCommandId</a>());
<a name="l00059"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#acf61c1f7f7d49d156bc6a3d2f7ed782b">00059</a>         }
<a name="l00060"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#aeffad6d8c56b60ff7b51d7a6fa23dee5">00060</a> 
<a name="l00061"></a>00061         int32 <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a7fc49db4aeed61445aeb06840ab1b6d5">GetPriority</a>()<span class="keyword">const</span>
<a name="l00062"></a><a class="code" href="classCPVCmnInterfaceCmdMessage.html#a4f88008ac9f0c9774ee0089464d1b641">00062</a> <span class="keyword">        </span>{
<a name="l00063"></a>00063             <span class="keywordflow">return</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#acf61c1f7f7d49d156bc6a3d2f7ed782b">iPriority</a>;
<a name="l00064"></a>00064         }
<a name="l00065"></a>00065 
<a name="l00066"></a>00066         <span class="keyword">friend</span> int32 <a class="code" href="classCPVCmnInterfaceCmdMessage.html#aa6b068afa9576b099b0fe73b5ff85e31">operator&lt;</a>(<span class="keyword">const</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html">CPVCmnInterfaceCmdMessage</a>&amp; a, <span class="keyword">const</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html">CPVCmnInterfaceCmdMessage</a>&amp; b);
<a name="l00067"></a>00067 
<a name="l00068"></a>00068         <span class="keywordtype">void</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#ac9c8a1c9a266d2df647746d2cc92978b">SetId</a>(<a class="code" href="pv__engine__types_8h.html#a92105868008db33057f5edd977e95f1e">PVCommandId</a> aId)
<a name="l00069"></a>00069         {
<a name="l00070"></a>00070             <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a68c9bbeebc8509d16cf304c00e151d99">iId</a> = aId;
<a name="l00071"></a>00071         }
<a name="l00072"></a>00072 
<a name="l00073"></a>00073     <span class="keyword">protected</span>:
<a name="l00074"></a>00074         <a class="code" href="pv__engine__types_8h.html#a92105868008db33057f5edd977e95f1e">PVCommandId</a> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a68c9bbeebc8509d16cf304c00e151d99">iId</a>;
<a name="l00075"></a>00075         <span class="keywordtype">int</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html#a9fedaab68484b1825fd567514efae7fa">iType</a>;
<a name="l00076"></a>00076         int32 <a class="code" href="classCPVCmnInterfaceCmdMessage.html#acf61c1f7f7d49d156bc6a3d2f7ed782b">iPriority</a>;
<a name="l00077"></a>00077         OsclAny* <a class="code" href="classCPVCmnInterfaceCmdMessage.html#aeffad6d8c56b60ff7b51d7a6fa23dee5">iContextData</a>;
<a name="l00078"></a>00078 
<a name="l00079"></a>00079         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classCPVCmnInterfaceCmdMessage.html#a4f88008ac9f0c9774ee0089464d1b641">PVInterfaceProxy</a>;
<a name="l00080"></a>00080 };
<a name="l00081"></a>00081 
<a name="l00082"></a><a class="code" href="pv__interface__cmd__message_8h.html#aa6b068afa9576b099b0fe73b5ff85e31">00082</a> <span class="keyword">inline</span> int32 <a class="code" href="pv__interface__cmd__message_8h.html#aa6b068afa9576b099b0fe73b5ff85e31">operator&lt;</a>(<span class="keyword">const</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html">CPVCmnInterfaceCmdMessage</a>&amp; a, <span class="keyword">const</span> <a class="code" href="classCPVCmnInterfaceCmdMessage.html">CPVCmnInterfaceCmdMessage</a>&amp; b)
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084     <span class="comment">//Use priority</span>
<a name="l00085"></a>00085     <span class="keywordflow">if</span> (a.<a class="code" href="classCPVCmnInterfaceCmdMessage.html#acf61c1f7f7d49d156bc6a3d2f7ed782b">iPriority</a> &lt; b.<a class="code" href="classCPVCmnInterfaceCmdMessage.html#acf61c1f7f7d49d156bc6a3d2f7ed782b">iPriority</a>)
<a name="l00086"></a>00086     {
<a name="l00087"></a>00087         <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00088"></a>00088     }
<a name="l00089"></a>00089     <span class="comment">//If priority is the same, use id.</span>
<a name="l00090"></a>00090     <span class="keywordflow">else</span> <span class="keywordflow">if</span> (a.<a class="code" href="classCPVCmnInterfaceCmdMessage.html#acf61c1f7f7d49d156bc6a3d2f7ed782b">iPriority</a> == b.<a class="code" href="classCPVCmnInterfaceCmdMessage.html#acf61c1f7f7d49d156bc6a3d2f7ed782b">iPriority</a>)
<a name="l00091"></a>00091     {
<a name="l00092"></a>00092         <span class="comment">//Smaller id means an older message so process older message first.</span>
<a name="l00093"></a>00093         <span class="keywordflow">return</span> (a.<a class="code" href="classCPVCmnInterfaceCmdMessage.html#a68c9bbeebc8509d16cf304c00e151d99">iId</a> &gt; b.<a class="code" href="classCPVCmnInterfaceCmdMessage.html#a68c9bbeebc8509d16cf304c00e151d99">iId</a>);
<a name="l00094"></a>00094     }
<a name="l00095"></a>00095     <span class="keywordflow">else</span>
<a name="l00096"></a>00096     {
<a name="l00097"></a>00097         <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00098"></a>00098     }
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100 <span class="preprocessor">#endif</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span>
<a name="l00102"></a>00102 
</pre></div></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.004.1.1 </small>
</small></address>
</body>
</html>