Module imo_001_22_area_notice :: Class AIVDM
[hide private]
[frames] | no frames]

Class AIVDM

source code

object --+
         |
        AIVDM
Known Subclasses:

AIS VDM Object for AIS top level messages 1 through 64.

Class attribute payload_bits must be set by the child class.

Instance Methods [hide private]
 
__init__(self, message_id=None, repeat_indicator=None, source_mmsi=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
get_bits(self)
Child classes must implement this.
source code
 
get_bits_header(self, message_id=None, repeat_indicator=None, source_mmsi=None) source code
list (even for normal_form for consistency)
get_aivdm(self, sequence_num=None, channel='A', normal_form=False, source_mmsi=None, repeat_indicator=None)
return the nmea string as if it had been received.
source code
 
kml(self, with_style=False, full=False, with_time=False)
return kml str for google earth
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, message_id=None, repeat_indicator=None, source_mmsi=None)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

get_bits(self)

source code 

Child classes must implement this. Return a BitVector representation. Child classes do NOT include the Message ID, repeat indicator, or source mmsi

get_aivdm(self, sequence_num=None, channel='A', normal_form=False, source_mmsi=None, repeat_indicator=None)

source code 

return the nmea string as if it had been received. Assumes that payload_bits has already been set

Parameters:
  • sequence_num - Which channel of AIVDM on the local serial line (in 0..9)
  • channel - VHF radio channel ("A" or "B")
  • normal_form - Set to true to always return aone line NMEA message. False allows multi-sentence messages
Returns: list (even for normal_form for consistency)
AIVDM sentences

kml(self, with_style=False, full=False, with_time=False)

source code 

return kml str for google earth

Parameters:
  • with_style - if style is True, it will use the standard style. Set to a name for a custom style
  • with_time - enable timestamps in Google Earth