.. py:module::rig.bitfield

.. py:class::rig.bitfield.BitField

:py:mod:`rig.bitfield`: routing key construction made easy
==========================================================

In many applications there is a need to define bit fields, for example when
defining SpiNNaker routing keys. Rig provides the class
:py:class:`rig.bitfield.BitField` which allows the definition of hierarchical
bit fields. The full API documentation is provided below and a :ref:`tutorial
is also available in the Rig documentation <bitfield-tutorial>`.

A tutorial introduction to this class is provided below and is
followed by the full API documentation.

.. autoclass:: rig.bitfield.BitField
    :members:
    :special-members:

.. autoclass:: rig.bitfield.UnknownTagError

.. autoclass:: rig.bitfield.UnavailableFieldError