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

Module ais_msg_20

source code

Autogenerated python functions to serialize/deserialize binary messages.

Generated by: ./aisxmlbinmsg2py.py

Need to then wrap these functions with the outer AIS packet and then convert the whole binary blob to a NMEA string. Those functions are not currently provided in this file.

serialize: python to ais binary deserialize: ais binary to python

The generated code uses translators.py, binary.py, and aisstring.py which should be packaged with the resulting files.


Requires:

Author: xmlbinmsg

Version: 4791

Status: under development

License: Generated code has no license

To Do: FIX: put in a description of the message here with fields and types.

Classes [hide private]
  Testdatalinkmng
Use testvalue tag text from each type to build test case the datalinkmng message

Functions [hide private]
BitVector encode(params, validate=False)
Create a datalinkmng binary message payload to pack into an AIS Msg datalinkmng.
dict decode(bv, validate=False)
Unpack a datalinkmng message
  decodeMessageID(bv, validate=False)
  decodeRepeatIndicator(bv, validate=False)
  decodeUserID(bv, validate=False)
  decodeSpare(bv, validate=False)
  decodeoffset1(bv, validate=False)
  decodenumslots1(bv, validate=False)
  decodetimeout1(bv, validate=False)
  decodeincrement1(bv, validate=False)
  decodeoffset2(bv, validate=False)
  decodenumslots2(bv, validate=False)
  decodetimeout2(bv, validate=False)
  decodeincrement2(bv, validate=False)
  decodeoffset3(bv, validate=False)
  decodenumslots3(bv, validate=False)
  decodetimeout3(bv, validate=False)
  decodeincrement3(bv, validate=False)
  decodeoffset4(bv, validate=False)
  decodenumslots4(bv, validate=False)
  decodetimeout4(bv, validate=False)
  decodeincrement4(bv, validate=False)
  decodevariablespare(bv, validate=False)
  printHtml(params, out=sys.stdout)
stdout printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres')
Print a datalinkmng message to stdout.
str sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres')
Return the SQL CREATE command for this message type
sqlhelp.create sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres')
Return the sqlhelp object to create the table.
str sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres')
Return the SQL INSERT command for this message type
sqlhelp.insert sqlInsert(params, extraParams=None, dbType='postgres')
Give the SQL INSERT statement
dict testParams()
Return a params file base on the testvalue tags.
  addMsgOptions(parser)

Variables [hide private]
  __date__ = '2007-02-26'
Date of last svn commit
  TrueBV = <ais.BitVector.BitVector object at 0x232e350>
Why always rebuild the True bit? This should speed things up a bunch
  FalseBV = <ais.BitVector.BitVector object at 0x232e3d0>
