twisted.positioning.base.PositionError : API documentation

class documentation

class PositionError(FancyEqMixin): (source)

Position error information.

Property	`pdop`	Undocumented
Property	`hdop`	Undocumented
Property	`vdop`	Undocumented
Class Variable	`compareAttributes`	Undocumented
Method	`__init__`	Initializes a positioning error object.
Method	`pdop.setter`	Undocumented
Method	`hdop.setter`	Undocumented
Method	`vdop.setter`	Undocumented
Method	`__repr__`	Returns a string representation of positioning information object.
Class Variable	`_ALLOWABLE_THRESHOLD`	The maximum allowable difference between PDOP and the geometric mean of VDOP and HDOP. That difference is supposed to be zero, but can be non-zero because of rounding error and limited reporting precision. You should never have to change this value.
Class Variable	`_DOP_EXPRESSIONS`	A mapping of DOP types (C[hvp]dop) to a list of callables that take self and return that DOP type, or raise `TypeError`. This allows a DOP value to either be returned directly if it's know, or computed from other DOP types if it isn't.
Instance Variable	`_pdop`	Undocumented
Instance Variable	`_hdop`	Undocumented
Instance Variable	`_vdop`	Undocumented
Instance Variable	`_testInvariant`	Undocumented
Class Variable	`_ALLOWABLE_TRESHOLD`	Undocumented
Method	`_testDilutionOfPositionInvariant`	Tests if this positioning error object satisfies the dilution of position invariant (PDOP = (HDOP2 + VDOP2)*.5), unless the `self._testInvariant` instance variable is `False`.
Method	`_getDOP`	Gets a particular dilution of position value.
Method	`_setDOP`	Sets a particular dilution of position value.
Class Variable	`_REPR_TEMPLATE`	Undocumented

Inherited from FancyEqMixin:

Method	`__eq__`	Undocumented
Method	`__ne__`	Undocumented

_ALLOWABLE_THRESHOLD = (source)

The maximum allowable difference between PDOP and the geometric mean of VDOP and HDOP. That difference is supposed to be zero, but can be non-zero because of rounding error and limited reporting precision. You should never have to change this value.

(type: float)

_DOP_EXPRESSIONS = (source)

A mapping of DOP types (C[hvp]dop) to a list of callables that take self and return that DOP type, or raise TypeError. This allows a DOP value to either be returned directly if it's know, or computed from other DOP types if it isn't.

(type: dict of str to callables)

@property
pdop = (source)

Undocumented

@property
hdop = (source)

Undocumented

@property
vdop = (source)

Undocumented

compareAttributes = (source)

overrides twisted.python.util.FancyEqMixin.compareAttributes

Undocumented

(type: tuple[str, ...])

def __init__(self, pdop=None, hdop=None, vdop=None, testInvariant=False): (source)

Initializes a positioning error object.

Parameters	pdop	The position dilution of precision. `None` if unknown. (type: `float` or `None`)
	hdop	The horizontal dilution of precision. `None` if unknown. (type: `float` or `None`)
	vdop	The vertical dilution of precision. `None` if unknown. (type: `float` or `None`)
	testInvariant	Flag to test if the DOP invariant is valid or not. If `True`, the invariant (PDOP = (HDOP2 + VDOP2)*.5) is checked at every mutation. By default, this is false, because the vast majority of DOP-providing devices ignore this invariant. (type: c{bool})

_pdop = (source)

Undocumented

_hdop = (source)

Undocumented

_vdop = (source)

Undocumented

_testInvariant = (source)

Undocumented

_ALLOWABLE_TRESHOLD = (source)

Undocumented

(type: float)

def _testDilutionOfPositionInvariant(self): (source)

Tests if this positioning error object satisfies the dilution of position invariant (PDOP = (HDOP**2 + VDOP**2)*.5), unless the self._testInvariant instance variable is False.

Returns	`None` if the invariant was not satisfied or not tested.
Raises	ValueError	Raised if the invariant was tested but not satisfied.

def _getDOP(self, dopType): (source)

Gets a particular dilution of position value.

Parameters	dopType	The type of dilution of position to get. One of ('pdop', 'hdop', 'vdop'). (type: `str`)
Returns	The DOP if it is known, `None` otherwise. (type: `float` or `None`)

def _setDOP(self, dopType, value): (source)

Sets a particular dilution of position value.

Parameters	dopType	The type of dilution of position to set. One of ('pdop', 'hdop', 'vdop'). (type: `str`)
	value	The value to set the dilution of position type to. (type: `float` If this position error tests dilution of precision invariants, it will be checked. If the invariant is not satisfied, the assignment will be undone and `ValueError` is raised. )

@pdop.setter
def pdop(self, value): (source)

Undocumented

@hdop.setter
def hdop(self, value): (source)

Undocumented

@vdop.setter
def vdop(self, value): (source)

Undocumented

_REPR_TEMPLATE = (source)

Undocumented

(type: str)

def __repr__(self): (source)

Returns a string representation of positioning information object.

Returns The string representation. (type: str)

API Documentation for Twisted, generated by pydoctor 21.2.2 at 2021-06-04 02:13:44.