Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / maclayer / MacLayerFlowPattern.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc (1.8.0_191) on Thu Mar 28 11:26:59 PDT 2019 -->
6 <title>MacLayerFlowPattern</title>
7 <meta name="date" content="2019-03-28">
8 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../../../script.js"></script>
10 </head>
11 <body>
12 <script type="text/javascript"><!--
13     try {
14         if (location.href.indexOf('is-external=true') == -1) {
15             parent.document.title="MacLayerFlowPattern";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
27 </script>
28 <noscript>
29 <div>JavaScript is disabled on your browser.</div>
30 </noscript>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
33 <!--   -->
34 </a>
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
37 <!--   -->
38 </a>
39 <ul class="navList" title="Navigation">
40 <li><a href="../../../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="package-tree.html">Tree</a></li>
44 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
45 <li><a href="../../../../index-files/index-1.html">Index</a></li>
46 <li><a href="../../../../help-doc.html">Help</a></li>
47 </ul>
48 </div>
49 <div class="subNav">
50 <ul class="navList">
51 <li>Prev&nbsp;Class</li>
52 <li><a href="../../../../edu/uci/iotproject/maclayer/MacLayerFlowPatternFinder.html" title="class in edu.uci.iotproject.maclayer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
53 </ul>
54 <ul class="navList">
55 <li><a href="../../../../index.html?edu/uci/iotproject/maclayer/MacLayerFlowPattern.html" target="_top">Frames</a></li>
56 <li><a href="MacLayerFlowPattern.html" target="_top">No&nbsp;Frames</a></li>
57 </ul>
58 <ul class="navList" id="allclasses_navbar_top">
59 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
60 </ul>
61 <div>
62 <script type="text/javascript"><!--
63   allClassesLink = document.getElementById("allclasses_navbar_top");
64   if(window==top) {
65     allClassesLink.style.display = "block";
66   }
67   else {
68     allClassesLink.style.display = "none";
69   }
70   //-->
71 </script>
72 </div>
73 <div>
74 <ul class="subNavList">
75 <li>Summary:&nbsp;</li>
76 <li>Nested&nbsp;|&nbsp;</li>
77 <li>Field&nbsp;|&nbsp;</li>
78 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
79 <li><a href="#method.summary">Method</a></li>
80 </ul>
81 <ul class="subNavList">
82 <li>Detail:&nbsp;</li>
83 <li>Field&nbsp;|&nbsp;</li>
84 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
85 <li><a href="#method.detail">Method</a></li>
86 </ul>
87 </div>
88 <a name="skip.navbar.top">
89 <!--   -->
90 </a></div>
91 <!-- ========= END OF TOP NAVBAR ========= -->
92 <!-- ======== START OF CLASS DATA ======== -->
93 <div class="header">
94 <div class="subTitle">edu.uci.iotproject.maclayer</div>
95 <h2 title="Class MacLayerFlowPattern" class="title">Class MacLayerFlowPattern</h2>
96 </div>
97 <div class="contentContainer">
98 <ul class="inheritance">
99 <li>java.lang.Object</li>
100 <li>
101 <ul class="inheritance">
102 <li>edu.uci.iotproject.maclayer.MacLayerFlowPattern</li>
103 </ul>
104 </li>
105 </ul>
106 <div class="description">
107 <ul class="blockList">
108 <li class="blockList">
109 <hr>
110 <br>
111 <pre>public class <span class="typeNameLabel">MacLayerFlowPattern</span>
112 extends java.lang.Object</pre>
113 <div class="block">TODO create base class for FlowPattern and derive MacLayer, TCP/IP layer versions from that.</div>
114 </li>
115 </ul>
116 </div>
117 <div class="summary">
118 <ul class="blockList">
119 <li class="blockList">
120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
121 <ul class="blockList">
122 <li class="blockList"><a name="constructor.summary">
123 <!--   -->
124 </a>
125 <h3>Constructor Summary</h3>
126 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
127 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
128 <tr>
129 <th class="colOne" scope="col">Constructor and Description</th>
130 </tr>
131 <tr class="altColor">
132 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/maclayer/MacLayerFlowPattern.html#MacLayerFlowPattern-java.lang.String-java.lang.String-java.util.List-">MacLayerFlowPattern</a></span>(java.lang.String&nbsp;patternId,
133                    java.lang.String&nbsp;macPrefix,
134                    java.util.List&lt;java.lang.Integer&gt;&nbsp;packetLengthSequence)</code>&nbsp;</td>
135 </tr>
136 </table>
137 </li>
138 </ul>
139 <!-- ========== METHOD SUMMARY =========== -->
140 <ul class="blockList">
141 <li class="blockList"><a name="method.summary">
142 <!--   -->
143 </a>
144 <h3>Method Summary</h3>
145 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
146 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
147 <tr>
148 <th class="colFirst" scope="col">Modifier and Type</th>
149 <th class="colLast" scope="col">Method and Description</th>
150 </tr>
151 <tr id="i0" class="altColor">
152 <td class="colFirst"><code>int</code></td>
153 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/maclayer/MacLayerFlowPattern.html#getLength--">getLength</a></span>()</code>&nbsp;</td>
154 </tr>
155 <tr id="i1" class="rowColor">
156 <td class="colFirst"><code>byte[]</code></td>
157 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/maclayer/MacLayerFlowPattern.html#getMacPrefixRawBytes--">getMacPrefixRawBytes</a></span>()</code>&nbsp;</td>
158 </tr>
159 <tr id="i2" class="altColor">
160 <td class="colFirst"><code>java.util.List&lt;java.lang.Integer&gt;</code></td>
161 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/maclayer/MacLayerFlowPattern.html#getPacketLengthSequence--">getPacketLengthSequence</a></span>()</code>&nbsp;</td>
162 </tr>
163 <tr id="i3" class="rowColor">
164 <td class="colFirst"><code>java.lang.String</code></td>
165 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/maclayer/MacLayerFlowPattern.html#getPatternId--">getPatternId</a></span>()</code>&nbsp;</td>
166 </tr>
167 </table>
168 <ul class="blockList">
169 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
170 <!--   -->
171 </a>
172 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
173 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
174 </ul>
175 </li>
176 </ul>
177 </li>
178 </ul>
179 </div>
180 <div class="details">
181 <ul class="blockList">
182 <li class="blockList">
183 <!-- ========= CONSTRUCTOR DETAIL ======== -->
184 <ul class="blockList">
185 <li class="blockList"><a name="constructor.detail">
186 <!--   -->
187 </a>
188 <h3>Constructor Detail</h3>
189 <a name="MacLayerFlowPattern-java.lang.String-java.lang.String-java.util.List-">
190 <!--   -->
191 </a>
192 <ul class="blockListLast">
193 <li class="blockList">
194 <h4>MacLayerFlowPattern</h4>
195 <pre>public&nbsp;MacLayerFlowPattern(java.lang.String&nbsp;patternId,
196                            java.lang.String&nbsp;macPrefix,
197                            java.util.List&lt;java.lang.Integer&gt;&nbsp;packetLengthSequence)</pre>
198 </li>
199 </ul>
200 </li>
201 </ul>
202 <!-- ============ METHOD DETAIL ========== -->
203 <ul class="blockList">
204 <li class="blockList"><a name="method.detail">
205 <!--   -->
206 </a>
207 <h3>Method Detail</h3>
208 <a name="getPatternId--">
209 <!--   -->
210 </a>
211 <ul class="blockList">
212 <li class="blockList">
213 <h4>getPatternId</h4>
214 <pre>public&nbsp;java.lang.String&nbsp;getPatternId()</pre>
215 </li>
216 </ul>
217 <a name="getMacPrefixRawBytes--">
218 <!--   -->
219 </a>
220 <ul class="blockList">
221 <li class="blockList">
222 <h4>getMacPrefixRawBytes</h4>
223 <pre>public&nbsp;byte[]&nbsp;getMacPrefixRawBytes()</pre>
224 </li>
225 </ul>
226 <a name="getPacketLengthSequence--">
227 <!--   -->
228 </a>
229 <ul class="blockList">
230 <li class="blockList">
231 <h4>getPacketLengthSequence</h4>
232 <pre>public&nbsp;java.util.List&lt;java.lang.Integer&gt;&nbsp;getPacketLengthSequence()</pre>
233 </li>
234 </ul>
235 <a name="getLength--">
236 <!--   -->
237 </a>
238 <ul class="blockListLast">
239 <li class="blockList">
240 <h4>getLength</h4>
241 <pre>public&nbsp;int&nbsp;getLength()</pre>
242 </li>
243 </ul>
244 </li>
245 </ul>
246 </li>
247 </ul>
248 </div>
249 </div>
250 <!-- ========= END OF CLASS DATA ========= -->
251 <!-- ======= START OF BOTTOM NAVBAR ====== -->
252 <div class="bottomNav"><a name="navbar.bottom">
253 <!--   -->
254 </a>
255 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
256 <a name="navbar.bottom.firstrow">
257 <!--   -->
258 </a>
259 <ul class="navList" title="Navigation">
260 <li><a href="../../../../overview-summary.html">Overview</a></li>
261 <li><a href="package-summary.html">Package</a></li>
262 <li class="navBarCell1Rev">Class</li>
263 <li><a href="package-tree.html">Tree</a></li>
264 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
265 <li><a href="../../../../index-files/index-1.html">Index</a></li>
266 <li><a href="../../../../help-doc.html">Help</a></li>
267 </ul>
268 </div>
269 <div class="subNav">
270 <ul class="navList">
271 <li>Prev&nbsp;Class</li>
272 <li><a href="../../../../edu/uci/iotproject/maclayer/MacLayerFlowPatternFinder.html" title="class in edu.uci.iotproject.maclayer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
273 </ul>
274 <ul class="navList">
275 <li><a href="../../../../index.html?edu/uci/iotproject/maclayer/MacLayerFlowPattern.html" target="_top">Frames</a></li>
276 <li><a href="MacLayerFlowPattern.html" target="_top">No&nbsp;Frames</a></li>
277 </ul>
278 <ul class="navList" id="allclasses_navbar_bottom">
279 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
280 </ul>
281 <div>
282 <script type="text/javascript"><!--
283   allClassesLink = document.getElementById("allclasses_navbar_bottom");
284   if(window==top) {
285     allClassesLink.style.display = "block";
286   }
287   else {
288     allClassesLink.style.display = "none";
289   }
290   //-->
291 </script>
292 </div>
293 <div>
294 <ul class="subNavList">
295 <li>Summary:&nbsp;</li>
296 <li>Nested&nbsp;|&nbsp;</li>
297 <li>Field&nbsp;|&nbsp;</li>
298 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
299 <li><a href="#method.summary">Method</a></li>
300 </ul>
301 <ul class="subNavList">
302 <li>Detail:&nbsp;</li>
303 <li>Field&nbsp;|&nbsp;</li>
304 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
305 <li><a href="#method.detail">Method</a></li>
306 </ul>
307 </div>
308 <a name="skip.navbar.bottom">
309 <!--   -->
310 </a></div>
311 <!-- ======== END OF BOTTOM NAVBAR ======= -->
312 </body>
313 </html>