Module prototypes

source code

The various types used in protocol descriptions

To implement a type used for protocol descriptions, examine the code for UINTlsb in this file. Of note:

• Inherit from BaseProtogenClass
• Call superclass constructors using super()
• Do not process any of the args or kwargs in the constructor unless you need them to alter how you are constructed
• At the end of the constructor, call _update if you are the most derived class
• In _update, call super()._update, and then delete keyword arguments as you process them (consider using BaseProtogenClass._consumekw function)
• If you are the most derived class, complain about unused keyword arguments (consider using BaseProtogenClass._complainaboutunusedargs function)
• set _bufferstartoffset and _bufferendoffset whenever you are read or written from a buffer
• (optionally) define a getvalue() method that returns a better type. For example if your class is integer like then this would return a real int. If string like, then this will return a real string.
• If you are a container, override iscontainer. You will also need to provide a containerelements() method which lets you iterate over the entries.

containerelements method:

• You should return tuples of (fieldname, fieldvalue, descriptionstring or None)
• fieldvalue should be the actual object, not a pretty version (eg a USTRING not str)