Drake
VectorSetpoint< Scalar > Class Template Reference

#include <drake/systems/controllers/setpoint.h>

Public Member Functions

 VectorSetpoint ()
 
 VectorSetpoint (int dim)
 
 VectorSetpoint (const VectorX< Scalar > &pos_d, const VectorX< Scalar > &vel_d, const VectorX< Scalar > &acc_d, const VectorX< Scalar > &Kp, const VectorX< Scalar > &Kd)
 
Scalar ComputeTargetAcceleration (int idx, Scalar pos, Scalar vel) const
 Computes target acceleration using PD feedback + feedforward acceleration. More...
 
VectorX< Scalar > ComputeTargetAcceleration (const VectorX< Scalar > &pos, const VectorX< Scalar > &vel) const
 Computes target acceleration using PD feedback + feedforward acceleration. More...
 
bool is_valid (int dim) const
 
const VectorX< Scalar > & desired_position () const
 
const VectorX< Scalar > & desired_velocity () const
 
const VectorX< Scalar > & desired_acceleration () const
 
const VectorX< Scalar > & Kp () const
 
const VectorX< Scalar > & Kd () const
 
int size () const
 
VectorX< Scalar > & mutable_desired_position ()
 
VectorX< Scalar > & mutable_desired_velocity ()
 
VectorX< Scalar > & mutable_desired_acceleration ()
 
VectorX< Scalar > & mutable_Kp ()
 
VectorX< Scalar > & mutable_Kd ()
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 VectorSetpoint (const VectorSetpoint &)=default
 
VectorSetpointoperator= (const VectorSetpoint &)=default
 
 VectorSetpoint (VectorSetpoint &&)=default
 
VectorSetpointoperator= (VectorSetpoint &&)=default
 

Constructor & Destructor Documentation

◆ VectorSetpoint() [1/5]

VectorSetpoint ( const VectorSetpoint< Scalar > &  )
default

◆ VectorSetpoint() [2/5]

VectorSetpoint ( VectorSetpoint< Scalar > &&  )
default

◆ VectorSetpoint() [3/5]

VectorSetpoint ( )
inline

◆ VectorSetpoint() [4/5]

VectorSetpoint ( int  dim)
inlineexplicit

◆ VectorSetpoint() [5/5]

VectorSetpoint ( const VectorX< Scalar > &  pos_d,
const VectorX< Scalar > &  vel_d,
const VectorX< Scalar > &  acc_d,
const VectorX< Scalar > &  Kp,
const VectorX< Scalar > &  Kd 
)
inline
Parameters
pos_dDesired position
vel_dDesired velocity
acc_dDesired feedforward acceleration
KpPosition gain
KdVelocity gain

Member Function Documentation

◆ ComputeTargetAcceleration() [1/2]

Scalar ComputeTargetAcceleration ( int  idx,
Scalar  pos,
Scalar  vel 
) const
inline

Computes target acceleration using PD feedback + feedforward acceleration.

Parameters
idxIndex
posMeasured position
velMeasured velocity
Returns
Computed acceleration

◆ ComputeTargetAcceleration() [2/2]

VectorX<Scalar> ComputeTargetAcceleration ( const VectorX< Scalar > &  pos,
const VectorX< Scalar > &  vel 
) const
inline

Computes target acceleration using PD feedback + feedforward acceleration.

Parameters
idxIndex
posMeasured position
velMeasured velocity
Returns
Computed acceleration

◆ desired_acceleration()

const VectorX<Scalar>& desired_acceleration ( ) const
inline

◆ desired_position()

const VectorX<Scalar>& desired_position ( ) const
inline

◆ desired_velocity()

const VectorX<Scalar>& desired_velocity ( ) const
inline

◆ is_valid()

bool is_valid ( int  dim) const
inline

◆ Kd()

const VectorX<Scalar>& Kd ( ) const
inline

◆ Kp()

const VectorX<Scalar>& Kp ( ) const
inline

◆ mutable_desired_acceleration()

VectorX<Scalar>& mutable_desired_acceleration ( )
inline

◆ mutable_desired_position()

VectorX<Scalar>& mutable_desired_position ( )
inline

◆ mutable_desired_velocity()

VectorX<Scalar>& mutable_desired_velocity ( )
inline

◆ mutable_Kd()

VectorX<Scalar>& mutable_Kd ( )
inline

◆ mutable_Kp()

VectorX<Scalar>& mutable_Kp ( )
inline

◆ operator=() [1/2]

VectorSetpoint& operator= ( const VectorSetpoint< Scalar > &  )
default

◆ operator=() [2/2]

VectorSetpoint& operator= ( VectorSetpoint< Scalar > &&  )
default

◆ size()

int size ( ) const
inline

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