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

Module imo_001_14

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]
  Testimo_tidal_window
Use testvalue tag text from each type to build test case the imo_tidal_window message
Functions [hide private]
BitVector
encode(params, validate=False)
Create a imo_tidal_window binary message payload to pack into an AIS Msg imo_tidal_window.		 source code
dict
decode(bv, validate=False)
Unpack a imo_tidal_window message		 source code
 
decodeMessageID(bv, validate=False) source code
 
decodeRepeatIndicator(bv, validate=False) source code
 
decodeUserID(bv, validate=False) source code
 
decodeSeqNum(bv, validate=False) source code
 
decodeDestinationID(bv, validate=False) source code
 
decodeRetransmitFlag(bv, validate=False) source code
 
decodeSpare(bv, validate=False) source code
 
decodedac(bv, validate=False) source code
 
decodefid(bv, validate=False) source code
 
decodemonth(bv, validate=False) source code
 
decodeday(bv, validate=False) source code
 
decodewindow1_longitude(bv, validate=False) source code
 
decodewindow1_latitude(bv, validate=False) source code
 
decodefromhour1(bv, validate=False) source code
 
decodefrommin1(bv, validate=False) source code
 
decodetohour1(bv, validate=False) source code
 
decodetomin1(bv, validate=False) source code
 
decodecurdir1(bv, validate=False) source code
 
decodecurspeed1(bv, validate=False) source code
 
decodewindow2_longitude(bv, validate=False) source code
 
decodewindow2_latitude(bv, validate=False) source code
 
decodefromhour2(bv, validate=False) source code
 
decodefrommin2(bv, validate=False) source code
 
decodetohour2(bv, validate=False) source code
 
decodetomin2(bv, validate=False) source code
 
decodecurdir2(bv, validate=False) source code
 
decodecurspeed2(bv, validate=False) source code
 
decodewindow3_longitude(bv, validate=False) source code
 
decodewindow3_latitude(bv, validate=False) source code
 
decodefromhour3(bv, validate=False) source code
 
decodefrommin3(bv, validate=False) source code
 
decodetohour3(bv, validate=False) source code
 
decodetomin3(bv, validate=False) source code
 
decodecurdir3(bv, validate=False) source code
 
decodecurspeed3(bv, validate=False) source code
 
printHtml(params, out=sys.stdout) source code
 
