interface documentation

class IPositioningReceiver(Interface): (source)

Known implementations: twisted.positioning.base.BasePositioningReceiver

View In Hierarchy

An interface for positioning providers.
Method altitude​Received Method called when an altitude is received.
Method beacon​Information​Received Method called when positioning beacon information is received.
Method climb​Received Method called when the climb is received.
Method heading​Received Method called when a true heading is received.
Method position​Error​Received Method called when position error is received.
Method position​Received Method called when a position is received.
Method speed​Received Method called when the speed is received.
Method time​Received Method called when time and date information arrives.
def altitudeReceived(altitude): (source)
Method called when an altitude is received.
Parameters
altitude:twisted.positioning.base.AltitudeThe altitude.
def beaconInformationReceived(beaconInformation): (source)
Method called when positioning beacon information is received.
Parameters
beacon​Information:twisted.positioning.base.BeaconInformationThe beacon information.
def climbReceived(climb): (source)
Method called when the climb is received.
Parameters
climb:twisted.positioning.base.ClimbThe climb of the mobile object.
def headingReceived(heading): (source)
Method called when a true heading is received.
Parameters
heading:twisted.positioning.base.HeadingThe heading.
def positionErrorReceived(positionError): (source)
Method called when position error is received.
Parameters
position​Error:twisted.positioning.base.PositionErrorThe position error.
def positionReceived(latitude, longitude): (source)
Method called when a position is received.
Parameters
latitude:twisted.positioning.base.CoordinateThe latitude of the received position.
longitude:twisted.positioning.base.CoordinateThe longitude of the received position.
def speedReceived(speed): (source)
Method called when the speed is received.
Parameters
speed:twisted.positioning.base.SpeedThe speed of a mobile object.
def timeReceived(time): (source)
Method called when time and date information arrives.
Parameters
time:datetime.datetimeThe date and time (expressed in UTC unless otherwise specified).