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

Module ais_msg_5

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: 2007-03-31

Classes [hide private]
  Testshipdata
Use testvalue tag text from each type to build test case the shipdata message
Functions [hide private]
BitVector
encode(params, validate=False)
Create a shipdata binary message payload to pack into an AIS Msg shipdata.		 source code
dict
decode(bv, validate=False)
Unpack a shipdata message		 source code
 
decodeMessageID(bv, validate=False) source code
 
decodeRepeatIndicator(bv, validate=False) source code
 
decodeUserID(bv, validate=False) source code
 
decodeAISversion(bv, validate=False) source code
 
decodeIMOnumber(bv, validate=False) source code
 
decodecallsign(bv, validate=False) source code
 
decodename(bv, validate=False) source code
 
decodeshipandcargo(bv, validate=False) source code
 
decodedimA(bv, validate=False) source code
 
decodedimB(bv, validate=False) source code
 
decodedimC(bv, validate=False) source code
 
decodedimD(bv, validate=False) source code
 
decodefixtype(bv, validate=False) source code
 
decodeETAminute(bv, validate=False) source code
 
decodeETAhour(bv, validate=False) source code
 
decodeETAday(bv, validate=False) source code
 
decodeETAmonth(bv, validate=False) source code
 
decodedraught(bv, validate=False) source code
 
decodedestination(bv, validate=False) source code
 
decodedte(bv, validate=False) source code
 
