Package ais :: Package sls :: Module lockschedule
[hide private]
[frames] | no frames]

Source Code for Module ais.sls.lockschedule

  1  #!/usr/bin/env python 
  2   
  3  __version__ = '$Revision: 4791 $'.split()[1] 
  4  __date__ = '$Date: 2008-01-11 $'.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  # FIX: check to see if these will be needed 
 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_lockschedule binary message payload to pack into an AIS Msg sls_lockschedule. 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_lockschedule 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 #Would be nice to check the bit count here.. 139 #if validate: 140 # assert (len(bv)==FIX: SOME NUMBER) 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
151 -def decodevessel(bv, validate=False):
152 return aisstring.decode(bv[0:90])
153
154 -def decodedirection(bv, validate=False):
155 return bool(int(bv[90:91]))
156
157 -def decodeETA_month(bv, validate=False):
158 return int(bv[91:95])
159
160 -def decodeETA_day(bv, validate=False):
161 return int(bv[95:100])
162
163 -def decodeETA_hour(bv, validate=False):
164 return int(bv[100:105])
165
166 -def decodeETA_min(bv, validate=False):
167 return int(bv[105:111])
168
169 -def decodereserved(bv, validate=False):
170 return 0
171 172
173 -def printHtml(params, out=sys.stdout):
174 out.write("<h3>sls_lockschedule</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 sls_lockschedule 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("sls_lockschedule:\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 # else: leave it empty 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 # Nothing to return
289 290 directionEncodeLut = { 291 'Down bound':'0', 292 'Up bound':'1', 293 } #directionEncodeLut 294 295 directionDecodeLut = { 296 '0':'Down bound', 297 '1':'Up bound', 298 } # directionEncodeLut 299 300 ###################################################################### 301 # SQL SUPPORT 302 ###################################################################### 303 304 dbTableName='sls_lockschedule' 305 'Database table name' 306
307 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None 308 ,addCoastGuardFields=True 309 ,dbType='postgres' 310 ):
311 ''' 312 Return the SQL CREATE command for this message type 313 @param outfile: file like object to print to. 314 @param fields: which fields to put in the create. Defaults to all. 315 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 316 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 317 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 318 @type addCoastGuardFields: bool 319 @return: sql create string 320 @rtype: str 321 322 @see: sqlCreate 323 ''' 324 # FIX: should this sqlCreate be the same as in LaTeX (createFuncName) rather than hard coded? 325 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))
326
327 -def sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres'):
328 ''' 329 Return the sqlhelp object to create the table. 330 331 @param fields: which fields to put in the create. Defaults to all. 332 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 333 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 334 @type addCoastGuardFields: bool 335 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 336 @return: An object that can be used to generate a return 337 @rtype: sqlhelp.create 338 ''' 339 if None == fields: fields = fieldList 340 import sqlhelp 341 c = sqlhelp.create('sls_lockschedule',dbType=dbType) 342 c.addPrimaryKey() 343 if 'vessel' in fields: c.addVarChar('vessel',15) 344 if 'direction' in fields: c.addBool('direction') 345 if 'ETA_month' in fields: c.addInt ('ETA_month') 346 if 'ETA_day' in fields: c.addInt ('ETA_day') 347 if 'ETA_hour' in fields: c.addInt ('ETA_hour') 348 if 'ETA_min' in fields: c.addInt ('ETA_min') 349 if 'reserved' in fields: c.addInt ('reserved') 350 351 if addCoastGuardFields: 352 # c.addInt('cg_rssi') # Relative signal strength indicator 353 # c.addInt('cg_d') # dBm receive strength 354 # c.addInt('cg_T') # Receive timestamp from the AIS equipment 355 # c.addInt('cg_S') # Slot received in 356 # c.addVarChar('cg_x',10) # Idonno 357 c.addVarChar('cg_r',15) # Receiver station ID - should usually be an MMSI, but sometimes is a string 358 c.addInt('cg_sec') # UTC seconds since the epoch 359 360 c.addTimestamp('cg_timestamp') # UTC decoded cg_sec - not actually in the data stream 361 362 return c
363
364 -def sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres'):
365 ''' 366 Return the SQL INSERT command for this message type 367 @param params: dictionary of values keyed by field name 368 @param outfile: file like object to print to. 369 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields 370 @return: sql create string 371 @rtype: str 372 373 @see: sqlCreate 374 ''' 375 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))
376 377
378 -def sqlInsert(params,extraParams=None,dbType='postgres'):
379 ''' 380 Give the SQL INSERT statement 381 @param params: dict keyed by field name of values 382 @param extraParams: any extra fields that you have created beyond the normal ais message fields 383 @rtype: sqlhelp.insert 384 @return: insert class instance 385 @todo: allow optional type checking of params? 386 @warning: this will take invalid keys happily and do what??? 387 ''' 388 import sqlhelp 389 i = sqlhelp.insert('sls_lockschedule',dbType=dbType) 390 391 if dbType=='postgres': 392 finished = [] 393 for key in params: 394 if key in finished: 395 continue 396 397 if key not in toPgFields and key not in fromPgFields: 398 if type(params[key])==Decimal: i.add(key,float(params[key])) 399 else: i.add(key,params[key]) 400 else: 401 if key in fromPgFields: 402 val = params[key] 403 # Had better be a WKT type like POINT(-88.1 30.321) 404 i.addPostGIS(key,val) 405 finished.append(key) 406 else: 407 # Need to construct the type. 408 pgName = toPgFields[key] 409 #valStr='GeomFromText(\''+pgTypes[pgName]+'(' 410 valStr=pgTypes[pgName]+'(' 411 vals = [] 412 for nonPgKey in fromPgFields[pgName]: 413 vals.append(str(params[nonPgKey])) 414 finished.append(nonPgKey) 415 valStr+=' '.join(vals)+')' 416 i.addPostGIS(pgName,valStr) 417 else: 418 for key in params: 419 if type(params[key])==Decimal: i.add(key,float(params[key])) 420 else: i.add(key,params[key]) 421 422 if None != extraParams: 423 for key in extraParams: 424 i.add(key,extraParams[key]) 425 426 return i
427 428 ###################################################################### 429 # LATEX SUPPORT 430 ###################################################################### 431
432 -def latexDefinitionTable(outfile=sys.stdout 433 ):
434 ''' 435 Return the LaTeX definition table for this message type 436 @param outfile: file like object to print to. 437 @type outfile: file obj 438 @return: LaTeX table string via the outfile 439 @rtype: str 440 441 ''' 442 o = outfile 443 444 o.write(''' 445 \\begin{table}%[htb] 446 \\centering 447 \\begin{tabular}{|l|c|l|} 448 \\hline 449 Parameter & Number of bits & Description 450 \\\\ \\hline\\hline 451 vessel & 90 & Vessel Name \\\\ \hline 452 direction & 1 & Up bound/Down bound \\\\ \hline 453 ETA\_month & 4 & Estimated time of arrival month 1..12 \\\\ \hline 454 ETA\_day & 5 & Estimated time of arrival day of the month 1..31 \\\\ \hline 455 ETA\_hour & 5 & Estimated time of arrival UTC hours 0..23 \\\\ \hline 456 ETA\_min & 6 & Estimated time of arrival minutes \\\\ \hline 457 reserved & 19 & Reserved bits for future use\\\\ \\hline \\hline 458 Total bits & 130 & Appears to take 1 slot with 38 pad bits to fill the last slot \\\\ \\hline 459 \\end{tabular} 460 \\caption{AIS message number 8: St Lawrance Seaway wind information} 461 \\label{tab:sls_lockschedule} 462 \\end{table} 463 ''')
464 465 ###################################################################### 466 # Text Definition 467 ###################################################################### 468
469 -def textDefinitionTable(outfile=sys.stdout 470 ,delim='\t' 471 ):
472 ''' 473 Return the text definition table for this message type 474 @param outfile: file like object to print to. 475 @type outfile: file obj 476 @return: text table string via the outfile 477 @rtype: str 478 479 ''' 480 o = outfile 481 o.write('''Parameter'''+delim+'Number of bits'''+delim+'''Description 482 vessel'''+delim+'''90'''+delim+'''Vessel Name 483 direction'''+delim+'''1'''+delim+'''Up bound/Down bound 484 ETA_month'''+delim+'''4'''+delim+'''Estimated time of arrival month 1..12 485 ETA_day'''+delim+'''5'''+delim+'''Estimated time of arrival day of the month 1..31 486 ETA_hour'''+delim+'''5'''+delim+'''Estimated time of arrival UTC hours 0..23 487 ETA_min'''+delim+'''6'''+delim+'''Estimated time of arrival minutes 488 reserved'''+delim+'''19'''+delim+'''Reserved bits for future use 489 Total bits'''+delim+'''130'''+delim+'''Appears to take 1 slot with 38 pad bits to fill the last slot''')
490 491 492 ###################################################################### 493 # UNIT TESTING 494 ###################################################################### 495 import unittest
496 -def testParams():
497 '''Return a params file base on the testvalue tags. 498 @rtype: dict 499 @return: params based on testvalue tags 500 ''' 501 params = {} 502 params['vessel'] = 'ICEBERG@@@@@@@@' 503 params['direction'] = True 504 params['ETA_month'] = 2 505 params['ETA_day'] = 28 506 params['ETA_hour'] = 23 507 params['ETA_min'] = 45 508 params['reserved'] = 0 509 510 return params
511
512 -class Testsls_lockschedule(unittest.TestCase):
513 '''Use testvalue tag text from each type to build test case the sls_lockschedule message'''
514 - def testEncodeDecode(self):
515 516 params = testParams() 517 bits = encode(params) 518 r = decode(bits) 519 520 # Check that each parameter came through ok. 521 self.failUnlessEqual(r['vessel'],params['vessel']) 522 self.failUnlessEqual(r['direction'],params['direction']) 523 self.failUnlessEqual(r['ETA_month'],params['ETA_month']) 524 self.failUnlessEqual(r['ETA_day'],params['ETA_day']) 525 self.failUnlessEqual(r['ETA_hour'],params['ETA_hour']) 526 self.failUnlessEqual(r['ETA_min'],params['ETA_min']) 527 self.failUnlessEqual(r['reserved'],params['reserved'])
528
529 -def addMsgOptions(parser):
530 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 531 help='decode a "sls_lockschedule" AIS message') 532 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 533 help='encode a "sls_lockschedule" AIS message') 534 parser.add_option('--vessel-field', dest='vesselField',default='@@@@@@@@@@@@@@@',metavar='aisstr6',type='string' 535 ,help='Field parameter value [default: %default]') 536 parser.add_option('--direction-field', dest='directionField',metavar='bool',type='int' 537 ,help='Field parameter value [default: %default]') 538 parser.add_option('--ETA_month-field', dest='ETA_monthField',metavar='uint',type='int' 539 ,help='Field parameter value [default: %default]') 540 parser.add_option('--ETA_day-field', dest='ETA_dayField',metavar='uint',type='int' 541 ,help='Field parameter value [default: %default]') 542 parser.add_option('--ETA_hour-field', dest='ETA_hourField',metavar='uint',type='int' 543 ,help='Field parameter value [default: %default]') 544 parser.add_option('--ETA_min-field', dest='ETA_minField',metavar='uint',type='int' 545 ,help='Field parameter value [default: %default]')
546 547 ############################################################ 548 if __name__=='__main__': 549 550 from optparse import OptionParser 551 parser = OptionParser(usage="%prog [options]", 552 version="%prog "+__version__) 553 554 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true', 555 help='run the documentation tests') 556 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true', 557 help='run the unit tests') 558 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true', 559 help='Make the test output verbose') 560 561 # FIX: remove nmea from binary messages. No way to build the whole packet? 562 # FIX: or build the surrounding msg 8 for a broadcast? 563 typeChoices = ('binary','nmeapayload','nmea') # FIX: what about a USCG type message? 564 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType' 565 ,default='nmeapayload' 566 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]') 567 568 569 outputChoices = ('std','html','csv','sql' ) 570 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType' 571 ,default='std' 572 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]') 573 574 parser.add_option('-o','--output',dest='outputFileName',default=None, 575 help='Name of the python file to write [default: stdout]') 576 577 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append', 578 choices=fieldList, 579 help='Which fields to include in the output. Currently only for csv output [default: all]') 580 581 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true', 582 help='Print the field name for csv') 583 584 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true', 585 help='Print out an sql create command for the table.') 586 587 parser.add_option('--latex-table',dest='latexDefinitionTable',default=False,action='store_true', 588 help='Print a LaTeX table of the type') 589 590 parser.add_option('--text-table',dest='textDefinitionTable',default=False,action='store_true', 591 help='Print delimited table of the type (for Word table importing)') 592 parser.add_option('--delimt-text-table',dest='delimTextDefinitionTable',default='\t' 593 ,help='Delimiter for text table [default: \'%default\'](for Word table importing)') 594 595 596 dbChoices = ('sqlite','postgres') 597 parser.add_option('-D','--db-type',dest='dbType',default='postgres' 598 ,choices=dbChoices,type='choice' 599 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]') 600 601 addMsgOptions(parser) 602 603 (options,args) = parser.parse_args() 604 success=True 605 606 if options.doctest: 607 import os; print os.path.basename(sys.argv[0]), 'doctests ...', 608 sys.argv= [sys.argv[0]] 609 if options.verbose: sys.argv.append('-v') 610 import doctest 611 numfail,numtests=doctest.testmod() 612 if numfail==0: print 'ok' 613 else: 614 print 'FAILED' 615 success=False 616 617 if not success: sys.exit('Something Failed') 618 del success # Hide success from epydoc 619 620 if options.unittest: 621 sys.argv = [sys.argv[0]] 622 if options.verbose: sys.argv.append('-v') 623 unittest.main() 624 625 outfile = sys.stdout 626 if None!=options.outputFileName: 627 outfile = file(options.outputFileName,'w') 628 629 630 if options.doEncode: 631 # First make sure all non required options are specified 632 if None==options.vesselField: parser.error("missing value for vesselField") 633 if None==options.directionField: parser.error("missing value for directionField") 634 if None==options.ETA_monthField: parser.error("missing value for ETA_monthField") 635 if None==options.ETA_dayField: parser.error("missing value for ETA_dayField") 636 if None==options.ETA_hourField: parser.error("missing value for ETA_hourField") 637 if None==options.ETA_minField: parser.error("missing value for ETA_minField") 638 msgDict={ 639 'vessel': options.vesselField, 640 'direction': options.directionField, 641 'ETA_month': options.ETA_monthField, 642 'ETA_day': options.ETA_dayField, 643 'ETA_hour': options.ETA_hourField, 644 'ETA_min': options.ETA_minField, 645 'reserved': '0', 646 } 647 648 bits = encode(msgDict) 649 if 'binary'==options.ioType: print str(bits) 650 elif 'nmeapayload'==options.ioType: 651 # FIX: figure out if this might be necessary at compile time 652 print "bitLen",len(bits) 653 bitLen=len(bits) 654 if bitLen%6!=0: 655 bits = bits + BitVector(size=(6 - (bitLen%6))) # Pad out to multiple of 6 656 print "result:",binary.bitvectoais6(bits)[0] 657 658 659 # FIX: Do not emit this option for the binary message payloads. Does not make sense. 660 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability") 661 else: sys.exit('ERROR: unknown ioType. Help!') 662 663 664 if options.sqlCreate: 665 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType) 666 667 if options.latexDefinitionTable: 668 latexDefinitionTable(outfile) 669 670 # For conversion to word tables 671 if options.textDefinitionTable: 672 textDefinitionTable(outfile,options.delimTextDefinitionTable) 673 674 if options.printCsvfieldList: 675 # Make a csv separated list of fields that will be displayed for csv 676 if None == options.fieldList: options.fieldList = fieldList 677 import StringIO 678 buf = StringIO.StringIO() 679 for field in options.fieldList: 680 buf.write(field+',') 681 result = buf.getvalue() 682 if result[-1] == ',': print result[:-1] 683 else: print result 684 685 if options.doDecode: 686 if len(args)==0: args = sys.stdin 687 for msg in args: 688 bv = None 689 690 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'): 691 # Found nmea 692 # FIX: do checksum 693 bv = binary.ais6tobitvec(msg.split(',')[5]) 694 else: # either binary or nmeapayload... expect mostly nmeapayloads 695 # assumes that an all 0 and 1 string can not be a nmeapayload 696 binaryMsg=True 697 for c in msg: 698 if c not in ('0','1'): 699 binaryMsg=False 700 break 701 if binaryMsg: 702 bv = BitVector(bitstring=msg) 703 else: # nmeapayload 704 bv = binary.ais6tobitvec(msg) 705 706 printFields(decode(bv) 707 ,out=outfile 708 ,format=options.outputType 709 ,fieldList=options.fieldList 710 ,dbType=options.dbType 711 ) 712