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

class documentation

`class Speed(_BaseSpeed): (source)`

Constructor: `Speed(speed)`

View In Hierarchy

The speed (rate of movement) of a mobile object.

Method | `__init__` | Initializes a `Speed` object.

Inherited from `_BaseSpeed`:

Method | `__float__` | Returns the speed represented by this object expressed in meters per second.
Method | `__repr__` | Returns a string representation of this speed object.
Class Variable | `compareAttributes` | Undocumented
Property | `inKnots` | Returns the speed represented by this object, expressed in knots. This attribute is immutable.
Property | `inMetersPerSecond` | The speed that this object represents, expressed in meters per second. This attribute is immutable.
Instance Variable | `_speed` | Undocumented

Inherited from `FancyEqMixin` (via `_BaseSpeed`):

Method | `__eq__` | Undocumented
Method | `__ne__` | Undocumented

def __init__(self, speed): (source)
overrides `twisted.positioning.base._BaseSpeed.__init__`

Initializes a `Speed` object.

Parameters
speed:`float` | The speed that this object represents, expressed in meters per second.
Raises
`ValueError` | Raised if `speed` is negative.