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

Module allaistypes

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]
  Testalltypesmsg
Use testvalue tag text from each type to build test case the alltypesmsg message
Functions [hide private]
BitVector
encode(params, validate=False)
Create a alltypesmsg binary message payload to pack into an AIS Msg alltypesmsg.		 source code
dict
decode(bv, validate=False)
Unpack a alltypesmsg message		 source code
 
decodedac(bv, validate=False) source code
 
decodereqDecimal(bv, validate=False) source code
 
decodeunavail_uint(bv, validate=False) source code
 
decodeanUInt(bv, validate=False) source code
 
decodeanInt(bv, validate=False) source code
 
decodeaBool(bv, validate=False) source code
 
decodeaStr(bv, validate=False) source code
 
decodeanUDecimal(bv, validate=False) source code
 
decodeaDecimal(bv, validate=False) source code
 
decodeaFloat(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 alltypesmsg 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 = ('dac', 'reqDecimal', 'unavail_uint', 'anUInt', 'a...
  fieldListPostgres = ('dac', 'reqDecimal', 'unavail_uint', 'anU...
  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.
  dbTableName = 'alltypesmsg'
Database table name
Function Details [hide private]

encode(params, validate=False)

source code 

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

Fields in params:
  • dac(uint): Designated Area Code (field automatically set to "366")
  • reqDecimal(decimal): required decimal value... FIX: scale or no? (field automatically set to "122")
  • unavail_uint(uint): Unavailable unsigned integer
  • anUInt(uint): NO unavailable unsigned integer
  • anInt(int): NO unavailable signed integer
  • aBool(bool): Simple bool
  • aStr(aisstr6): An ais string of 5 characters
  • anUDecimal(udecimal): An unsigned decimal. Allow smaller numbers
  • aDecimal(decimal): A decimal
  • aFloat(float): An IEEE floating point number
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 alltypesmsg message

Fields in params:
  • dac(uint): Designated Area Code (field automatically set to "366")
  • reqDecimal(decimal): required decimal value... FIX: scale or no? (field automatically set to "122")
  • unavail_uint(uint): Unavailable unsigned integer
  • anUInt(uint): NO unavailable unsigned integer
  • anInt(int): NO unavailable signed integer
  • aBool(bool): Simple bool
  • aStr(aisstr6): An ais string of 5 characters
  • anUDecimal(udecimal): An unsigned decimal. Allow smaller numbers
  • aDecimal(decimal): A decimal
  • aFloat(float): An IEEE floating point number
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 alltypesmsg message to stdout.

Fields in params:
  • dac(uint): Designated Area Code (field automatically set to "366")
  • reqDecimal(decimal): required decimal value... FIX: scale or no? (field automatically set to "122")
  • unavail_uint(uint): Unavailable unsigned integer
  • anUInt(uint): NO unavailable unsigned integer
  • anInt(int): NO unavailable signed integer
  • aBool(bool): Simple bool
  • aStr(aisstr6): An ais string of 5 characters
  • anUDecimal(udecimal): An unsigned decimal. Allow smaller numbers
  • aDecimal(decimal): A decimal
  • aFloat(float): An IEEE floating point number
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:
('dac',
 'reqDecimal',
 'unavail_uint',
 'anUInt',
 'anInt',
 'aBool',
 'aStr',
 'anUDecimal',
...

fieldListPostgres

Value:
('dac',
 'reqDecimal',
 'unavail_uint',
 'anUInt',
 'anInt',
 'aBool',
 'aStr',
 'anUDecimal',
...

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