twisted.positioning._sentence._BaseSentence(object)
class documentationtwisted.positioning._sentence
View Source
(View In Hierarchy)
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()
Instance Variable | presentAttribues | 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. (type: set of str ) |
Method | __init__ | Initializes a sentence with parsed sentence data. |
Method | presentAttributes | An iterable containing the names of the attributes that are present in this sentence. |
Method | __getattr__ | Gets an attribute of this sentence. |
Method | __repr__ | Returns a textual representation of this sentence. |
Initializes a sentence with parsed sentence data.
Parameters | sentenceData | The parsed sentence data. (type: dict (str -> str or None )) |
An iterable containing the names of the attributes that are present in this sentence.
Returns | The iterable of names of present attributes. (type: iterable of str ) |
Returns a textual representation of this sentence.
Returns | A textual representation of this sentence. (type: str ) |