Line data    Source code

       1            0 : // Distributed under the MIT License.
       2              : // See LICENSE.txt for details.
       3              : 
       4              : #pragma once
       5              : 
       6              : /// \ingroup ControlSystemGroup
       7              : /// Control systems and related functionality
       8              : namespace control_system {
       9              : /// \ingroup ControlSystemGroup
      10              : /// All Actions related to the control system
      11              : namespace Actions {}
      12              : 
      13              : /*!
      14              :  * \ingroup ControlSystemGroup
      15              :  * \brief All control errors that will be used in control systems.
      16              :  *
      17              :  * \details A control error is a struct that conforms to the
      18              :  * control_system::protocols::ControlError protocol. Control errors compute the
      19              :  * error between current map parameters and what they are expected to be. See
      20              :  * an example of a control error here:
      21              :  * \snippet Helpers/ControlSystem/Examples.hpp ControlError
      22              :  */
      23              : namespace ControlErrors {}
      24              : 
      25              : /*!
      26              :  * \ingroup ControlSystemGroup
      27              :  * \brief All control systems.
      28              :  *
      29              :  * \details A control system is a struct that conforms to the
      30              :  * control_system::protocols::ControlSystem protocol. They are used to control
      31              :  * the time dependent coordinate maps in an evolution. See an example of a
      32              :  * control system here:
      33              :  * \snippet Helpers/ControlSystem/Examples.hpp ControlSystem
      34              :  */
      35            1 : namespace Systems {}
      36              : 
      37              : /// \ingroup ControlSystemGroup
      38              : /// Classes and functions used in implementation of size control
      39              : namespace size {}
      40              : 
      41              : }  // namespace control_system