.. _alredballdetection-api:

ALRedBallDetection API
======================

:ref:`Overview <alredballdetection>` | API

Namespace : **AL**

.. code-block:: cpp

  #include <alproxies/alredballdetectionproxy.h>


Method list
-----------

.. cpp:class:: ALRedBallDetectionProxy

  * Methods:

    * :cpp:func:`ALRedBallDetectionProxy::subscribe`
    * :cpp:func:`ALRedBallDetectionProxy::unsubscribe`

.. seealso::

* :ref:`Methods inherited from ALModule <almodule-api>`

Methods
-------

.. cpp:function:: void ALRedBallDetectionProxy::subscribe(const std::string& name)

    Subscribes to **ALRedBallDetection**.
    This causes the module to start writing information to **ALMemory** in *"RedBallDetected"*.
    This can be accessed in *ALMemory* using :cpp:func:`ALMemoryProxy::getData`.

    :param name: Name to identify the subscriber



.. cpp:function:: void ALRedBallDetectionProxy::unsubscribe(const std::string& name)

    Unsubscribes to **ALRedBallDetection**.
    This causes the module to stop writing information to **ALMemory** in *"RedBallDetected"*.

    :param name: Name to identify the subscriber (as used in :cpp:func:`ALRedBallDetectionProxy::subscribe`).