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

Source Code for Module ais.sls.lockorder

  1  #!/usr/bin/env python 
  2   
  3  __version__ = '$Revision: 4791 $'.split()[1] 
  4  __date__ = '$Date: 2007-04-07 $'.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          'time_month', 
 51          'time_day', 
 52          'time_hour', 
 53          'time_min', 
 54          'lockid', 
 55          'pos_longitude', 
 56          'pos_latitude', 
 57          'reserved', 
 58          'lockschedules', 
 59  ) 
 60   
 61  fieldListPostgres = ( 
 62          'time_month', 
 63          'time_day', 
 64          'time_hour', 
 65          'time_min', 
 66          'lockid', 
 67          'pos',  # PostGIS data type 
 68          'reserved', 
 69          'lockschedules', 
 70  ) 
 71   
 72  toPgFields = { 
 73          'pos_longitude':'pos', 
 74          'pos_latitude':'pos', 
 75  } 
 76  ''' 
 77  Go to the Postgis field names from the straight field name 
 78  ''' 
 79   
 80  fromPgFields = { 
 81          'pos':('pos_longitude','pos_latitude',), 
 82  } 
 83  ''' 
 84  Go from the Postgis field names to the straight field name 
 85  ''' 
 86   
 87  pgTypes = { 
 88          'pos':'POINT', 
 89  } 
 90  ''' 
 91  Lookup table for each postgis field name to get its type. 
 92  ''' 
 93   
