Index (spartanLib2 API)

A B C D E F G H I J L M N O P R S T U V X Y
All Classes All Packages

A

AButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the A button.
acceleration - Variable in class org.chsrobotics.lib.trajectory.ProfilePhase
add(DifferentialDrivetrainInput) - Method in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput: Returns a new DifferentialDrivetrainInput consisting of the sum of left and right values.
addDeadband(double) - Method in class org.chsrobotics.lib.input.JoystickAxis: Adds a deadband to the axis such that axis absolute values below this will be returned as 0.
ArcadeDrive - Class in org.chsrobotics.lib.drive.differential: Moves the robot in teleop using separate inputs for linear and rotational motion.
ArcadeDrive(JoystickAxis, JoystickAxis, double, double, double, double) - Constructor for class org.chsrobotics.lib.drive.differential.ArcadeDrive: Constructs an ArcadeDrive.
AsymmetricTrapezoidProfile - Class in org.chsrobotics.lib.trajectory: A MotionProfile that allows for smooth motion between two states, generated with acceleration, velocity, and deceleration constraints.
AsymmetricTrapezoidProfile(AsymmetricTrapezoidProfile.Constraints, MotionProfile.State) - Constructor for class org.chsrobotics.lib.trajectory.AsymmetricTrapezoidProfile: Constructs an AsymmetricTrapezoidProfile with an initial position and velocity of 0,0.
AsymmetricTrapezoidProfile(AsymmetricTrapezoidProfile.Constraints, MotionProfile.State, MotionProfile.State) - Constructor for class org.chsrobotics.lib.trajectory.AsymmetricTrapezoidProfile: Constructs an AsymmetricTrapezoidProfile.
AsymmetricTrapezoidProfile.Constraints - Class in org.chsrobotics.lib.trajectory: A data class to hold the maximum allowable rates for the output of a AsymmetricTrapezoidProfile.

B

backButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the back button on the controller.
BButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the B button.

C

