LocalGuidance
A library that generates velocity references to follow a path.
robot_utils::PidControllerQuaternion Class Reference

#include <PidControllerQuaternion.hpp>

Public Member Functions

 PidControllerQuaternion ()
 
 PidControllerQuaternion (const Eigen::Vector3d maxEffort, const Eigen::Vector3d kp, const Eigen::Vector3d ki, const Eigen::Vector3d kd)
 
virtual ~PidControllerQuaternion ()
 
Eigen::Vector3d update (const double dt, const kindr::RotationQuaternionPD q_BI_des, const kindr::RotationQuaternionPD q_BI_meas, const kindr::LocalAngularVelocityPD B_w_IB_des, const kindr::LocalAngularVelocityPD B_w_IB_meas)
 Update the quaternion PID q_BI Rotates quantity in frame I to frame B B_w_IB Angular velocity of B w.r.t. frame I expressed in frame B. More...
 
Eigen::Vector3d update (const double dt, const kindr::RotationQuaternionPD q_BI_des, const kindr::RotationQuaternionPD q_BI_meas, const kindr::LocalAngularVelocityPD B_w_IB_des)
 
Eigen::Vector3d update (const double dt, const kindr::RotationQuaternionPD q_BI_des, const kindr::RotationQuaternionPD q_BI_meas)
 
void reset ()
 
void setGains (const Eigen::Vector3d kp, const Eigen::Vector3d ki, const Eigen::Vector3d kd)
 
void setKp (const Eigen::Vector3d kp)
 
void setKi (const Eigen::Vector3d ki)
 
void setKd (const Eigen::Vector3d kd)
 
void setMaxEffort (const Eigen::Vector3d eff)
 
Eigen::Vector3d getKp () const
 
Eigen::Vector3d getKi () const
 
Eigen::Vector3d getKd () const
 
Eigen::Vector3d getMaxEffort () const
 
bool addParametersToHandler (const std::string &pidName)
 

Protected Attributes

Eigen::Vector3d integral_
 
kindr::RotationQuaternionPD q_BI_prev_
 
parameter_handler::Parameter< Eigen::Vector3d > kp_
 
parameter_handler::Parameter< Eigen::Vector3d > ki_
 
parameter_handler::Parameter< Eigen::Vector3d > kd_
 
parameter_handler::Parameter< Eigen::Vector3d > maxEffort_
 

Constructor & Destructor Documentation

robot_utils::PidControllerQuaternion::PidControllerQuaternion ( )
robot_utils::PidControllerQuaternion::PidControllerQuaternion ( const Eigen::Vector3d  maxEffort,
const Eigen::Vector3d  kp,
const Eigen::Vector3d  ki,
const Eigen::Vector3d  kd 
)
virtual robot_utils::PidControllerQuaternion::~PidControllerQuaternion ( )
virtual

Member Function Documentation

bool robot_utils::PidControllerQuaternion::addParametersToHandler ( const std::string &  pidName)
Eigen::Vector3d robot_utils::PidControllerQuaternion::getKd ( ) const
inline
Eigen::Vector3d robot_utils::PidControllerQuaternion::getKi ( ) const
inline
Eigen::Vector3d robot_utils::PidControllerQuaternion::getKp ( ) const
inline
Eigen::Vector3d robot_utils::PidControllerQuaternion::getMaxEffort ( ) const
inline
void robot_utils::PidControllerQuaternion::reset ( )
void robot_utils::PidControllerQuaternion::setGains ( const Eigen::Vector3d  kp,
const Eigen::Vector3d  ki,
const Eigen::Vector3d  kd 
)
inline
void robot_utils::PidControllerQuaternion::setKd ( const Eigen::Vector3d  kd)
inline
void robot_utils::PidControllerQuaternion::setKi ( const Eigen::Vector3d  ki)
inline
void robot_utils::PidControllerQuaternion::setKp ( const Eigen::Vector3d  kp)
inline
void robot_utils::PidControllerQuaternion::setMaxEffort ( const Eigen::Vector3d  eff)
inline
Eigen::Vector3d robot_utils::PidControllerQuaternion::update ( const double  dt,
const kindr::RotationQuaternionPD  q_BI_des,
const kindr::RotationQuaternionPD  q_BI_meas,
const kindr::LocalAngularVelocityPD  B_w_IB_des,
const kindr::LocalAngularVelocityPD  B_w_IB_meas 
)

Update the quaternion PID q_BI Rotates quantity in frame I to frame B B_w_IB Angular velocity of B w.r.t. frame I expressed in frame B.

Eigen::Vector3d robot_utils::PidControllerQuaternion::update ( const double  dt,
const kindr::RotationQuaternionPD  q_BI_des,
const kindr::RotationQuaternionPD  q_BI_meas,
const kindr::LocalAngularVelocityPD  B_w_IB_des 
)
Eigen::Vector3d robot_utils::PidControllerQuaternion::update ( const double  dt,
const kindr::RotationQuaternionPD  q_BI_des,
const kindr::RotationQuaternionPD  q_BI_meas 
)

Member Data Documentation

Eigen::Vector3d robot_utils::PidControllerQuaternion::integral_
protected
parameter_handler::Parameter<Eigen::Vector3d> robot_utils::PidControllerQuaternion::kd_
protected
parameter_handler::Parameter<Eigen::Vector3d> robot_utils::PidControllerQuaternion::ki_
protected
parameter_handler::Parameter<Eigen::Vector3d> robot_utils::PidControllerQuaternion::kp_
protected
parameter_handler::Parameter<Eigen::Vector3d> robot_utils::PidControllerQuaternion::maxEffort_
protected
kindr::RotationQuaternionPD robot_utils::PidControllerQuaternion::q_BI_prev_
protected

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