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

Module whalenotice2

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]
  Testwhalenotice
Use testvalue tag text from each type to build test case the whalenotice message
Functions [hide private]
BitVector
encode(params, validate=False)
Create a whalenotice binary message payload to pack into an AIS Msg whalenotice.		 source code
dict
decode(bv, validate=False)
Unpack a whalenotice 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
 
decodedac(bv, validate=False) source code
 
decodefid(bv, validate=False) source code
 
decodeefid(bv, validate=False) source code
 
decodenumreports(bv, validate=False) source code
 
decodestationid1(bv, validate=False) source code
 
decodetime1_day(bv, validate=False) source code
 
decodetime1_hour(bv, validate=False) source code
 
decodetime1_min(bv, validate=False) source code
 
decodecenter1_longitude(bv, validate=False) source code
 
decodecenter1_latitude(bv, validate=False) source code
 
decodetimetoexpire1(bv, validate=False) source code
 
decoderadius1(bv, validate=False) source code
 
decodestationid2(bv, validate=False) source code
 
decodetime2_day(bv, validate=False) source code
 
decodetime2_hour(bv, validate=False) source code
 
decodetime2_min(bv, validate=False) source code
 
decodecenter2_longitude(bv, validate=False) source code
 
decodecenter2_latitude(bv, validate=False) source code
 
decodetimetoexpire2(bv, validate=False) source code
 
decoderadius2(bv, validate=False) source code
 
decodestationid3(bv, validate=False) source code
 
decodetime3_day(bv, validate=False) source code
 
decodetime3_hour(bv, validate=False) source code
 
decodetime3_min(bv, validate=False) source code
 
decodecenter3_longitude(bv, validate=False) source code
 
decodecenter3_latitude(bv, validate=False) source code
 
decodetimetoexpire3(bv, validate=False) source code
 
decoderadius3(bv, validate=False) source code
 
