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

class documentation

`class PositioningBeacon: (source)`

Known subclasses: `twisted.positioning.base.Satellite`

Implements interfaces: `twisted.positioning.ipositioning.IPositioningBeacon`

View In Hierarchy

A positioning beacon.

Method | `__hash__` | Returns the hash of the identifier for this beacon.
Method | `__init__` | Initializes a positioning beacon.
Method | `__repr__` | Returns a string representation of 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 __hash__(self): (source)

Returns the hash of the identifier for this beacon.

Returns
`int` | The hash of the identifier. (`hash(self.identifier)`)

def __init__(self, identifier): (source)
overridden in `twisted.positioning.base.Satellite`

Initializes a positioning beacon.

Parameters
identifier:Can be pretty much anything (see ivar documentation). | The identifier for this beacon.

def __repr__(self): (source)
overridden in `twisted.positioning.base.Satellite`

Returns a string representation of this beacon.

Returns
`str` | The string representation.

identifier: Pretty much anything that can be used as a unique identifier. Depends on the implementation. = (source)
from `twisted.positioning.ipositioning.IPositioningBeacon`

The unique identifier for this beacon. This is usually an integer. For GPS, this is also known as the PRN.