`twisted.positioning.base.Heading(Angle)`

class documentation`twisted.positioning.base`

View Source
(View In Hierarchy)
The heading of a mobile object.

Instance Variable | variation | The (optional) magnetic variation. The sign of the variation is positive
for variations towards the east (clockwise from north), and negative for
variations towards the west (counterclockwise from north). If the variation
is unknown or not applicable, this is `None` . (type: `Angle` or `NoneType` .) |

Instance Variable | correctedHeading 0 | The heading, corrected for variation. If the variation is unknown
(`None` ), is None. This attribute is read-only (its value is
determined by the angle and variation attributes). The value is coerced to
being between 0 (inclusive) and 360 (exclusive). |

Method | __init__ | Initializes a angle with an optional variation. |

Class Method | fromFloats | Constructs a Heading from the float values of the angle and variation. |

Method | correctedHeading | Corrects the heading by the given variation. This is sometimes known as the true heading. |

Method | setSign | Sets the sign of the variation of this heading. |

Method | __repr__ | Returns a string representation of this angle. |

Inherited from FancyEqMixin (via Angle):

Method | __eq__ | Undocumented |

Method | __ne__ | Undocumented |

Inherited from FancyEqMixin (via Angle):

Method | __eq__ | Undocumented |

Method | __ne__ | Undocumented |

variation =

The (optional) magnetic variation. The sign of the variation is positive
for variations towards the east (clockwise from north), and negative for
variations towards the west (counterclockwise from north). If the variation
is unknown or not applicable, this is

`None`

. (type: `Angle`

or `NoneType`

.)
correctedHeading 0 =

The heading, corrected for variation. If the variation is unknown
(

`None`

), is None. This attribute is read-only (its value is
determined by the angle and variation attributes). The value is coerced to
being between 0 (inclusive) and 360 (exclusive).
def
__init__(self, angle=None, variation=None):
(source)

overrides twisted.positioning.base.Angle.__init__

Initializes a angle with an optional variation.

@classmethod

def fromFloats(cls, angleValue=None, variationValue=None): (source)

def fromFloats(cls, angleValue=None, variationValue=None): (source)

Constructs a Heading from the float values of the angle and variation.

Parameters | angleValue | The angle value of this heading. (type: `float` ) |

variationValue | The value of the variation of this heading. (type: `float` @return A `Heading ` with the given values.) |

@property

def correctedHeading(self): (source)

def correctedHeading(self): (source)

Corrects the heading by the given variation. This is sometimes known as the true heading.

Returns | The heading, corrected by the variation. If the variation or the angle are
unknown, returns `None` . (type: `float` or `NoneType` ) |

def
setSign(self, sign):
(source)

overrides twisted.positioning.base.Angle.setSign

Sets the sign of the variation of this heading.

Parameters | sign | The new sign. `1` for positive and `-1` for negative
signs, respectively. (type: `int` ) |

Raises | ValueError | If the `sign` parameter is not `-1` or
`1` . |

def
__repr__(self):
(source)

overrides twisted.positioning.base.Angle.__repr__

Returns a string representation of this angle.

Returns | The string representation. (type: `str` ) |