Module prototypes :: Class DATA

Class DATA

       object --+    
                |    
BaseProtogenClass --+
                    |
                   DATA

Known Subclasses:

A block of bytes

Instance Methods

[hide private]

__init__(self, *args, **kwargs)
A data 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 bytes 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 data 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=0) The padding byte if fixed length when writing and the value isn't long enough
sizeinbytes - (Optional) Set if fixed length. If not set, then the rest of the packet will be consumed on reads.
default - (Optional) Our default value
raiseonwrongsize - (Default True) raise ValueLengthException if the supplied value is too large to fit within sizeinbytes.

Overrides: object.__init__