bgneal@68: Exceptions
bgneal@68: ==========
bgneal@68: 
bgneal@68: The ``m209`` library defines an exception hierarchy, rooted at the
bgneal@68: ``M209Error`` class. These exceptions are briefly described below.
bgneal@68: 
bgneal@68: .. class:: m209.M209Error()
bgneal@68: 
bgneal@68:    The base exception in the hierarchy. It inherits from the built in
bgneal@68:    Python ``Exception`` class.
bgneal@68: 
bgneal@68: .. class:: m209.drum.DrumError()
bgneal@68: 
bgneal@68:    Inherits from :class:`~m209.M209Error`. This is an internal exception, used
bgneal@68:    to report drum related errors.
bgneal@68: 
bgneal@68: .. class:: m209.key_wheel.KeyWheelError()
bgneal@68: 
bgneal@68:    Inherits from :class:`~m209.M209Error`. This is an internal exception, used
bgneal@68:    to report key wheel related errors.
bgneal@68: 
bgneal@68: .. class:: m209.keylist.generate.KeyListGenError()
bgneal@68: 
bgneal@68:    Inherits from :class:`~m209.M209Error`. This is public exception, used
bgneal@68:    to report errors during the key list generation process.
bgneal@68: 
bgneal@68: .. class:: m209.procedure.ProcedureError()
bgneal@68: 
bgneal@68:    Inherits from :class:`~m209.M209Error`. This is public exception, used
bgneal@68:    to report errors during :class:`~m209.procedure.StdProcedure` operations.