calculate(double) - Method in class org.chsrobotics.lib.controllers.PID: Returns an output from the controller with the default robot loop time.
calculate(double) - Method in class org.chsrobotics.lib.math.filters.DifferentiatingFilter: Calculates the rate of change (derivative) of a value relative to the filter's previous input, using the default loop time of the robot.
calculate(double) - Method in interface org.chsrobotics.lib.math.filters.Filter: Adds the value to the window and calculates the current output of the filter
calculate(double) - Method in class org.chsrobotics.lib.math.filters.PeakDetectionFilter: Returns whether a value is considered a peak, a valley, or neither within the combined input data.
calculate(double) - Method in class org.chsrobotics.lib.math.filters.RateLimiter
calculate(double) - Method in class org.chsrobotics.lib.math.filters.ThresholdFilter
calculate(double) - Method in class org.chsrobotics.lib.trajectory.MotionProfile: Calculates the current State of the profile at a given time.
calculate(double, double) - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns an output from the controller, provided a feedback measurement and place into the MotionProfile to sample.
calculate(double, double) - Method in class org.chsrobotics.lib.controllers.PID: Returns an output from the controller with a given dt.
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.DifferentiatingFilter: Calculates the rate of change (derivative) of a value relative to the filter's previous input, using a given change in time.
calculate(double, double, double) - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns an output from the controller, provided a feedback measurement, place into the MotionProfile, and delta-time.
clamp(double) - Method in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput: Returns a new DifferentialDrivetrainInput clamped to not exceed a maximum absolute value.
close() - Method in class org.chsrobotics.lib.telemetry.DashboardChooser
ConditionalConsumerCommand<T> - Class in org.chsrobotics.lib.commands: Class to allow calling methods with one or two parameters (of the same type), in the command-based structure, upon state change of a boolean conditional.
ConditionalConsumerCommand(BiConsumer<T, T>, Tuple2<T>, Tuple2<T>, double, Supplier<Boolean>, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConditionalConsumerCommand: Constructs a ConditionalConsumerCommand for a method with two parameter.
ConditionalConsumerCommand(BiConsumer<T, T>, Tuple2<T>, Tuple2<T>, Supplier<Boolean>, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConditionalConsumerCommand: Constructs a ConditionalConsumerCommand for a method with two parameter which never ends.
ConditionalConsumerCommand(Consumer<T>, T, T, Supplier<Boolean>, double, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConditionalConsumerCommand: Constructs a ConditionalConsumerCommand for a method with one parameter.
ConditionalConsumerCommand(Consumer<T>, T, T, Supplier<Boolean>, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConditionalConsumerCommand: Constructs a ConditionalConsumerCommand for a method with one parameter which never ends.
ConditionalEndConsumerCommand<T> - Class in org.chsrobotics.lib.commands: Class for the command-based structure which allows for method execution (using one or two values of generic T) at beginning and end of the command, with a boolean lambda of when the command should end.
ConditionalEndConsumerCommand(BiConsumer<T, T>, Tuple2<T>, Tuple2<T>, Supplier<Boolean>, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConditionalEndConsumerCommand: Constructs a ConditionalConsumerCommand for a method with two parameters.
ConditionalEndConsumerCommand(Consumer<T>, T, T, Supplier<Boolean>, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConditionalEndConsumerCommand: Constructs a ConditionalConsumerCommand for a method with one parameter.
ConditionalEndRunnableCommand - Class in org.chsrobotics.lib.commands: Class for the command-based structure which allows for method execution at beginning and end of the command, with a boolean lambda of when the command should end.
ConditionalEndRunnableCommand(Runnable, Runnable, Supplier<Boolean>, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConditionalEndRunnableCommand: Constructs a ConditionalEndRunnableCommand.
ConditionalRunnableCommand - Class in org.chsrobotics.lib.commands: Class to allow execution of methods (with no parameters) upon boolean state change, in the command-based structure.
ConditionalRunnableCommand(Runnable, Runnable, Supplier<Boolean>, double, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConditionalRunnableCommand: Constructs a ConditionalRunnableCommand.
ConditionalRunnableCommand(Runnable, Runnable, Supplier<Boolean>, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConditionalRunnableCommand: Constructs a ConditionalRunnableCommand that does not end.
Constraints(double, double) - Constructor for class org.chsrobotics.lib.trajectory.TrapezoidProfile.Constraints: Constructs a TrapezoidProfileConstraints.
Constraints(double, double, double) - Constructor for class org.chsrobotics.lib.trajectory.AsymmetricTrapezoidProfile.Constraints: Constructs Constraints for a AsymmetricTrapezoidProfile.
ConsumerCommand<T> - Class in org.chsrobotics.lib.commands: Simple class to allow calling methods with one or two parameters (of the same type) in the command-based structure.
ConsumerCommand(BiConsumer<T, T>, Tuple2<T>, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConsumerCommand: Constructs a ConsumerCommand for a method with two parameters of the same type that ends instantly.
ConsumerCommand(BiConsumer<T, T>, Tuple2<T>, Tuple2<T>, double, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConsumerCommand: Constructs a ConsumerCommand for a method with two parameters.
ConsumerCommand(Consumer<T>, T, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConsumerCommand: Constructs a ConsumerCommand for a method with a single parameter that instantly ends.
ConsumerCommand(Consumer<T>, T, T, double, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.ConsumerCommand: Constructs a ConsumerCommand for a method with one parameter.
CurvatureDrive - Class in org.chsrobotics.lib.drive.differential: Moves the robot in teleoperated mode similarly to ArcadeDrive, but with turning speeds dependent on linear speeds.
CurvatureDrive(JoystickAxis, JoystickAxis, double, double, double, double, boolean) - Constructor for class org.chsrobotics.lib.drive.differential.CurvatureDrive: Constructs a CurvatureDrive.

D

DashboardChooser<T> - Class in org.chsrobotics.lib.telemetry: A NTSendable which replaces the SendableChooser in favor of a listener-based api.
DashboardChooser(Map<String, T>, String) - Constructor for class org.chsrobotics.lib.telemetry.DashboardChooser: Constructs a DashboardChooser from a Map<String, T>, recording changes to the chosen value to the default on-robot log at HighLevelLogger.getLog().
DashboardChooser(Map<String, T>, String, boolean) - Constructor for class org.chsrobotics.lib.telemetry.DashboardChooser: Constructs a DashboardChooser from a Map<String, T>.
DashboardChooser.Option - Interface in org.chsrobotics.lib.telemetry: Interface implemented by enums which allows DashboardChooser to automatically create choosers.
DashboardChooser.ValueUpdater<T> - Interface in org.chsrobotics.lib.telemetry: Interface which defines a lambda for receiving DashboardChooser updates.
DifferentialDriveMode - Interface in org.chsrobotics.lib.drive.differential: Represents a mapping of joystick inputs to left and right drivetrain motor inputs.
DifferentialDrivetrainInput - Class in org.chsrobotics.lib.drive.differential: A data class that holds differential drivetrain inputs, split into drivetrain's left and right sides.
DifferentialDrivetrainInput(double, double) - Constructor for class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput: Constructs a DifferentialDrivetrainInput.
DifferentiatingFilter - Class in org.chsrobotics.lib.math.filters: A filter that returns the rate of change (derivative) of a stream of data.
DifferentiatingFilter() - Constructor for class org.chsrobotics.lib.math.filters.DifferentiatingFilter

E

end(boolean) - Method in class org.chsrobotics.lib.commands.ConditionalEndConsumerCommand
end(boolean) - Method in class org.chsrobotics.lib.commands.ConditionalEndRunnableCommand
end(boolean) - Method in class org.chsrobotics.lib.commands.ConsumerCommand
end(boolean) - Method in class org.chsrobotics.lib.commands.RunnableCommand
equals(Object) - Method in class org.chsrobotics.lib.controllers.PID.PIDConstants
equals(Object) - Method in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput
equals(Object) - Method in class org.chsrobotics.lib.trajectory.AsymmetricTrapezoidProfile.Constraints
equals(Object) - Method in class org.chsrobotics.lib.trajectory.MotionProfile.State
equals(Object) - Method in class org.chsrobotics.lib.trajectory.ProfilePhase
equals(Object) - Method in class org.chsrobotics.lib.trajectory.TrapezoidProfile.Constraints
execute() - Method in class org.chsrobotics.lib.commands.ConditionalConsumerCommand
execute() - Method in class org.chsrobotics.lib.commands.ConditionalRunnableCommand
execute() - Method in class org.chsrobotics.lib.drive.differential.ArcadeDrive: Calculate the drive output using the current joystick inputs.
execute() - Method in class org.chsrobotics.lib.drive.differential.CurvatureDrive: Calculate the drive output using the current joystick inputs.
execute() - Method in interface org.chsrobotics.lib.drive.differential.DifferentialDriveMode: Calculate the drive output using the current joystick inputs.
execute() - Method in class org.chsrobotics.lib.drive.differential.MixedDrive: Calculate the drive output using the current joystick inputs.
execute() - Method in class org.chsrobotics.lib.drive.differential.TankDrive: Calculate the drive output using the current joystick inputs.

F

Filter - Interface in org.chsrobotics.lib.math.filters: Common interface for this library's filters.
firstValue() - Method in class org.chsrobotics.lib.util.Tuple2: Returns the first value of the tuple.
fromEnum(Class<? extends DashboardChooser.Option>, DashboardChooser.Option) - Static method in class org.chsrobotics.lib.telemetry.DashboardChooser: Returns a DashboardChooser from an enum implementing DashboardChooser.Option, saving changes to the default log from HighLevelLogger.getLog()
fromEnum(Class<? extends DashboardChooser.Option>, DashboardChooser.Option, boolean) - Static method in class org.chsrobotics.lib.telemetry.DashboardChooser: Constructs a DashboardChooser from an enum implementing DashboardChooser.Option.

G

GearRatioHelper - Class in org.chsrobotics.lib.util: Simple utility representing a gear ratio.
GearRatioHelper(double) - Constructor for class org.chsrobotics.lib.util.GearRatioHelper: Creates a gear ratio helper from a double ratio of input to output.
GearRatioHelper(double, double) - Constructor for class org.chsrobotics.lib.util.GearRatioHelper: Constructs a GearRatioHelper.
get() - Method in class org.chsrobotics.lib.input.JoystickButton: Returns a boolean of whether the button is pressed (in a true state).
getConstants() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns the current gains of the controller.
getConstants() - Method in class org.chsrobotics.lib.controllers.PID: Returns the current gains of the controller.
getCurrentOutput() - Method in class org.chsrobotics.lib.math.filters.DifferentiatingFilter: Returns the current output of the filter without updating with a new value.
getCurrentOutput() - Method in interface org.chsrobotics.lib.math.filters.Filter: Returns the current output of the filter without updating with a new value.
getCurrentOutput() - Method in class org.chsrobotics.lib.math.filters.PeakDetectionFilter: Returns the current output of the filter without updating with a new value.
getCurrentOutput() - Method in class org.chsrobotics.lib.math.filters.RateLimiter
getCurrentOutput() - Method in class org.chsrobotics.lib.math.filters.ThresholdFilter
getCurrentState() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns the last reported measurement given to the controller.
getCurrentState() - Method in class org.chsrobotics.lib.controllers.PID: Returns the last reported measurement given to the controller.
getDisplayName() - Method in interface org.chsrobotics.lib.telemetry.DashboardChooser.Option
getIntegralAccumulation() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns the accumulated past error in the integral term.
getIntegralAccumulation() - Method in class org.chsrobotics.lib.controllers.PID: Returns the accumulated past error in the integral term.
getkD() - Method in class org.chsrobotics.lib.controllers.PID: Returns the current derivative gain of the controller.
getkD() - Method in class org.chsrobotics.lib.controllers.PID.PIDConstants: Returns the derivative gain.
getKD() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns the current derivative gain of the controller.
getkI() - Method in class org.chsrobotics.lib.controllers.PID: Returns the current integral gain of the controller.
getkI() - Method in class org.chsrobotics.lib.controllers.PID.PIDConstants: Returns the integral gain.
getKI() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns the current integral gain of the controller.
getkP() - Method in class org.chsrobotics.lib.controllers.PID: Returns the current proportional gain of the controller.
getkP() - Method in class org.chsrobotics.lib.controllers.PID.PIDConstants: Returns the proportional gain.
getKP() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns the current proportional gain of the controller.
getLeftRumble() - Method in class org.chsrobotics.lib.input.XboxController: Returns the currently applied left-side rumble value.
getLog() - Static method in class org.chsrobotics.lib.telemetry.HighLevelLogger: Returns the DataLog populated by this, for use in more-granular and robot-specific logging.
getPhases() - Method in class org.chsrobotics.lib.trajectory.MotionProfile: Gets all the phases in the profile.
getRightRumble() - Method in class org.chsrobotics.lib.input.XboxController: Returns the currently applied right-side rumble value.
getSelected() - Method in class org.chsrobotics.lib.telemetry.DashboardChooser: Gets the currently selected option's value.
getSetpoint() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns the current setpoint (target) of the controller, as a State with both position and velocity.
getSetpoint() - Method in class org.chsrobotics.lib.controllers.PID: Returns the current setpoint (target) of the controller.
getSetpoint(double) - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns the current setpoint (target) of the controller, as a State with both position and velocity.
getSetpointPositionTolerance() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns the maximum allowed position error for isAtSetpoint() to return true.
getSetpointPositionTolerance() - Method in class org.chsrobotics.lib.controllers.PID: Returns the maximum allowed position error for isAtSetpoint() to return true.
getSetpointVelocityTolerance() - Method in class org.chsrobotics.lib.controllers.PID: Returns the maximum allowed velocity error for isAtSetpoint() to return true.
getValue() - Method in class org.chsrobotics.lib.input.JoystickAxis: Returns the current value of the axis, with deadband applied.

H

hashCode() - Method in class org.chsrobotics.lib.controllers.PID.PIDConstants
hashCode() - Method in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput
hashCode() - Method in class org.chsrobotics.lib.trajectory.AsymmetricTrapezoidProfile.Constraints
hashCode() - Method in class org.chsrobotics.lib.trajectory.MotionProfile.State
hashCode() - Method in class org.chsrobotics.lib.trajectory.ProfilePhase
hashCode() - Method in class org.chsrobotics.lib.trajectory.TrapezoidProfile.Constraints
HighLevelLogger - Class in org.chsrobotics.lib.telemetry: Convenience wrapper class for telemetry/ logging with built-in logging for robot-agnostic data like environment metadata, RoboRio status, and scheduled commands.
HighLevelLogger() - Constructor for class org.chsrobotics.lib.telemetry.HighLevelLogger

I

initialize() - Method in class org.chsrobotics.lib.commands.ConditionalConsumerCommand
initialize() - Method in class org.chsrobotics.lib.commands.ConditionalEndConsumerCommand
initialize() - Method in class org.chsrobotics.lib.commands.ConditionalEndRunnableCommand
initialize() - Method in class org.chsrobotics.lib.commands.ConditionalRunnableCommand
initialize() - Method in class org.chsrobotics.lib.commands.ConsumerCommand
initialize() - Method in class org.chsrobotics.lib.commands.LogMessageCommand
initialize() - Method in class org.chsrobotics.lib.commands.RunnableCommand
initialState - Variable in class org.chsrobotics.lib.trajectory.MotionProfile
initialVelocity - Variable in class org.chsrobotics.lib.trajectory.ProfilePhase
initSendable(NTSendableBuilder) - Method in class org.chsrobotics.lib.telemetry.DashboardChooser
inputFromOutput(double) - Method in class org.chsrobotics.lib.util.GearRatioHelper: Returns how far the "input" side of the mechanism will have travelled if the "output" has travelled the indicated angular distance.
invert(boolean) - Method in class org.chsrobotics.lib.input.JoystickButton: Sets whether the button should be inverted (a pressed state returns false instead of true).
isAtSetpoint() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Returns whether the controller has reached the position of the setpoint.
isAtSetpoint() - Method in class org.chsrobotics.lib.controllers.PID: Returns whether the controller has reached the setpoint with minimal velocity.
isFinished() - Method in class org.chsrobotics.lib.commands.ConditionalConsumerCommand
isFinished() - Method in class org.chsrobotics.lib.commands.ConditionalEndConsumerCommand
isFinished() - Method in class org.chsrobotics.lib.commands.ConditionalEndRunnableCommand
isFinished() - Method in class org.chsrobotics.lib.commands.ConditionalRunnableCommand
isFinished() - Method in class org.chsrobotics.lib.commands.ConsumerCommand
isFinished() - Method in class org.chsrobotics.lib.commands.LogMessageCommand
isFinished() - Method in class org.chsrobotics.lib.commands.RunnableCommand
isFinished(double) - Method in class org.chsrobotics.lib.trajectory.MotionProfile: Returns true if the provided time is greater than the length of the profile.
isInverted() - Method in class org.chsrobotics.lib.input.JoystickAxis: Returns whether the axis is inverted (polarity switched).
isInverted() - Method in class org.chsrobotics.lib.input.JoystickButton: Returns whether the button is inverted (a pressed state returns false instead of true).
isPublishingToNT() - Method in class org.chsrobotics.lib.telemetry.Logger: Returns whether this is publishing values to NetworkTables.
isReal() - Method in class org.chsrobotics.lib.input.JoystickAxis: Whether this JoystickAxis is a representation of physical hardware.
isReal() - Method in class org.chsrobotics.lib.input.JoystickButton: Whether this JoystickButton is a representation of physical hardware.
isRecordingToLog() - Method in class org.chsrobotics.lib.telemetry.Logger: Returns whether this is recording values to the on-robot log.

J

JoystickAxis - Class in org.chsrobotics.lib.input: Represents a hardware axis on an input device which has a value in [-1,1] (inclusive).
JoystickAxis(Supplier<Double>, String, boolean) - Constructor for class org.chsrobotics.lib.input.JoystickAxis: Constructs a JoystickAxis.
JoystickButton - Class in org.chsrobotics.lib.input: Represents a hardware button on an input device which has two states.
JoystickButton(Supplier<Boolean>, String, boolean) - Constructor for class org.chsrobotics.lib.input.JoystickButton: Constructs a JoystickButton.

L

left - Variable in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput
leftBumperButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the left bumper.
leftStickButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the left stick button (pushing the stick into the controller, should make a small click).
leftStickHorizontalAxis() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickAxis cooresponding to the left stick's horizontal axis.
leftStickVerticalAxis() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickAxis cooresponding to the left stick's vertical axis.
leftTriggerAxis() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickAxis cooresponding to the left trigger.
logError(String) - Static method in class org.chsrobotics.lib.telemetry.HighLevelLogger: Writes an error, using the provided string, to the DriverStation console, and writes it to the log.
Logger<T> - Class in org.chsrobotics.lib.telemetry: Utility to streamline publishing data to NetworkTables and saving it to an on-robot log file.
Logger(DataLog, String, String, boolean, boolean) - Constructor for class org.chsrobotics.lib.telemetry.Logger: Constructs a Logger using a provided DataLog, with the option of whether to publish to NT and the log.
Logger(String, String) - Constructor for class org.chsrobotics.lib.telemetry.Logger: Constructs a Logger using HighLevelLogger.getLog(), publishing to NT and logging.
logMessage(String) - Static method in class org.chsrobotics.lib.telemetry.HighLevelLogger: Logs a String message (warning, state transition, startup information, etc.), and prints it to the standard output (DriverStation console).
LogMessageCommand - Class in org.chsrobotics.lib.commands: Simple command to log a message to the default DataLog (given by HighLevelLogger.getLog()).
LogMessageCommand(String) - Constructor for class org.chsrobotics.lib.commands.LogMessageCommand: Constructs a LogMessageCommand.
LogMessageCommand(Supplier<String>) - Constructor for class org.chsrobotics.lib.commands.LogMessageCommand: Construts a LogMessageCommand.
logPeriodic() - Static method in class org.chsrobotics.lib.telemetry.HighLevelLogger: Method to be called once per robot loop cycle, updating the various Loggers wrapped by this class.
logWarning(String) - Static method in class org.chsrobotics.lib.telemetry.HighLevelLogger: Writes a warning, using the provided string, to the DriverStation console, and writes it to the log.

M

maxAcceleration - Variable in class org.chsrobotics.lib.trajectory.AsymmetricTrapezoidProfile.Constraints
maxAcceleration - Variable in class org.chsrobotics.lib.trajectory.TrapezoidProfile.Constraints
maxDeceleration - Variable in class org.chsrobotics.lib.trajectory.AsymmetricTrapezoidProfile.Constraints
maxVelocity - Variable in class org.chsrobotics.lib.trajectory.AsymmetricTrapezoidProfile.Constraints
maxVelocity - Variable in class org.chsrobotics.lib.trajectory.TrapezoidProfile.Constraints
MixedDrive - Class in org.chsrobotics.lib.drive.differential: DifferentialDriveMode composed of any number of DifferentialDriveModes, with configurable influences over the total value.
MixedDrive(Map<DifferentialDriveMode, Double>) - Constructor for class org.chsrobotics.lib.drive.differential.MixedDrive: Constructs a MixedDrive.
MotionProfile - Class in org.chsrobotics.lib.trajectory: A group of ProfilePhases that represents an arbitrary trajectory of compound accelerations, coasts, and decelerations.
MotionProfile(MotionProfile.State) - Constructor for class org.chsrobotics.lib.trajectory.MotionProfile: Constructs a MotionProfile with no phases and a defined initial state.
MotionProfile(MotionProfile.State, ProfilePhase...) - Constructor for class org.chsrobotics.lib.trajectory.MotionProfile: Constructs a MotionProfile with arbitrary phases.
MotionProfile(ProfilePhase...) - Constructor for class org.chsrobotics.lib.trajectory.MotionProfile: Constructs a MotionProfile of arbitrary phases with an initial state of zero displacement and zero velocity.
MotionProfile.State - Class in org.chsrobotics.lib.trajectory: Holds the velocity and position states of a MotionProfile at a time in its span.
MotionProfilePID - Class in org.chsrobotics.lib.controllers: A PID controller with built-in motion profile following.
MotionProfilePID(double, double, double, MotionProfile) - Constructor for class org.chsrobotics.lib.controllers.MotionProfilePID: Constructs a MotionProfilePID out of kP, kI, and kD gains, and a MotionProfile to follow.
MotionProfilePID(PID.PIDConstants, MotionProfile) - Constructor for class org.chsrobotics.lib.controllers.MotionProfilePID: Constructs a MotionProfilePID out of provided PIDConstants and a MotionProfile to follow.
multiply(double) - Method in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput: Returns a new DifferentialDrivetrainInput with the left and right values multiplied by a scalar.
MultiPointInterpolator - Class in org.chsrobotics.lib.math: Provides linear interpolation through a map of two variables.
MultiPointInterpolator(TreeMap<Double, Double>) - Constructor for class org.chsrobotics.lib.math.MultiPointInterpolator: Constructs a MultiPointInterpolator.

N

normalizeAngleDegrees(double) - Static method in class org.chsrobotics.lib.math.UtilityMath: Normalizes an angle in degrees between 0 and 360.
normalizeAngleRadians(double) - Static method in class org.chsrobotics.lib.math.UtilityMath: Normalizes an angle in radians between 0 and 2 pi.
normalizeSet(double[], double) - Static method in class org.chsrobotics.lib.math.UtilityMath: Scales a set of doubles symmetrically to ensure that none of them exceed a maximum absolute value, while still maintaining the same ratio.

O

of(U, U) - Static method in class org.chsrobotics.lib.util.Tuple2: Constructs and returns a Tuple2 of two values of the same data type.
onOptionSelected(T, T) - Method in interface org.chsrobotics.lib.telemetry.DashboardChooser.ValueUpdater: Called when a new option has been selected in the dashboard
org.chsrobotics.lib.commands - package org.chsrobotics.lib.commands
org.chsrobotics.lib.controllers - package org.chsrobotics.lib.controllers
org.chsrobotics.lib.drive.differential - package org.chsrobotics.lib.drive.differential
org.chsrobotics.lib.input - package org.chsrobotics.lib.input
org.chsrobotics.lib.math - package org.chsrobotics.lib.math
org.chsrobotics.lib.math.filters - package org.chsrobotics.lib.math.filters
org.chsrobotics.lib.telemetry - package org.chsrobotics.lib.telemetry
org.chsrobotics.lib.trajectory - package org.chsrobotics.lib.trajectory
org.chsrobotics.lib.util - package org.chsrobotics.lib.util
outputFromInput(double) - Method in class org.chsrobotics.lib.util.GearRatioHelper: Returns how far the "output" side of the mechanism will have travelled if the "input" has travelled the indicated angular distance.

P

PeakDetectionFilter - Class in org.chsrobotics.lib.math.filters: A filter to isolate peaks in a stream of data.
PeakDetectionFilter(int, double, double, double) - Constructor for class org.chsrobotics.lib.math.filters.PeakDetectionFilter: Constructs a PeakDetection filter.
PeakDetectionFilter(int, double, double, double, double) - Constructor for class org.chsrobotics.lib.math.filters.PeakDetectionFilter: Constructs a PeakDetection filter with a minimum delta from the mean to be considered a signal.
phases - Variable in class org.chsrobotics.lib.trajectory.MotionProfile
PID - Class in org.chsrobotics.lib.controllers: Implementation of a simple Proportional-Integral-Derivative feedback controller.
PID(double, double, double, double) - Constructor for class org.chsrobotics.lib.controllers.PID: Constructs a PID with given gains.
PID(PID.PIDConstants, double) - Constructor for class org.chsrobotics.lib.controllers.PID: Constructs a PID with a given PIDConstants.
PID.PIDConstants - Class in org.chsrobotics.lib.controllers: Data class for holding the gains to a PID controller.
PIDConstants(double, double, double) - Constructor for class org.chsrobotics.lib.controllers.PID.PIDConstants: Constructs a PIDConstants out of provided gains.
position - Variable in class org.chsrobotics.lib.trajectory.MotionProfile.State
position - Variable in class org.chsrobotics.lib.trajectory.ProfilePhase
ProfilePhase - Class in org.chsrobotics.lib.trajectory: Holds constant-acceleration kinematic rates and time.
ProfilePhase(double, double, double) - Constructor for class org.chsrobotics.lib.trajectory.ProfilePhase: Constructs a ProfilePhase from a given acceleration, initial velocity, and time.
ProfilePhase(double, double, double, double) - Constructor for class org.chsrobotics.lib.trajectory.ProfilePhase: Constructs a ProfilePhase.
publishSendable(String, Sendable) - Static method in class org.chsrobotics.lib.telemetry.HighLevelLogger: Publishes a Sendable object to NetworkTables.
putNewPair(double, double) - Method in class org.chsrobotics.lib.math.MultiPointInterpolator: Adds a new key/value pair to to the map at runtime.
putNewPairs(TreeMap<Double, Double>) - Method in class org.chsrobotics.lib.math.MultiPointInterpolator: Adds to the map at runtime.

R

RateLimiter - Class in org.chsrobotics.lib.math.filters: Filter which constrains the maximum rate of change of a reference.
RateLimiter(double) - Constructor for class org.chsrobotics.lib.math.filters.RateLimiter: Constructs a RateLimiter with the default robot loop cycle time.
RateLimiter(double, double) - Constructor for class org.chsrobotics.lib.math.filters.RateLimiter: Constructs a RateLimiter.
registerListener(DashboardChooser.ValueUpdater<T>) - Method in class org.chsrobotics.lib.telemetry.DashboardChooser: Register a listener to be called when the option is updated.
reset() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Resets all references to past states in the controller, effectively restarting it.
reset() - Method in class org.chsrobotics.lib.controllers.PID: Resets all references to past states in the controller, effectively restarting it.
reset() - Method in class org.chsrobotics.lib.math.filters.DifferentiatingFilter: Resets the history of the filter.
reset() - Method in interface org.chsrobotics.lib.math.filters.Filter: Resets the history of the filter.
reset() - Method in class org.chsrobotics.lib.math.filters.PeakDetectionFilter: Resets the history of the filter.
reset() - Method in class org.chsrobotics.lib.math.filters.RateLimiter
reset() - Method in class org.chsrobotics.lib.math.filters.ThresholdFilter
resetIntegralAccumulation() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Resets accumulation of past error in the integral term.
resetIntegralAccumulation() - Method in class org.chsrobotics.lib.controllers.PID: Resets accumulation of past error in the integral term.
resetPreviousMeasurement() - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Resets the previous measurement used for velocity approximation for the derivative term.
resetPreviousMeasurement() - Method in class org.chsrobotics.lib.controllers.PID: Resets the previous measurement used for velocity approximation for the derivative term.
right - Variable in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput
rightBumperButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the right bumper.
rightStickButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the right stick button (pushing the stick into the controller, should make a small click).
rightStickHorizontalAxis() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickAxis cooresponding to the right stick's horizontal axis.
rightStickVerticalAxis() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickAxis cooresponding to the right stick's vertical axis.
rightTriggerAxis() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickAxis cooresponding to the right trigger.
RunnableCommand - Class in org.chsrobotics.lib.commands: Simple class to call a method (with no parameters) in the command-based structure.
RunnableCommand(Runnable, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.RunnableCommand: Constructs a RunnableCommand that instantly ends.
RunnableCommand(Runnable, Runnable, double, Subsystem...) - Constructor for class org.chsrobotics.lib.commands.RunnableCommand: Constructs a RunnableCommand.
runsWhenDisabled() - Method in class org.chsrobotics.lib.commands.ConditionalConsumerCommand
runsWhenDisabled() - Method in class org.chsrobotics.lib.commands.ConditionalEndConsumerCommand
runsWhenDisabled() - Method in class org.chsrobotics.lib.commands.ConditionalEndRunnableCommand
runsWhenDisabled() - Method in class org.chsrobotics.lib.commands.ConditionalRunnableCommand
runsWhenDisabled() - Method in class org.chsrobotics.lib.commands.ConsumerCommand
runsWhenDisabled() - Method in class org.chsrobotics.lib.commands.LogMessageCommand
runsWhenDisabled() - Method in class org.chsrobotics.lib.commands.RunnableCommand

S

sample(double) - Method in class org.chsrobotics.lib.math.MultiPointInterpolator: Samples the profile for a value at a given key.
scaleToSum(double[], double) - Static method in class org.chsrobotics.lib.math.UtilityMath: Scales a set of doubles symmetrically such that they sum to a desired number, while maintaining the same ratio.
secondValue() - Method in class org.chsrobotics.lib.util.Tuple2: Returns the seond value of the tuple.
setConstants(double, double, double) - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Sets the gains of the controller using provided gains.
setConstants(double, double, double) - Method in class org.chsrobotics.lib.controllers.PID: Sets the gains of the controller using provided gains.
setConstants(PID.PIDConstants) - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Sets the gains of the controller using a provided PIDConstants.
setConstants(PID.PIDConstants) - Method in class org.chsrobotics.lib.controllers.PID: Sets the gains of the controller using a provided PIDConstants.
setInverted(boolean) - Method in class org.chsrobotics.lib.input.JoystickAxis: Sets whether the axis should be inverted (polarity switched).
setkD(double) - Method in class org.chsrobotics.lib.controllers.PID: Sets the derivative gain of the controller.
setKD(double) - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Sets the derivative gain of the controller.
setkI(double) - Method in class org.chsrobotics.lib.controllers.PID: Sets the integral gain of the controller.
setKI(double) - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Sets the integral gain of the controller.
setkP(double) - Method in class org.chsrobotics.lib.controllers.PID: Sets the proportional gain of the controller.
setKP(double) - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Sets the proportional gain of the controller.
setLeftRumble(double) - Method in class org.chsrobotics.lib.input.XboxController: Sets the rumble of the left side of the controller, for driver feedback.
setRightRumble(double) - Method in class org.chsrobotics.lib.input.XboxController: Sets the rumble of the right side of the controller, for driver feedback.
setRunsWhileDisabled(boolean) - Method in class org.chsrobotics.lib.commands.ConditionalConsumerCommand: Sets whether this command should continue to run even while the robot is in a disabled state.
setRunsWhileDisabled(boolean) - Method in class org.chsrobotics.lib.commands.ConditionalEndConsumerCommand: Sets whether this command should continue to run even while the robot is in a disabled state.
setRunsWhileDisabled(boolean) - Method in class org.chsrobotics.lib.commands.ConditionalEndRunnableCommand: Sets whether this command should continue to run even while the robot is in a disabled state.
setRunsWhileDisabled(boolean) - Method in class org.chsrobotics.lib.commands.ConditionalRunnableCommand: Sets whether this command should continue to run even while the robot is in a disabled state.
setRunsWhileDisabled(boolean) - Method in class org.chsrobotics.lib.commands.ConsumerCommand: Sets whether this command should continue to run even while the robot is in a disabled state.
setRunsWhileDisabled(boolean) - Method in class org.chsrobotics.lib.commands.RunnableCommand: Sets whether this command should continue to run even while the robot is in a disabled state.
setSetpoint(double) - Method in class org.chsrobotics.lib.controllers.PID: Sets the setpoint (target) of the controller.
setSetpointTolerance(double) - Method in class org.chsrobotics.lib.controllers.MotionProfilePID: Sets the maximum position allowed for isFinished() to return true.
setSetpointTolerance(double, double) - Method in class org.chsrobotics.lib.controllers.PID: Sets the maximum error of both position and velocity allowed for isAtSetpoint() to return true.
simpleLinearInterpolation(double, double, double, double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath: Interpolates a value between two points.
smallestAngleDegreesBetween(double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath: Returns the angle in degrees between two other angles with the smallest absolute value.
smallestAngleRadiansBetween(double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath: Returns the angle in radians between two other angles with the smallest absolute value.
startButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the start button on the controller.
startLogging() - Static method in class org.chsrobotics.lib.telemetry.HighLevelLogger: Starts the HighLevelLogger.
startPublishingToDashboard() - Method in class org.chsrobotics.lib.telemetry.Logger: New values sent to update() will be pushed to NetworkTables.
startRecordingToLog() - Method in class org.chsrobotics.lib.telemetry.Logger: New values sent to update() will be recorded to the log.
State(double, double) - Constructor for class org.chsrobotics.lib.trajectory.MotionProfile.State: Constructs a State out of a given position and velocity.
stopPublishingToDashboard() - Method in class org.chsrobotics.lib.telemetry.Logger: New values sent to update() will not be pushed to NetworkTables.
stopRecordingToLog() - Method in class org.chsrobotics.lib.telemetry.Logger: New values sent to update() will not be recorded to the log.

T

TankDrive - Class in org.chsrobotics.lib.drive.differential: Moves the robot in teleoperated mode using one input directly mapped to each wheel.
TankDrive(JoystickAxis, JoystickAxis) - Constructor for class org.chsrobotics.lib.drive.differential.TankDrive: Constructs a TankDrive with no rate limiting.
TankDrive(JoystickAxis, JoystickAxis, double, double) - Constructor for class org.chsrobotics.lib.drive.differential.TankDrive: Constructs a TankDrive.
ThresholdFilter - Class in org.chsrobotics.lib.math.filters: A filter that completely attentuates any value (infinite impulse) below or above a defined threshold.
ThresholdFilter(double, boolean) - Constructor for class org.chsrobotics.lib.math.filters.ThresholdFilter: Constructs a ThresholdFilter.
time - Variable in class org.chsrobotics.lib.trajectory.ProfilePhase
toDoubleRatioInputToOutput() - Method in class org.chsrobotics.lib.util.GearRatioHelper: Returns the gear ratio as input/output.
toDoubleRatioOutputToInput() - Method in class org.chsrobotics.lib.util.GearRatioHelper: Returns the gear ratio as output/input.
toList() - Method in class org.chsrobotics.lib.util.Tuple2: Returns the data of this object as a list of two elements.
toString() - Method in class org.chsrobotics.lib.controllers.PID.PIDConstants
toString() - Method in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput
toString() - Method in class org.chsrobotics.lib.input.JoystickAxis
toString() - Method in class org.chsrobotics.lib.input.JoystickButton
toString() - Method in class org.chsrobotics.lib.trajectory.AsymmetricTrapezoidProfile.Constraints
toString() - Method in class org.chsrobotics.lib.trajectory.MotionProfile.State
toString() - Method in class org.chsrobotics.lib.trajectory.ProfilePhase
toString() - Method in class org.chsrobotics.lib.trajectory.TrapezoidProfile.Constraints
toString() - Method in class org.chsrobotics.lib.util.Tuple2
totalTime() - Method in class org.chsrobotics.lib.trajectory.MotionProfile: Returns the total timespan of the profile.
TrapezoidProfile - Class in org.chsrobotics.lib.trajectory: Represents a special case of an AsymmetricTrapezoidProfile where the maxAcceleration and maxDeceleration constraints are the same.
TrapezoidProfile(TrapezoidProfile.Constraints, MotionProfile.State) - Constructor for class org.chsrobotics.lib.trajectory.TrapezoidProfile: Constructs a Trapezoid profile out of given constraints, a goal state, and an initial state of zero position and velocity.
TrapezoidProfile(TrapezoidProfile.Constraints, MotionProfile.State, MotionProfile.State) - Constructor for class org.chsrobotics.lib.trajectory.TrapezoidProfile: Constructs a TrapezoidProfile out of given constraints, an initial state, and a goal state.
TrapezoidProfile.Constraints - Class in org.chsrobotics.lib.trajectory: Data class to hold the maximum allowed rates for the output of a TrapezoidProfile.
Tuple2<T> - Class in org.chsrobotics.lib.util: Very simple utility class which can hold any two objects of the same type in order.
Tuple2(T, T) - Constructor for class org.chsrobotics.lib.util.Tuple2: Constructs a Tuple2.

U

unregisterListener(DashboardChooser.ValueUpdater<T>) - Method in class org.chsrobotics.lib.telemetry.DashboardChooser: Unregister a listener when no longer needed.
update(T) - Method in class org.chsrobotics.lib.telemetry.Logger: Feeds a new value to the Logger, which may be sent to NetworkTables, an on-robot log, both, or neither, depending on how this class is configured.
UtilityMath - Class in org.chsrobotics.lib.math: Various useful small math functions.
UtilityMath() - Constructor for class org.chsrobotics.lib.math.UtilityMath

V

velocity - Variable in class org.chsrobotics.lib.trajectory.MotionProfile.State
VirtualJoystickButton - Class in org.chsrobotics.lib.input: Class to mock a joystick button from a hardware joystick axis.
VirtualJoystickButton(JoystickAxis, double, double, boolean) - Constructor for class org.chsrobotics.lib.input.VirtualJoystickButton: Constructs a VirtualJoystickButton.

X

XboxController - Class in org.chsrobotics.lib.input: Wrapper class for the Xbox controller used by FRC 997.
XboxController(int) - Constructor for class org.chsrobotics.lib.input.XboxController: Constructs an XboxController connected to a specific port in the driver station application.
XButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the X button.

Y

YButton() - Method in class org.chsrobotics.lib.input.XboxController: Returns the JoystickButton cooresponding to the Y button.

A B C D E F G H I J L M N O P R S T U V X Y
All Classes All Packages