decodeSpare(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 shipdata 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
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', 'AISver...
  fieldListPostgres = ('MessageID', 'RepeatIndicator', 'UserID',...
  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...
  RepeatIndicatorDecodeLut = {'0': 'default', '3': 'do not repea...
  shipandcargoEncodeLut = {'High speed craft (HSC), Hazardous ca...
  shipandcargoDecodeLut = {'20': 'Wing in ground (WIG), all ship...
  dimCEncodeLut = {'63 m or greater': '63'}
  dimCDecodeLut = {'63': '63 m or greater'}
  dimDEncodeLut = {'63 m or greater': '63'}
  dimDDecodeLut = {'63': '63 m or greater'}
  fixtypeEncodeLut = {'Chayka': '5', 'GLONASS': '2', 'GPS': '1',...
  fixtypeDecodeLut = {'0': 'undefined', '1': 'GPS', '2': 'GLONAS...
  dteEncodeLut = {'available': '0', 'not available': '1'}
  dteDecodeLut = {'0': 'available', '1': 'not available'}
Function Details [hide private]

encode(params, validate=False)

source code 

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

Fields in params:
  • MessageID(uint): AIS message number. Must be 5 (field automatically set to "5")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): Unique ship identification number (MMSI)
  • AISversion(uint): Compliant with what edition. 0 is the first edition.
  • IMOnumber(uint): vessel identification number (different than mmsi)
  • callsign(aisstr6): Ship radio call sign
  • name(aisstr6): Vessel name
  • shipandcargo(uint): what
  • dimA(uint): Distance from bow to reference position
  • dimB(uint): Distance from reference position to stern
  • dimC(uint): Distance from port side to reference position
  • dimD(uint): Distance from reference position to starboard side
  • fixtype(uint): Method used for positioning
  • ETAminute(uint): Estimated time of arrival - minutes
  • ETAhour(uint): Estimated time of arrival - hour
  • ETAday(uint): Estimated time of arrival - day
  • ETAmonth(uint): Estimated time of arrival - month
  • draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater
  • destination(aisstr6): Where is the vessel going
  • dte(uint): Data terminal ready
  • Spare(uint): Reserved for definition by a regional authority. (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 shipdata message

Fields in params:
  • MessageID(uint): AIS message number. Must be 5 (field automatically set to "5")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): Unique ship identification number (MMSI)
  • AISversion(uint): Compliant with what edition. 0 is the first edition.
  • IMOnumber(uint): vessel identification number (different than mmsi)
  • callsign(aisstr6): Ship radio call sign
  • name(aisstr6): Vessel name
  • shipandcargo(uint): what
  • dimA(uint): Distance from bow to reference position
  • dimB(uint): Distance from reference position to stern
  • dimC(uint): Distance from port side to reference position
  • dimD(uint): Distance from reference position to starboard side
  • fixtype(uint): Method used for positioning
  • ETAminute(uint): Estimated time of arrival - minutes
  • ETAhour(uint): Estimated time of arrival - hour
  • ETAday(uint): Estimated time of arrival - day
  • ETAmonth(uint): Estimated time of arrival - month
  • draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater
  • destination(aisstr6): Where is the vessel going
  • dte(uint): Data terminal ready
  • Spare(uint): Reserved for definition by a regional authority. (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 shipdata message to stdout.

Fields in params:
  • MessageID(uint): AIS message number. Must be 5 (field automatically set to "5")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): Unique ship identification number (MMSI)
  • AISversion(uint): Compliant with what edition. 0 is the first edition.
  • IMOnumber(uint): vessel identification number (different than mmsi)
  • callsign(aisstr6): Ship radio call sign
  • name(aisstr6): Vessel name
  • shipandcargo(uint): what
  • dimA(uint): Distance from bow to reference position
  • dimB(uint): Distance from reference position to stern
  • dimC(uint): Distance from port side to reference position
  • dimD(uint): Distance from reference position to starboard side
  • fixtype(uint): Method used for positioning
  • ETAminute(uint): Estimated time of arrival - minutes
  • ETAhour(uint): Estimated time of arrival - hour
  • ETAday(uint): Estimated time of arrival - day
  • ETAmonth(uint): Estimated time of arrival - month
  • draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater
  • destination(aisstr6): Where is the vessel going
  • dte(uint): Data terminal ready
  • Spare(uint): Reserved for definition by a regional authority. (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

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',
 'AISversion',
 'IMOnumber',
 'callsign',
 'name',
 'shipandcargo',
...

fieldListPostgres

Value:
('MessageID',
 'RepeatIndicator',
 'UserID',
 'AISversion',
 'IMOnumber',
 'callsign',
 'name',
 'shipandcargo',
...

RepeatIndicatorEncodeLut

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

RepeatIndicatorDecodeLut

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

shipandcargoEncodeLut

Value:
{'High speed craft (HSC), Hazardous catagory A': '41',
 'High speed craft (HSC), Hazardous catagory B': '42',
 'High speed craft (HSC), Hazardous catagory C': '43',
 'High speed craft (HSC), Hazardous catagory D': '44',
 'High speed craft (HSC), No additional information': '49',
 'High speed craft (HSC), Reserved for future use': '48',
 'High speed craft (HSC), all ships of this type': '40',
 'Wing in ground (WIG), Hazardous catagory A': '21',
...

shipandcargoDecodeLut

Value:
{'20': 'Wing in ground (WIG), all ships of this type',
 '21': 'Wing in ground (WIG), Hazardous catagory A',
 '22': 'Wing in ground (WIG), Hazardous catagory B',
 '23': 'Wing in ground (WIG), Hazardous catagory C',
 '24': 'Wing in ground (WIG), Hazardous catagory D',
 '25': 'Wing in ground (WIG), Reserved for future use',
 '26': 'Wing in ground (WIG), Reserved for future use',
 '27': 'Wing in ground (WIG), Reserved for future use',
...

fixtypeEncodeLut

Value:
{'Chayka': '5',
 'GLONASS': '2',
 'GPS': '1',
 'Loran-C': '4',
 'combined GPS/GLONASS': '3',
 'integrated navigation system': '6',
 'surveyed': '7',
 'undefined': '0'}

fixtypeDecodeLut

Value:
{'0': 'undefined',
 '1': 'GPS',
 '2': 'GLONASS',
 '3': 'combined GPS/GLONASS',
 '4': 'Loran-C',
 '5': 'Chayka',
 '6': 'integrated navigation system',
 '7': 'surveyed'}

   Trees       Indices       Help   
Generated by Epydoc 3.0beta1 on Sat Mar 31 08:52:51 2007 http://epydoc.sourceforge.net