PDController
All Classes Files Functions
Functions
InputParameters.hpp File Reference

Provides the function for reading inputs and the function for checking the physical constraints on the input. More...

#include <string>

Go to the source code of this file.

Functions

void get_input (string filename, double &r_t, double &K_d, double &K_p, double &t_step, double &t_sim)
 Reads input from a file with the given file name. More...
 
void input_constraints (double r_t, double K_d, double K_p, double t_step, double t_sim)
 Verifies that input values satisfy the physical constraints. More...
 

Detailed Description

Provides the function for reading inputs and the function for checking the physical constraints on the input.

Author
Naveen Ganesh Muralidharan
Note
Generated by Drasil v0.1-alpha

Function Documentation

◆ get_input()

void get_input ( string  filename,
double &  r_t,
double &  K_d,
double &  K_p,
double &  t_step,
double &  t_sim 
)

Reads input from a file with the given file name.

Parameters
filenamename of the input file
r_tSet-Point: The desired value that the control system must reach. This also knows as the reference variable
K_dDerivative Gain: Gain constant of the derivative controller
K_pProportional Gain: Gain constant of the proportional controller
t_stepStep Time: Simulation step time (s)
t_simSimulation Time: Total execution time of the PD simulation (s)

◆ input_constraints()

void input_constraints ( double  r_t,
double  K_d,
double  K_p,
double  t_step,
double  t_sim 
)

Verifies that input values satisfy the physical constraints.

Parameters
r_tSet-Point: The desired value that the control system must reach. This also knows as the reference variable
K_dDerivative Gain: Gain constant of the derivative controller
K_pProportional Gain: Gain constant of the proportional controller
t_stepStep Time: Simulation step time (s)
t_simSimulation Time: Total execution time of the PD simulation (s)