Module prototypes :: Class COUNTEDBUFFEREDSTRING

Class COUNTEDBUFFEREDSTRING

       object --+    
                |    
BaseProtogenClass --+
                    |
                   COUNTEDBUFFEREDSTRING

A string as used on Audiovox. There is a one byte header saying how long the string is, followed by the string in a fixed sized buffer

Instance Methods

[hide private]

__init__(self, *args, **kwargs)
A string value can be specified to this constructor, or in the value keyword arg.

source code

_update(self, args, kwargs)

source code

readfrombuffer(self, buf)
Get our value from the buffer

source code

writetobuffer(self, buf)
Scribble ourselves to the buf

source code

packetsize(self)
Returns size in bytes that we occupy

source code

getvalue(self)
Returns the string we are

source code

Inherited from BaseProtogenClass: autologread, autologwrite, iscontainer, packetspan, update

Inherited from BaseProtogenClass (private): _complainaboutunusedargs, _consumekw, _ismostderived

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, *args, **kwargs)
(Constructor)

source code

A string value can be specified to this constructor, or in the value keyword arg.

Parameters:

constant - (Optional) A constant value. All reads must have this value
pad - (Default=32 - space) When writing, what to pad the rest of the buffer with
default - (Optional) Our default value
raiseontruncate - (Default True) raise ValueLengthException if the supplied value is too large to fit within the buffer.
value - (Optional) Value
sizeinbytes - (Mandatory) Size of the buffer, including the count byte

Overrides: object.__init__