.. java:import:: ch.epfl.leb.alica.interfaces.controllers ControllerStatusPanel

Controller
==========

.. java:package:: ch.epfl.leb.alica.interfaces
   :noindex:

.. java:type:: public interface Controller

   Adjusts control parameters in response to values provided by the analyzer. A controller receives the output of the analyzer as input, and then adjusts its internal state accordingly. It can be asked for its state at any time by the WorkerThread.

   :author: Marcel Stefko

Methods
-------
getCurrentOutput
^^^^^^^^^^^^^^^^

.. java:method:: public double getCurrentOutput()
   :outertype: Controller

   Returns an output value derived from the controller's internal state.

   :return: The controller's new output value for the control signal.

getName
^^^^^^^

.. java:method:: public String getName()
   :outertype: Controller

   Returns a unique name for the controller.

   :return: A unique name for the controller.

getSetpoint
^^^^^^^^^^^

.. java:method:: public double getSetpoint()
   :outertype: Controller

   Returns the current value for the setpoint.

   :return: The current setpoint value.

getStatusPanel
^^^^^^^^^^^^^^

.. java:method:: public ControllerStatusPanel getStatusPanel()
   :outertype: Controller

   Returns the controller's status panel that will be displayed in the GUI. If no panel is implemented, this method should return null. In this case, the corresponding space in the MonitorGUI will appear blank.

   :return: The status panel of the controller, or null.

nextValue
^^^^^^^^^

.. java:method:: public double nextValue(double value)
   :outertype: Controller

   Receives next input from the WorkerThread (this the batched output of the analyzer). This method must be able to accept Double.NaN, which the analyzer will produce if if can not produce an output for some reason.

   :param value: The analyzer's input value.
   :return: The controller's new output value for the control signal.

setSetpoint
^^^^^^^^^^^

.. java:method:: public void setSetpoint(double new_setpoint)
   :outertype: Controller

   Sets a new values for the controller's setpoint.

   :param new_setpoint: The desired value for the process variable.