wpi::math::DifferentialDriveKinematicsConstraint Class Reference

A class that enforces constraints on the differential drive kinematics. More...

#include <wpi/math/trajectory/constraint/DifferentialDriveKinematicsConstraint.hpp>

Inheritance diagram for wpi::math::DifferentialDriveKinematicsConstraint:

Public Member Functions
constexpr	DifferentialDriveKinematicsConstraint (DifferentialDriveKinematics kinematics, wpi::units::meters_per_second_t maxVelocity)
constexpr wpi::units::meters_per_second_t	MaxVelocity (const Pose2d &pose, wpi::units::curvature_t curvature, wpi::units::meters_per_second_t velocity) const override
	Returns the max velocity given the current pose and curvature.
constexpr MinMax	MinMaxAcceleration (const Pose2d &pose, wpi::units::curvature_t curvature, wpi::units::meters_per_second_t velocity) const override
	Returns the minimum and maximum allowable acceleration for the trajectory given pose, curvature, and velocity.
Public Member Functions inherited from wpi::math::TrajectoryConstraint
constexpr	TrajectoryConstraint ()=default
constexpr	TrajectoryConstraint (const TrajectoryConstraint &)=default
constexpr TrajectoryConstraint &	operator= (const TrajectoryConstraint &)=default
constexpr	TrajectoryConstraint (TrajectoryConstraint &&)=default
constexpr TrajectoryConstraint &	operator= (TrajectoryConstraint &&)=default
virtual constexpr	~TrajectoryConstraint ()=default

Detailed Description

A class that enforces constraints on the differential drive kinematics.

This can be used to ensure that the trajectory is constructed so that the commanded velocities for both sides of the drivetrain stay below a certain limit.

Constructor & Destructor Documentation

DifferentialDriveKinematicsConstraint()

wpi::math::DifferentialDriveKinematicsConstraint::DifferentialDriveKinematicsConstraint ( DifferentialDriveKinematics kinematics, wpi::units::meters_per_second_t maxVelocity )

inlineconstexpr

Member Function Documentation

MaxVelocity()

wpi::units::meters_per_second_t wpi::math::DifferentialDriveKinematicsConstraint::MaxVelocity ( const Pose2d & pose, wpi::units::curvature_t curvature, wpi::units::meters_per_second_t velocity ) const

inlineconstexproverridevirtual

Returns the max velocity given the current pose and curvature.

Parameters

pose	The pose at the current point in the trajectory.
curvature	The curvature at the current point in the trajectory.
velocity	The velocity at the current point in the trajectory before constraints are applied.

Returns

The absolute maximum velocity.

Implements wpi::math::TrajectoryConstraint.

MinMaxAcceleration()

MinMax wpi::math::DifferentialDriveKinematicsConstraint::MinMaxAcceleration ( const Pose2d & pose, wpi::units::curvature_t curvature, wpi::units::meters_per_second_t velocity ) const

inlineconstexproverridevirtual

Returns the minimum and maximum allowable acceleration for the trajectory given pose, curvature, and velocity.

Parameters

pose	The pose at the current point in the trajectory.
curvature	The curvature at the current point in the trajectory.
velocity	The velocity at the current point in the trajectory.

Returns

The min and max acceleration bounds.

Implements wpi::math::TrajectoryConstraint.

---

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

• wpi/math/trajectory/constraint/DifferentialDriveKinematicsConstraint.hpp