Why always rebuild the False bit? This should speed things up a bunch
  fieldList = ('MessageID', 'RepeatIndicator', 'UserID', 'Spare', ...
  fieldListPostgres = ('MessageID', 'RepeatIndicator', 'UserID', 'Spare', ...
  toPgFields = {}
Go to the Postgis field names from the straight field name
  fromPgFields = {}
Go from the Postgis field names to the straight field name
  pgTypes = {}
Lookup table for each postgis field name to get its type.
  RepeatIndicatorEncodeLut = {'default': '0', 'do not repeat any more': '3'}
  RepeatIndicatorDecodeLut = {'0': 'default', '3': 'do not repeat any more'}
  typeChoices = 'binary', 'nmeapayload', 'nmea'
  outputChoices = 'std', 'html', 'csv', 'sql'
  dbChoices = 'sqlite', 'postgres'
  outfile = file(options.outputFileName, 'w')
  msgDict = {'MessageID': '20', 'RepeatIndicator': options.Repea...
  bitLen = len(bits)
  bits = bits+ BitVector(size= (6-(bitLen % 6)))
  buf = StringIO.StringIO()
  result = buf.getvalue()

Function Details [hide private]

encode(params, validate=False)

source code 

Create a datalinkmng binary message payload to pack into an AIS Msg datalinkmng.

Fields in params:
  • MessageID(uint): AIS message number. Must be 20 (field automatically set to "20")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): Unique ship identification number (MMSI)
  • Spare(uint): Not used. Should be set to zero. (field automatically set to "0")
  • offset1(uint): Reserved offset number
  • numslots1(uint): Number of reserved consecutive slots
  • timeout1(uint): Time-out value in minutes
  • increment1(uint): Increment to repeast reservation of this block
  • offset2(uint): Reserved offset number (optional)
  • numslots2(uint): Number of reserved consecutive slots (optional)
  • timeout2(uint): Time-out value in minutes (optional)
  • increment2(uint): Increment to repeast reservation of this block (optional)
  • offset3(uint): Reserved offset number (optional)
  • numslots3(uint): Number of reserved consecutive slots (optional)
  • timeout3(uint): Time-out value in minutes (optional)
  • increment3(uint): Increment to repeast reservation of this block (optional)
  • offset4(uint): Reserved offset number (optional)
  • numslots4(uint): Number of reserved consecutive slots (optional)
  • timeout4(uint): Time-out value in minutes (optional)
  • increment4(uint): Increment to repeast reservation of this block (optional)
  • variablespare(uint): This field is a serious pain. This padding makes the message byte aligned (field automatically set to "0")
Parameters:
  • params - Dictionary of field names/values. Throws a ValueError exception if required is missing
  • validate - Set to true to cause checking to occur. Runs slower. FIX: not implemented.
Returns: BitVector
encoded binary message (for binary messages, this needs to be wrapped in a msg 8

Note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits.

decode(bv, validate=False)

source code 

Unpack a datalinkmng message

Fields in params:
  • MessageID(uint): AIS message number. Must be 20 (field automatically set to "20")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): Unique ship identification number (MMSI)
  • Spare(uint): Not used. Should be set to zero. (field automatically set to "0")
  • offset1(uint): Reserved offset number
  • numslots1(uint): Number of reserved consecutive slots
  • timeout1(uint): Time-out value in minutes
  • increment1(uint): Increment to repeast reservation of this block
  • offset2(uint): Reserved offset number (optional)
  • numslots2(uint): Number of reserved consecutive slots (optional)
  • timeout2(uint): Time-out value in minutes (optional)
  • increment2(uint): Increment to repeast reservation of this block (optional)
  • offset3(uint): Reserved offset number (optional)
  • numslots3(uint): Number of reserved consecutive slots (optional)
  • timeout3(uint): Time-out value in minutes (optional)
  • increment3(uint): Increment to repeast reservation of this block (optional)
  • offset4(uint): Reserved offset number (optional)
  • numslots4(uint): Number of reserved consecutive slots (optional)
  • timeout4(uint): Time-out value in minutes (optional)
  • increment4(uint): Increment to repeast reservation of this block (optional)
  • variablespare(uint): This field is a serious pain. This padding makes the message byte aligned (field automatically set to "0")
Parameters:
  • bv (BitVector) - Bits defining a message
  • validate - Set to true to cause checking to occur. Runs slower. FIX: not implemented.
Returns: dict
params

decodeMessageID(bv, validate=False)

source code 
None

decodeRepeatIndicator(bv, validate=False)

source code 
None

decodeUserID(bv, validate=False)

source code 
None

decodeSpare(bv, validate=False)

source code 
None

decodeoffset1(bv, validate=False)

source code 
None

decodenumslots1(bv, validate=False)

source code 
None

decodetimeout1(bv, validate=False)

source code 
None

decodeincrement1(bv, validate=False)

source code 
None

decodeoffset2(bv, validate=False)

source code 
None

decodenumslots2(bv, validate=False)

source code 
None

decodetimeout2(bv, validate=False)

source code 
None

decodeincrement2(bv, validate=False)

source code 
None

decodeoffset3(bv, validate=False)

source code 
None

decodenumslots3(bv, validate=False)

source code 
None

decodetimeout3(bv, validate=False)

source code 
None

decodeincrement3(bv, validate=False)

source code 
None

decodeoffset4(bv, validate=False)

source code 
None

decodenumslots4(bv, validate=False)

source code 
None

decodetimeout4(bv, validate=False)

source code 
None

decodeincrement4(bv, validate=False)

source code 
None

decodevariablespare(bv, validate=False)

source code 
None

printHtml(params, out=sys.stdout)

source code 
None

printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres')

source code 

Print a datalinkmng message to stdout.

Fields in params:
  • MessageID(uint): AIS message number. Must be 20 (field automatically set to "20")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): Unique ship identification number (MMSI)
  • Spare(uint): Not used. Should be set to zero. (field automatically set to "0")
  • offset1(uint): Reserved offset number
  • numslots1(uint): Number of reserved consecutive slots
  • timeout1(uint): Time-out value in minutes
  • increment1(uint): Increment to repeast reservation of this block
  • offset2(uint): Reserved offset number (optional)
  • numslots2(uint): Number of reserved consecutive slots (optional)
  • timeout2(uint): Time-out value in minutes (optional)
  • increment2(uint): Increment to repeast reservation of this block (optional)
  • offset3(uint): Reserved offset number (optional)
  • numslots3(uint): Number of reserved consecutive slots (optional)
  • timeout3(uint): Time-out value in minutes (optional)
  • increment3(uint): Increment to repeast reservation of this block (optional)
  • offset4(uint): Reserved offset number (optional)
  • numslots4(uint): Number of reserved consecutive slots (optional)
  • timeout4(uint): Time-out value in minutes (optional)
  • increment4(uint): Increment to repeast reservation of this block (optional)
  • variablespare(uint): This field is a serious pain. This padding makes the message byte aligned (field automatically set to "0")
Parameters:
  • params - Dictionary of field names/values.
  • out - File like object to write to
Returns: stdout
text to out

sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres')

source code 
Return the SQL CREATE command for this message type
Parameters:
  • outfile - file like object to print to.
  • fields - which fields to put in the create. Defaults to all.
  • extraFields - A sequence of tuples containing (name,sql type) for additional fields
  • addCoastGuardFields (bool) - Add the extra fields that come after the NMEA check some from the USCG N-AIS format
  • dbType - Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
Returns: str
sql create string

See Also: sqlCreate

sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres')

source code 
Return the sqlhelp object to create the table.
Parameters:
  • fields - which fields to put in the create. Defaults to all.
  • extraFields - A sequence of tuples containing (name,sql type) for additional fields
  • addCoastGuardFields (bool) - Add the extra fields that come after the NMEA check some from the USCG N-AIS format
  • dbType - Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
Returns: sqlhelp.create
An object that can be used to generate a return

sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres')

source code 
Return the SQL INSERT command for this message type
Parameters:
  • params - dictionary of values keyed by field name
  • outfile - file like object to print to.
  • extraParams - A sequence of tuples containing (name,sql type) for additional fields
Returns: str
sql create string

See Also: sqlCreate

sqlInsert(params, extraParams=None, dbType='postgres')

source code 
Give the SQL INSERT statement
Parameters:
  • params - dict keyed by field name of values
  • extraParams - any extra fields that you have created beyond the normal ais message fields
Returns: sqlhelp.insert
insert class instance

To Do: allow optional type checking of params?

Warning: this will take invalid keys happily and do what???

testParams()

source code 
Return a params file base on the testvalue tags.
Returns: dict
params based on testvalue tags

addMsgOptions(parser)

source code 
None

Variables Details [hide private]

__date__

Date of last svn commit
Value:
'2007-02-26'                                                           
      

TrueBV

Why always rebuild the True bit? This should speed things up a bunch
Value:
<ais.BitVector.BitVector object at 0x232e350>                          
      

FalseBV

Why always rebuild the False bit? This should speed things up a bunch
Value:
<ais.BitVector.BitVector object at 0x232e3d0>                          
      

fieldList

None
Value:
('MessageID',
 'RepeatIndicator',
 'UserID',
 'Spare',
 'offset1',
 'numslots1',
 'timeout1',
 'increment1',
...                                                                    
      

fieldListPostgres

None
Value:
('MessageID',
 'RepeatIndicator',
 'UserID',
 'Spare',
 'offset1',
 'numslots1',
 'timeout1',
 'increment1',
...                                                                    
      

toPgFields

Go to the Postgis field names from the straight field name
Value:
{}                                                                     
      

fromPgFields

Go from the Postgis field names to the straight field name
Value:
{}                                                                     
      

pgTypes

Lookup table for each postgis field name to get its type.
Value:
{}                                                                     
      

RepeatIndicatorEncodeLut

None
Value:
{'default': '0', 'do not repeat any more': '3'}                        
      

RepeatIndicatorDecodeLut

None
Value:
{'0': 'default', '3': 'do not repeat any more'}                        
      

typeChoices

None
Value:
'binary', 'nmeapayload', 'nmea'                                        
      

outputChoices

None
Value:
'std', 'html', 'csv', 'sql'                                            
      

dbChoices

None
Value:
'sqlite', 'postgres'                                                   
      

outfile

None
Value:
file(options.outputFileName, 'w')                                      
      

msgDict

None
Value:
{'MessageID': '20', 'RepeatIndicator': options.RepeatIndicatorField, '
UserID': options.UserIDField, 'Spare': '0', 'offset1': options.offset1
Field, 'numslots1': options.numslots1Field, 'timeout1': options.timeou
t1Field, 'increment1': options.increment1Field, 'offset2': options.off
set2Field, 'numslots2': options.numslots2Field, 'timeout2': options.ti
meout2Field, 'increment2': options.increment2Field, 'offset3': options
.offset3Field, 'numslots3': options.numslots3Field, 'timeout3': option
s.timeout3Field, 'increment3': options.increment3Field, 'offset4': opt
...                                                                    
      

bitLen

None
Value:
len(bits)                                                              
      

bits

None
Value:
bits+ BitVector(size= (6-(bitLen % 6)))                                
      

buf

None
Value:
StringIO.StringIO()                                                    
      

result

None
Value:
buf.getvalue()