i.h

Go to the documentation of this file.

 * @details
 * This file defines the @ref control_system::integral::I class, which
 * implements a discrete-time integral controller.
 *
 * The controller generates a control output by integrating the error
 * between a reference value and the measured or current value over
 * time.
 *
 * The controller maintains the previous output as internal state and
 * applies a configurable maximum output limit.
 *
 * @tparam T Numeric data type used for the controller calculations.
 *
 * @author Abhinay Kumar
 * @version 1.0.0
 * @date 2026-08-11
 *
 * @copyright
 * Copyright (c) 2026 Abhinay Kumar
 */
 
#ifndef CONTROL_SYSTEM_INTEGRAL_I_H
#define CONTROL_SYSTEM_INTEGRAL_I_H
 
#include "../utility/utility.h"
 
namespace control_system
{

 
    namespace integral
    {



         * The I class implements a discrete-time integral controller
         * using a configurable integral gain and sampling time.
         *
         * The controller maintains its previous output as internal state
         * and applies a configurable maximum output limit.
         *
         * @tparam T Numeric data type used for the controller.
         *
         * @par Example
         * @code{.cpp}
         * control_system::integral::I<double> controller;
         *
         * controller.init(
         *     0.001,
         *     Ki,
         *     0.0,
         *     100.0
         * );
         *
         * double output = controller.update(reference, measurement);
         * @endcode
         */
        template <typename T>
        class I
        {
        public:

             * Constructs the controller with its parameters and internal
             * state initialized to their default values.
             */
            I();

             * @brief Initializes the integral controller.
             *
             * @param[in] dt_ Controller sampling time in seconds.
             * @param[in] Ki_ Integral gain.
             * @param[in] u_k_1_ Previous controller output.
             * @param[in] u_max_ Maximum allowed controller output.
             *
             * @details
             * Initializes the controller sampling time, integral gain,
             * previous controller output, and output limit.
             */
            void init(T dt_, T Ki_, T u_k_1_, T u_max_);

            void set_param(T dt_, T Ki_, T u_k_1_, T u_max_);

            T update(T x_0, T x);

            void reset();

            void merge(T u_k_1_);

            void set_dt(T dt_);

            void set_Ki(T Ki_);

            void set_u_0(T u_k_1_);

            void set_u_max(T u_max_);

            T get_dt();

            T get_Ki();

            T get_u_k_1();

            T get_u_max();
 
        private:
            T dt = 0.0;

            T u_k_1 = 0.0;

            T Ki = 0.0;

            T u_max = 9999999999;
        };
 
#include "../../src/integral/i.tpp"
    }
}
 
#endif