printKml(params, out=sys.stdout)
KML (Keyhole Markup Language) for Google Earth, but without the header/footer		 source code
stdout
printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres')
Print a imo_tidal_window 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', 'SeqNum...
  fieldListPostgres = ('MessageID', 'RepeatIndicator', 'UserID',...
  toPgFields = {'window1_latitude': 'window1', 'window1_longitud...
Go to the Postgis field names from the straight field name
  fromPgFields = {'window1': ('window1_longitude', 'window1_lati...
Go from the Postgis field names to the straight field name
  pgTypes = {'window1': 'POINT', 'window2': 'POINT', 'window3': ...
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...
  RetransmitFlagEncodeLut = {'no retransmission': '0', 'restrans...
  RetransmitFlagDecodeLut = {'0': 'no retransmission', '1': 'res...
  dbTableName = 'imo_tidal_window'
Database table name
Function Details [hide private]

encode(params, validate=False)

source code 

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

Fields in params:
  • MessageID(uint): AIS message number. Must be 6 (field automatically set to "6")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): MMSI number of transmitter broadcasting the message
  • SeqNum(uint): Sequence number as described in 5.3.1. Assigned to each station
  • DestinationID(uint): Unique ship identification number (MMSI)
  • RetransmitFlag(bool): Should be set upon retransmission
  • Spare(uint): Must be 0 (field automatically set to "0")
  • dac(uint): Designated Area Code - part 1 of the IAI (field automatically set to "1")
  • fid(uint): Functional Identifier - part 2 of the IAI (field automatically set to "11")
  • month(uint): UTC month
  • day(uint): UTC day
  • window1_longitude(decimal): Not sure what this position is for? Center? East West location
  • window1_latitude(decimal): Not sure what this position is for? Center? North South location
  • fromhour1(uint): From UTC hour
  • frommin1(uint): From UTC minute
  • tohour1(uint): To UTC hour
  • tomin1(uint): To UTC minute
  • curdir1(uint): Current direction
  • curspeed1(udecimal): Current speed
  • window2_longitude(decimal): Not sure what this position is for? Center? East West location
  • window2_latitude(decimal): Not sure what this position is for? Center? North South location
  • fromhour2(uint): From UTC hour
  • frommin2(uint): From UTC minute
  • tohour2(uint): To UTC hour
  • tomin2(uint): To UTC minute
  • curdir2(uint): Current direction
  • curspeed2(udecimal): Current speed
  • window3_longitude(decimal): Not sure what this position is for? Center? East West location
  • window3_latitude(decimal): Not sure what this position is for? Center? North South location
  • fromhour3(uint): From UTC hour
  • frommin3(uint): From UTC minute
  • tohour3(uint): To UTC hour
  • tomin3(uint): To UTC minute
  • curdir3(uint): Current direction
  • curspeed3(udecimal): Current speed
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 imo_tidal_window message

Fields in params:
  • MessageID(uint): AIS message number. Must be 6 (field automatically set to "6")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): MMSI number of transmitter broadcasting the message
  • SeqNum(uint): Sequence number as described in 5.3.1. Assigned to each station
  • DestinationID(uint): Unique ship identification number (MMSI)
  • RetransmitFlag(bool): Should be set upon retransmission
  • Spare(uint): Must be 0 (field automatically set to "0")
  • dac(uint): Designated Area Code - part 1 of the IAI (field automatically set to "1")
  • fid(uint): Functional Identifier - part 2 of the IAI (field automatically set to "11")
  • month(uint): UTC month
  • day(uint): UTC day
  • window1_longitude(decimal): Not sure what this position is for? Center? East West location
  • window1_latitude(decimal): Not sure what this position is for? Center? North South location
  • fromhour1(uint): From UTC hour
  • frommin1(uint): From UTC minute
  • tohour1(uint): To UTC hour
  • tomin1(uint): To UTC minute
  • curdir1(uint): Current direction
  • curspeed1(udecimal): Current speed
  • window2_longitude(decimal): Not sure what this position is for? Center? East West location
  • window2_latitude(decimal): Not sure what this position is for? Center? North South location
  • fromhour2(uint): From UTC hour
  • frommin2(uint): From UTC minute
  • tohour2(uint): To UTC hour
  • tomin2(uint): To UTC minute
  • curdir2(uint): Current direction
  • curspeed2(udecimal): Current speed
  • window3_longitude(decimal): Not sure what this position is for? Center? East West location
  • window3_latitude(decimal): Not sure what this position is for? Center? North South location
  • fromhour3(uint): From UTC hour
  • frommin3(uint): From UTC minute
  • tohour3(uint): To UTC hour
  • tomin3(uint): To UTC minute
  • curdir3(uint): Current direction
  • curspeed3(udecimal): Current speed
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 imo_tidal_window message to stdout.

Fields in params:
  • MessageID(uint): AIS message number. Must be 6 (field automatically set to "6")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): MMSI number of transmitter broadcasting the message
  • SeqNum(uint): Sequence number as described in 5.3.1. Assigned to each station
  • DestinationID(uint): Unique ship identification number (MMSI)
  • RetransmitFlag(bool): Should be set upon retransmission
  • Spare(uint): Must be 0 (field automatically set to "0")
  • dac(uint): Designated Area Code - part 1 of the IAI (field automatically set to "1")
  • fid(uint): Functional Identifier - part 2 of the IAI (field automatically set to "11")
  • month(uint): UTC month
  • day(uint): UTC day
  • window1_longitude(decimal): Not sure what this position is for? Center? East West location
  • window1_latitude(decimal): Not sure what this position is for? Center? North South location
  • fromhour1(uint): From UTC hour
  • frommin1(uint): From UTC minute
  • tohour1(uint): To UTC hour
  • tomin1(uint): To UTC minute
  • curdir1(uint): Current direction
  • curspeed1(udecimal): Current speed
  • window2_longitude(decimal): Not sure what this position is for? Center? East West location
  • window2_latitude(decimal): Not sure what this position is for? Center? North South location
  • fromhour2(uint): From UTC hour
  • frommin2(uint): From UTC minute
  • tohour2(uint): To UTC hour
  • tomin2(uint): To UTC minute
  • curdir2(uint): Current direction
  • curspeed2(udecimal): Current speed
  • window3_longitude(decimal): Not sure what this position is for? Center? East West location
  • window3_latitude(decimal): Not sure what this position is for? Center? North South location
  • fromhour3(uint): From UTC hour
  • frommin3(uint): From UTC minute
  • tohour3(uint): To UTC hour
  • tomin3(uint): To UTC minute
  • curdir3(uint): Current direction
  • curspeed3(udecimal): Current speed
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',
 'SeqNum',
 'DestinationID',
 'RetransmitFlag',
 'Spare',
 'dac',
...

fieldListPostgres

Value:
('MessageID',
 'RepeatIndicator',
 'UserID',
 'SeqNum',
 'DestinationID',
 'RetransmitFlag',
 'Spare',
 'dac',
...

toPgFields

Go to the Postgis field names from the straight field name
Value:
{'window1_latitude': 'window1',
 'window1_longitude': 'window1',
 'window2_latitude': 'window2',
 'window2_longitude': 'window2',
 'window3_latitude': 'window3',
 'window3_longitude': 'window3'}

fromPgFields

Go from the Postgis field names to the straight field name
Value:
{'window1': ('window1_longitude', 'window1_latitude'),
 'window2': ('window2_longitude', 'window2_latitude'),
 'window3': ('window3_longitude', 'window3_latitude')}

pgTypes

Lookup table for each postgis field name to get its type.
Value:
{'window1': 'POINT', 'window2': 'POINT', 'window3': 'POINT'}

RepeatIndicatorEncodeLut

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

RepeatIndicatorDecodeLut

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

RetransmitFlagEncodeLut

Value:
{'no retransmission': '0', 'restransmitted': '1'}

RetransmitFlagDecodeLut

Value:
{'0': 'no retransmission', '1': 'restransmitted'}

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