tomlankhorst/control
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
control::classic::P< T > Class Template Reference

#include <pid.h>

Inheritance diagram for control::classic::P< T >:
control::classic::AbstractController< T > control::system::SISO< T >

Public Member Functions

 P (T Kp_=1.0, T Limit_=max< T >())
 
- Public Member Functions inherited from control::classic::AbstractController< T >
 AbstractController (T Limit_=max< T >())
 
step (T e) final
 
void setLimit (T limit)
 
virtual void reset ()
 

Public Attributes

const T Kp
 
- Public Attributes inherited from control::classic::AbstractController< T >
Limit
 
bool clipping = false
 

Protected Member Functions

control (T e)
 
- Protected Member Functions inherited from control::classic::AbstractController< T >
clip (T u)
 

Detailed Description

template<typename T>
class control::classic::P< T >

Proportional controller

Constructor & Destructor Documentation

◆ P()

template<typename T >
control::classic::P< T >::P ( Kp_ = 1.0,
Limit_ = max<T>() 
)
inlineexplicit

Constructor of proportional controller

Parameters
Kp_Proportional gain
Limit_Maximum output value

Member Function Documentation

◆ control()

template<typename T >
T control::classic::P< T >::control ( e)
inlineprotectedvirtual

Retrieves the control output, unclipped

Parameters
Te the error
Returns
T the raw output

Implements control::classic::AbstractController< T >.


The documentation for this class was generated from the following file: