Trees       Indices       Help   
Package ais :: Module ais_msg_22
[hide private]
[frames] | no frames]

Module ais_msg_22

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.

Date: 2008-01-09

Classes [hide private]
  TestChanMngmt
Use testvalue tag text from each type to build test case the ChanMngmt message
Functions [hide private]
BitVector
encode(params, validate=False)
Create a ChanMngmt binary message payload to pack into an AIS Msg ChanMngmt.		 source code
dict
decode(bv, validate=False)
Unpack a ChanMngmt message		 source code
 
decodeMessageID(bv, validate=False) source code
 
decodeRepeatIndicator(bv, validate=False) source code
 
decodeUserID(bv, validate=False) source code
 
decodeSpare(bv, validate=False) source code
 
decodeChanA(bv, validate=False) source code
 
decodeChanB(bv, validate=False) source code
 
decodeTxRxMode(bv, validate=False) source code
 
decodepower(bv, validate=False) source code
 
decodecorner1_lon(bv, validate=False) source code
 
decodecorner1_lat(bv, validate=False) source code
 
decodecorner2_lon(bv, validate=False) source code
 
decodecorner2_lat(bv, validate=False) source code
 
decodeIndicatorType(bv, validate=False) source code
 
decodeChanABandwidth(bv, validate=False) source code
 
decodeChanBBandwidth(bv, validate=False) source code
 
decodeTransZoneSize(bv, validate=False) source code
 
decodeSpare2(bv, validate=False) source code
 
printHtml(params, out=sys.stdout) source code
stdout
printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres')
Print a ChanMngmt message to stdout.		 source code
str
sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres')
Return the SQL CREATE command for this message type		 source code
sqlhelp.create
sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres')
Return the sqlhelp object to create the table.		 source code
str
sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres')
Return the SQL INSERT command for this message type		 source code
sqlhelp.insert
sqlInsert(params, extraParams=None, dbType='postgres')
Give the SQL INSERT statement		 source code
str
latexDefinitionTable(outfile=sys.stdout)
Return the LaTeX definition table for this message type		 source code
str
textDefinitionTable(outfile=sys.stdout, delim='\t')
Return the text definition table for this message type		 source code
dict
testParams()
Return a params file base on the testvalue tags.		 source code
 
addMsgOptions(parser) source code
Variables [hide private]
  TrueBV = BitVector(bitstring= "1")
Why always rebuild the True bit? This should speed things up a bunch
  FalseBV = BitVector(bitstring= "0")
Why always rebuild the False bit? This should speed things up a bunch
  fieldList = ('MessageID', 'RepeatIndicator', 'UserID', 'Spare'...
  fieldListPostgres = ('MessageID', 'RepeatIndicator', 'UserID',...
  toPgFields = {'corner1_lat': 'corner1', 'corner1_lon': 'corner...
Go to the Postgis field names from the straight field name
  fromPgFields = {'corner1': ('corner1_lon', 'corner1_lat'), 'co...
Go from the Postgis field names to the straight field name
  pgTypes = {'corner1': 'POINT', 'corner2': 'POINT'}
Lookup table for each postgis field name to get its type.
  RepeatIndicatorEncodeLut = {'default': '0', 'do not repeat any...
  RepeatIndicatorDecodeLut = {'0': 'default', '3': 'do not repea...
  TxRxModeEncodeLut = {'Tx A, Rx A/Rx B': '1', 'Tx A/Tx B, Rx A/...
  TxRxModeDecodeLut = {'0': 'Tx A/Tx B, Rx A/RX B', '1': 'Tx A, ...
  powerEncodeLut = {'high': '0', 'low': '1'}
  powerDecodeLut = {'0': 'high', '1': 'low'}
  IndicatorTypeEncodeLut = {'addressed': '1', 'broadcast': '0'}
  IndicatorTypeDecodeLut = {'0': 'broadcast', '1': 'addressed'}
  ChanABandwidthEncodeLut = {'12.5kHz': '1', 'specified by chann...
  ChanABandwidthDecodeLut = {'0': 'specified by channel number',...
  ChanBBandwidthEncodeLut = {'12.5kHz': '1', 'specified by chann...
  ChanBBandwidthDecodeLut = {'0': 'specified by channel number',...
  TransZoneSizeEncodeLut = {'1': '0', '2': '1', '3': '2', '4': '...
  TransZoneSizeDecodeLut = {'0': '1', '1': '2', '2': '3', '3': '...
  dbTableName = 'ChanMngmt'
Database table name
Function Details [hide private]

encode(params, validate=False)

source code 

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

Fields in params:
  • MessageID(uint): AIS message number. Must be 22 (field automatically set to "22")
  • 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")
  • ChanA(uint): Channel number from ITU-R M.1084 Annex 4
  • ChanB(uint): Channel number from ITU-R M.1084 Annex 4
  • TxRxMode(uint): FIX: find the description
  • power(uint): FIX: put in a description
  • corner1_lon(decimal): north-east corner of area for assignment longitude of corner
  • corner1_lat(decimal): north-east corner of area for assignment latitude of corner
  • corner2_lon(decimal): south-west corner of area for assignment longitude of corner
  • corner2_lat(decimal): south-west corner of area for assignment latitude of corner
  • IndicatorType(uint): FIX: put in a description
  • ChanABandwidth(uint): FIX: put in a description
  • ChanBBandwidth(uint): FIX: put in a description
  • TransZoneSize(uint): FIX: put in a description
  • Spare2(uint): Not used. Should be set to zero. (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 ChanMngmt message

Fields in params:
  • MessageID(uint): AIS message number. Must be 22 (field automatically set to "22")
  • 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")
  • ChanA(uint): Channel number from ITU-R M.1084 Annex 4
  • ChanB(uint): Channel number from ITU-R M.1084 Annex 4
  • TxRxMode(uint): FIX: find the description
  • power(uint): FIX: put in a description
  • corner1_lon(decimal): north-east corner of area for assignment longitude of corner
  • corner1_lat(decimal): north-east corner of area for assignment latitude of corner
  • corner2_lon(decimal): south-west corner of area for assignment longitude of corner
  • corner2_lat(decimal): south-west corner of area for assignment latitude of corner
  • IndicatorType(uint): FIX: put in a description
  • ChanABandwidth(uint): FIX: put in a description
  • ChanBBandwidth(uint): FIX: put in a description
  • TransZoneSize(uint): FIX: put in a description
  • Spare2(uint): Not used. Should be set to zero. (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

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

source code 

Print a ChanMngmt message to stdout.

Fields in params:
  • MessageID(uint): AIS message number. Must be 22 (field automatically set to "22")
  • 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")
  • ChanA(uint): Channel number from ITU-R M.1084 Annex 4
  • ChanB(uint): Channel number from ITU-R M.1084 Annex 4
  • TxRxMode(uint): FIX: find the description
  • power(uint): FIX: put in a description
  • corner1_lon(decimal): north-east corner of area for assignment longitude of corner
  • corner1_lat(decimal): north-east corner of area for assignment latitude of corner
  • corner2_lon(decimal): south-west corner of area for assignment longitude of corner
  • corner2_lat(decimal): south-west corner of area for assignment latitude of corner
  • IndicatorType(uint): FIX: put in a description
  • ChanABandwidth(uint): FIX: put in a description
  • ChanBBandwidth(uint): FIX: put in a description
  • TransZoneSize(uint): FIX: put in a description
  • Spare2(uint): Not used. Should be set to zero. (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???

latexDefinitionTable(outfile=sys.stdout)

source code 
Return the LaTeX definition table for this message type
Parameters:
  • outfile (file obj) - file like object to print to.
Returns: str
LaTeX table string via the outfile

textDefinitionTable(outfile=sys.stdout, delim='\t')

source code 
Return the text definition table for this message type
Parameters:
  • outfile (file obj) - file like object to print to.
Returns: str
text table string via the outfile

testParams()

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

Variables Details [hide private]

fieldList

Value:
('MessageID',
 'RepeatIndicator',
 'UserID',
 'Spare',
 'ChanA',
 'ChanB',
 'TxRxMode',
 'power',
...

fieldListPostgres

Value:
('MessageID',
 'RepeatIndicator',
 'UserID',
 'Spare',
 'ChanA',
 'ChanB',
 'TxRxMode',
 'power',
...

toPgFields

Go to the Postgis field names from the straight field name
Value:
{'corner1_lat': 'corner1',
 'corner1_lon': 'corner1',
 'corner2_lat': 'corner2',
 'corner2_lon': 'corner2'}

fromPgFields

Go from the Postgis field names to the straight field name
Value:
{'corner1': ('corner1_lon', 'corner1_lat'),
 'corner2': ('corner2_lon', 'corner2_lat')}

RepeatIndicatorEncodeLut

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

RepeatIndicatorDecodeLut

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

TxRxModeEncodeLut

Value:
{'Tx A, Rx A/Rx B': '1',
 'Tx A/Tx B, Rx A/RX B': '0',
 'Tx B, Rx A/Rx B': '2'}

TxRxModeDecodeLut

Value:
{'0': 'Tx A/Tx B, Rx A/RX B',
 '1': 'Tx A, Rx A/Rx B',
 '2': 'Tx B, Rx A/Rx B'}

ChanABandwidthEncodeLut

Value:
{'12.5kHz': '1', 'specified by channel number': '0'}

ChanABandwidthDecodeLut

Value:
{'0': 'specified by channel number', '1': '12.5kHz'}

ChanBBandwidthEncodeLut

Value:
{'12.5kHz': '1', 'specified by channel number': '0'}

ChanBBandwidthDecodeLut

Value:
{'0': 'specified by channel number', '1': '12.5kHz'}

TransZoneSizeEncodeLut

Value:
{'1': '0',
 '2': '1',
 '3': '2',
 '4': '3',
 '5': '4',
 '6': '5',
 '7': '6',
 '8': '7'}

TransZoneSizeDecodeLut

Value:
{'0': '1',
 '1': '2',
 '2': '3',
 '3': '4',
 '4': '5',
 '5': '6',
 '6': '7',
 '7': '8'}

   Trees       Indices       Help   
Generated by Epydoc 3.0beta1 on Fri Jan 11 11:03:03 2008 http://epydoc.sourceforge.net