class documentation

The heading of a mobile object.

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

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

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

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

Class Variable | `compareAttributes` |
Undocumented |

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` . |

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

Inherited from `Angle`

:

Method | `__float__` |
Returns this angle as a float. |

Instance Variable | `angleType` |
Undocumented |

Property | `inDecimalDegrees` |
The value of this angle in decimal degrees. This value is immutable. |

Property | `inDegreesMinutesSeconds` |
The value of this angle as a degrees, minutes, seconds tuple. This value is immutable. |

Class Variable | `_ANGLE_TYPE_NAMES` |
English names for angle types. |

Class Variable | `_RANGE_EXPRESSIONS` |
A collection of expressions for the allowable range for the angular value of a particular coordinate value. |

Instance Variable | `_angle` |
Undocumented |

Property | `_angleTypeNameRepr` |
Returns a string representation of the type of this angle. |

Property | `_angleValueRepr` |
Returns a string representation of the angular value of this angle. |

Inherited from `FancyEqMixin`

(via `Angle`

):

Method | `__eq__` |
Undocumented |

Method | `__ne__` |
Undocumented |

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

Parameters | |

angleValue:float | The angle value of this heading. |

variationValue:float | The value of the variation of this heading. |

Returns | |

A `Heading` with the given values. |

overrides

`twisted.positioning.base.Angle.__repr__`

Returns a string representation of this angle.

Returns | |

str | The string representation. |

overrides

`twisted.positioning.base.Angle.setSign`

Sets the sign of the variation of this heading.

Parameters | |

sign:int | The new sign. 1 for positive and -1 for negative signs, respectively. |

Raises | |

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

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`

.