Package ais :: Module sls_header
[hide private]
[frames] | no frames]

Source Code for Module ais.sls_header

  1  #!/usr/bin/env python 
  2   
  3  __version__ = '$Revision: 4791 $'.split()[1] 
  4  __date__ = '$Date: 2007-01-05 $'.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  ''' 
 34   
 35  import sys 
 36  from decimal import Decimal 
 37  from BitVector import BitVector 
 38   
 39  import binary, aisstring 
 40   
 41  # FIX: check to see if these will be needed 
 42  TrueBV  = BitVector(bitstring="1") 
 43  "Why always rebuild the True bit?  This should speed things up a bunch" 
 44  FalseBV = BitVector(bitstring="0") 
 45  "Why always rebuild the False bit?  This should speed things up a bunch" 
 46   
 47   
48 -def encode(params, validate=False):
49 '''Create a sls_header binary message payload to pack into an AIS Msg sls_header. 50 51 Fields in params: 52 - dac(uint): Designated Area Code 366 for US 53 - fid(uint): Functional Id (field automatically set to "1") 54 - reserved(uint): say what? (field automatically set to "0") 55 - MessageID(uint): Binary message indentifier 56 - BinaryData(binary): FIX: make this consume the rest! 57 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing 58 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 59 @rtype: BitVector 60 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8 61 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits. 62 ''' 63 64 bvList = [] 65 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dac']),10)) 66 bvList.append(binary.setBitVectorSize(BitVector(intVal=1),6)) 67 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 68 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['MessageID']),6)) 69 bvList.append(params['BinaryData']) 70 71 return binary.joinBV(bvList)
72
73 -def decode(bv, validate=False):
74 '''Unpack a sls_header message 75 76 Fields in params: 77 - dac(uint): Designated Area Code 366 for US 78 - fid(uint): Functional Id (field automatically set to "1") 79 - reserved(uint): say what? (field automatically set to "0") 80 - MessageID(uint): Binary message indentifier 81 - BinaryData(binary): FIX: make this consume the rest! 82 @type bv: BitVector 83 @param bv: Bits defining a message 84 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 85 @rtype: dict 86 @return: params 87 ''' 88 89 #Would be nice to check the bit count here.. 90 #if validate: 91 # assert (len(bv)==FIX: SOME NUMBER) 92 r = {} 93 r['dac']=int(bv[0:10]) 94 r['fid']=1 95 r['reserved']=0 96 r['MessageID']=int(bv[18:24]) 97 r['BinaryData']=bv[24:] 98 return r
99
100 -def decodedac(bv, validate=False):
101 return int(bv[0:10])
102
103 -def decodefid(bv, validate=False):
104 return 1
105
106 -def decodereserved(bv, validate=False):
107 return 0
108
109 -def decodeMessageID(bv, validate=False):
110 return int(bv[18:24])
111
112 -def decodeBinaryData(bv, validate=False):
113 return bv[24:]
114 115
116 -def printHtml(params, out=sys.stdout):
117 out.write("<h3>sls_header<h3>\n") 118 out.write("<table border=\"1\">\n") 119 out.write("<tr bgcolor=\"orange\">\n") 120 out.write("<th align=\"left\">Field Name</th>\n") 121 out.write("<th align=\"left\">Type</th>\n") 122 out.write("<th align=\"left\">Value</th>\n") 123 out.write("<th align=\"left\">Value in Lookup Table</th>\n") 124 out.write("\n") 125 out.write("<tr>\n") 126 out.write("<td>dac</td>\n") 127 out.write("<td>uint</td>\n") 128 if 'dac' in params: 129 out.write(" <td>"+str(params['dac'])+"</td>\n") 130 out.write(" <td>"+str(params['dac'])+"</td>\n") 131 out.write("</tr>\n") 132 out.write("\n") 133 out.write("<tr>\n") 134 out.write("<td>fid</td>\n") 135 out.write("<td>uint</td>\n") 136 if 'fid' in params: 137 out.write(" <td>"+str(params['fid'])+"</td>\n") 138 out.write(" <td>"+str(params['fid'])+"</td>\n") 139 out.write("</tr>\n") 140 out.write("\n") 141 out.write("<tr>\n") 142 out.write("<td>reserved</td>\n") 143 out.write("<td>uint</td>\n") 144 if 'reserved' in params: 145 out.write(" <td>"+str(params['reserved'])+"</td>\n") 146 out.write(" <td>"+str(params['reserved'])+"</td>\n") 147 out.write("</tr>\n") 148 out.write("\n") 149 out.write("<tr>\n") 150 out.write("<td>MessageID</td>\n") 151 out.write("<td>uint</td>\n") 152 if 'MessageID' in params: 153 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 154 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 155 out.write("</tr>\n") 156 out.write("\n") 157 out.write("<tr>\n") 158 out.write("<td>BinaryData</td>\n") 159 out.write("<td>binary</td>\n") 160 if 'BinaryData' in params: 161 out.write(" <td>"+str(params['BinaryData'])+"</td>\n") 162 out.write(" <td>"+str(params['BinaryData'])+"</td>\n") 163 out.write("</tr>\n") 164 out.write("</table>\n")
165 -def printFields(params, out=sys.stdout, format='std'):
166 '''Print a BinaryData message to stdout. 167 168 Fields in params: 169 - dac(uint): Designated Area Code 366 for US 170 - fid(uint): Functional Id (field automatically set to "1") 171 - reserved(uint): say what? (field automatically set to "0") 172 - MessageID(uint): Binary message indentifier 173 - BinaryData(binary): FIX: make this consume the rest! 174 @param params: Dictionary of field names/values. 175 @param out: File like object to write to 176 @rtype: stdout 177 @return: text to out 178 ''' 179 180 if 'std'==format: 181 out.write("BinaryData:\n") 182 if 'dac' in params: out.write(" dac: "+str(params['dac'])+"\n") 183 if 'fid' in params: out.write(" fid: "+str(params['fid'])+"\n") 184 if 'reserved' in params: out.write(" reserved: "+str(params['reserved'])+"\n") 185 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n") 186 if 'BinaryData' in params: out.write(" BinaryData: "+str(params['BinaryData'])+"\n") 187 elif 'html'==format: 188 printHtml(params,out) 189 else: 190 print "ERROR: unknown format:",format 191 assert False 192 193 return # Nothing to return
194 195 196 197 ###################################################################### 198 # UNIT TESTING 199 ###################################################################### 200 import unittest
201 -def testParams():
202 '''Return a params file base on the testvalue tags. 203 @rtype: dict 204 @return: params based on testvalue tags 205 ''' 206 params = {} 207 params['dac'] = 366 208 params['fid'] = 1 209 params['reserved'] = 0 210 params['MessageID'] = 3 211 params['BinaryData'] = BitVector(bitstring='0') 212 213 return params
214
215 -class Testsls_header(unittest.TestCase):
216 '''Use testvalue tag text from each type to build test case the sls_header message'''
217 - def testEncodeDecode(self):
218 219 params = testParams() 220 bits = encode(params) 221 r = decode(bits) 222 223 # Check that each parameter came through ok. 224 self.failUnlessEqual(r['dac'],params['dac']) 225 self.failUnlessEqual(r['fid'],params['fid']) 226 self.failUnlessEqual(r['reserved'],params['reserved']) 227 self.failUnlessEqual(r['MessageID'],params['MessageID']) 228 self.failUnlessEqual(r['BinaryData'],params['BinaryData'])
229
230 -def addMsgOptions(parser):
231 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 232 help='decode a "sls_header" AIS message') 233 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 234 help='encode a "sls_header" AIS message') 235 parser.add_option('--dac-field', dest='dacField',metavar='uint',type='int' 236 ,help='Field parameter value [default: %default]') 237 parser.add_option('--MessageID-field', dest='MessageIDField',metavar='uint',type='int' 238 ,help='Field parameter value [default: %default]') 239 parser.add_option('--BinaryData-field', dest='BinaryDataField',metavar='binary',type='string' 240 ,help='Field parameter value [default: %default]')
241 242 ############################################################ 243 if __name__=='__main__': 244 245 from optparse import OptionParser 246 parser = OptionParser(usage="%prog [options]", 247 version="%prog "+__version__) 248 249 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true', 250 help='run the documentation tests') 251 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true', 252 help='run the unit tests') 253 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true', 254 help='Make the test output verbose') 255 256 # FIX: remove nmea from binary messages. No way to build the whole packet? 257 # FIX: or build the surrounding msg 8 for a broadcast? 258 typeChoices = ('binary','nmeapayload','nmea') # FIX: what about a USCG type message? 259 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType' 260 ,default='nmeapayload' 261 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]') 262 263 264 outputChoices = ('std','html','xml' ) 265 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType' 266 ,default='std' 267 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]') 268 269 parser.add_option('-o','--output',dest='outputFileName',default=None, 270 help='Name of the python file to write [default: stdout]') 271 272 addMsgOptions(parser) 273 274 (options,args) = parser.parse_args() 275 success=True 276 277 if options.doctest: 278 import os; print os.path.basename(sys.argv[0]), 'doctests ...', 279 sys.argv= [sys.argv[0]] 280 if options.verbose: sys.argv.append('-v') 281 import doctest 282 numfail,numtests=doctest.testmod() 283 if numfail==0: print 'ok' 284 else: 285 print 'FAILED' 286 success=False 287 288 if not success: sys.exit('Something Failed') 289 del success # Hide success from epydoc 290 291 if options.unittest: 292 sys.argv = [sys.argv[0]] 293 if options.verbose: sys.argv.append('-v') 294 unittest.main() 295 296 outfile = sys.stdout 297 if None!=options.outputFileName: 298 outfile = file(options.outputFileName,'w') 299 300 301 if options.doEncode: 302 # First make sure all non required options are specified 303 if None==options.dacField: parser.error("missing value for dacField") 304 if None==options.MessageIDField: parser.error("missing value for MessageIDField") 305 if None==options.BinaryDataField: parser.error("missing value for BinaryDataField") 306 msgDict={ 307 'dac': options.dacField, 308 'fid': '1', 309 'reserved': '0', 310 'MessageID': options.MessageIDField, 311 'BinaryData': options.BinaryDataField, 312 } 313 314 bits = encode(msgDict) 315 if 'binary'==options.ioType: print str(bits) 316 elif 'nmeapayload'==options.ioType: 317 # FIX: figure out if this might be necessary at compile time 318 print "bitLen",len(bits) 319 bitLen=len(bits) 320 if bitLen%6!=0: 321 bits = bits + BitVector(size=(6 - (bitLen%6))) # Pad out to multiple of 6 322 print "result:",binary.bitvectoais6(bits)[0] 323 324 325 # FIX: Do not emit this option for the binary message payloads. Does not make sense. 326 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability") 327 else: sys.exit('ERROR: unknown ioType. Help!') 328 329 if options.doDecode: 330 for msg in args: 331 bv = None 332 if 'binary' == options.ioType: bv = BitVector(bitstring=msg) 333 elif 'nmeapayload'== options.ioType: bv = binary.ais6tobitvec(msg) 334 elif 'nmea' == options.ioType: bv = binary.ais6tobitvec(msg.split(',')[5]) 335 else: sys.exit('ERROR: unknown ioType. Help!') 336 337 printFields(decode(bv),out=outfile,format=options.outputType) 338