twisted.positioning.base.Angle : API documentation

Method	__init__	Initializes an angle.
Method	inDecimalDegrees	The value of this angle in decimal degrees. This value is immutable.
Method	inDegreesMinutesSeconds	The value of this angle as a degrees, minutes, seconds tuple. This value is immutable.
Method	setSign	Sets the sign of this angle.
Method	__float__	Returns this angle as a float.
Method	__repr__	Returns a string representation of this angle.
Class Variable	_RANGE_EXPRESSIONS	A collection of expressions for the allowable range for the angular value of a particular coordinate value. (type: `dict` of `Angles` constants to callables)
Class Variable	_ANGLE_TYPE_NAMES	English names for angle types. (type: `dict` of `Angles` constants to `str`)
Method	_angleValueRepr	Returns a string representation of the angular value of this angle.
Method	_angleTypeNameRepr	Returns a string representation of the type of this angle.

Inherited from FancyEqMixin:

Method	__eq__	Undocumented
Method	__ne__	Undocumented

_RANGE_EXPRESSIONS =

A collection of expressions for the allowable range for the angular value of a particular coordinate value. (type: dict of Angles constants to callables)

_ANGLE_TYPE_NAMES =

English names for angle types. (type: dict of Angles constants to str)

def __init__(self, angle=None, angleType=None): (source)

overridden in twisted.positioning.base.Coordinate, twisted.positioning.base.Heading

Initializes an angle.

Parameters	angle	The value of the angle in decimal degrees. (`None` if unknown). (type: `float` or `None`)
	angleType	A symbolic constant describing the angle type. Should be one of `Angles` or {None} if unknown.
Raises	ValueError	If the angle type is not the default argument, but it is an unknown type (not in `Angle._RANGE_EXPRESSIONS`), or it is a known type but the supplied value was out of the allowable range for said type.

@property
def inDecimalDegrees(self): (source)

The value of this angle in decimal degrees. This value is immutable.

Returns This angle expressed in decimal degrees, or None if the angle is unknown. (type: float (or None))

@property
def inDegreesMinutesSeconds(self): (source)

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

Returns This angle expressed in degrees, minutes, seconds. None if the angle is unknown. (type: 3-tuple of int (or None))

def setSign(self, sign): (source)

overridden in twisted.positioning.base.Heading

Sets the sign of this angle.

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 __float__(self): (source)

Returns this angle as a float.

Returns The float value of this angle, expressed in degrees. (type: float)

def __repr__(self): (source)

overridden in twisted.positioning.base.Heading

Returns a string representation of this angle.

Returns The string representation. (type: str)

@property
def _angleValueRepr(self): (source)

Returns a string representation of the angular value of this angle.

This is a helper function for the actual __repr__.

Returns The string representation. (type: str)

@property
def _angleTypeNameRepr(self): (source)

Returns a string representation of the type of this angle.

This is a helper function for the actual __repr__.

Returns The string representation. (type: str)

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

`twisted.positioning.base.Angle(FancyEqMixin, object)` class documentation