1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2007-02-16 $'.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 'vessel',
51 'direction',
52 'ETA_month',
53 'ETA_day',
54 'ETA_hour',
55 'ETA_min',
56 'reserved',
57 )
58
59 fieldListPostgres = (
60 'vessel',
61 'direction',
62 'ETA_month',
63 'ETA_day',
64 'ETA_hour',
65 'ETA_min',
66 'reserved',
67 )
68
69 toPgFields = {
70 }
71 '''
72 Go to the Postgis field names from the straight field name
73 '''
74
75 fromPgFields = {
76 }
77 '''
78 Go from the Postgis field names to the straight field name
79 '''
80
81 pgTypes = {
82 }
83 '''
84 Lookup table for each postgis field name to get its type.
85 '''
86
87 -def encode(params, validate=False):
88 '''Create a sls_lockorder binary message payload to pack into an AIS Msg sls_lockorder.
89
90 Fields in params:
91 - vessel(aisstr6): Vessel Name
92 - direction(bool): Up bound/Down bound
93 - ETA_month(uint): Estimated time of arrival month 1..12
94 - ETA_day(uint): Estimated time of arrival day of the month 1..31
95 - ETA_hour(uint): Estimated time of arrival UTC hours 0..23
96 - ETA_min(uint): Estimated time of arrival minutes
97 - reserved(uint): Reserved bits for future use (field automatically set to "0")
98 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing
99 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
100 @rtype: BitVector
101 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8
102 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits.
103 '''
104
105 bvList = []
106 if 'vessel' in params:
107 bvList.append(aisstring.encode(params['vessel'],90))
108 else:
109 bvList.append(aisstring.encode('@@@@@@@@@@@@@@@',90))
110 if params["direction"]: bvList.append(TrueBV)
111 else: bvList.append(FalseBV)
112 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['ETA_month']),4))
113 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['ETA_day']),5))
114 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['ETA_hour']),5))
115 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['ETA_min']),6))
116 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),19))
117
118 return binary.joinBV(bvList)
119
120 -def decode(bv, validate=False):
121 '''Unpack a sls_lockorder message
122
123 Fields in params:
124 - vessel(aisstr6): Vessel Name
125 - direction(bool): Up bound/Down bound
126 - ETA_month(uint): Estimated time of arrival month 1..12
127 - ETA_day(uint): Estimated time of arrival day of the month 1..31
128 - ETA_hour(uint): Estimated time of arrival UTC hours 0..23
129 - ETA_min(uint): Estimated time of arrival minutes
130 - reserved(uint): Reserved bits for future use (field automatically set to "0")
131 @type bv: BitVector
132 @param bv: Bits defining a message
133 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
134 @rtype: dict
135 @return: params
136 '''
137
138
139
140
141 r = {}
142 r['vessel']=aisstring.decode(bv[0:90])
143 r['direction']=bool(int(bv[90:91]))
144 r['ETA_month']=int(bv[91:95])
145 r['ETA_day']=int(bv[95:100])
146 r['ETA_hour']=int(bv[100:105])
147 r['ETA_min']=int(bv[105:111])
148 r['reserved']=0
149 return r
150
153
155 return bool(int(bv[90:91]))
156
158 return int(bv[91:95])
159
161 return int(bv[95:100])
162
164 return int(bv[100:105])
165
167 return int(bv[105:111])
168
170 return 0
171
172
174 out.write("<h3>sls_lockorder<h3>\n")
175 out.write("<table border=\"1\">\n")
176 out.write("<tr bgcolor=\"orange\">\n")
177 out.write("<th align=\"left\">Field Name</th>\n")
178 out.write("<th align=\"left\">Type</th>\n")
179 out.write("<th align=\"left\">Value</th>\n")
180 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
181 out.write("<th align=\"left\">Units</th>\n")
182 out.write("\n")
183 out.write("<tr>\n")
184 out.write("<td>vessel</td>\n")
185 out.write("<td>aisstr6</td>\n")
186 if 'vessel' in params:
187 out.write(" <td>"+str(params['vessel'])+"</td>\n")
188 out.write(" <td>"+str(params['vessel'])+"</td>\n")
189 out.write("</tr>\n")
190 out.write("\n")
191 out.write("<tr>\n")
192 out.write("<td>direction</td>\n")
193 out.write("<td>bool</td>\n")
194 if 'direction' in params:
195 out.write(" <td>"+str(params['direction'])+"</td>\n")
196 if str(params['direction']) in directionDecodeLut:
197 out.write("<td>"+directionDecodeLut[str(params['direction'])]+"</td>")
198 else:
199 out.write("<td><i>Missing LUT entry</i></td>")
200 out.write("</tr>\n")
201 out.write("\n")
202 out.write("<tr>\n")
203 out.write("<td>ETA_month</td>\n")
204 out.write("<td>uint</td>\n")
205 if 'ETA_month' in params:
206 out.write(" <td>"+str(params['ETA_month'])+"</td>\n")
207 out.write(" <td>"+str(params['ETA_month'])+"</td>\n")
208 out.write("</tr>\n")
209 out.write("\n")
210 out.write("<tr>\n")
211 out.write("<td>ETA_day</td>\n")
212 out.write("<td>uint</td>\n")
213 if 'ETA_day' in params:
214 out.write(" <td>"+str(params['ETA_day'])+"</td>\n")
215 out.write(" <td>"+str(params['ETA_day'])+"</td>\n")
216 out.write("</tr>\n")
217 out.write("\n")
218 out.write("<tr>\n")
219 out.write("<td>ETA_hour</td>\n")
220 out.write("<td>uint</td>\n")
221 if 'ETA_hour' in params:
222 out.write(" <td>"+str(params['ETA_hour'])+"</td>\n")
223 out.write(" <td>"+str(params['ETA_hour'])+"</td>\n")
224 out.write("</tr>\n")
225 out.write("\n")
226 out.write("<tr>\n")
227 out.write("<td>ETA_min</td>\n")
228 out.write("<td>uint</td>\n")
229 if 'ETA_min' in params:
230 out.write(" <td>"+str(params['ETA_min'])+"</td>\n")
231 out.write(" <td>"+str(params['ETA_min'])+"</td>\n")
232 out.write("</tr>\n")
233 out.write("\n")
234 out.write("<tr>\n")
235 out.write("<td>reserved</td>\n")
236 out.write("<td>uint</td>\n")
237 if 'reserved' in params:
238 out.write(" <td>"+str(params['reserved'])+"</td>\n")
239 out.write(" <td>"+str(params['reserved'])+"</td>\n")
240 out.write("</tr>\n")
241 out.write("</table>\n")
242
243 -def printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres'):
244 '''Print a reserved message to stdout.
245
246 Fields in params:
247 - vessel(aisstr6): Vessel Name
248 - direction(bool): Up bound/Down bound
249 - ETA_month(uint): Estimated time of arrival month 1..12
250 - ETA_day(uint): Estimated time of arrival day of the month 1..31
251 - ETA_hour(uint): Estimated time of arrival UTC hours 0..23
252 - ETA_min(uint): Estimated time of arrival minutes
253 - reserved(uint): Reserved bits for future use (field automatically set to "0")
254 @param params: Dictionary of field names/values.
255 @param out: File like object to write to
256 @rtype: stdout
257 @return: text to out
258 '''
259
260 if 'std'==format:
261 out.write("reserved:\n")
262 if 'vessel' in params: out.write(" vessel: "+str(params['vessel'])+"\n")
263 if 'direction' in params: out.write(" direction: "+str(params['direction'])+"\n")
264 if 'ETA_month' in params: out.write(" ETA_month: "+str(params['ETA_month'])+"\n")
265 if 'ETA_day' in params: out.write(" ETA_day: "+str(params['ETA_day'])+"\n")
266 if 'ETA_hour' in params: out.write(" ETA_hour: "+str(params['ETA_hour'])+"\n")
267 if 'ETA_min' in params: out.write(" ETA_min: "+str(params['ETA_min'])+"\n")
268 if 'reserved' in params: out.write(" reserved: "+str(params['reserved'])+"\n")
269 elif 'csv'==format:
270 if None == options.fieldList:
271 options.fieldList = fieldList
272 needComma = False;
273 for field in fieldList:
274 if needComma: out.write(',')
275 needComma = True
276 if field in params:
277 out.write(str(params[field]))
278
279 out.write("\n")
280 elif 'html'==format:
281 printHtml(params,out)
282 elif 'sql'==format:
283 sqlInsertStr(params,out,dbType=dbType)
284 else:
285 print "ERROR: unknown format:",format
286 assert False
287
288 return
289
290 directionEncodeLut = {
291 'Down bound':'0',
292 'Up bound':'1',
293 }
294
295 directionDecodeLut = {
296 '0':'Down bound',
297 '1':'Up bound',
298 }
299
300
301
302
303
304 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None
305 ,addCoastGuardFields=True
306 ,dbType='postgres'
307 ):
308 '''
309 Return the SQL CREATE command for this message type
310 @param outfile: file like object to print to.
311 @param fields: which fields to put in the create. Defaults to all.
312 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields
313 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format
314 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
315 @type addCoastGuardFields: bool
316 @return: sql create string
317 @rtype: str
318
319 @see: sqlCreate
320 '''
321 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))
322
323 -def sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres'):
324 '''
325 Return the sqlhelp object to create the table.
326
327 @param fields: which fields to put in the create. Defaults to all.
328 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields
329 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format
330 @type addCoastGuardFields: bool
331 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
332 @return: An object that can be used to generate a return
333 @rtype: sqlhelp.create
334 '''
335 if None == fields: fields = fieldList
336 import sqlhelp
337 c = sqlhelp.create('sls_lockorder',dbType=dbType)
338 c.addPrimaryKey()
339 if 'vessel' in fields: c.addVarChar('vessel',15)
340 if 'direction' in fields: c.addBool('direction')
341 if 'ETA_month' in fields: c.addInt ('ETA_month')
342 if 'ETA_day' in fields: c.addInt ('ETA_day')
343 if 'ETA_hour' in fields: c.addInt ('ETA_hour')
344 if 'ETA_min' in fields: c.addInt ('ETA_min')
345 if 'reserved' in fields: c.addInt ('reserved')
346
347 if addCoastGuardFields:
348
349
350
351
352
353 c.addVarChar('cg_r',15)
354 c.addInt('cg_sec')
355
356 c.addTimestamp('cg_timestamp')
357
358 return c
359
360 -def sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres'):
361 '''
362 Return the SQL INSERT command for this message type
363 @param params: dictionary of values keyed by field name
364 @param outfile: file like object to print to.
365 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields
366 @return: sql create string
367 @rtype: str
368
369 @see: sqlCreate
370 '''
371 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))
372
373
374 -def sqlInsert(params,extraParams=None,dbType='postgres'):
375 '''
376 Give the SQL INSERT statement
377 @param params: dict keyed by field name of values
378 @param extraParams: any extra fields that you have created beyond the normal ais message fields
379 @rtype: sqlhelp.insert
380 @return: insert class instance
381 @todo: allow optional type checking of params?
382 @warning: this will take invalid keys happily and do what???
383 '''
384 import sqlhelp
385 i = sqlhelp.insert('sls_lockorder',dbType=dbType)
386
387 if dbType=='postgres':
388 finished = []
389 for key in params:
390 if key in finished:
391
392 continue
393
394 if key not in toPgFields and key not in fromPgFields:
395 if type(params[key])==Decimal: i.add(key,float(params[key]))
396 else: i.add(key,params[key])
397 else:
398 if key in fromPgFields:
399 val = params[key]
400
401 i.addPostGIS(key,val)
402 finished.append(key)
403 else:
404
405 pgName = toPgFields[key]
406
407 valStr=pgTypes[pgName]+'('
408 vals = []
409 for nonPgKey in fromPgFields[pgName]:
410 vals.append(str(params[nonPgKey]))
411 finished.append(nonPgKey)
412 valStr+=' '.join(vals)+')'
413 i.addPostGIS(pgName,valStr)
414 else:
415 for key in params:
416 if type(params[key])==Decimal: i.add(key,float(params[key]))
417 else: i.add(key,params[key])
418
419 if None != extraParams:
420 for key in extraParams:
421 i.add(key,extraParams[key])
422
423 return i
424
425
426
427
428
429 import unittest
431 '''Return a params file base on the testvalue tags.
432 @rtype: dict
433 @return: params based on testvalue tags
434 '''
435 params = {}
436 params['vessel'] = 'ICEBERG@@@@@@@@'
437 params['direction'] = True
438 params['ETA_month'] = 2
439 params['ETA_day'] = 28
440 params['ETA_hour'] = 23
441 params['ETA_min'] = 45
442 params['reserved'] = 0
443
444 return params
445
447 '''Use testvalue tag text from each type to build test case the sls_lockorder message'''
449
450 params = testParams()
451 bits = encode(params)
452 r = decode(bits)
453
454
455 self.failUnlessEqual(r['vessel'],params['vessel'])
456 self.failUnlessEqual(r['direction'],params['direction'])
457 self.failUnlessEqual(r['ETA_month'],params['ETA_month'])
458 self.failUnlessEqual(r['ETA_day'],params['ETA_day'])
459 self.failUnlessEqual(r['ETA_hour'],params['ETA_hour'])
460 self.failUnlessEqual(r['ETA_min'],params['ETA_min'])
461 self.failUnlessEqual(r['reserved'],params['reserved'])
462
464 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
465 help='decode a "sls_lockorder" AIS message')
466 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
467 help='encode a "sls_lockorder" AIS message')
468 parser.add_option('--vessel-field', dest='vesselField',default='@@@@@@@@@@@@@@@',metavar='aisstr6',type='string'
469 ,help='Field parameter value [default: %default]')
470 parser.add_option('--direction-field', dest='directionField',metavar='bool',type='int'
471 ,help='Field parameter value [default: %default]')
472 parser.add_option('--ETA_month-field', dest='ETA_monthField',metavar='uint',type='int'
473 ,help='Field parameter value [default: %default]')
474 parser.add_option('--ETA_day-field', dest='ETA_dayField',metavar='uint',type='int'
475 ,help='Field parameter value [default: %default]')
476 parser.add_option('--ETA_hour-field', dest='ETA_hourField',metavar='uint',type='int'
477 ,help='Field parameter value [default: %default]')
478 parser.add_option('--ETA_min-field', dest='ETA_minField',metavar='uint',type='int'
479 ,help='Field parameter value [default: %default]')
480
481
482 if __name__=='__main__':
483
484 from optparse import OptionParser
485 parser = OptionParser(usage="%prog [options]",
486 version="%prog "+__version__)
487
488 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
489 help='run the documentation tests')
490 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
491 help='run the unit tests')
492 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
493 help='Make the test output verbose')
494
495
496
497 typeChoices = ('binary','nmeapayload','nmea')
498 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
499 ,default='nmeapayload'
500 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]')
501
502
503 outputChoices = ('std','html','csv','sql' )
504 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
505 ,default='std'
506 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
507
508 parser.add_option('-o','--output',dest='outputFileName',default=None,
509 help='Name of the python file to write [default: stdout]')
510
511 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append',
512 choices=fieldList,
513 help='Which fields to include in the output. Currently only for csv output [default: all]')
514
515 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true',
516 help='Print the field name for csv')
517
518 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true',
519 help='Print out an sql create command for the table.')
520
521 dbChoices = ('sqlite','postgres')
522 parser.add_option('-D','--db-type',dest='dbType',default='postgres'
523 ,choices=dbChoices,type='choice'
524 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]')
525
526 addMsgOptions(parser)
527
528 (options,args) = parser.parse_args()
529 success=True
530
531 if options.doctest:
532 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
533 sys.argv= [sys.argv[0]]
534 if options.verbose: sys.argv.append('-v')
535 import doctest
536 numfail,numtests=doctest.testmod()
537 if numfail==0: print 'ok'
538 else:
539 print 'FAILED'
540 success=False
541
542 if not success: sys.exit('Something Failed')
543 del success
544
545 if options.unittest:
546 sys.argv = [sys.argv[0]]
547 if options.verbose: sys.argv.append('-v')
548 unittest.main()
549
550 outfile = sys.stdout
551 if None!=options.outputFileName:
552 outfile = file(options.outputFileName,'w')
553
554
555 if options.doEncode:
556
557 if None==options.vesselField: parser.error("missing value for vesselField")
558 if None==options.directionField: parser.error("missing value for directionField")
559 if None==options.ETA_monthField: parser.error("missing value for ETA_monthField")
560 if None==options.ETA_dayField: parser.error("missing value for ETA_dayField")
561 if None==options.ETA_hourField: parser.error("missing value for ETA_hourField")
562 if None==options.ETA_minField: parser.error("missing value for ETA_minField")
563 msgDict={
564 'vessel': options.vesselField,
565 'direction': options.directionField,
566 'ETA_month': options.ETA_monthField,
567 'ETA_day': options.ETA_dayField,
568 'ETA_hour': options.ETA_hourField,
569 'ETA_min': options.ETA_minField,
570 'reserved': '0',
571 }
572
573 bits = encode(msgDict)
574 if 'binary'==options.ioType: print str(bits)
575 elif 'nmeapayload'==options.ioType:
576
577 print "bitLen",len(bits)
578 bitLen=len(bits)
579 if bitLen%6!=0:
580 bits = bits + BitVector(size=(6 - (bitLen%6)))
581 print "result:",binary.bitvectoais6(bits)[0]
582
583
584
585 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
586 else: sys.exit('ERROR: unknown ioType. Help!')
587
588
589 if options.sqlCreate:
590 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType)
591
592 if options.printCsvfieldList:
593
594 if None == options.fieldList: options.fieldList = fieldList
595 import StringIO
596 buf = StringIO.StringIO()
597 for field in options.fieldList:
598 buf.write(field+',')
599 result = buf.getvalue()
600 if result[-1] == ',': print result[:-1]
601 else: print result
602
603 if options.doDecode:
604 for msg in args:
605 bv = None
606
607 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'):
608
609
610 bv = binary.ais6tobitvec(msg.split(',')[5])
611 else:
612
613 binaryMsg=True
614 for c in msg:
615 if c not in ('0','1'):
616 binaryMsg=False
617 break
618 if binaryMsg:
619 bv = BitVector(bitstring=msg)
620 else:
621 bv = binary.ais6tobitvec(msg)
622
623 printFields(decode(bv)
624 ,out=outfile
625 ,format=options.outputType
626 ,fieldList=options.fieldList
627 ,dbType=options.dbType
628 )
629