1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2007-03-18 $'.split()[1]
5 __author__ = 'xmlbinmsg'
6
7 __doc__='''
8
9 Autogenerated python functions to serialize/deserialize binary messages.
10
11 Generated by: ./aisxmlbinmsg2py.py
12
13 Need to then wrap these functions with the outer AIS packet and then
14 convert the whole binary blob to a NMEA string. Those functions are
15 not currently provided in this file.
16
17 serialize: python to ais binary
18 deserialize: ais binary to python
19
20 The generated code uses translators.py, binary.py, and aisstring.py
21 which should be packaged with the resulting files.
22
23
24 @requires: U{epydoc<http://epydoc.sourceforge.net/>} > 3.0alpha3
25 @requires: U{BitVector<http://cheeseshop.python.org/pypi/BitVector>}
26
27 @author: '''+__author__+'''
28 @version: ''' + __version__ +'''
29 @var __date__: Date of last svn commit
30 @undocumented: __version__ __author__ __doc__ parser
31 @status: under development
32 @license: Generated code has no license
33 @todo: FIX: put in a description of the message here with fields and types.
34 '''
35
36 import sys
37 from decimal import Decimal
38 from BitVector import BitVector
39
40 import binary, aisstring
41
42
43 TrueBV = BitVector(bitstring="1")
44 "Why always rebuild the True bit? This should speed things up a bunch"
45 FalseBV = BitVector(bitstring="0")
46 "Why always rebuild the False bit? This should speed things up a bunch"
47
48
49 fieldList = (
50 'MessageID',
51 'RepeatIndicator',
52 'UserID',
53 'Spare',
54 'offset1',
55 'numslots1',
56 'timeout1',
57 'increment1',
58 'offset2',
59 'numslots2',
60 'timeout2',
61 'increment2',
62 'offset3',
63 'numslots3',
64 'timeout3',
65 'increment3',
66 'offset4',
67 'numslots4',
68 'timeout4',
69 'increment4',
70 'variablespare',
71 )
72
73 fieldListPostgres = (
74 'MessageID',
75 'RepeatIndicator',
76 'UserID',
77 'Spare',
78 'offset1',
79 'numslots1',
80 'timeout1',
81 'increment1',
82 'offset2',
83 'numslots2',
84 'timeout2',
85 'increment2',
86 'offset3',
87 'numslots3',
88 'timeout3',
89 'increment3',
90 'offset4',
91 'numslots4',
92 'timeout4',
93 'increment4',
94 'variablespare',
95 )
96
97 toPgFields = {
98 }
99 '''
100 Go to the Postgis field names from the straight field name
101 '''
102
103 fromPgFields = {
104 }
105 '''
106 Go from the Postgis field names to the straight field name
107 '''
108
109 pgTypes = {
110 }
111 '''
112 Lookup table for each postgis field name to get its type.
113 '''
114
115 -def encode(params, validate=False):
116 '''Create a datalinkmng binary message payload to pack into an AIS Msg datalinkmng.
117
118 Fields in params:
119 - MessageID(uint): AIS message number. Must be 20 (field automatically set to "20")
120 - RepeatIndicator(uint): Indicated how many times a message has been repeated
121 - UserID(uint): Unique ship identification number (MMSI)
122 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0")
123 - offset1(uint): Reserved offset number
124 - numslots1(uint): Number of reserved consecutive slots
125 - timeout1(uint): Time-out value in minutes
126 - increment1(uint): Increment to repeast reservation of this block
127 - offset2(uint): Reserved offset number (optional)
128 - numslots2(uint): Number of reserved consecutive slots (optional)
129 - timeout2(uint): Time-out value in minutes (optional)
130 - increment2(uint): Increment to repeast reservation of this block (optional)
131 - offset3(uint): Reserved offset number (optional)
132 - numslots3(uint): Number of reserved consecutive slots (optional)
133 - timeout3(uint): Time-out value in minutes (optional)
134 - increment3(uint): Increment to repeast reservation of this block (optional)
135 - offset4(uint): Reserved offset number (optional)
136 - numslots4(uint): Number of reserved consecutive slots (optional)
137 - timeout4(uint): Time-out value in minutes (optional)
138 - increment4(uint): Increment to repeast reservation of this block (optional)
139 - variablespare(uint): This field is a serious pain. This padding makes the message byte aligned (field automatically set to "0")
140 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing
141 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
142 @rtype: BitVector
143 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8
144 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits.
145 '''
146
147 bvList = []
148 bvList.append(binary.setBitVectorSize(BitVector(intVal=20),6))
149 if 'RepeatIndicator' in params:
150 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['RepeatIndicator']),2))
151 else:
152 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2))
153 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['UserID']),30))
154 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2))
155 if 'offset1' in params:
156 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['offset1']),12))
157 else:
158 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),12))
159 if 'numslots1' in params:
160 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['numslots1']),4))
161 else:
162 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4))
163 if 'timeout1' in params:
164 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeout1']),3))
165 else:
166 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),3))
167 if 'increment1' in params:
168 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['increment1']),11))
169 else:
170 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),11))
171 if 'offset2' in params:
172 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['offset2']),12))
173 else:
174 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),12))
175 if 'numslots2' in params:
176 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['numslots2']),4))
177 else:
178 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4))
179 if 'timeout2' in params:
180 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeout2']),3))
181 else:
182 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),3))
183 if 'increment2' in params:
184 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['increment2']),11))
185 else:
186 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),11))
187 if 'offset3' in params:
188 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['offset3']),12))
189 else:
190 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),12))
191 if 'numslots3' in params:
192 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['numslots3']),4))
193 else:
194 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4))
195 if 'timeout3' in params:
196 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeout3']),3))
197 else:
198 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),3))
199 if 'increment3' in params:
200 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['increment3']),11))
201 else:
202 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),11))
203 if 'offset4' in params:
204 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['offset4']),12))
205 else:
206 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),12))
207 if 'numslots4' in params:
208 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['numslots4']),4))
209 else:
210 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4))
211 if 'timeout4' in params:
212 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeout4']),3))
213 else:
214 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),3))
215 if 'increment4' in params:
216 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['increment4']),11))
217 else:
218 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),11))
219 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),6))
220
221 return binary.joinBV(bvList)
222
223 -def decode(bv, validate=False):
224 '''Unpack a datalinkmng message
225
226 Fields in params:
227 - MessageID(uint): AIS message number. Must be 20 (field automatically set to "20")
228 - RepeatIndicator(uint): Indicated how many times a message has been repeated
229 - UserID(uint): Unique ship identification number (MMSI)
230 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0")
231 - offset1(uint): Reserved offset number
232 - numslots1(uint): Number of reserved consecutive slots
233 - timeout1(uint): Time-out value in minutes
234 - increment1(uint): Increment to repeast reservation of this block
235 - offset2(uint): Reserved offset number (optional)
236 - numslots2(uint): Number of reserved consecutive slots (optional)
237 - timeout2(uint): Time-out value in minutes (optional)
238 - increment2(uint): Increment to repeast reservation of this block (optional)
239 - offset3(uint): Reserved offset number (optional)
240 - numslots3(uint): Number of reserved consecutive slots (optional)
241 - timeout3(uint): Time-out value in minutes (optional)
242 - increment3(uint): Increment to repeast reservation of this block (optional)
243 - offset4(uint): Reserved offset number (optional)
244 - numslots4(uint): Number of reserved consecutive slots (optional)
245 - timeout4(uint): Time-out value in minutes (optional)
246 - increment4(uint): Increment to repeast reservation of this block (optional)
247 - variablespare(uint): This field is a serious pain. This padding makes the message byte aligned (field automatically set to "0")
248 @type bv: BitVector
249 @param bv: Bits defining a message
250 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
251 @rtype: dict
252 @return: params
253 '''
254
255
256
257
258 r = {}
259 r['MessageID']=20
260 r['RepeatIndicator']=int(bv[6:8])
261 r['UserID']=int(bv[8:38])
262 r['Spare']=0
263 r['offset1']=int(bv[40:52])
264 r['numslots1']=int(bv[52:56])
265 r['timeout1']=int(bv[56:59])
266 r['increment1']=int(bv[59:70])
267 if len(bv)<=72: return r;
268 r['offset2']=int(bv[70:82])
269 r['numslots2']=int(bv[82:86])
270 r['timeout2']=int(bv[86:89])
271 r['increment2']=int(bv[89:100])
272 if len(bv)<=104: return r;
273 r['offset3']=int(bv[100:112])
274 r['numslots3']=int(bv[112:116])
275 r['timeout3']=int(bv[116:119])
276 r['increment3']=int(bv[119:130])
277 if len(bv)<=136: return r;
278 r['offset4']=int(bv[130:142])
279 r['numslots4']=int(bv[142:146])
280 r['timeout4']=int(bv[146:149])
281 r['increment4']=int(bv[149:160])
282 r['variablespare']=0
283 return r
284
287
290
293
296
298 return int(bv[40:52])
299
301 return int(bv[52:56])
302
304 return int(bv[56:59])
305
307 return int(bv[59:70])
308
310 return int(bv[70:82])
311
313 return int(bv[82:86])
314
316 return int(bv[86:89])
317
319 return int(bv[89:100])
320
322 return int(bv[100:112])
323
325 return int(bv[112:116])
326
328 return int(bv[116:119])
329
331 return int(bv[119:130])
332
334 return int(bv[130:142])
335
337 return int(bv[142:146])
338
340 return int(bv[146:149])
341
343 return int(bv[149:160])
344
347
348
350 out.write("<h3>datalinkmng<h3>\n")
351 out.write("<table border=\"1\">\n")
352 out.write("<tr bgcolor=\"orange\">\n")
353 out.write("<th align=\"left\">Field Name</th>\n")
354 out.write("<th align=\"left\">Type</th>\n")
355 out.write("<th align=\"left\">Value</th>\n")
356 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
357 out.write("<th align=\"left\">Units</th>\n")
358 out.write("\n")
359 out.write("<tr>\n")
360 out.write("<td>MessageID</td>\n")
361 out.write("<td>uint</td>\n")
362 if 'MessageID' in params:
363 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
364 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
365 out.write("</tr>\n")
366 out.write("\n")
367 out.write("<tr>\n")
368 out.write("<td>RepeatIndicator</td>\n")
369 out.write("<td>uint</td>\n")
370 if 'RepeatIndicator' in params:
371 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n")
372 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut:
373 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>")
374 else:
375 out.write("<td><i>Missing LUT entry</i></td>")
376 out.write("</tr>\n")
377 out.write("\n")
378 out.write("<tr>\n")
379 out.write("<td>UserID</td>\n")
380 out.write("<td>uint</td>\n")
381 if 'UserID' in params:
382 out.write(" <td>"+str(params['UserID'])+"</td>\n")
383 out.write(" <td>"+str(params['UserID'])+"</td>\n")
384 out.write("</tr>\n")
385 out.write("\n")
386 out.write("<tr>\n")
387 out.write("<td>Spare</td>\n")
388 out.write("<td>uint</td>\n")
389 if 'Spare' in params:
390 out.write(" <td>"+str(params['Spare'])+"</td>\n")
391 out.write(" <td>"+str(params['Spare'])+"</td>\n")
392 out.write("</tr>\n")
393 out.write("\n")
394 out.write("<tr>\n")
395 out.write("<td>offset1</td>\n")
396 out.write("<td>uint</td>\n")
397 if 'offset1' in params:
398 out.write(" <td>"+str(params['offset1'])+"</td>\n")
399 out.write(" <td>"+str(params['offset1'])+"</td>\n")
400 out.write("</tr>\n")
401 out.write("\n")
402 out.write("<tr>\n")
403 out.write("<td>numslots1</td>\n")
404 out.write("<td>uint</td>\n")
405 if 'numslots1' in params:
406 out.write(" <td>"+str(params['numslots1'])+"</td>\n")
407 out.write(" <td>"+str(params['numslots1'])+"</td>\n")
408 out.write("</tr>\n")
409 out.write("\n")
410 out.write("<tr>\n")
411 out.write("<td>timeout1</td>\n")
412 out.write("<td>uint</td>\n")
413 if 'timeout1' in params:
414 out.write(" <td>"+str(params['timeout1'])+"</td>\n")
415 out.write(" <td>"+str(params['timeout1'])+"</td>\n")
416 out.write("<td>min</td>\n")
417 out.write("</tr>\n")
418 out.write("\n")
419 out.write("<tr>\n")
420 out.write("<td>increment1</td>\n")
421 out.write("<td>uint</td>\n")
422 if 'increment1' in params:
423 out.write(" <td>"+str(params['increment1'])+"</td>\n")
424 out.write(" <td>"+str(params['increment1'])+"</td>\n")
425 out.write("</tr>\n")
426 out.write("\n")
427 out.write("<tr>\n")
428 out.write("<td>offset2</td>\n")
429 out.write("<td>uint</td>\n")
430 if 'offset2' in params:
431 out.write(" <td>"+str(params['offset2'])+"</td>\n")
432 out.write(" <td>"+str(params['offset2'])+"</td>\n")
433 out.write("</tr>\n")
434 out.write("\n")
435 out.write("<tr>\n")
436 out.write("<td>numslots2</td>\n")
437 out.write("<td>uint</td>\n")
438 if 'numslots2' in params:
439 out.write(" <td>"+str(params['numslots2'])+"</td>\n")
440 out.write(" <td>"+str(params['numslots2'])+"</td>\n")
441 out.write("</tr>\n")
442 out.write("\n")
443 out.write("<tr>\n")
444 out.write("<td>timeout2</td>\n")
445 out.write("<td>uint</td>\n")
446 if 'timeout2' in params:
447 out.write(" <td>"+str(params['timeout2'])+"</td>\n")
448 out.write(" <td>"+str(params['timeout2'])+"</td>\n")
449 out.write("<td>min</td>\n")
450 out.write("</tr>\n")
451 out.write("\n")
452 out.write("<tr>\n")
453 out.write("<td>increment2</td>\n")
454 out.write("<td>uint</td>\n")
455 if 'increment2' in params:
456 out.write(" <td>"+str(params['increment2'])+"</td>\n")
457 out.write(" <td>"+str(params['increment2'])+"</td>\n")
458 out.write("</tr>\n")
459 out.write("\n")
460 out.write("<tr>\n")
461 out.write("<td>offset3</td>\n")
462 out.write("<td>uint</td>\n")
463 if 'offset3' in params:
464 out.write(" <td>"+str(params['offset3'])+"</td>\n")
465 out.write(" <td>"+str(params['offset3'])+"</td>\n")
466 out.write("</tr>\n")
467 out.write("\n")
468 out.write("<tr>\n")
469 out.write("<td>numslots3</td>\n")
470 out.write("<td>uint</td>\n")
471 if 'numslots3' in params:
472 out.write(" <td>"+str(params['numslots3'])+"</td>\n")
473 out.write(" <td>"+str(params['numslots3'])+"</td>\n")
474 out.write("</tr>\n")
475 out.write("\n")
476 out.write("<tr>\n")
477 out.write("<td>timeout3</td>\n")
478 out.write("<td>uint</td>\n")
479 if 'timeout3' in params:
480 out.write(" <td>"+str(params['timeout3'])+"</td>\n")
481 out.write(" <td>"+str(params['timeout3'])+"</td>\n")
482 out.write("<td>min</td>\n")
483 out.write("</tr>\n")
484 out.write("\n")
485 out.write("<tr>\n")
486 out.write("<td>increment3</td>\n")
487 out.write("<td>uint</td>\n")
488 if 'increment3' in params:
489 out.write(" <td>"+str(params['increment3'])+"</td>\n")
490 out.write(" <td>"+str(params['increment3'])+"</td>\n")
491 out.write("</tr>\n")
492 out.write("\n")
493 out.write("<tr>\n")
494 out.write("<td>offset4</td>\n")
495 out.write("<td>uint</td>\n")
496 if 'offset4' in params:
497 out.write(" <td>"+str(params['offset4'])+"</td>\n")
498 out.write(" <td>"+str(params['offset4'])+"</td>\n")
499 out.write("</tr>\n")
500 out.write("\n")
501 out.write("<tr>\n")
502 out.write("<td>numslots4</td>\n")
503 out.write("<td>uint</td>\n")
504 if 'numslots4' in params:
505 out.write(" <td>"+str(params['numslots4'])+"</td>\n")
506 out.write(" <td>"+str(params['numslots4'])+"</td>\n")
507 out.write("</tr>\n")
508 out.write("\n")
509 out.write("<tr>\n")
510 out.write("<td>timeout4</td>\n")
511 out.write("<td>uint</td>\n")
512 if 'timeout4' in params:
513 out.write(" <td>"+str(params['timeout4'])+"</td>\n")
514 out.write(" <td>"+str(params['timeout4'])+"</td>\n")
515 out.write("<td>min</td>\n")
516 out.write("</tr>\n")
517 out.write("\n")
518 out.write("<tr>\n")
519 out.write("<td>increment4</td>\n")
520 out.write("<td>uint</td>\n")
521 if 'increment4' in params:
522 out.write(" <td>"+str(params['increment4'])+"</td>\n")
523 out.write(" <td>"+str(params['increment4'])+"</td>\n")
524 out.write("</tr>\n")
525 out.write("\n")
526 out.write("<tr>\n")
527 out.write("<td>variablespare</td>\n")
528 out.write("<td>uint</td>\n")
529 if 'variablespare' in params:
530 out.write(" <td>"+str(params['variablespare'])+"</td>\n")
531 out.write(" <td>"+str(params['variablespare'])+"</td>\n")
532 out.write("</tr>\n")
533 out.write("</table>\n")
534
535 -def printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres'):
536 '''Print a datalinkmng message to stdout.
537
538 Fields in params:
539 - MessageID(uint): AIS message number. Must be 20 (field automatically set to "20")
540 - RepeatIndicator(uint): Indicated how many times a message has been repeated
541 - UserID(uint): Unique ship identification number (MMSI)
542 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0")
543 - offset1(uint): Reserved offset number
544 - numslots1(uint): Number of reserved consecutive slots
545 - timeout1(uint): Time-out value in minutes
546 - increment1(uint): Increment to repeast reservation of this block
547 - offset2(uint): Reserved offset number (optional)
548 - numslots2(uint): Number of reserved consecutive slots (optional)
549 - timeout2(uint): Time-out value in minutes (optional)
550 - increment2(uint): Increment to repeast reservation of this block (optional)
551 - offset3(uint): Reserved offset number (optional)
552 - numslots3(uint): Number of reserved consecutive slots (optional)
553 - timeout3(uint): Time-out value in minutes (optional)
554 - increment3(uint): Increment to repeast reservation of this block (optional)
555 - offset4(uint): Reserved offset number (optional)
556 - numslots4(uint): Number of reserved consecutive slots (optional)
557 - timeout4(uint): Time-out value in minutes (optional)
558 - increment4(uint): Increment to repeast reservation of this block (optional)
559 - variablespare(uint): This field is a serious pain. This padding makes the message byte aligned (field automatically set to "0")
560 @param params: Dictionary of field names/values.
561 @param out: File like object to write to
562 @rtype: stdout
563 @return: text to out
564 '''
565
566 if 'std'==format:
567 out.write("datalinkmng:\n")
568 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n")
569 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n")
570 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n")
571 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n")
572 if 'offset1' in params: out.write(" offset1: "+str(params['offset1'])+"\n")
573 if 'numslots1' in params: out.write(" numslots1: "+str(params['numslots1'])+"\n")
574 if 'timeout1' in params: out.write(" timeout1: "+str(params['timeout1'])+"\n")
575 if 'increment1' in params: out.write(" increment1: "+str(params['increment1'])+"\n")
576 if 'offset2' in params: out.write(" offset2: "+str(params['offset2'])+"\n")
577 if 'numslots2' in params: out.write(" numslots2: "+str(params['numslots2'])+"\n")
578 if 'timeout2' in params: out.write(" timeout2: "+str(params['timeout2'])+"\n")
579 if 'increment2' in params: out.write(" increment2: "+str(params['increment2'])+"\n")
580 if 'offset3' in params: out.write(" offset3: "+str(params['offset3'])+"\n")
581 if 'numslots3' in params: out.write(" numslots3: "+str(params['numslots3'])+"\n")
582 if 'timeout3' in params: out.write(" timeout3: "+str(params['timeout3'])+"\n")
583 if 'increment3' in params: out.write(" increment3: "+str(params['increment3'])+"\n")
584 if 'offset4' in params: out.write(" offset4: "+str(params['offset4'])+"\n")
585 if 'numslots4' in params: out.write(" numslots4: "+str(params['numslots4'])+"\n")
586 if 'timeout4' in params: out.write(" timeout4: "+str(params['timeout4'])+"\n")
587 if 'increment4' in params: out.write(" increment4: "+str(params['increment4'])+"\n")
588 if 'variablespare' in params: out.write(" variablespare: "+str(params['variablespare'])+"\n")
589 elif 'csv'==format:
590 if None == options.fieldList:
591 options.fieldList = fieldList
592 needComma = False;
593 for field in fieldList:
594 if needComma: out.write(',')
595 needComma = True
596 if field in params:
597 out.write(str(params[field]))
598
599 out.write("\n")
600 elif 'html'==format:
601 printHtml(params,out)
602 elif 'sql'==format:
603 sqlInsertStr(params,out,dbType=dbType)
604 else:
605 print "ERROR: unknown format:",format
606 assert False
607
608 return
609
610 RepeatIndicatorEncodeLut = {
611 'default':'0',
612 'do not repeat any more':'3',
613 }
614
615 RepeatIndicatorDecodeLut = {
616 '0':'default',
617 '3':'do not repeat any more',
618 }
619
620
621
622
623
624 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None
625 ,addCoastGuardFields=True
626 ,dbType='postgres'
627 ):
628 '''
629 Return the SQL CREATE command for this message type
630 @param outfile: file like object to print to.
631 @param fields: which fields to put in the create. Defaults to all.
632 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields
633 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format
634 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
635 @type addCoastGuardFields: bool
636 @return: sql create string
637 @rtype: str
638
639 @see: sqlCreate
640 '''
641 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))
642
643 -def sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres'):
644 '''
645 Return the sqlhelp object to create the table.
646
647 @param fields: which fields to put in the create. Defaults to all.
648 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields
649 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format
650 @type addCoastGuardFields: bool
651 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
652 @return: An object that can be used to generate a return
653 @rtype: sqlhelp.create
654 '''
655 if None == fields: fields = fieldList
656 import sqlhelp
657 c = sqlhelp.create('datalinkmng',dbType=dbType)
658 c.addPrimaryKey()
659 if 'MessageID' in fields: c.addInt ('MessageID')
660 if 'RepeatIndicator' in fields: c.addInt ('RepeatIndicator')
661 if 'UserID' in fields: c.addInt ('UserID')
662 if 'Spare' in fields: c.addInt ('Spare')
663 if 'offset1' in fields: c.addInt ('offset1')
664 if 'numslots1' in fields: c.addInt ('numslots1')
665 if 'timeout1' in fields: c.addInt ('timeout1')
666 if 'increment1' in fields: c.addInt ('increment1')
667 if 'offset2' in fields: c.addInt ('offset2')
668 if 'numslots2' in fields: c.addInt ('numslots2')
669 if 'timeout2' in fields: c.addInt ('timeout2')
670 if 'increment2' in fields: c.addInt ('increment2')
671 if 'offset3' in fields: c.addInt ('offset3')
672 if 'numslots3' in fields: c.addInt ('numslots3')
673 if 'timeout3' in fields: c.addInt ('timeout3')
674 if 'increment3' in fields: c.addInt ('increment3')
675 if 'offset4' in fields: c.addInt ('offset4')
676 if 'numslots4' in fields: c.addInt ('numslots4')
677 if 'timeout4' in fields: c.addInt ('timeout4')
678 if 'increment4' in fields: c.addInt ('increment4')
679 if 'variablespare' in fields: c.addInt ('variablespare')
680
681 if addCoastGuardFields:
682
683
684
685
686
687 c.addVarChar('cg_r',15)
688 c.addInt('cg_sec')
689
690 c.addTimestamp('cg_timestamp')
691
692 return c
693
694 -def sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres'):
695 '''
696 Return the SQL INSERT command for this message type
697 @param params: dictionary of values keyed by field name
698 @param outfile: file like object to print to.
699 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields
700 @return: sql create string
701 @rtype: str
702
703 @see: sqlCreate
704 '''
705 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))
706
707
708 -def sqlInsert(params,extraParams=None,dbType='postgres'):
709 '''
710 Give the SQL INSERT statement
711 @param params: dict keyed by field name of values
712 @param extraParams: any extra fields that you have created beyond the normal ais message fields
713 @rtype: sqlhelp.insert
714 @return: insert class instance
715 @todo: allow optional type checking of params?
716 @warning: this will take invalid keys happily and do what???
717 '''
718 import sqlhelp
719 i = sqlhelp.insert('datalinkmng',dbType=dbType)
720
721 if dbType=='postgres':
722 finished = []
723 for key in params:
724 if key in finished:
725 continue
726
727 if key not in toPgFields and key not in fromPgFields:
728 if type(params[key])==Decimal: i.add(key,float(params[key]))
729 else: i.add(key,params[key])
730 else:
731 if key in fromPgFields:
732 val = params[key]
733
734 i.addPostGIS(key,val)
735 finished.append(key)
736 else:
737
738 pgName = toPgFields[key]
739
740 valStr=pgTypes[pgName]+'('
741 vals = []
742 for nonPgKey in fromPgFields[pgName]:
743 vals.append(str(params[nonPgKey]))
744 finished.append(nonPgKey)
745 valStr+=' '.join(vals)+')'
746 i.addPostGIS(pgName,valStr)
747 else:
748 for key in params:
749 if type(params[key])==Decimal: i.add(key,float(params[key]))
750 else: i.add(key,params[key])
751
752 if None != extraParams:
753 for key in extraParams:
754 i.add(key,extraParams[key])
755
756 return i
757
758
759
760
761
762 import unittest
764 '''Return a params file base on the testvalue tags.
765 @rtype: dict
766 @return: params based on testvalue tags
767 '''
768 params = {}
769 params['MessageID'] = 20
770 params['RepeatIndicator'] = 1
771 params['UserID'] = 1193046
772 params['Spare'] = 0
773 params['offset1'] = 10
774 params['numslots1'] = 1
775 params['timeout1'] = 1
776 params['increment1'] = 14
777 params['offset2'] = 20
778 params['numslots2'] = 2
779 params['timeout2'] = 2
780 params['increment2'] = 24
781 params['offset3'] = 30
782 params['numslots3'] = 3
783 params['timeout3'] = 3
784 params['increment3'] = 34
785 params['offset4'] = 40
786 params['numslots4'] = 4
787 params['timeout4'] = 4
788 params['increment4'] = 44
789 params['variablespare'] = 0
790
791 return params
792
794 '''Use testvalue tag text from each type to build test case the datalinkmng message'''
796
797 params = testParams()
798 bits = encode(params)
799 r = decode(bits)
800
801
802 self.failUnlessEqual(r['MessageID'],params['MessageID'])
803 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator'])
804 self.failUnlessEqual(r['UserID'],params['UserID'])
805 self.failUnlessEqual(r['Spare'],params['Spare'])
806 self.failUnlessEqual(r['offset1'],params['offset1'])
807 self.failUnlessEqual(r['numslots1'],params['numslots1'])
808 self.failUnlessEqual(r['timeout1'],params['timeout1'])
809 self.failUnlessEqual(r['increment1'],params['increment1'])
810 self.failUnlessEqual(r['offset2'],params['offset2'])
811 self.failUnlessEqual(r['numslots2'],params['numslots2'])
812 self.failUnlessEqual(r['timeout2'],params['timeout2'])
813 self.failUnlessEqual(r['increment2'],params['increment2'])
814 self.failUnlessEqual(r['offset3'],params['offset3'])
815 self.failUnlessEqual(r['numslots3'],params['numslots3'])
816 self.failUnlessEqual(r['timeout3'],params['timeout3'])
817 self.failUnlessEqual(r['increment3'],params['increment3'])
818 self.failUnlessEqual(r['offset4'],params['offset4'])
819 self.failUnlessEqual(r['numslots4'],params['numslots4'])
820 self.failUnlessEqual(r['timeout4'],params['timeout4'])
821 self.failUnlessEqual(r['increment4'],params['increment4'])
822 self.failUnlessEqual(r['variablespare'],params['variablespare'])
823
825 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
826 help='decode a "datalinkmng" AIS message')
827 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
828 help='encode a "datalinkmng" AIS message')
829 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int'
830 ,help='Field parameter value [default: %default]')
831 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int'
832 ,help='Field parameter value [default: %default]')
833 parser.add_option('--offset1-field', dest='offset1Field',default=0,metavar='uint',type='int'
834 ,help='Field parameter value [default: %default]')
835 parser.add_option('--numslots1-field', dest='numslots1Field',default=0,metavar='uint',type='int'
836 ,help='Field parameter value [default: %default]')
837 parser.add_option('--timeout1-field', dest='timeout1Field',default=0,metavar='uint',type='int'
838 ,help='Field parameter value [default: %default]')
839 parser.add_option('--increment1-field', dest='increment1Field',default=0,metavar='uint',type='int'
840 ,help='Field parameter value [default: %default]')
841 parser.add_option('--offset2-field', dest='offset2Field',default=0,metavar='uint',type='int'
842 ,help='Field parameter value [default: %default]')
843 parser.add_option('--numslots2-field', dest='numslots2Field',default=0,metavar='uint',type='int'
844 ,help='Field parameter value [default: %default]')
845 parser.add_option('--timeout2-field', dest='timeout2Field',default=0,metavar='uint',type='int'
846 ,help='Field parameter value [default: %default]')
847 parser.add_option('--increment2-field', dest='increment2Field',default=0,metavar='uint',type='int'
848 ,help='Field parameter value [default: %default]')
849 parser.add_option('--offset3-field', dest='offset3Field',default=0,metavar='uint',type='int'
850 ,help='Field parameter value [default: %default]')
851 parser.add_option('--numslots3-field', dest='numslots3Field',default=0,metavar='uint',type='int'
852 ,help='Field parameter value [default: %default]')
853 parser.add_option('--timeout3-field', dest='timeout3Field',default=0,metavar='uint',type='int'
854 ,help='Field parameter value [default: %default]')
855 parser.add_option('--increment3-field', dest='increment3Field',default=0,metavar='uint',type='int'
856 ,help='Field parameter value [default: %default]')
857 parser.add_option('--offset4-field', dest='offset4Field',default=0,metavar='uint',type='int'
858 ,help='Field parameter value [default: %default]')
859 parser.add_option('--numslots4-field', dest='numslots4Field',default=0,metavar='uint',type='int'
860 ,help='Field parameter value [default: %default]')
861 parser.add_option('--timeout4-field', dest='timeout4Field',default=0,metavar='uint',type='int'
862 ,help='Field parameter value [default: %default]')
863 parser.add_option('--increment4-field', dest='increment4Field',default=0,metavar='uint',type='int'
864 ,help='Field parameter value [default: %default]')
865
866
867 if __name__=='__main__':
868
869 from optparse import OptionParser
870 parser = OptionParser(usage="%prog [options]",
871 version="%prog "+__version__)
872
873 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
874 help='run the documentation tests')
875 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
876 help='run the unit tests')
877 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
878 help='Make the test output verbose')
879
880
881
882 typeChoices = ('binary','nmeapayload','nmea')
883 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
884 ,default='nmeapayload'
885 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]')
886
887
888 outputChoices = ('std','html','csv','sql' )
889 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
890 ,default='std'
891 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
892
893 parser.add_option('-o','--output',dest='outputFileName',default=None,
894 help='Name of the python file to write [default: stdout]')
895
896 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append',
897 choices=fieldList,
898 help='Which fields to include in the output. Currently only for csv output [default: all]')
899
900 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true',
901 help='Print the field name for csv')
902
903 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true',
904 help='Print out an sql create command for the table.')
905
906 dbChoices = ('sqlite','postgres')
907 parser.add_option('-D','--db-type',dest='dbType',default='postgres'
908 ,choices=dbChoices,type='choice'
909 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]')
910
911 addMsgOptions(parser)
912
913 (options,args) = parser.parse_args()
914 success=True
915
916 if options.doctest:
917 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
918 sys.argv= [sys.argv[0]]
919 if options.verbose: sys.argv.append('-v')
920 import doctest
921 numfail,numtests=doctest.testmod()
922 if numfail==0: print 'ok'
923 else:
924 print 'FAILED'
925 success=False
926
927 if not success: sys.exit('Something Failed')
928 del success
929
930 if options.unittest:
931 sys.argv = [sys.argv[0]]
932 if options.verbose: sys.argv.append('-v')
933 unittest.main()
934
935 outfile = sys.stdout
936 if None!=options.outputFileName:
937 outfile = file(options.outputFileName,'w')
938
939
940 if options.doEncode:
941
942 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField")
943 if None==options.UserIDField: parser.error("missing value for UserIDField")
944 if None==options.offset1Field: parser.error("missing value for offset1Field")
945 if None==options.numslots1Field: parser.error("missing value for numslots1Field")
946 if None==options.timeout1Field: parser.error("missing value for timeout1Field")
947 if None==options.increment1Field: parser.error("missing value for increment1Field")
948 if None==options.offset2Field: parser.error("missing value for offset2Field")
949 if None==options.numslots2Field: parser.error("missing value for numslots2Field")
950 if None==options.timeout2Field: parser.error("missing value for timeout2Field")
951 if None==options.increment2Field: parser.error("missing value for increment2Field")
952 if None==options.offset3Field: parser.error("missing value for offset3Field")
953 if None==options.numslots3Field: parser.error("missing value for numslots3Field")
954 if None==options.timeout3Field: parser.error("missing value for timeout3Field")
955 if None==options.increment3Field: parser.error("missing value for increment3Field")
956 if None==options.offset4Field: parser.error("missing value for offset4Field")
957 if None==options.numslots4Field: parser.error("missing value for numslots4Field")
958 if None==options.timeout4Field: parser.error("missing value for timeout4Field")
959 if None==options.increment4Field: parser.error("missing value for increment4Field")
960 msgDict={
961 'MessageID': '20',
962 'RepeatIndicator': options.RepeatIndicatorField,
963 'UserID': options.UserIDField,
964 'Spare': '0',
965 'offset1': options.offset1Field,
966 'numslots1': options.numslots1Field,
967 'timeout1': options.timeout1Field,
968 'increment1': options.increment1Field,
969 'offset2': options.offset2Field,
970 'numslots2': options.numslots2Field,
971 'timeout2': options.timeout2Field,
972 'increment2': options.increment2Field,
973 'offset3': options.offset3Field,
974 'numslots3': options.numslots3Field,
975 'timeout3': options.timeout3Field,
976 'increment3': options.increment3Field,
977 'offset4': options.offset4Field,
978 'numslots4': options.numslots4Field,
979 'timeout4': options.timeout4Field,
980 'increment4': options.increment4Field,
981 'variablespare': '0',
982 }
983
984 bits = encode(msgDict)
985 if 'binary'==options.ioType: print str(bits)
986 elif 'nmeapayload'==options.ioType:
987
988 print "bitLen",len(bits)
989 bitLen=len(bits)
990 if bitLen%6!=0:
991 bits = bits + BitVector(size=(6 - (bitLen%6)))
992 print "result:",binary.bitvectoais6(bits)[0]
993
994
995
996 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
997 else: sys.exit('ERROR: unknown ioType. Help!')
998
999
1000 if options.sqlCreate:
1001 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType)
1002
1003 if options.printCsvfieldList:
1004
1005 if None == options.fieldList: options.fieldList = fieldList
1006 import StringIO
1007 buf = StringIO.StringIO()
1008 for field in options.fieldList:
1009 buf.write(field+',')
1010 result = buf.getvalue()
1011 if result[-1] == ',': print result[:-1]
1012 else: print result
1013
1014 if options.doDecode:
1015 for msg in args:
1016 bv = None
1017
1018 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'):
1019
1020
1021 bv = binary.ais6tobitvec(msg.split(',')[5])
1022 else:
1023
1024 binaryMsg=True
1025 for c in msg:
1026 if c not in ('0','1'):
1027 binaryMsg=False
1028 break
1029 if binaryMsg:
1030 bv = BitVector(bitstring=msg)
1031 else:
1032 bv = binary.ais6tobitvec(msg)
1033
1034 printFields(decode(bv)
1035 ,out=outfile
1036 ,format=options.outputType
1037 ,fieldList=options.fieldList
1038 ,dbType=options.dbType
1039 )
1040