t.p._._BaseSentence(object) : class documentation

Part of twisted.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 (except for the documentation of course) if that protocol implements the IPositioningSentenceProducer interface. 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.
presentAttribues =
An iterable containing the names of the attributes that are present in this sentence.
ALLOWED_ATTRIBUTES =
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.
ParameterssentenceDataThe parsed sentence data. (type: dict (str -> str or NoneType))
@property
def presentAttributes(self): (source)
An iterable containing the names of the attributes that are present in this sentence.
ReturnsThe iterable of names of present attributes. (type: iterable of str)
def __getattr__(self, name): (source)
Gets an attribute of this sentence.
def __repr__(self): (source)
Returns a textual representation of this sentence.
ReturnsA textual representation of this sentence. (type: str)
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.