decodeSpare2(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 whalenotice 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 = {'center1_latitude': 'center1', 'center1_longitud...
Go to the Postgis field names from the straight field name
  fromPgFields = {'center1': ('center1_longitude', 'center1_lati...
Go from the Postgis field names to the straight field name
  pgTypes = {'center1': 'POINT', 'center2': 'POINT', 'center3': ...
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...
  timetoexpire1EncodeLut = {'No detection/notice active in regio...
  timetoexpire1DecodeLut = {'0': 'No detection/notice active in ...
  timetoexpire2EncodeLut = {'No detection/notice active in regio...
  timetoexpire2DecodeLut = {'0': 'No detection/notice active in ...
  timetoexpire3EncodeLut = {'No detection/notice active in regio...
  timetoexpire3DecodeLut = {'0': 'No detection/notice active in ...
  dbTableName = 'whalenotice'
Database table name
Function Details [hide private]

encode(params, validate=False)

source code 

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

Fields in params:
  • MessageID(uint): AIS message number. Must be 8 (field automatically set to "8")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): Unique ship identification number (MMSI)
  • Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
  • dac(uint): Designated Area Code - 366 for the United States (field automatically set to "366")
  • fid(uint): Functional IDentifier - 63 for the Whale Notice (field automatically set to "63")
  • efid(uint): Extended Functional IDentifier. 1 for the Whale Notice (dac+fid+efid defines the exact message type) (field automatically set to "1")
  • numreports(uint): Number of detection reports filled out in this message
  • stationid1(uint): Identifier of the station that recorded the whale. Usually a number.
  • time1_day(uint): Time of most recent whale detection. UTC day of the month 1..31
  • time1_hour(uint): Time of most recent whale detection. UTC hours 0..23
  • time1_min(uint): Time of most recent whale detection. UTC minutes
  • center1_longitude(decimal): Center of the detection zone. East West location
  • center1_latitude(decimal): Center of the detection zone. North South location
  • timetoexpire1(uint): Seconds from the detection time until the notice expires
  • radius1(uint): Distance from center of detection zone (lat/lon above)
  • stationid2(uint): Identifier of the station that recorded the whale. Usually a number.
  • time2_day(uint): Time of most recent whale detection. UTC day of the month 1..31
  • time2_hour(uint): Time of most recent whale detection. UTC hours 0..23
  • time2_min(uint): Time of most recent whale detection. UTC minutes
  • center2_longitude(decimal): Center of the detection zone. East West location
  • center2_latitude(decimal): Center of the detection zone. North South location
  • timetoexpire2(uint): Seconds from the detection time until the notice expires
  • radius2(uint): Distance from center of detection zone (lat/lon above)
  • stationid3(uint): Identifier of the station that recorded the whale. Usually a number.
  • time3_day(uint): Time of most recent whale detection. UTC day of the month 1..31
  • time3_hour(uint): Time of most recent whale detection. UTC hours 0..23
  • time3_min(uint): Time of most recent whale detection. UTC minutes
  • center3_longitude(decimal): Center of the detection zone. East West location
  • center3_latitude(decimal): Center of the detection zone. North South location
  • timetoexpire3(uint): Seconds from the detection time until the notice expires
  • radius3(uint): Distance from center of detection zone (lat/lon above)
  • 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 whalenotice message

Fields in params:
  • MessageID(uint): AIS message number. Must be 8 (field automatically set to "8")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): Unique ship identification number (MMSI)
  • Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
  • dac(uint): Designated Area Code - 366 for the United States (field automatically set to "366")
  • fid(uint): Functional IDentifier - 63 for the Whale Notice (field automatically set to "63")
  • efid(uint): Extended Functional IDentifier. 1 for the Whale Notice (dac+fid+efid defines the exact message type) (field automatically set to "1")
  • numreports(uint): Number of detection reports filled out in this message
  • stationid1(uint): Identifier of the station that recorded the whale. Usually a number.
  • time1_day(uint): Time of most recent whale detection. UTC day of the month 1..31
  • time1_hour(uint): Time of most recent whale detection. UTC hours 0..23
  • time1_min(uint): Time of most recent whale detection. UTC minutes
  • center1_longitude(decimal): Center of the detection zone. East West location
  • center1_latitude(decimal): Center of the detection zone. North South location
  • timetoexpire1(uint): Seconds from the detection time until the notice expires
  • radius1(uint): Distance from center of detection zone (lat/lon above)
  • stationid2(uint): Identifier of the station that recorded the whale. Usually a number.
  • time2_day(uint): Time of most recent whale detection. UTC day of the month 1..31
  • time2_hour(uint): Time of most recent whale detection. UTC hours 0..23
  • time2_min(uint): Time of most recent whale detection. UTC minutes
  • center2_longitude(decimal): Center of the detection zone. East West location
  • center2_latitude(decimal): Center of the detection zone. North South location
  • timetoexpire2(uint): Seconds from the detection time until the notice expires
  • radius2(uint): Distance from center of detection zone (lat/lon above)
  • stationid3(uint): Identifier of the station that recorded the whale. Usually a number.
  • time3_day(uint): Time of most recent whale detection. UTC day of the month 1..31
  • time3_hour(uint): Time of most recent whale detection. UTC hours 0..23
  • time3_min(uint): Time of most recent whale detection. UTC minutes
  • center3_longitude(decimal): Center of the detection zone. East West location
  • center3_latitude(decimal): Center of the detection zone. North South location
  • timetoexpire3(uint): Seconds from the detection time until the notice expires
  • radius3(uint): Distance from center of detection zone (lat/lon above)
  • 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 whalenotice message to stdout.

Fields in params:
  • MessageID(uint): AIS message number. Must be 8 (field automatically set to "8")
  • RepeatIndicator(uint): Indicated how many times a message has been repeated
  • UserID(uint): Unique ship identification number (MMSI)
  • Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
  • dac(uint): Designated Area Code - 366 for the United States (field automatically set to "366")
  • fid(uint): Functional IDentifier - 63 for the Whale Notice (field automatically set to "63")
  • efid(uint): Extended Functional IDentifier. 1 for the Whale Notice (dac+fid+efid defines the exact message type) (field automatically set to "1")
  • numreports(uint): Number of detection reports filled out in this message
  • stationid1(uint): Identifier of the station that recorded the whale. Usually a number.
  • time1_day(uint): Time of most recent whale detection. UTC day of the month 1..31
  • time1_hour(uint): Time of most recent whale detection. UTC hours 0..23
  • time1_min(uint): Time of most recent whale detection. UTC minutes
  • center1_longitude(decimal): Center of the detection zone. East West location
  • center1_latitude(decimal): Center of the detection zone. North South location
  • timetoexpire1(uint): Seconds from the detection time until the notice expires
  • radius1(uint): Distance from center of detection zone (lat/lon above)
  • stationid2(uint): Identifier of the station that recorded the whale. Usually a number.
  • time2_day(uint): Time of most recent whale detection. UTC day of the month 1..31
  • time2_hour(uint): Time of most recent whale detection. UTC hours 0..23
  • time2_min(uint): Time of most recent whale detection. UTC minutes
  • center2_longitude(decimal): Center of the detection zone. East West location
  • center2_latitude(decimal): Center of the detection zone. North South location
  • timetoexpire2(uint): Seconds from the detection time until the notice expires
  • radius2(uint): Distance from center of detection zone (lat/lon above)
  • stationid3(uint): Identifier of the station that recorded the whale. Usually a number.
  • time3_day(uint): Time of most recent whale detection. UTC day of the month 1..31
  • time3_hour(uint): Time of most recent whale detection. UTC hours 0..23
  • time3_min(uint): Time of most recent whale detection. UTC minutes
  • center3_longitude(decimal): Center of the detection zone. East West location
  • center3_latitude(decimal): Center of the detection zone. North South location
  • timetoexpire3(uint): Seconds from the detection time until the notice expires
  • radius3(uint): Distance from center of detection zone (lat/lon above)
  • 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',
 'dac',
 'fid',
 'efid',
 'numreports',
...

fieldListPostgres

Value:
('MessageID',
 'RepeatIndicator',
 'UserID',
 'Spare',
 'dac',
 'fid',
 'efid',
 'numreports',
...

toPgFields

Go to the Postgis field names from the straight field name
Value:
{'center1_latitude': 'center1',
 'center1_longitude': 'center1',
 'center2_latitude': 'center2',
 'center2_longitude': 'center2',
 'center3_latitude': 'center3',
 'center3_longitude': 'center3'}

fromPgFields

Go from the Postgis field names to the straight field name
Value:
{'center1': ('center1_longitude', 'center1_latitude'),
 'center2': ('center2_longitude', 'center2_latitude'),
 'center3': ('center3_longitude', 'center3_latitude')}

pgTypes

Lookup table for each postgis field name to get its type.
Value:
{'center1': 'POINT', 'center2': 'POINT', 'center3': 'POINT'}

RepeatIndicatorEncodeLut

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

RepeatIndicatorDecodeLut

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

timetoexpire1EncodeLut

Value:
{'No detection/notice active in region': '0'}

timetoexpire1DecodeLut

Value:
{'0': 'No detection/notice active in region'}

timetoexpire2EncodeLut

Value:
{'No detection/notice active in region': '0'}

timetoexpire2DecodeLut

Value:
{'0': 'No detection/notice active in region'}

timetoexpire3EncodeLut

Value:
{'No detection/notice active in region': '0'}

timetoexpire3DecodeLut

Value:
{'0': 'No detection/notice active in region'}

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