WPILibC++ 2022.4.1
frc::ArmFeedforward Class Reference

A helper class that computes feedforward outputs for a simple arm (modeled as a motor acting against the force of gravity on a beam suspended at an angle). More...

#include <frc/controller/ArmFeedforward.h>

## Public Types

using Acceleration = units::compound_unit< units::radians_per_second, units::inverse< units::second > >

using kv_unit = units::compound_unit< units::volts, units::inverse< units::radians_per_second > >

using ka_unit = units::compound_unit< units::volts, units::inverse< Acceleration > >

## Public Member Functions

constexpr ArmFeedforward ()=default

constexpr ArmFeedforward (units::volt_t kS, units::volt_t kG, units::unit_t< kv_unit > kV, units::unit_t< ka_unit > kA=units::unit_t< ka_unit >(0))
Creates a new ArmFeedforward with the specified gains. More...

units::volt_t Calculate (units::unit_t< Angle > angle, units::unit_t< Velocity > velocity, units::unit_t< Acceleration > acceleration=units::unit_t< Acceleration >(0)) const
Calculates the feedforward from the gains and setpoints. More...

units::unit_t< VelocityMaxAchievableVelocity (units::volt_t maxVoltage, units::unit_t< Angle > angle, units::unit_t< Acceleration > acceleration)
Calculates the maximum achievable velocity given a maximum voltage supply, a position, and an acceleration. More...

units::unit_t< VelocityMinAchievableVelocity (units::volt_t maxVoltage, units::unit_t< Angle > angle, units::unit_t< Acceleration > acceleration)
Calculates the minimum achievable velocity given a maximum voltage supply, a position, and an acceleration. More...

units::unit_t< AccelerationMaxAchievableAcceleration (units::volt_t maxVoltage, units::unit_t< Angle > angle, units::unit_t< Velocity > velocity)
Calculates the maximum achievable acceleration given a maximum voltage supply, a position, and a velocity. More...

units::unit_t< AccelerationMinAchievableAcceleration (units::volt_t maxVoltage, units::unit_t< Angle > angle, units::unit_t< Velocity > velocity)
Calculates the minimum achievable acceleration given a maximum voltage supply, a position, and a velocity. More...

## Public Attributes

units::volt_t kS {0}

units::volt_t kG {0}

units::unit_t< kv_unitkV {0}

units::unit_t< ka_unitkA {0}

## Detailed Description

A helper class that computes feedforward outputs for a simple arm (modeled as a motor acting against the force of gravity on a beam suspended at an angle).

## ◆ Acceleration

 using frc::ArmFeedforward::Acceleration = units::compound_unit >

## ◆ ka_unit

 using frc::ArmFeedforward::ka_unit = units::compound_unit >

## ◆ kv_unit

 using frc::ArmFeedforward::kv_unit = units::compound_unit >

## ◆ ArmFeedforward() [1/2]

 constexpr frc::ArmFeedforward::ArmFeedforward ( )
constexprdefault

## ◆ ArmFeedforward() [2/2]

 constexpr frc::ArmFeedforward::ArmFeedforward ( units::volt_t kS, units::volt_t kG, units::unit_t< kv_unit > kV, units::unit_t< ka_unit > kA = units::unit_t(0) )
inlineconstexpr

Creates a new ArmFeedforward with the specified gains.

Parameters
 kS The static gain, in volts. kG The gravity gain, in volts. kV The velocity gain, in volt seconds per radian. kA The acceleration gain, in volt seconds^2 per radian.

## ◆ Calculate()

 units::volt_t frc::ArmFeedforward::Calculate ( units::unit_t< Angle > angle, units::unit_t< Velocity > velocity, units::unit_t< Acceleration > acceleration = units::unit_t(0) ) const
inline

Calculates the feedforward from the gains and setpoints.

Parameters
 angle The angle setpoint, in radians. velocity The velocity setpoint, in radians per second. acceleration The acceleration setpoint, in radians per second^2.
Returns
The computed feedforward, in volts.

## ◆ MaxAchievableAcceleration()

 units::unit_t< Acceleration > frc::ArmFeedforward::MaxAchievableAcceleration ( units::volt_t maxVoltage, units::unit_t< Angle > angle, units::unit_t< Velocity > velocity )
inline

Calculates the maximum achievable acceleration given a maximum voltage supply, a position, and a velocity.

Useful for ensuring that velocity and acceleration constraints for a trapezoidal profile are simultaneously achievable - enter the velocity constraint, and this will give you a simultaneously-achievable acceleration constraint.

Parameters
 maxVoltage The maximum voltage that can be supplied to the arm. angle The angle of the arm velocity The velocity of the arm.
Returns
The maximum possible acceleration at the given velocity and angle.

## ◆ MaxAchievableVelocity()

 units::unit_t< Velocity > frc::ArmFeedforward::MaxAchievableVelocity ( units::volt_t maxVoltage, units::unit_t< Angle > angle, units::unit_t< Acceleration > acceleration )
inline

Calculates the maximum achievable velocity given a maximum voltage supply, a position, and an acceleration.

Useful for ensuring that velocity and acceleration constraints for a trapezoidal profile are simultaneously achievable - enter the acceleration constraint, and this will give you a simultaneously-achievable velocity constraint.

Parameters
 maxVoltage The maximum voltage that can be supplied to the arm. angle The angle of the arm acceleration The acceleration of the arm.
Returns
The maximum possible velocity at the given acceleration and angle.

## ◆ MinAchievableAcceleration()

 units::unit_t< Acceleration > frc::ArmFeedforward::MinAchievableAcceleration ( units::volt_t maxVoltage, units::unit_t< Angle > angle, units::unit_t< Velocity > velocity )
inline

Calculates the minimum achievable acceleration given a maximum voltage supply, a position, and a velocity.

Useful for ensuring that velocity and acceleration constraints for a trapezoidal profile are simultaneously achievable - enter the velocity constraint, and this will give you a simultaneously-achievable acceleration constraint.

Parameters
 maxVoltage The maximum voltage that can be supplied to the arm. angle The angle of the arm velocity The velocity of the arm.
Returns
The minimum possible acceleration at the given velocity and angle.

## ◆ MinAchievableVelocity()

 units::unit_t< Velocity > frc::ArmFeedforward::MinAchievableVelocity ( units::volt_t maxVoltage, units::unit_t< Angle > angle, units::unit_t< Acceleration > acceleration )
inline

Calculates the minimum achievable velocity given a maximum voltage supply, a position, and an acceleration.

Useful for ensuring that velocity and acceleration constraints for a trapezoidal profile are simultaneously achievable - enter the acceleration constraint, and this will give you a simultaneously-achievable velocity constraint.

Parameters
 maxVoltage The maximum voltage that can be supplied to the arm. angle The angle of the arm acceleration The acceleration of the arm.
Returns
The minimum possible velocity at the given acceleration and angle.

## ◆ kA

 units::unit_t frc::ArmFeedforward::kA {0}

## ◆ kG

 units::volt_t frc::ArmFeedforward::kG {0}

## ◆ kS

 units::volt_t frc::ArmFeedforward::kS {0}

## ◆ kV

 units::unit_t frc::ArmFeedforward::kV {0}

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