twisted.positioning._sentence._BaseSentence

class documentation

class _BaseSentence: (source)

Known subclasses: twisted.positioning.nmea.NMEASentence

Constructor: _BaseSentence(sentenceData)

View In Hierarchy

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()
Method __getattr__ Gets an attribute of this sentence.
Method __init__ Initializes a sentence with parsed sentence data.
Method __repr__ Returns a textual representation of this sentence.
Constant ALLOWED_ATTRIBUTES A set of attributes that are allowed in this sentence.
Property presentAttributes An iterable containing the names of the attributes that are present in this sentence.
Instance Variable _sentenceData Undocumented
def __getattr__(self, name): (source)

Gets an attribute of this sentence.

def __init__(self, sentenceData): (source)

Initializes a sentence with parsed sentence data.

Parameters
sentenceData:dict (str -> str or None)The parsed sentence data.
def __repr__(self) -> str: (source)

Returns a textual representation of this sentence.

Returns
strA textual representation of this sentence.
ALLOWED_ATTRIBUTES: set of str = (source)
overridden in twisted.positioning.nmea.NMEASentence

A set of attributes that are allowed in this sentence.

Value
set()
@property
presentAttributes: iterable of str = (source)

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

_sentenceData = (source)

Undocumented