94 -def encode(params, validate=False):
95 '''Create a sls_lockorder binary message payload to pack into an AIS Msg sls_lockorder. 96 97 Fields in params: 98 - time_month(uint): Time tag of measurement month 1..12 99 - time_day(uint): Time tag of measurement day of the month 1..31 100 - time_hour(uint): Time tag of measurement UTC hours 0..23 101 - time_min(uint): Time tag of measurement minutes 102 - lockid(aisstr6): Character identifier of the station 103 - pos_longitude(decimal): Location of measurement East West location 104 - pos_latitude(decimal): Location of measurement North South location 105 - reserved(uint): Reserved bits for future use (field automatically set to "0") 106 - lockschedules(binary): up to 6 lock schedule reports 107 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing 108 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 109 @rtype: BitVector 110 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8 111 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits. 112 ''' 113 114 bvList = [] 115 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_month']),4)) 116 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_day']),5)) 117 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_hour']),5)) 118 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_min']),6)) 119 if 'lockid' in params: 120 bvList.append(aisstring.encode(params['lockid'],42)) 121 else: 122 bvList.append(aisstring.encode('@@@@@@@',42)) 123 if 'pos_longitude' in params: 124 bvList.append(binary.bvFromSignedInt(int(Decimal(params['pos_longitude'])*Decimal('60000')),25)) 125 else: 126 bvList.append(binary.bvFromSignedInt(10860000,25)) 127 if 'pos_latitude' in params: 128 bvList.append(binary.bvFromSignedInt(int(Decimal(params['pos_latitude'])*Decimal('60000')),24)) 129 else: 130 bvList.append(binary.bvFromSignedInt(5460000,24)) 131 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),19)) 132 bvList.append(params['lockschedules']) 133 134 return binary.joinBV(bvList)
135
136 -def decode(bv, validate=False):
137 '''Unpack a sls_lockorder message 138 139 Fields in params: 140 - time_month(uint): Time tag of measurement month 1..12 141 - time_day(uint): Time tag of measurement day of the month 1..31 142 - time_hour(uint): Time tag of measurement UTC hours 0..23 143 - time_min(uint): Time tag of measurement minutes 144 - lockid(aisstr6): Character identifier of the station 145 - pos_longitude(decimal): Location of measurement East West location 146 - pos_latitude(decimal): Location of measurement North South location 147 - reserved(uint): Reserved bits for future use (field automatically set to "0") 148 - lockschedules(binary): up to 6 lock schedule reports 149 @type bv: BitVector 150 @param bv: Bits defining a message 151 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 152 @rtype: dict 153 @return: params 154 ''' 155 156 #Would be nice to check the bit count here.. 157 #if validate: 158 # assert (len(bv)==FIX: SOME NUMBER) 159 r = {} 160 r['time_month']=int(bv[0:4]) 161 r['time_day']=int(bv[4:9]) 162 r['time_hour']=int(bv[9:14]) 163 r['time_min']=int(bv[14:20]) 164 r['lockid']=aisstring.decode(bv[20:62]) 165 r['pos_longitude']=Decimal(binary.signedIntFromBV(bv[62:87]))/Decimal('60000') 166 r['pos_latitude']=Decimal(binary.signedIntFromBV(bv[87:111]))/Decimal('60000') 167 r['reserved']=0 168 r['lockschedules']=bv[130:] 169 return r
170
171 -def decodetime_month(bv, validate=False):
172 return int(bv[0:4])
173
174 -def decodetime_day(bv, validate=False):
175 return int(bv[4:9])
176
177 -def decodetime_hour(bv, validate=False):
178 return int(bv[9:14])
179
180 -def decodetime_min(bv, validate=False):
181 return int(bv[14:20])
182
183 -def decodelockid(bv, validate=False):
184 return aisstring.decode(bv[20:62])
185
186 -def decodepos_longitude(bv, validate=False):
187 return Decimal(binary.signedIntFromBV(bv[62:87]))/Decimal('60000')
188
189 -def decodepos_latitude(bv, validate=False):
190 return Decimal(binary.signedIntFromBV(bv[87:111]))/Decimal('60000')
191
192 -def decodereserved(bv, validate=False):
193 return 0
194
195 -def decodelockschedules(bv, validate=False):
196 return bv[130:]
197 198
199 -def printHtml(params, out=sys.stdout):
200 out.write("<h3>sls_lockorder<h3>\n") 201 out.write("<table border=\"1\">\n") 202 out.write("<tr bgcolor=\"orange\">\n") 203 out.write("<th align=\"left\">Field Name</th>\n") 204 out.write("<th align=\"left\">Type</th>\n") 205 out.write("<th align=\"left\">Value</th>\n") 206 out.write("<th align=\"left\">Value in Lookup Table</th>\n") 207 out.write("<th align=\"left\">Units</th>\n") 208 out.write("\n") 209 out.write("<tr>\n") 210 out.write("<td>time_month</td>\n") 211 out.write("<td>uint</td>\n") 212 if 'time_month' in params: 213 out.write(" <td>"+str(params['time_month'])+"</td>\n") 214 out.write(" <td>"+str(params['time_month'])+"</td>\n") 215 out.write("</tr>\n") 216 out.write("\n") 217 out.write("<tr>\n") 218 out.write("<td>time_day</td>\n") 219 out.write("<td>uint</td>\n") 220 if 'time_day' in params: 221 out.write(" <td>"+str(params['time_day'])+"</td>\n") 222 out.write(" <td>"+str(params['time_day'])+"</td>\n") 223 out.write("</tr>\n") 224 out.write("\n") 225 out.write("<tr>\n") 226 out.write("<td>time_hour</td>\n") 227 out.write("<td>uint</td>\n") 228 if 'time_hour' in params: 229 out.write(" <td>"+str(params['time_hour'])+"</td>\n") 230 out.write(" <td>"+str(params['time_hour'])+"</td>\n") 231 out.write("</tr>\n") 232 out.write("\n") 233 out.write("<tr>\n") 234 out.write("<td>time_min</td>\n") 235 out.write("<td>uint</td>\n") 236 if 'time_min' in params: 237 out.write(" <td>"+str(params['time_min'])+"</td>\n") 238 out.write(" <td>"+str(params['time_min'])+"</td>\n") 239 out.write("</tr>\n") 240 out.write("\n") 241 out.write("<tr>\n") 242 out.write("<td>lockid</td>\n") 243 out.write("<td>aisstr6</td>\n") 244 if 'lockid' in params: 245 out.write(" <td>"+str(params['lockid'])+"</td>\n") 246 out.write(" <td>"+str(params['lockid'])+"</td>\n") 247 out.write("</tr>\n") 248 out.write("\n") 249 out.write("<tr>\n") 250 out.write("<td>pos_longitude</td>\n") 251 out.write("<td>decimal</td>\n") 252 if 'pos_longitude' in params: 253 out.write(" <td>"+str(params['pos_longitude'])+"</td>\n") 254 out.write(" <td>"+str(params['pos_longitude'])+"</td>\n") 255 out.write("<td>degrees</td>\n") 256 out.write("</tr>\n") 257 out.write("\n") 258 out.write("<tr>\n") 259 out.write("<td>pos_latitude</td>\n") 260 out.write("<td>decimal</td>\n") 261 if 'pos_latitude' in params: 262 out.write(" <td>"+str(params['pos_latitude'])+"</td>\n") 263 out.write(" <td>"+str(params['pos_latitude'])+"</td>\n") 264 out.write("<td>degrees</td>\n") 265 out.write("</tr>\n") 266 out.write("\n") 267 out.write("<tr>\n") 268 out.write("<td>reserved</td>\n") 269 out.write("<td>uint</td>\n") 270 if 'reserved' in params: 271 out.write(" <td>"+str(params['reserved'])+"</td>\n") 272 out.write(" <td>"+str(params['reserved'])+"</td>\n") 273 out.write("</tr>\n") 274 out.write("\n") 275 out.write("<tr>\n") 276 out.write("<td>lockschedules</td>\n") 277 out.write("<td>binary</td>\n") 278 if 'lockschedules' in params: 279 out.write(" <td>"+str(params['lockschedules'])+"</td>\n") 280 out.write(" <td>"+str(params['lockschedules'])+"</td>\n") 281 out.write("</tr>\n") 282 out.write("</table>\n")
283 284
285 -def printKml(params, out=sys.stdout):
286 '''KML (Keyhole Markup Language) for Google Earth, but without the header/footer''' 287 out.write("\ <Placemark>\n") 288 out.write("\t <name>"+str(params['lockid'])+"</name>\n") 289 out.write("\t\t<description>\n") 290 import StringIO 291 buf = StringIO.StringIO() 292 printHtml(params,buf) 293 import cgi 294 out.write(cgi.escape(buf.getvalue())) 295 out.write("\t\t</description>\n") 296 out.write("\t\t<styleUrl>#m_ylw-pushpin_copy0</styleUrl>\n") 297 out.write("\t\t<Point>\n") 298 out.write("\t\t\t<coordinates>") 299 out.write(str(params['pos_longitude'])) 300 out.write(',') 301 out.write(str(params['pos_latitude'])) 302 out.write(",0</coordinates>\n") 303 out.write("\t\t</Point>\n") 304 out.write("\t</Placemark>\n")
305
306 -def printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres'):
307 '''Print a sls_lockorder message to stdout. 308 309 Fields in params: 310 - time_month(uint): Time tag of measurement month 1..12 311 - time_day(uint): Time tag of measurement day of the month 1..31 312 - time_hour(uint): Time tag of measurement UTC hours 0..23 313 - time_min(uint): Time tag of measurement minutes 314 - lockid(aisstr6): Character identifier of the station 315 - pos_longitude(decimal): Location of measurement East West location 316 - pos_latitude(decimal): Location of measurement North South location 317 - reserved(uint): Reserved bits for future use (field automatically set to "0") 318 - lockschedules(binary): up to 6 lock schedule reports 319 @param params: Dictionary of field names/values. 320 @param out: File like object to write to 321 @rtype: stdout 322 @return: text to out 323 ''' 324 325 if 'std'==format: 326 out.write("sls_lockorder:\n") 327 if 'time_month' in params: out.write(" time_month: "+str(params['time_month'])+"\n") 328 if 'time_day' in params: out.write(" time_day: "+str(params['time_day'])+"\n") 329 if 'time_hour' in params: out.write(" time_hour: "+str(params['time_hour'])+"\n") 330 if 'time_min' in params: out.write(" time_min: "+str(params['time_min'])+"\n") 331 if 'lockid' in params: out.write(" lockid: "+str(params['lockid'])+"\n") 332 if 'pos_longitude' in params: out.write(" pos_longitude: "+str(params['pos_longitude'])+"\n") 333 if 'pos_latitude' in params: out.write(" pos_latitude: "+str(params['pos_latitude'])+"\n") 334 if 'reserved' in params: out.write(" reserved: "+str(params['reserved'])+"\n") 335 if 'lockschedules' in params: out.write(" lockschedules: "+str(params['lockschedules'])+"\n") 336 elif 'csv'==format: 337 if None == options.fieldList: 338 options.fieldList = fieldList 339 needComma = False; 340 for field in fieldList: 341 if needComma: out.write(',') 342 needComma = True 343 if field in params: 344 out.write(str(params[field])) 345 # else: leave it empty 346 out.write("\n") 347 elif 'html'==format: 348 printHtml(params,out) 349 elif 'sql'==format: 350 sqlInsertStr(params,out,dbType=dbType) 351 elif 'kml'==format: 352 printKml(params,out) 353 elif 'kml-full'==format: 354 out.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n") 355 out.write("<kml xmlns=\"http://earth.google.com/kml/2.1\">\n") 356 out.write("<Document>\n") 357 out.write(" <name>sls_lockorder</name>\n") 358 printKml(params,out) 359 out.write("</Document>\n") 360 out.write("</kml>\n") 361 else: 362 print "ERROR: unknown format:",format 363 assert False 364 365 return # Nothing to return
366 367 ###################################################################### 368 # SQL SUPPORT 369 ###################################################################### 370
371 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None 372 ,addCoastGuardFields=True 373 ,dbType='postgres' 374 ):
375 ''' 376 Return the SQL CREATE command for this message type 377 @param outfile: file like object to print to. 378 @param fields: which fields to put in the create. Defaults to all. 379 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 380 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 381 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 382 @type addCoastGuardFields: bool 383 @return: sql create string 384 @rtype: str 385 386 @see: sqlCreate 387 ''' 388 # FIX: should this sqlCreate be the same as in LaTeX (createFuncName) rather than hard coded? 389 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))
390
391 -def sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres'):
392 ''' 393 Return the sqlhelp object to create the table. 394 395 @param fields: which fields to put in the create. Defaults to all. 396 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 397 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 398 @type addCoastGuardFields: bool 399 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 400 @return: An object that can be used to generate a return 401 @rtype: sqlhelp.create 402 ''' 403 if None == fields: fields = fieldList 404 import sqlhelp 405 c = sqlhelp.create('sls_lockorder',dbType=dbType) 406 c.addPrimaryKey() 407 if 'time_month' in fields: c.addInt ('time_month') 408 if 'time_day' in fields: c.addInt ('time_day') 409 if 'time_hour' in fields: c.addInt ('time_hour') 410 if 'time_min' in fields: c.addInt ('time_min') 411 if 'lockid' in fields: c.addVarChar('lockid',7) 412 if dbType != 'postgres': 413 if 'pos_longitude' in fields: c.addDecimal('pos_longitude',7,4) 414 if dbType != 'postgres': 415 if 'pos_latitude' in fields: c.addDecimal('pos_latitude',7,4) 416 if 'reserved' in fields: c.addInt ('reserved') 417 if 'lockschedules' in fields: c.addBitVarying('lockschedules',1024) 418 419 if addCoastGuardFields: 420 # c.addInt('cg_rssi') # Relative signal strength indicator 421 # c.addInt('cg_d') # dBm receive strength 422 # c.addInt('cg_T') # Receive timestamp from the AIS equipment 423 # c.addInt('cg_S') # Slot received in 424 # c.addVarChar('cg_x',10) # Idonno 425 c.addVarChar('cg_r',15) # Receiver station ID - should usually be an MMSI, but sometimes is a string 426 c.addInt('cg_sec') # UTC seconds since the epoch 427 428 c.addTimestamp('cg_timestamp') # UTC decoded cg_sec - not actually in the data stream 429 430 if dbType == 'postgres': 431 c.addPostGIS('pos','POINT',2); 432 433 return c
434
435 -def sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres'):
436 ''' 437 Return the SQL INSERT command for this message type 438 @param params: dictionary of values keyed by field name 439 @param outfile: file like object to print to. 440 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields 441 @return: sql create string 442 @rtype: str 443 444 @see: sqlCreate 445 ''' 446 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))
447 448
449 -def sqlInsert(params,extraParams=None,dbType='postgres'):
450 ''' 451 Give the SQL INSERT statement 452 @param params: dict keyed by field name of values 453 @param extraParams: any extra fields that you have created beyond the normal ais message fields 454 @rtype: sqlhelp.insert 455 @return: insert class instance 456 @todo: allow optional type checking of params? 457 @warning: this will take invalid keys happily and do what??? 458 ''' 459 import sqlhelp 460 i = sqlhelp.insert('sls_lockorder',dbType=dbType) 461 462 if dbType=='postgres': 463 finished = [] 464 for key in params: 465 if key in finished: 466 continue 467 468 if key not in toPgFields and key not in fromPgFields: 469 if type(params[key])==Decimal: i.add(key,float(params[key])) 470 else: i.add(key,params[key]) 471 else: 472 if key in fromPgFields: 473 val = params[key] 474 # Had better be a WKT type like POINT(-88.1 30.321) 475 i.addPostGIS(key,val) 476 finished.append(key) 477 else: 478 # Need to construct the type. 479 pgName = toPgFields[key] 480 #valStr='GeomFromText(\''+pgTypes[pgName]+'(' 481 valStr=pgTypes[pgName]+'(' 482 vals = [] 483 for nonPgKey in fromPgFields[pgName]: 484 vals.append(str(params[nonPgKey])) 485 finished.append(nonPgKey) 486 valStr+=' '.join(vals)+')' 487 i.addPostGIS(pgName,valStr) 488 else: 489 for key in params: 490 if type(params[key])==Decimal: i.add(key,float(params[key])) 491 else: i.add(key,params[key]) 492 493 if None != extraParams: 494 for key in extraParams: 495 i.add(key,extraParams[key]) 496 497 return i
498 499 ###################################################################### 500 # LATEX SUPPORT 501 ###################################################################### 502
503 -def latexDefinitionTable(outfile=sys.stdout 504 ):
505 ''' 506 Return the LaTeX definition table for this message type 507 @param outfile: file like object to print to. 508 @type outfile: file obj 509 @return: LaTeX table string via the outfile 510 @rtype: str 511 512 ''' 513 o = outfile 514 515 o.write(''' 516 \\begin{table}%[htb] 517 \\centering 518 \\begin{tabular}{|l|c|l|} 519 \\hline 520 Parameter & Number of bits & Description 521 \\\\ \\hline\\hline 522 time\_month & 4 & Time tag of measurement month 1..12 \\\\ \hline 523 time\_day & 5 & Time tag of measurement day of the month 1..31 \\\\ \hline 524 time\_hour & 5 & Time tag of measurement UTC hours 0..23 \\\\ \hline 525 time\_min & 6 & Time tag of measurement minutes \\\\ \hline 526 lockid & 42 & Character identifier of the station \\\\ \hline 527 pos\_longitude & 25 & Location of measurement East West location \\\\ \hline 528 pos\_latitude & 24 & Location of measurement North South location \\\\ \hline 529 reserved & 19 & Reserved bits for future use \\\\ \hline 530 lockschedules & -1 & up to 6 lock schedule reports\\\\ \\hline \\hline 531 Total bits & 129 & Appears to take 1 slot with 39 pad bits to fill the last slot \\\\ \\hline 532 \\end{tabular} 533 \\caption{AIS message number 8: St Lawrance Seaway wind information} 534 \\label{tab:sls_lockorder} 535 \\end{table} 536 ''')
537 538 ###################################################################### 539 # Text Definition 540 ###################################################################### 541
542 -def textDefinitionTable(outfile=sys.stdout 543 ,delim='\t' 544 ):
545 ''' 546 Return the text definition table for this message type 547 @param outfile: file like object to print to. 548 @type outfile: file obj 549 @return: text table string via the outfile 550 @rtype: str 551 552 ''' 553 o = outfile 554 o.write('''Parameter'''+delim+'Number of bits'''+delim+'''Description 555 time_month'''+delim+'''4'''+delim+'''Time tag of measurement month 1..12 556 time_day'''+delim+'''5'''+delim+'''Time tag of measurement day of the month 1..31 557 time_hour'''+delim+'''5'''+delim+'''Time tag of measurement UTC hours 0..23 558 time_min'''+delim+'''6'''+delim+'''Time tag of measurement minutes 559 lockid'''+delim+'''42'''+delim+'''Character identifier of the station 560 pos_longitude'''+delim+'''25'''+delim+'''Location of measurement East West location 561 pos_latitude'''+delim+'''24'''+delim+'''Location of measurement North South location 562 reserved'''+delim+'''19'''+delim+'''Reserved bits for future use 563 lockschedules'''+delim+'''-1'''+delim+'''up to 6 lock schedule reports 564 Total bits'''+delim+'''129'''+delim+'''Appears to take 1 slot with 39 pad bits to fill the last slot''')
565 566 567 ###################################################################### 568 # UNIT TESTING 569 ###################################################################### 570 import unittest
571 -def testParams():
572 '''Return a params file base on the testvalue tags. 573 @rtype: dict 574 @return: params based on testvalue tags 575 ''' 576 params = {} 577 params['time_month'] = 2 578 params['time_day'] = 28 579 params['time_hour'] = 23 580 params['time_min'] = 45 581 params['lockid'] = 'A345678' 582 params['pos_longitude'] = Decimal('-122.16328') 583 params['pos_latitude'] = Decimal('37.42446') 584 params['reserved'] = 0 585 params['lockschedules'] = BitVector(bitstring='0001010101010000') 586 587 return params
588
589 -class Testsls_lockorder(unittest.TestCase):
590 '''Use testvalue tag text from each type to build test case the sls_lockorder message'''
591 - def testEncodeDecode(self):
592 593 params = testParams() 594 bits = encode(params) 595 r = decode(bits) 596 597 # Check that each parameter came through ok. 598 self.failUnlessEqual(r['time_month'],params['time_month']) 599 self.failUnlessEqual(r['time_day'],params['time_day']) 600 self.failUnlessEqual(r['time_hour'],params['time_hour']) 601 self.failUnlessEqual(r['time_min'],params['time_min']) 602 self.failUnlessEqual(r['lockid'],params['lockid']) 603 self.failUnlessAlmostEqual(r['pos_longitude'],params['pos_longitude'],4) 604 self.failUnlessAlmostEqual(r['pos_latitude'],params['pos_latitude'],4) 605 self.failUnlessEqual(r['reserved'],params['reserved']) 606 self.failUnlessEqual(r['lockschedules'],params['lockschedules'])
607
608 -def addMsgOptions(parser):
609 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 610 help='decode a "sls_lockorder" AIS message') 611 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 612 help='encode a "sls_lockorder" AIS message') 613 parser.add_option('--time_month-field', dest='time_monthField',metavar='uint',type='int' 614 ,help='Field parameter value [default: %default]') 615 parser.add_option('--time_day-field', dest='time_dayField',metavar='uint',type='int' 616 ,help='Field parameter value [default: %default]') 617 parser.add_option('--time_hour-field', dest='time_hourField',metavar='uint',type='int' 618 ,help='Field parameter value [default: %default]') 619 parser.add_option('--time_min-field', dest='time_minField',metavar='uint',type='int' 620 ,help='Field parameter value [default: %default]') 621 parser.add_option('--lockid-field', dest='lockidField',default='@@@@@@@',metavar='aisstr6',type='string' 622 ,help='Field parameter value [default: %default]') 623 parser.add_option('--pos_longitude-field', dest='pos_longitudeField',default=Decimal('181'),metavar='decimal',type='string' 624 ,help='Field parameter value [default: %default]') 625 parser.add_option('--pos_latitude-field', dest='pos_latitudeField',default=Decimal('91'),metavar='decimal',type='string' 626 ,help='Field parameter value [default: %default]') 627 parser.add_option('--lockschedules-field', dest='lockschedulesField',metavar='binary',type='string' 628 ,help='Field parameter value [default: %default]')
629 630 ############################################################ 631 if __name__=='__main__': 632 633 from optparse import OptionParser 634 parser = OptionParser(usage="%prog [options]", 635 version="%prog "+__version__) 636 637 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true', 638 help='run the documentation tests') 639 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true', 640 help='run the unit tests') 641 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true', 642 help='Make the test output verbose') 643 644 # FIX: remove nmea from binary messages. No way to build the whole packet? 645 # FIX: or build the surrounding msg 8 for a broadcast? 646 typeChoices = ('binary','nmeapayload','nmea') # FIX: what about a USCG type message? 647 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType' 648 ,default='nmeapayload' 649 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]') 650 651 652 outputChoices = ('std','html','csv','sql' , 'kml','kml-full') 653 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType' 654 ,default='std' 655 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]') 656 657 parser.add_option('-o','--output',dest='outputFileName',default=None, 658 help='Name of the python file to write [default: stdout]') 659 660 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append', 661 choices=fieldList, 662 help='Which fields to include in the output. Currently only for csv output [default: all]') 663 664 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true', 665 help='Print the field name for csv') 666 667 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true', 668 help='Print out an sql create command for the table.') 669 670 parser.add_option('--latex-table',dest='latexDefinitionTable',default=False,action='store_true', 671 help='Print a LaTeX table of the type') 672 673 parser.add_option('--text-table',dest='textDefinitionTable',default=False,action='store_true', 674 help='Print delimited table of the type (for Word table importing)') 675 parser.add_option('--delimt-text-table',dest='delimTextDefinitionTable',default='\t' 676 ,help='Delimiter for text table [default: \'%default\'](for Word table importing)') 677 678 679 dbChoices = ('sqlite','postgres') 680 parser.add_option('-D','--db-type',dest='dbType',default='postgres' 681 ,choices=dbChoices,type='choice' 682 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]') 683 684 addMsgOptions(parser) 685 686 (options,args) = parser.parse_args() 687 success=True 688 689 if options.doctest: 690 import os; print os.path.basename(sys.argv[0]), 'doctests ...', 691 sys.argv= [sys.argv[0]] 692 if options.verbose: sys.argv.append('-v') 693 import doctest 694 numfail,numtests=doctest.testmod() 695 if numfail==0: print 'ok' 696 else: 697 print 'FAILED' 698 success=False 699 700 if not success: sys.exit('Something Failed') 701 del success # Hide success from epydoc 702 703 if options.unittest: 704 sys.argv = [sys.argv[0]] 705 if options.verbose: sys.argv.append('-v') 706 unittest.main() 707 708 outfile = sys.stdout 709 if None!=options.outputFileName: 710 outfile = file(options.outputFileName,'w') 711 712 713 if options.doEncode: 714 # First make sure all non required options are specified 715 if None==options.time_monthField: parser.error("missing value for time_monthField") 716 if None==options.time_dayField: parser.error("missing value for time_dayField") 717 if None==options.time_hourField: parser.error("missing value for time_hourField") 718 if None==options.time_minField: parser.error("missing value for time_minField") 719 if None==options.lockidField: parser.error("missing value for lockidField") 720 if None==options.pos_longitudeField: parser.error("missing value for pos_longitudeField") 721 if None==options.pos_latitudeField: parser.error("missing value for pos_latitudeField") 722 if None==options.lockschedulesField: parser.error("missing value for lockschedulesField") 723 msgDict={ 724 'time_month': options.time_monthField, 725 'time_day': options.time_dayField, 726 'time_hour': options.time_hourField, 727 'time_min': options.time_minField, 728 'lockid': options.lockidField, 729 'pos_longitude': options.pos_longitudeField, 730 'pos_latitude': options.pos_latitudeField, 731 'reserved': '0', 732 'lockschedules': options.lockschedulesField, 733 } 734 735 bits = encode(msgDict) 736 if 'binary'==options.ioType: print str(bits) 737 elif 'nmeapayload'==options.ioType: 738 # FIX: figure out if this might be necessary at compile time 739 print "bitLen",len(bits) 740 bitLen=len(bits) 741 if bitLen%6!=0: 742 bits = bits + BitVector(size=(6 - (bitLen%6))) # Pad out to multiple of 6 743 print "result:",binary.bitvectoais6(bits)[0] 744 745 746 # FIX: Do not emit this option for the binary message payloads. Does not make sense. 747 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability") 748 else: sys.exit('ERROR: unknown ioType. Help!') 749 750 751 if options.sqlCreate: 752 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType) 753 754 if options.latexDefinitionTable: 755 latexDefinitionTable(outfile) 756 757 # For conversion to word tables 758 if options.textDefinitionTable: 759 textDefinitionTable(outfile,options.delimTextDefinitionTable) 760 761 if options.printCsvfieldList: 762 # Make a csv separated list of fields that will be displayed for csv 763 if None == options.fieldList: options.fieldList = fieldList 764 import StringIO 765 buf = StringIO.StringIO() 766 for field in options.fieldList: 767 buf.write(field+',') 768 result = buf.getvalue() 769 if result[-1] == ',': print result[:-1] 770 else: print result 771 772 if options.doDecode: 773 for msg in args: 774 bv = None 775 776 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'): 777 # Found nmea 778 # FIX: do checksum 779 bv = binary.ais6tobitvec(msg.split(',')[5]) 780 else: # either binary or nmeapayload... expect mostly nmeapayloads 781 # assumes that an all 0 and 1 string can not be a nmeapayload 782 binaryMsg=True 783 for c in msg: 784 if c not in ('0','1'): 785 binaryMsg=False 786 break 787 if binaryMsg: 788 bv = BitVector(bitstring=msg) 789 else: # nmeapayload 790 bv = binary.ais6tobitvec(msg) 791 792 printFields(decode(bv) 793 ,out=outfile 794 ,format=options.outputType 795 ,fieldList=options.fieldList 796 ,dbType=options.dbType 797 ) 798