Package com.ctre.phoenix6.mechanisms.swerve

Class SwerveRequest.Idle

java.lang.Object

com.ctre.phoenix6.mechanisms.swerve.SwerveRequest.Idle

All Implemented Interfaces:

SwerveRequest

Enclosing interface:

SwerveRequest

public static class SwerveRequest.Idle
extends Object
implements SwerveRequest

Does nothing to the swerve module state. This is the default state of a newly created swerve drive mechanism.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ctre.phoenix6.mechanisms.swerve.SwerveRequest

SwerveRequest.ApplyChassisSpeeds, SwerveRequest.FieldCentric, SwerveRequest.FieldCentricFacingAngle, SwerveRequest.ForwardReference, SwerveRequest.Idle, SwerveRequest.PointWheelsAt, SwerveRequest.RobotCentric, SwerveRequest.SwerveControlRequestParameters, SwerveRequest.SwerveDriveBrake, SwerveRequest.SysIdSwerveRotation, SwerveRequest.SysIdSwerveSteerGains, SwerveRequest.SysIdSwerveTranslation

Constructor Summary

Constructors

Constructor	Description
Idle()

Method Summary

Modifier and Type	Method	Description
StatusCode	apply(SwerveRequest.SwerveControlRequestParameters parameters, SwerveModule... modulesToApply)	Applies this swerve request to the given modules.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Idle

public Idle()

Method Details

apply

public StatusCode apply(SwerveRequest.SwerveControlRequestParameters parameters, SwerveModule... modulesToApply)

Description copied from interface: SwerveRequest

Applies this swerve request to the given modules. This is typically called by the SwerveDrivetrain.

Specified by:

apply in interface SwerveRequest

Parameters:

parameters - Parameters the control request needs to calculate the module state

modulesToApply - Modules to which the control request is applied

Returns:

Status code of sending the request