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

class documentation

`class BeaconInformation: (source)`

Constructor: `BeaconInformation(seenBeacons)`

View In Hierarchy

Information about positioning beacons (a generalized term for the reference objects that help you determine your position, such as satellites or cell towers).

Method | `__init__` | Initializes a beacon information object.
Method | `__repr__` | Returns a string representation of this beacon information object.
Instance Variable | `seenBeacons` | A set of visible beacons. Note that visible beacons are not necessarily used in acquiring a positioning fix.
Instance Variable | `usedBeacons` | A set of the beacons that were used in obtaining a positioning fix. This only contains beacons that are actually used, not beacons for which it is unknown if they are used or not.

def __init__(self, seenBeacons=()): (source)

Initializes a beacon information object.

Parameters
seenBeacons:iterable of `IPositioningBeacon`s | A collection of beacons that are currently seen.

def __repr__(self) -> `str`: (source)

Returns a string representation of this beacon information object.

The beacons are sorted by their identifier.

Returns
`str` | The string representation.

seenBeacons: `set` of `IPositioningBeacon` = (source)

A set of visible beacons. Note that visible beacons are not necessarily used in acquiring a positioning fix.

usedBeacons: `set` of `IPositioningBeacon` = (source)

A set of the beacons that were used in obtaining a positioning fix. This only contains beacons that are actually used, not beacons for which it is unknown if they are used or not.