twisted.positioning.base._BaseSpeed(FancyEqMixin, object) class documentation

Part of twisted.positioning.base (View In Hierarchy)

Known subclasses: twisted.positioning.base.Climb, twisted.positioning.base.Speed

An object representing the abstract concept of the speed (rate of movement) of a mobile object.

This primarily has behavior for converting between units and comparison.

Method __init__ Initializes a speed.
Method inMetersPerSecond The speed that this object represents, expressed in meters per second. This attribute is immutable.
Method inKnots Returns the speed represented by this object, expressed in knots. This attribute is immutable.
Method __float__ Returns the speed represented by this object expressed in meters per second.
Method __repr__ Returns a string representation of this speed object.

Inherited from FancyEqMixin:

Method __eq__ Undocumented
Method __ne__ Undocumented
def __init__(self, speed):
overridden in twisted.positioning.base.Climb, twisted.positioning.base.Speed

Initializes a speed.

ParametersspeedThe speed that this object represents, expressed in meters per second. (type: float)
RaisesValueErrorRaised if value was invalid for this particular kind of speed. Only happens in subclasses.
@property
def inMetersPerSecond(self):

The speed that this object represents, expressed in meters per second. This attribute is immutable.

ReturnsThe speed this object represents, in meters per second. (type: float)
@property
def inKnots(self):

Returns the speed represented by this object, expressed in knots. This attribute is immutable.

ReturnsThe speed this object represents, in knots. (type: float)
def __float__(self):

Returns the speed represented by this object expressed in meters per second.

ReturnsThe speed represented by this object, expressed in meters per second. (type: float)
def __repr__(self):

Returns a string representation of this speed object.

ReturnsThe string representation. (type: str)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.