Index

A B C D E F G H I J L M N O P Q R S T U V W X Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

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
 
acot(double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns the trigonometric arccotangent (inverse cotangent) of a ratio of right triangle sides.
acot2(double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Two-argument arccotangent (inverse cotangent).
acsc(double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns the trigonometric arccosecant (inverse cosecant) of a ratio of right triangle sides.
add(DifferentialDrivetrainInput) - Method in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput
Returns a new DifferentialDrivetrainInput consisting of the sum of left and right values.
add(LEDAnimationFrame) - Method in class org.chsrobotics.lib.hardware.ledStrip.LEDAnimationFrame
Returns a new LEDAnimationFrame of another frame appended to this frame.
add(Filter, Filter) - Static method in class org.chsrobotics.lib.math.filters.Filter
Returns a filter of a sum of the outputs of two other filters.
add(Vector3D) - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Adds two vectors.
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.
alternating(int, int, RGBColor, RGBColor) - Static method in class org.chsrobotics.lib.hardware.ledStrip.LEDAnimationFrame
Statically constructs and returns a new LEDAnimationFrame of alternating colors.
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.
ARITHMETIC - Enum constant in enum class org.chsrobotics.lib.math.filters.MovingAverageFilter.MEAN_IMPLEMENTATION
 
arithmeticMean(double[]) - Static method in class org.chsrobotics.lib.math.UtilityMath
Computes the arithmetic mean, often called the average, of a set of numbers.
asec(double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns the trigonometric arcsecant (inverse secant) of a ratio of right triangle sides.
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.
atSetpoint() - Method in class org.chsrobotics.lib.controllers.ComposedFeedbackController
 
atSetpoint() - Method in interface org.chsrobotics.lib.controllers.FeedbackController
Returns whether the controller has reached the setpoint with minimal velocity.
atSetpoint() - Method in class org.chsrobotics.lib.controllers.PID
 
autoGenerateLogs(DataLog, String, String, boolean, boolean) - Method in class org.chsrobotics.lib.controllers.PID
 
autoGenerateLogs(DataLog, String, String, boolean, boolean) - Method in class org.chsrobotics.lib.telemetry.HighLevelLogger
 
autoGenerateLogs(DataLog, String, String, boolean, boolean) - Method in interface org.chsrobotics.lib.telemetry.IntrinsicLoggable
Auto-generates Loggers for important internal values.
autoGenerateLogs(String, String) - Method in interface org.chsrobotics.lib.telemetry.IntrinsicLoggable
Auto-generates Loggers for important and notable internal values, using the default DataLog, and both publishing to NT and logging on-robot.
AUTONOMOUS - Enum constant in enum class org.chsrobotics.lib.util.SRobot.RobotState
 

B

b - Variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
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.
BLACK - Static variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
BLUE - Static variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 

C

calculate(double) - Method in class org.chsrobotics.lib.controllers.ComposedFeedbackController
 
calculate(double) - Method in interface org.chsrobotics.lib.controllers.FeedbackController
Returns an output from the controller with the default robot loop time.
calculate(double) - Method in class org.chsrobotics.lib.controllers.PID
 
calculate(double) - Method in class org.chsrobotics.lib.math.filters.ComposedFilter
 
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 class org.chsrobotics.lib.math.filters.ExponentialMovingAverage
 
calculate(double) - Method in class 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.IntegratingFilter
 
calculate(double) - Method in class org.chsrobotics.lib.math.filters.MovingAverageFilter
 
calculate(double) - Method in class org.chsrobotics.lib.math.filters.NullFilter
 
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.ComposedFeedbackController
 
calculate(double, double) - Method in interface org.chsrobotics.lib.controllers.FeedbackController
Returns an output from the controller with a given dt.
calculate(double, double) - Method in class org.chsrobotics.lib.controllers.PID
 
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.ComposedFilter
 
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.DifferentiatingFilter
 
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.ExponentialMovingAverage
 
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.Filter
Adds the value to the window and calculates the current output of the filter, with a change in time since the last call of this.
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.IntegratingFilter
 
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.MovingAverageFilter
 
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.NullFilter
 
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.RateLimiter
 
calculate(double, double) - Method in class org.chsrobotics.lib.math.filters.ThresholdFilter
 
cascading(LEDAnimationFrame) - Static method in class org.chsrobotics.lib.hardware.ledStrip.SimpleLEDAnimation
Statically constructs and returns a new SimpleLEDAnimation which offsets itself from an initial frame by one step each cycle.
changeSaturation(double) - Method in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
Returns a new RGBColor with a modified saturation, or color intensity, from this.
clamp(double) - Method in class org.chsrobotics.lib.drive.differential.DifferentialDrivetrainInput
Returns a new DifferentialDrivetrainInput clamped to not exceed a maximum absolute value.
clamp(double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Constrains a value under a maximum absolute value.
clamp(double, double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Constrains a value between two other numbers.
close() - Method in class org.chsrobotics.lib.telemetry.DashboardChooser
 
ComposedFeedbackController - Class in org.chsrobotics.lib.controllers
A controller made of a sum of filters, each multiplied by a constant gain.
ComposedFeedbackController(List<Filter>) - Constructor for class org.chsrobotics.lib.controllers.ComposedFeedbackController
Constructs a ComposedController.
ComposedFeedbackController(Map<Filter, Double>) - Constructor for class org.chsrobotics.lib.controllers.ComposedFeedbackController
Constructs a ComposedController.
ComposedFilter - Class in org.chsrobotics.lib.math.filters
A filter composed of multiple filters, such that the output of a filter is the input of another, etc.
ComposedFilter(Filter...) - Constructor for class org.chsrobotics.lib.math.filters.ComposedFilter
Constructs a ComposedFilter.
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.
cot(double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Takes the trigonometric cotangent of an angle.
crossProduct(Vector3D) - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Performs the cross product operation (sum of the perpindicular component vectors) between two vectors.
csc(double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Takes the trigonometric cosecant of an angle.
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.
defaultAbsoluteEpsilon - Static variable in class org.chsrobotics.lib.math.UtilityMath
 
defaultPositionErrorToleranceProportion - Static variable in interface org.chsrobotics.lib.controllers.FeedbackController
 
defaultProportionEpsilon - Static variable in class org.chsrobotics.lib.math.UtilityMath
 
defaultVelocityErrorToleranceProportion - Static variable in interface org.chsrobotics.lib.controllers.FeedbackController
 
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
 
DISABLED - Enum constant in enum class org.chsrobotics.lib.util.SRobot.RobotState
 
dotProduct(Vector3D) - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Performs the dot product operation (sum of the product of parallel component vector signed magnitudes) between two vectors.

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
 
epsilonEqualsAbsolute(double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns whether two values are equal to within an epsilon (calculated by their difference and expected from floating-point arithmetic).
epsilonEqualsAbsolute(double, double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns whether two values are equal to within an epsilon (calculated by their difference and expected from floating-point arithmetic).
epsilonEqualsProportion(double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns whether two values are equal to within an epsilon (calculated multiplicatively and expected from floating-point arithmetic).
epsilonEqualsProportion(double, double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns whether two values are equal to within an epsilon (calculated multiplicatively and expected from floating-point arithmetic).
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.hardware.ledStrip.LEDAnimationFrame
 
equals(Object) - Method in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
equals(Object) - Method in class org.chsrobotics.lib.hardware.ledStrip.SimpleLEDAnimation
 
equals(Object) - Method in class org.chsrobotics.lib.math.geometry.Vector3D
 
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
 
ESTOPPED - Enum constant in enum class org.chsrobotics.lib.util.SRobot.RobotState
 
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.
ExponentialMovingAverage - Class in org.chsrobotics.lib.math.filters
An IIR variation upon the moving average.
ExponentialMovingAverage(double) - Constructor for class org.chsrobotics.lib.math.filters.ExponentialMovingAverage
Constructs an ExponentialMovingAverage.

F

FeedbackController - Interface in org.chsrobotics.lib.controllers
Interface for the feedback (past state-dependent and -varying) controllers of the library.
Filter - Class in org.chsrobotics.lib.math.filters
Common superclass for this library's filters.
Filter() - Constructor for class org.chsrobotics.lib.math.filters.Filter
 
firstValue() - Method in class org.chsrobotics.lib.util.Tuple2
Returns the first value of the tuple.
flashing(int, int, LEDAnimationFrame, LEDAnimationFrame) - Static method in class org.chsrobotics.lib.hardware.ledStrip.SimpleLEDAnimation
Statically constructs and returns a new SimpleLEDAnimation which periodically cycles between two frames.
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

g - Variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
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.
GEOMETRIC - Enum constant in enum class org.chsrobotics.lib.math.filters.MovingAverageFilter.MEAN_IMPLEMENTATION
 
geometricMean(double[]) - Static method in class org.chsrobotics.lib.math.UtilityMath
Computes the geometric mean of a series of numbers.
getAsBoolean() - 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.PID
Returns the current gains of the controller.
getCurrentOutput() - Method in class org.chsrobotics.lib.math.filters.ComposedFilter
 
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 class org.chsrobotics.lib.math.filters.ExponentialMovingAverage
 
getCurrentOutput() - Method in class 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.IntegratingFilter
 
getCurrentOutput() - Method in class org.chsrobotics.lib.math.filters.MovingAverageFilter
 
getCurrentOutput() - Method in class org.chsrobotics.lib.math.filters.NullFilter
 
getCurrentOutput() - Method in class org.chsrobotics.lib.math.filters.RateLimiter
 
getCurrentOutput() - Method in class org.chsrobotics.lib.math.filters.ThresholdFilter
 
getCurrentValue() - Method in class org.chsrobotics.lib.controllers.ComposedFeedbackController
 
getCurrentValue() - Method in interface org.chsrobotics.lib.controllers.FeedbackController
Returns the last output of the controller without updating with a new value.
getCurrentValue() - Method in class org.chsrobotics.lib.controllers.PID
 
getDContribution() - Method in class org.chsrobotics.lib.controllers.PID
Returns the last result of just the D term.
getDeltaX() - Method in class org.chsrobotics.lib.math.geometry.Line2D
Returns the change in the X-axis from the start of the line to the end of the line.
getDeltaY() - Method in class org.chsrobotics.lib.math.geometry.Line2D
Returns the change in the Y-axis from the start of the line to the end of the line.
getDirectionRadians() - Method in class org.chsrobotics.lib.math.geometry.Line2D
Returns the angle of the line in radians from the startpoint.
getDisplayName() - Method in interface org.chsrobotics.lib.telemetry.DashboardChooser.Option
 
getEndPoint() - Method in class org.chsrobotics.lib.math.geometry.Line2D
Returns the endpoint of the line.
getFrame(int) - Method in class org.chsrobotics.lib.hardware.ledStrip.SimpleLEDAnimation
Returns the LEDAnimationFrame at an index.
getIContribution() - Method in class org.chsrobotics.lib.controllers.PID
Returns the last result of just the I term.
getInstance() - Static method in class org.chsrobotics.lib.telemetry.HighLevelLogger
 
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.
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.
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.
getLeftRumble() - Method in class org.chsrobotics.lib.input.XboxController
Returns the currently applied left-side rumble value.
getLog() - Method in class org.chsrobotics.lib.telemetry.HighLevelLogger
Returns the DataLog populated by this, for use in more-granular and robot-specific logging.
getLogger(String) - Method in class org.chsrobotics.lib.telemetry.Logger.LoggerFactory
Constructs and returns a new logger with the parameters given above.
getMagnitude() - Method in class org.chsrobotics.lib.math.geometry.Line2D
Returns the absolute length of the line.
getMagnitude() - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Returns the magnitude of the vector as an unsigned (always positive) double.
getMaxAbsControlEffort() - Method in class org.chsrobotics.lib.controllers.PID
Returns the maximum absolute control effort allowed from the controller.
getMaxAbsDContribution() - Method in class org.chsrobotics.lib.controllers.PID
Returns the maximum absolute contribution allowed from the Derivative term of the controller.
getMaxAbsIContribution() - Method in class org.chsrobotics.lib.controllers.PID
Returns the maximum absolute contribution allowed from the Integral term of the controller.
getMaxAbsPContribution() - Method in class org.chsrobotics.lib.controllers.PID
Returns the maximum absolute contribution allowed from the Proportional term of the controller.
getNextFrame() - Method in interface org.chsrobotics.lib.hardware.ledStrip.LEDAnimation
Returns the current frame of the LEDAnimation.
getNextFrame() - Method in class org.chsrobotics.lib.hardware.ledStrip.SimpleLEDAnimation
 
getPContribution() - Method in class org.chsrobotics.lib.controllers.PID
Returns the last result of just the P term.
getPeriodSeconds() - Static method in class org.chsrobotics.lib.util.SRobot
Returns the time, in each seconds, nominally taken by each robot loop cycle.
getPhases() - Method in class org.chsrobotics.lib.trajectory.MotionProfile
Gets all the phases in the profile.
getPixel(int) - Method in class org.chsrobotics.lib.hardware.ledStrip.LEDAnimationFrame
Gets the pixel color value at an index.
getRightRumble() - Method in class org.chsrobotics.lib.input.XboxController
Returns the currently applied right-side rumble value.
getRobotState() - Static method in class org.chsrobotics.lib.util.SRobot
Returns the current state of the robot.
getSelected() - Method in class org.chsrobotics.lib.telemetry.DashboardChooser
Gets the currently selected option's value.
getSetpoint() - Method in class org.chsrobotics.lib.controllers.ComposedFeedbackController
 
getSetpoint() - Method in interface org.chsrobotics.lib.controllers.FeedbackController
Returns the current setpoint (target) of the controller.
getSetpoint() - Method in class org.chsrobotics.lib.controllers.PID
 
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.
getStartPoint() - Method in class org.chsrobotics.lib.math.geometry.Line2D
Returns the startpoint of the line.
getValue() - Method in class org.chsrobotics.lib.input.JoystickAxis
Returns the current value of the axis, with deadband applied.
getX() - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Returns the X (i-hat, positive to the horizontal right on a graph) component of the vector.
getY() - Method in class org.chsrobotics.lib.math.geometry.Vector1D
 
getY() - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Returns the Y (j-hat, positive up vertically on a graph) component of the vector.
getZ() - Method in class org.chsrobotics.lib.math.geometry.Vector2D
 
getZ() - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Returns the Z (k-hat, positive out of the graph) component of the vector.
gradientCascade(int, RGBColor, RGBColor) - Static method in class org.chsrobotics.lib.hardware.ledStrip.SimpleLEDAnimation
Statically constructs and returns a new SimpleLEDAnimation of a gradient between two colors which offsets itself by one step each cycle.
GREEN - Static variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 

H

HARMONIC - Enum constant in enum class org.chsrobotics.lib.math.filters.MovingAverageFilter.MEAN_IMPLEMENTATION
 
harmonicMean(double[]) - Static method in class org.chsrobotics.lib.math.UtilityMath
Computes the harmonic mean of a series of numbers.
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.math.geometry.Vector3D
 
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.
hypotenuse(double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns the solution of the Pythagorean formula for the hypotenuse of a right triangle, with the leg lengths given.

I

INDIGO - Static variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
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.
inRange(double, double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns if a number is between (inclusive) the boundary numbers.
IntegratingFilter - Class in org.chsrobotics.lib.math.filters
Filter which returns the time-weighted sum (integral) of a series of values.
IntegratingFilter(int) - Constructor for class org.chsrobotics.lib.math.filters.IntegratingFilter
Constructs an IntegratingFilter.
intersects(Line2D) - Method in class org.chsrobotics.lib.math.geometry.Line2D
Returns whether a line intersects this line.
IntrinsicLoggable - Interface in org.chsrobotics.lib.telemetry
Interface for classes which can auto-generate Loggers for internal fields.
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).
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.
isReal() - Static method in class org.chsrobotics.lib.util.SRobot
Returns whether the robot exists in a real or simulated environment.
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(EventLoop, BooleanSupplier, String, boolean) - Constructor for class org.chsrobotics.lib.input.JoystickButton
Constructs a JoystickButton.

L

LEDAnimation - Interface in org.chsrobotics.lib.hardware.ledStrip
Interface for LEDAnimation sequences, which can pre-generated or made at runtime by implementing classes.
LEDAnimationFrame - Class in org.chsrobotics.lib.hardware.ledStrip
Wraps around an array of RGBColors (or individual pixel color values), intended for combination into full animations.
LEDAnimationFrame(RGBColor...) - Constructor for class org.chsrobotics.lib.hardware.ledStrip.LEDAnimationFrame
Constructs an LEDAnimationFrame.
LEDStrip - Class in org.chsrobotics.lib.hardware.ledStrip
Convenience wrapper around an addressable LED strip (WS2812 or 2811).
LEDStrip(int, int) - Constructor for class org.chsrobotics.lib.hardware.ledStrip.LEDStrip
Constructs a new LEDStrip.
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.
leg(double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Returns the solution of the Pythagorean formula for a leg of a right triangle, with the other leg length and the hypotenuse length given.
Line2D - Class in org.chsrobotics.lib.math.geometry
Class representing a line in 2-dimensional space, in the form of a vector.
Line2D(double, double) - Constructor for class org.chsrobotics.lib.math.geometry.Line2D
Constructs a Line2D from polar form with a startpoint at the origin.
Line2D(Vector2D) - Constructor for class org.chsrobotics.lib.math.geometry.Line2D
Constructs a Line2D from Cartesian form using the origin as the startpoint.
Line2D(Vector2D, double, double) - Constructor for class org.chsrobotics.lib.math.geometry.Line2D
Constructs a Line2D from polar form with a provided startpoint.
Line2D(Vector2D, Vector2D) - Constructor for class org.chsrobotics.lib.math.geometry.Line2D
Constructs a Line2D from Cartesian form with a provided startpoint.
linearInterpolation(Vector3D, Vector3D, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Finds a midpoint between two other points in up to three-dimensional space.
logError(String) - 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.
Logger.LoggerFactory<U> - Class in org.chsrobotics.lib.telemetry
Factory class to simplify creating many similar logs at once.
LoggerFactory(DataLog, String, boolean, boolean) - Constructor for class org.chsrobotics.lib.telemetry.Logger.LoggerFactory
Constructs a LoggerFactory.
LoggerFactory(String) - Constructor for class org.chsrobotics.lib.telemetry.Logger.LoggerFactory
Constructs a Logger using HighLevelLogger.getLog(), publishing to NT and logging.
logMessage(String) - 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.
logWarning(String) - 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.
MovingAverageFilter - Class in org.chsrobotics.lib.math.filters
Filter which computes the arithmetic mean of a stream of data.
MovingAverageFilter(int, MovingAverageFilter.MEAN_IMPLEMENTATION) - Constructor for class org.chsrobotics.lib.math.filters.MovingAverageFilter
Constructs a MovingAverageFilter.
MovingAverageFilter.MEAN_IMPLEMENTATION - Enum Class in org.chsrobotics.lib.math.filters
Enum of different definitions of the mean.
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.

N

NONE - Enum constant in enum class org.chsrobotics.lib.util.SRobot.RobotState
 
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.
NullFilter - Class in org.chsrobotics.lib.math.filters
Filter which performs a nonop on a signal (returns it unchanged).
NullFilter() - Constructor for class org.chsrobotics.lib.math.filters.NullFilter
 
numberOfFrames() - Method in class org.chsrobotics.lib.hardware.ledStrip.SimpleLEDAnimation
Returns the number of frames the animation consists of.
numberOfPixels() - Method in class org.chsrobotics.lib.hardware.ledStrip.LEDAnimationFrame
Returns the number of pixels currently in the animation frame.
numberOfPixelsPerFrame() - Method in interface org.chsrobotics.lib.hardware.ledStrip.LEDAnimation
Returns the number of pixels per each frame.
numberOfPixelsPerFrame() - Method in class org.chsrobotics.lib.hardware.ledStrip.SimpleLEDAnimation
 

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.
offset(int) - Method in class org.chsrobotics.lib.hardware.ledStrip.LEDAnimationFrame
Returns a new LEDAnimationFrame with each color offset (raised or lowered) in index by a given step.
onOptionSelected(T, T) - Method in interface org.chsrobotics.lib.telemetry.DashboardChooser.ValueUpdater
Called when a new option has been selected in the dashboard
ORANGE - Static variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
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.hardware.ledStrip - package org.chsrobotics.lib.hardware.ledStrip
 
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.math.geometry - package org.chsrobotics.lib.math.geometry
 
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

periodic(SRobot.RobotState) - Method in class org.chsrobotics.lib.util.SRobot
Override this method and put your own logic here!
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 and an infinite integration window.
PID(double, double, double, int, double) - Constructor for class org.chsrobotics.lib.controllers.PID
Constructs a PID with given gains and a finite integration window.
PID(PID.PIDConstants, double) - Constructor for class org.chsrobotics.lib.controllers.PID
Constructs a PID with a given PIDConstants and an infinite integration window.
PID(PID.PIDConstants, int, double) - Constructor for class org.chsrobotics.lib.controllers.PID
Constructs a PID with a given PIDConstants and a finite integration window.
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.
pointLiesWithin(Vector2D) - Method in class org.chsrobotics.lib.math.geometry.Polygon
Returns whether a point is inside (not on the edge of) a polygon.
pointOn(Vector2D) - Method in class org.chsrobotics.lib.math.geometry.Line2D
Returns whether a point lies upon the line.
Polygon - Class in org.chsrobotics.lib.math.geometry
Represents a closed shape with a definite number of sides in 2-dimensional space.
Polygon(Vector2D...) - Constructor for class org.chsrobotics.lib.math.geometry.Polygon
Constructs a Polygon.
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) - Method in class org.chsrobotics.lib.telemetry.HighLevelLogger
Publishes a Sendable object to NetworkTables.
push(T) - Method in class org.chsrobotics.lib.util.SizedStack
 

Q

quadraticZeros(double, double, double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Finds the zeros (x-intercepts) of a quadratic (second- or lower-order polynomial) function of the form y(x) = ax^2 + bx + c.

R

r - Variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
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.
RED - Static variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
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.ComposedFeedbackController
 
reset() - Method in interface org.chsrobotics.lib.controllers.FeedbackController
Resets the controller.
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.ComposedFilter
 
reset() - Method in class org.chsrobotics.lib.math.filters.DifferentiatingFilter
Resets the history of the filter.
reset() - Method in class org.chsrobotics.lib.math.filters.ExponentialMovingAverage
 
reset() - Method in class org.chsrobotics.lib.math.filters.Filter
Resets the history of the filter.
reset() - Method in class org.chsrobotics.lib.math.filters.IntegratingFilter
 
reset() - Method in class org.chsrobotics.lib.math.filters.MovingAverageFilter
 
reset() - Method in class org.chsrobotics.lib.math.filters.NullFilter
 
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.PID
Resets accumulation of past error in the integral term.
resetPreviousMeasurement() - Method in class org.chsrobotics.lib.controllers.PID
Resets the previous measurement used for velocity approximation for the derivative term.
RGBColor - Class in org.chsrobotics.lib.hardware.ledStrip
Represents a color in Red-Green-Blue space, with methods for manipulating said color.
RGBColor(int, int, int) - Constructor for class org.chsrobotics.lib.hardware.ledStrip.RGBColor
Constructs an RGBColor.
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.
root(double, int) - Static method in class org.chsrobotics.lib.math.UtilityMath
Calculates a higher order root of a number.
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

scalarDivide(double) - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Divides the vector by a scalar.
scalarMultiply(double) - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Multiplies the vector by a scalar.
scalarMultiply(Filter, double) - Static method in class org.chsrobotics.lib.math.filters.Filter
Returns a new filter of the outputs of a filter multiplied by a scalar.
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.
sec(double) - Static method in class org.chsrobotics.lib.math.UtilityMath
Takes the trigonometric secant of an angle.
secondValue() - Method in class org.chsrobotics.lib.util.Tuple2
Returns the seond value of the tuple.
setAnimation(LEDAnimation) - Method in class org.chsrobotics.lib.hardware.ledStrip.LEDStrip
Sets the currently displayed LEDAnimation.
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.PID
Sets the gains of the controller using a provided PIDConstants.
setFrame(LEDAnimationFrame) - Method in class org.chsrobotics.lib.hardware.ledStrip.LEDStrip
Sets the currently displayed LEDAnimation to an animation consisting of only a given frame.
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.
setkI(double) - Method in class org.chsrobotics.lib.controllers.PID
Sets the integral gain of the controller.
setkP(double) - Method in class org.chsrobotics.lib.controllers.PID
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.
setMaxAbsControlEffort(double) - Method in class org.chsrobotics.lib.controllers.PID
Sets a new value to use to constrain the maximum absolute control effort from the controller.
setMaxAbsIContribution(double) - Method in class org.chsrobotics.lib.controllers.PID
Sets a new value to use to constrain the maximum absolute contribution from the Integral term of the controller.
setMaxAbsPContribution(double) - Method in class org.chsrobotics.lib.controllers.PID
Sets a new value to use to constrain the maximum absolute contribution from the Proportional term of the controller.
setMaxDContribution(double) - Method in class org.chsrobotics.lib.controllers.PID
Sets a new value to use to constrain the maximum absolute contribution from the Derivative term of the controller.
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.ComposedFeedbackController
 
setSetpoint(double) - Method in interface org.chsrobotics.lib.controllers.FeedbackController
Sets the setpoint (target) of the controller.
setSetpoint(double) - Method in class org.chsrobotics.lib.controllers.PID
 
setSetpointTolerance(double, double) - Method in class org.chsrobotics.lib.controllers.ComposedFeedbackController
 
setSetpointTolerance(double, double) - Method in interface org.chsrobotics.lib.controllers.FeedbackController
Sets the maximum error of both position and velocity allowed for atSetpoint() 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.
SimpleLEDAnimation - Class in org.chsrobotics.lib.hardware.ledStrip
Wraps around an array of LEDAnimationFrames, intended for playing back in sequence.
SimpleLEDAnimation(LEDAnimationFrame...) - Constructor for class org.chsrobotics.lib.hardware.ledStrip.SimpleLEDAnimation
Constructs a new SimpleLEDAnimation.
SizedStack<T> - Class in org.chsrobotics.lib.util
Extension of a Last-In-First-Out stack which has a cap to the number of stored items.
SizedStack(int) - Constructor for class org.chsrobotics.lib.util.SizedStack
Constructs a SizedStack.
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.
smear(double, RGBColor) - Method in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
Interpolates a new color somewhere between this color and another.
SRobot - Class in org.chsrobotics.lib.util
"SpartanRobot"
SRobot() - Constructor for class org.chsrobotics.lib.util.SRobot
 
SRobot.RobotState - Enum Class in org.chsrobotics.lib.util
Enum of possible DriverStation robot control states.
start() - Method in class org.chsrobotics.lib.util.SRobot
Call this method to start robot code execution.
startButton() - Method in class org.chsrobotics.lib.input.XboxController
Returns the JoystickButton cooresponding to the start button on the controller.
startLogging() - 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.
stateTransition(SRobot.RobotState, SRobot.RobotState) - Method in class org.chsrobotics.lib.util.SRobot
Override this method and put your own logic here!
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.
subtract(Vector3D) - Method in class org.chsrobotics.lib.math.geometry.Vector3D
Subtracts two vectors.

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.
TELEOPERATED - Enum constant in enum class org.chsrobotics.lib.util.SRobot.RobotState
 
TEST - Enum constant in enum class org.chsrobotics.lib.util.SRobot.RobotState
 
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.
toNewSize(int) - Method in class org.chsrobotics.lib.hardware.ledStrip.LEDAnimationFrame
Returns a new LEDAnimationFrame based off of this frame, but at a different size.
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.hardware.ledStrip.RGBColor
 
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.math.geometry.Vector3D
 
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() - Method in class org.chsrobotics.lib.hardware.ledStrip.LEDStrip
Advances to the next step of the animation.
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.
updateLogs() - Method in class org.chsrobotics.lib.controllers.PID
 
updateLogs() - Method in class org.chsrobotics.lib.telemetry.HighLevelLogger
 
updateLogs() - Method in interface org.chsrobotics.lib.telemetry.IntrinsicLoggable
Updates the internally generated Loggers.
UtilityMath - Class in org.chsrobotics.lib.math
Various useful small math functions.
UtilityMath() - Constructor for class org.chsrobotics.lib.math.UtilityMath
 

V

valueOf(String) - Static method in enum class org.chsrobotics.lib.math.filters.MovingAverageFilter.MEAN_IMPLEMENTATION
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.chsrobotics.lib.util.SRobot.RobotState
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.chsrobotics.lib.math.filters.MovingAverageFilter.MEAN_IMPLEMENTATION
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.chsrobotics.lib.util.SRobot.RobotState
Returns an array containing the constants of this enum class, in the order they are declared.
Vector1D - Class in org.chsrobotics.lib.math.geometry
Special case of a Vector3D in one dimension.
Vector1D(double) - Constructor for class org.chsrobotics.lib.math.geometry.Vector1D
Constructs a 1-dimensional vector.
Vector2D - Class in org.chsrobotics.lib.math.geometry
Special case of a Vector3D in two dimensions.
Vector2D(double, double) - Constructor for class org.chsrobotics.lib.math.geometry.Vector2D
Constructs a 2-dimensional vector.
Vector3D - Class in org.chsrobotics.lib.math.geometry
Represents a 3-dimensional vector in a right-handed system.
Vector3D(double, double, double) - Constructor for class org.chsrobotics.lib.math.geometry.Vector3D
Constructs a 3-dimensional vector.
velocity - Variable in class org.chsrobotics.lib.trajectory.MotionProfile.State
 
VIOLET - Static variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
VirtualJoystickButton - Class in org.chsrobotics.lib.input
Class to mock a joystick button from a hardware joystick axis.
VirtualJoystickButton(EventLoop, JoystickAxis, double, double, boolean) - Constructor for class org.chsrobotics.lib.input.VirtualJoystickButton
Constructs a VirtualJoystickButton.
VirtualJoystickButton(JoystickAxis, double, double, boolean) - Constructor for class org.chsrobotics.lib.input.VirtualJoystickButton
Constructs a VirtualJoystickButton, using the default CommandScheduler polling.

W

WHITE - Static variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 

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, using the default CommandScheduler event loop.
XboxController(EventLoop, 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.
YELLOW - Static variable in class org.chsrobotics.lib.hardware.ledStrip.RGBColor
 
A B C D E F G H I J L M N O P Q R S T U V W X Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form