twisted.positioning._sentence._BaseSentence : API documentation

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.

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.

Parameters sentenceData The 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.

Returns The iterable of names of present attributes. (type: iterable of str)

def __repr__(self): (source)

Returns a textual representation of this sentence.

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

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