twisted.positioning._sentence._BaseSentence : API documentation

class documentation

class twisted.positioning._sentence._BaseSentence: (source)

Known subclasses: twisted.positioning.nmea.NMEASentence

A base sentence class for a particular protocol.

Using this base class, specific sentence classes can almost automatically be created for a particular protocol. To do this, fill the ALLOWED_ATTRIBUTES class attribute using the getSentenceAttributes class method of the producer:

    class FooSentence(BaseSentence):
        """
        A sentence for integalactic transmodulator sentences.

        @ivar transmogrificationConstant: The value used in the
            transmogrifier while producing this sentence, corrected for
            gravitational fields.
        @type transmogrificationConstant: C{Tummy}
        """
        ALLOWED_ATTRIBUTES = FooProtocol.getSentenceAttributes()

Property	presentAttributes	An iterable containing the names of the attributes that are present in this sentence.
Class Variable	ALLOWED_ATTRIBUTES	A set of attributes that are allowed in this sentence.
Method	__init__	Initializes a sentence with parsed sentence data.
Method	__getattr__	Gets an attribute of this sentence.
Method	__repr__	Returns a textual representation of this sentence.
Instance Variable	_sentenceData	Undocumented

@property
presentAttributes = (source)

An iterable containing the names of the attributes that are present in this sentence.

(type: iterable of str)

ALLOWED_ATTRIBUTES = (source)

overridden in twisted.positioning.nmea.NMEASentence

A set of attributes that are allowed in this sentence.

(type: set of str)

def __init__(self, sentenceData): (source)

Initializes a sentence with parsed sentence data.

Parameters sentenceData The parsed sentence data. (type: dict (str -> str or None))

_sentenceData = (source)

Undocumented

def __getattr__(self, name): (source)

Gets an attribute of this sentence.

def __repr__(self): (source)

Returns a textual representation of this sentence.

Returns A textual representation of this sentence. (type: str)

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.