Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`positioning`.`base`.`Satellite``

class documentation

`class Satellite(PositioningBeacon): (source)`

Constructor: `Satellite(identifier, azimuth, elevation, signalToNoiseRatio)`

View In Hierarchy

A satellite.

Method | `__init__` | Initializes a satellite object.
Method | `__repr__` | Returns a string representation of this Satellite.
Instance Variable | `azimuth` | The azimuth of the satellite. This is the heading (positive angle relative to true north) where the satellite appears to be to the device.
Instance Variable | `elevation` | The (positive) angle above the horizon where this satellite appears to be to the device.
Instance Variable | `signalToNoiseRatio` | The signal to noise ratio of the signal coming from this satellite.

Inherited from `PositioningBeacon`:

Method | `__hash__` | Returns the hash of the identifier for this beacon.
Instance Variable | `identifier` | The unique identifier for this beacon. This is usually an integer. For GPS, this is also known as the PRN.

def __init__(self, identifier, azimuth=None, elevation=None, signalToNoiseRatio=None): (source)
overrides `twisted.positioning.base.PositioningBeacon.__init__`

Initializes a satellite object.

Parameters
identifier:`int` | The PRN (unique identifier) of this satellite.
azimuth:`float` | The azimuth of the satellite (see instance variable documentation).
elevation:`float` | The elevation of the satellite (see instance variable documentation).
signalToNoiseRatio:`float` | The signal to noise ratio of the connection to this satellite (see instance variable documentation).

def __repr__(self) -> `str`: (source)
overrides `twisted.positioning.base.PositioningBeacon.__repr__`

Returns a string representation of this Satellite.

Returns
`str` | The string representation.

azimuth = (source)

The azimuth of the satellite. This is the heading (positive angle relative to true north) where the satellite appears to be to the device.

elevation = (source)

The (positive) angle above the horizon where this satellite appears to be to the device.

signalToNoiseRatio = (source)

The signal to noise ratio of the signal coming from this satellite.