:mod:`dfba.control`
===================

.. py:module:: dfba.control

.. autoapi-nested-parse::

   Definition of `ControlParameter` class.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dfba.control.ControlParameter




.. class:: ControlParameter(name: str, change_point: str = None, values: List = None, change_points: List = None, *args, **kwargs)


   Bases: :py:obj:`optlang.symbolics.Symbol`

   Holds information regarding a control parameter in a `DfbaModel` object.

   .. attribute:: id

      The identifier to associate with this control parameter.

      :type: string

   .. attribute:: change_points

      The time points at which this control parameter changes value.

      :type: list

   .. attribute:: values

      The values taken by this control parameter.

      :type: list

   .. method:: id(self) -> str
      :property:

      For convenience, synonym with .name from `symbolics.Symbol`.


   .. method:: change_points(self) -> List
      :property:

      Time points at which this control parameter changes value.


   .. method:: values(self) -> List
      :property:

      Actual values of the control parameter.


   .. method:: set_parameters(self, change_points: List, values: List) -> None

      Standardize input attributes.