A C D E F G H I K L M N P R S T U V W Y Z
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ALMOST_ZERO - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- assertEquals(String, Object, Object) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Tests the equality of two values, then prints and returns the result.
C
- calculateNextMovements() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Calculates the target velocity of the robot, and the magnitude of any turn that it needs to take, all based on the current position of the robot.
- calculateOutput(int, double, double) - Method in interface frc.robot.util.hyperdrive.emulation.IController
-
Uses the specified controller to calculate the necessary percent output to acheive a value.
- calculateOutput(int, double, double) - Method in class frc.robot.util.hyperdrive.emulation.TankController
- calculateTrajectory(Point2D) - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Calculates the trajectory that the robot needs to take in order for it to stay on course with the Path that it is currently running.
- CENTIMETERS - frc.robot.util.hyperdrive.util.Units.LENGTH
- closeFile() - Method in class frc.robot.util.hyperdrive.recording.PathRecorder
-
Closes the path file after recording.
- closestToZero(double[]) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Returns the number in the set that is closest to zero.
- ConstantEmulationParams - Class in frc.robot.util.hyperdrive.emulation
-
A set of parameters that Hyperdrive will use to drive the robot through a path.
- ConstantEmulationParams(double, double, double, double, double, double, int, int, PIDFAConfig) - Constructor for class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
-
Creates a new ConstantEmulationParams, describing the parameters that are to be followed as the robot emulates a
Path
. - controller - Variable in class frc.robot.util.hyperdrive.emulation.Trajectory
- convertDistance(double, Units.LENGTH, Units.LENGTH) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Converts a measurement between units of length.
- convertForce(double, Units.FORCE, Units.FORCE) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Converts a force value between units.
- convertTime(double, Units.TIME, Units.TIME) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Converts a value between units of time.
- convertTime(Units.TIME) - Method in class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Converts the velocities to a specified unit of time.
D
- DECASECONDS - frc.robot.util.hyperdrive.util.Units.TIME
-
The common time unit for CTRE motor controllers.
- DEFAULT_COEFFICIENT_OF_STATIC_FRICTION - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- DEFAULT_IMMEDIATE_PATH_SIZE - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- DEFAULT_MAX_SPEED_IPS - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- DEFAULT_MIN_SPEED_IPS - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- DEFAULT_OVERTURN - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- DEFAULT_POINT_SKIP_COUNT - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- DEFAULT_POSITIONAL_CORRECT_DISTANCE - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- DEFAULT_POSITIONAL_CORRECT_INHIBITOR - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- DIRECTORY_REQUEST - frc.robot.util.hyperdrive.pathvisualizer.MessageType
- distance - Variable in class frc.robot.util.hyperdrive.emulation.Trajectory
- DriveStyle - Enum in frc.robot.util.hyperdrive.enumeration
-
Documents the type of robot being driven.
E
- EMULATE_MAX_HEADING_TO_TURN_DIFFERENCE - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- EMULATE_POINT_PASS_LIMIT - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- end() - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Frees up resources used by the PathEmulator during path emulation.
- END_SEQUENCE - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
F
- FALCON500 - Static variable in class frc.robot.util.hyperdrive.simulator.SimulatedMotor
- FEET - frc.robot.util.hyperdrive.util.Units.LENGTH
- finishPath() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Frees up resources used while emulating the Path.
- flushFile() - Method in class frc.robot.util.hyperdrive.recording.PathRecorder
-
Forces the PathRecorder to update the path file.
- frc.robot.util.hyperdrive - package frc.robot.util.hyperdrive
- frc.robot.util.hyperdrive.emulation - package frc.robot.util.hyperdrive.emulation
- frc.robot.util.hyperdrive.enumeration - package frc.robot.util.hyperdrive.enumeration
- frc.robot.util.hyperdrive.pathvisualizer - package frc.robot.util.hyperdrive.pathvisualizer
- frc.robot.util.hyperdrive.recording - package frc.robot.util.hyperdrive.recording
- frc.robot.util.hyperdrive.simulator - package frc.robot.util.hyperdrive.simulator
- frc.robot.util.hyperdrive.util - package frc.robot.util.hyperdrive.util
- fromString(String) - Static method in enum frc.robot.util.hyperdrive.pathvisualizer.MessageType
-
Returns a MessageType based on the contents of the code.
- fromString(String) - Static method in class frc.robot.util.hyperdrive.util.Point2D
-
Returns a Point2D from a given String input - Expected Format: [x],[y],[heading]
G
- getAccel() - Method in class frc.robot.util.hyperdrive.util.PIDFAConfig
-
Returns the maximum acceleration of the robot at full throttle.
- getAndSetDouble(String, double) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
- getAngleToHeading(double, double) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Gets the angle that the robot needs to turn through to achieve a heading.
- getCode() - Method in enum frc.robot.util.hyperdrive.pathvisualizer.MessageType
-
Gets the string code that represents the MessageType.
- getCoefficientOfStaticFriction() - Method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
- getCoefficientOfStaticFriction() - Method in interface frc.robot.util.hyperdrive.emulation.IEmulateParams
-
Returns the approximate coefficient of static friction between the robot's wheels, and the surface that it is driving on.
- getCoefficientOfStaticFriction() - Method in class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
- getController() - Method in class frc.robot.util.hyperdrive.emulation.Trajectory
-
Returns the controller that this Trajectory uses.
- getCurrentPoint() - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Returns the index of the current point that the robot is trying to achieve.
- getCurrentPoint() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Returns the index of the point in the
Path
that the robot is trying to emulate, that the robot is currently working to achieve. - getCurrentPositionAndHeading() - Method in class frc.robot.util.hyperdrive.simulator.SimulatedRobot
-
Returns the current position of the simulated robot.
- getDefaults(Units.LENGTH, PIDFAConfig) - Static method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
-
Returns the default values for robots to use, in whatever unit is supplied.
- getDistance() - Method in class frc.robot.util.hyperdrive.emulation.Trajectory
-
Returns the distance that the robot will cover while moving through the trajectory.
- getDistanceFrom(Point2D) - Method in class frc.robot.util.hyperdrive.util.Point2D
-
Returns the distance from the given point.
- getDrivenPath() - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Returns the
Path
that the robot just took while trying to drive the path supplied to this class. - getFilePath() - Method in class frc.robot.util.hyperdrive.recording.PathRecorder
-
Returns the absolute file path of the Path that the PathRecorder is writing to.
- getFilesInDirectory(String, boolean) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Returns a list of files.
- getGyro() - Method in class frc.robot.util.hyperdrive.simulator.SimulatedRobot
-
Returns the simulated robot's gyro.
- getHeading() - Method in class frc.robot.util.hyperdrive.util.Point2D
-
Returns the heading of the point.
- getHeading() - Method in class frc.robot.util.hyperdrive.util.TankGyro
-
Returns the heading of the robot, in degrees, as calculated using the drivetrain motor positions.
- getHeadingTo(Point2D) - Method in class frc.robot.util.hyperdrive.util.Point2D
-
Returns the heading needed to point at the passed point.
- getImmediatePathSize() - Method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
- getImmediatePathSize() - Method in interface frc.robot.util.hyperdrive.emulation.IEmulateParams
-
Gets the number of points ahead of the robot (after the skipped points) that will be looked at to determine the robot's upcoming turns.
- getImmediatePathSize() - Method in class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
- getIndex() - Method in enum frc.robot.util.hyperdrive.pathvisualizer.MessageType
-
Gets the index of the MessageType.
- getInitialTorque() - Method in class frc.robot.util.hyperdrive.simulator.SimulatedMotor
-
Returns the y-intercept of the torque vs.
- getkD() - Method in class frc.robot.util.hyperdrive.util.PIDFAConfig
-
Returns the kD value of this PIDFAConfig.
- getkF() - Method in class frc.robot.util.hyperdrive.util.PIDFAConfig
-
Returns the kF value of this PIDFAConfig.
- getkI() - Method in class frc.robot.util.hyperdrive.util.PIDFAConfig
-
Returns the kI value of this PIDFAConfig.
- getkP() - Method in class frc.robot.util.hyperdrive.util.PIDFAConfig
-
Returns the kP (proportional gain) value of this PIDFAConfig.
- getLeftPercentOutput(double) - Method in class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Calculates percent output of the left wheels needed to continue driving the path at this point.
- getLeftVelocity() - Method in class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Returns the target velocity of the left drive wheels needed to stay on course with the path currently being driven.
- getLeftVelocity() - Method in class frc.robot.util.hyperdrive.simulator.SimulatedRobot
-
Returns the current left velocity of the robot.
- getLengthUnits() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Returns the units of length that the Hyperdrive has been configured to use.
- getMaximumOutput() - Method in class frc.robot.util.hyperdrive.util.PIDFAConfig
-
Returns the maximum allowed output of the robot.
- getMaximumSpeed() - Method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
- getMaximumSpeed() - Method in interface frc.robot.util.hyperdrive.emulation.IEmulateParams
-
The maximum speed, in units PER SECOND that the robot can be going at any given time during the path emulation, and the speed that the robot will try to achieve during any straightaways.
- getMaximumSpeed() - Method in class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
- getMinimumOutput() - Method in class frc.robot.util.hyperdrive.util.PIDFAConfig
-
Returns the minimum allowed output of the robot.
- getMinimumSpeed() - Method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
- getMinimumSpeed() - Method in interface frc.robot.util.hyperdrive.emulation.IEmulateParams
-
The minimum speed, in units PER SECOND that the robot can be going at any given time during the path emulation.
- getMinimumSpeed() - Method in class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
- getMotorUnitsPerUnit() - Method in class frc.robot.util.hyperdrive.emulation.Trajectory
-
Returns the units per unit value that was passed into the constructor.
- getOverturn() - Method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
- getOverturn() - Method in interface frc.robot.util.hyperdrive.emulation.IEmulateParams
-
Can also be called a turn inhibitor.
- getOverturn() - Method in class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
- getParameters() - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Returns the
IEmulateParams
That are currently being used to make the robot drive its path. - getParameters() - Method in class frc.robot.util.hyperdrive.emulation.Trajectory
-
Returns the parameters that this Trajectory uses.
- getPath() - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Returns the
Path
that the robot is currently running. - getPIDController(int) - Method in interface frc.robot.util.hyperdrive.emulation.IController
-
Returns the PIDController with the given name.
- getPIDController(int) - Method in class frc.robot.util.hyperdrive.emulation.TankController
- getPIDFAConfig() - Method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
- getPIDFAConfig() - Method in interface frc.robot.util.hyperdrive.emulation.IEmulateParams
-
Gets the robots PIDFA configuration, which contains the user-configurable kP, kI, kD, kF and acceleration values necessary to figure out what percent output to drive the motors at.
- getPIDFAConfig() - Method in class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
- getPoints() - Method in class frc.robot.util.hyperdrive.util.Path
-
Returns the Path's points.
- getPointSkipCount() - Method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
- getPointSkipCount() - Method in interface frc.robot.util.hyperdrive.emulation.IEmulateParams
-
Returns the number of points that are directly ahead of the robot that will be skipped by the path emulation algorithm.
- getPointSkipCount() - Method in class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
- getPositionalCorrectionDistance() - Method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
- getPositionalCorrectionDistance() - Method in interface frc.robot.util.hyperdrive.emulation.IEmulateParams
-
Returns the minimum distance from the path that the robot must have in order to start correcting its position.
- getPositionalCorrectionDistance() - Method in class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
- getPositionalCorrectionInhibitor() - Method in class frc.robot.util.hyperdrive.emulation.ConstantEmulationParams
- getPositionalCorrectionInhibitor() - Method in interface frc.robot.util.hyperdrive.emulation.IEmulateParams
-
Returns the inhibitor for the robot's positional correction.
- getPositionalCorrectionInhibitor() - Method in class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
- getPositionAndHeading() - Method in class frc.robot.util.hyperdrive.util.PositionTracker
-
Returns the current position and heading of the robot.
- getRawLeftVelocity() - Method in class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Returns the value of the left velocity in its original distance units per second.
- getRawRightVelocity() - Method in class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Returns the value of the right velocity in its original distance units per second.
- getRecordedPath() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Returns the
Path
that the Path Recorder has just recorded. - getRightPercentOutput(double) - Method in class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Calculates the percent output of the right wheels needed to continue driving the path at this point.
- getRightVelocity() - Method in class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Returns the target velocity of the right drive wheels in order to stay on course with the path currently being driven.This value is returned in the raw motor controller units (assuming that a call to
TankTrajectory.convertTime(frc.robot.util.hyperdrive.util.Units.TIME)
was made with the right time unit), so the target velocity of the motors can be directly set to this value. - getRightVelocity() - Method in class frc.robot.util.hyperdrive.simulator.SimulatedRobot
-
Returns the current right velocity of the robot.
- getRobotPositionAndHeading() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Returns the current position and heading of the robot in field space.
- getTankTrajectory(double) - Method in class frc.robot.util.hyperdrive.emulation.Trajectory
-
Returns the trajectory information in a format that can drive tank-style robots.
- getTorqueCurveSlope() - Method in class frc.robot.util.hyperdrive.simulator.SimulatedMotor
-
Returns the slope of the empirical torque vs.
- getTotalPoints() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Returns the number of points that are present in the
Path
that the robot is current emulating. - getTurn() - Method in class frc.robot.util.hyperdrive.emulation.Trajectory
-
Returns the angular displacment, in radians, of the robot as it moves through the trajectory.
- getVelocity() - Method in class frc.robot.util.hyperdrive.emulation.Trajectory
-
Returns the target velocity of the robot as it goes through this trajectory.
- getX() - Method in class frc.robot.util.hyperdrive.util.Point2D
-
Returns the X-coordinate of the point.
- getY() - Method in class frc.robot.util.hyperdrive.util.Point2D
-
Returns the Y-coordinate of the point.
H
- Hyperdrive - Class in frc.robot.util.hyperdrive
-
A tool for autonomously driving the robot around.
- Hyperdrive(DriveStyle, Units.LENGTH, double) - Constructor for class frc.robot.util.hyperdrive.Hyperdrive
-
Creates a new Hyperdrive, using the default robot weight, 125 pounds, and PathVisualizer port, 3695.
- Hyperdrive(DriveStyle, Units.LENGTH, double, Units.FORCE, double) - Constructor for class frc.robot.util.hyperdrive.Hyperdrive
-
Creates a new Hyperdrive, using the default PathVisualizer port, 3695.
- Hyperdrive(DriveStyle, Units.LENGTH, double, Units.FORCE, double, int) - Constructor for class frc.robot.util.hyperdrive.Hyperdrive
-
Creates a new Hyperdrive.
- HyperdriveConstants - Class in frc.robot.util.hyperdrive
-
This class stores constants (public static final) that are used by Hyperdrive.
- HyperdriveUtil - Class in frc.robot.util.hyperdrive.util
-
This class is similar to Utilities in Monopoly, because similarly to the fact that the Utilities are the worst property in Monopoly, this class is the worst in this library.
I
- IController - Interface in frc.robot.util.hyperdrive.emulation
-
Interface for objects containing multiple PID controllers and other important runtime parameters.
- IEmulateParams - Interface in frc.robot.util.hyperdrive.emulation
-
Parameters for the robot to use while driving through a Path.
- INCHES - frc.robot.util.hyperdrive.util.Units.LENGTH
- init() - Method in class frc.robot.util.hyperdrive.recording.PathRecorder
-
Opens the path file and prepares PathRecorder to write to it.
- initializeRecorder() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Declares, initializes, and starts the PathRecorder to record a driven Path.
- initializeRecorder(String) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Decalares, initalizes, and starts the PathRecorder to record a driven Path.
- INTERNAL_FRICTION_ACCELERATION - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- invertDirection() - Method in class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Inverts the direction of the robot as it drives through a path.
- invertTurn() - Method in class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Inverts the turn that the robot takes during the Path.
- isFinished() - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Returns whether or not the robot has completed the Path.
- isLoaded() - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Determines whether or not this PathEmulator has both a path and parameters to do trajectory calculations with.
- isValid() - Method in class frc.robot.util.hyperdrive.util.Path
-
Returns true if this Path was initalized correctly, false otherwise.
K
- KILOGRAM_FORCE - frc.robot.util.hyperdrive.util.Units.FORCE
L
- LEFT_CONTROLLER - Static variable in class frc.robot.util.hyperdrive.emulation.TankController
- load(Path, IEmulateParams) - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Loads the PathEmulator with the given
Path
andIEmulateParams
. - LOAD - frc.robot.util.hyperdrive.pathvisualizer.MessageType
- loadPath(Path, IEmulateParams) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Loads a
Path
for Hyperdrive to emulate. - loadPath(String, IEmulateParams) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Loads a
Path
for Hyperdrive to emulate from the given file path.
M
- massKGFromWeight(double, Units.FORCE) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Calculates the mass of an object, in kilograms, from its weight.
- MessageType - Enum in frc.robot.util.hyperdrive.pathvisualizer
-
Describes a message that the robot receives from PathVisualizer
- METERS - frc.robot.util.hyperdrive.util.Units.LENGTH
- MINUTES - frc.robot.util.hyperdrive.util.Units.TIME
-
The common time unit in REV motor controllers.
- motorUnitsPerUnit - Variable in class frc.robot.util.hyperdrive.emulation.Trajectory
N
- NEO - Static variable in class frc.robot.util.hyperdrive.simulator.SimulatedMotor
- NEWTON - frc.robot.util.hyperdrive.util.Units.FORCE
P
- parameters - Variable in class frc.robot.util.hyperdrive.emulation.Trajectory
- Path - Class in frc.robot.util.hyperdrive.util
-
Represents a Path that can be driven by the robot.
- Path(Point2D[]) - Constructor for class frc.robot.util.hyperdrive.util.Path
-
Creates a new Path.
- Path(String) - Constructor for class frc.robot.util.hyperdrive.util.Path
-
Creates a new path from the given file path.
- PATH - frc.robot.util.hyperdrive.pathvisualizer.MessageType
- PATH_EMULATOR_DEFAULT_RESULTS_PATH - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- PATH_RECORDER_DEFAULT_RECORD_PATH - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- PATH_RECORDER_DISTANCE_INTERVAL - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- PathEmulator - Class in frc.robot.util.hyperdrive.emulation
-
Big brain that does the path trajectory calculations.
- PathEmulator(DriveStyle, double, Units.LENGTH, double, Units.FORCE) - Constructor for class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Creates an empty PathEmulator.
- PathEmulator(DriveStyle, double, Units.LENGTH, double, Units.FORCE, Path, IEmulateParams) - Constructor for class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Creates a new PathEmulator that is pre-loaded with the given
Path
andIEmulateParams
. - pathFinished() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Returns true if Hyperdrive is done driving the robot through a Path, and false otherwise.
- PathRecorder - Class in frc.robot.util.hyperdrive.recording
-
A utility for recording paths.
- PathRecorder(String, Units.LENGTH) - Constructor for class frc.robot.util.hyperdrive.recording.PathRecorder
-
Creates a new PathRecorder writing to the given file.
- performInitialCalculations() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Makes the emulator perform some calculations that must take place in order for the path to be driven to the best of Hyperdrive's ability.
- performInitialCalculations(Point2D) - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Performs calculations that are required for Hyperdrive to drive a path to the best of its ability.
- PIDFAConfig - Class in frc.robot.util.hyperdrive.util
-
Represents a PIDF configuration with maximum acceleration
- PIDFAConfig(double, double, double, double, double, double, double) - Constructor for class frc.robot.util.hyperdrive.util.PIDFAConfig
-
Creates a new PIDFAConfig.
- Point2D - Class in frc.robot.util.hyperdrive.util
-
Simple class structure that holds a point in the XY plane.
- Point2D(double, double, double) - Constructor for class frc.robot.util.hyperdrive.util.Point2D
-
Creates a new Point2D.
- POSITION - frc.robot.util.hyperdrive.pathvisualizer.MessageType
- PositionTracker - Class in frc.robot.util.hyperdrive.util
-
A class that tracks the position of the robot in field space.
- PositionTracker(double) - Constructor for class frc.robot.util.hyperdrive.util.PositionTracker
-
Creates a new Position tracker, with starting position and rotation at 0.
- PositionTracker(double, double, double, double) - Constructor for class frc.robot.util.hyperdrive.util.PositionTracker
-
Creates a new PositionTracker.
- POUND - frc.robot.util.hyperdrive.util.Units.FORCE
- PreferenceEmulationParams - Class in frc.robot.util.hyperdrive.emulation
-
A class that uses the Preferences table on the dashboard to determine a path's emulation parameters.
- PreferenceEmulationParams(Units.LENGTH) - Constructor for class frc.robot.util.hyperdrive.emulation.PreferenceEmulationParams
-
Creates a new PreferenceEmulationParams.
- PVHost - Class in frc.robot.util.hyperdrive.pathvisualizer
-
Robot code host for the PathVisualizer application.
- PVHost(int) - Constructor for class frc.robot.util.hyperdrive.pathvisualizer.PVHost
-
Creates a new PVHost.
R
- recordPoint(Point2D) - Method in class frc.robot.util.hyperdrive.recording.PathRecorder
-
Updates the PathRecorder with the current robot position.
- RIGHT_CONTROLLER - Static variable in class frc.robot.util.hyperdrive.emulation.TankController
- roundTo(double, int) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Really stupid but needed to round a double to n places
S
- SAVE - frc.robot.util.hyperdrive.pathvisualizer.MessageType
- SECONDS - frc.robot.util.hyperdrive.util.Units.TIME
-
Regular, human-readable time.
- sendPath(Path, String) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Sends a
Path
to the PathVisualizer client, if there is one. - sendPath(Path, String) - Method in class frc.robot.util.hyperdrive.pathvisualizer.PVHost
-
Sends a path to the PathVisualizer client for viewing.
- setCurrentPositionAndHeading(Point2D) - Method in class frc.robot.util.hyperdrive.simulator.SimulatedRobot
-
Sets the position and heading of the simulated robot.
- setHeading(double) - Method in class frc.robot.util.hyperdrive.util.TankGyro
-
Sets the heading of the TankGyro.
- setInverted(boolean) - Method in class frc.robot.util.hyperdrive.util.TankGyro
-
Inverts (or un-inverts) the gyro.
- setPositionAndHeading(double, double, double) - Method in class frc.robot.util.hyperdrive.util.PositionTracker
-
Sets the position and heading of the robot.
- setPositionAndHeading(Point2D) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Sets the position and heading of the robot.
- setPositionAndHeading(Point2D) - Method in class frc.robot.util.hyperdrive.util.PositionTracker
-
Sets the position and heading of the robot.
- SimulatedMotor - Class in frc.robot.util.hyperdrive.simulator
-
Represents a simulated motor
- SimulatedMotor(double, double) - Constructor for class frc.robot.util.hyperdrive.simulator.SimulatedMotor
-
Creates a new SimulatedMotor.
- SimulatedRobot - Class in frc.robot.util.hyperdrive.simulator
-
Keeps information about the robot's configuration.
- SimulatedRobot(SimulatedMotor, double, double, double, double, Units.FORCE) - Constructor for class frc.robot.util.hyperdrive.simulator.SimulatedRobot
-
Creates a new SimulatedRobot.
- SimulatedRobot(SimulatedMotor, int, double, double, double, double, Units.FORCE, double) - Constructor for class frc.robot.util.hyperdrive.simulator.SimulatedRobot
-
Creates a new SimulatedRobot.
- SOCKET_BUFFER_SIZE - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- specifyResultsFile(String) - Method in class frc.robot.util.hyperdrive.emulation.PathEmulator
-
Changes the location of the file where results are stored.
- specifyResultsFile(String) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Forces Hyperdrive to record the results of the driven path to the file location provided.
- SPLIT_SEQUENCE - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- START_SEQUENCE - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
- stopRecorder() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Stops the Path Recorder if it is currently active.
- SUBJECT_SEQUENCE - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
T
- TANK - frc.robot.util.hyperdrive.enumeration.DriveStyle
- TankController - Class in frc.robot.util.hyperdrive.emulation
-
Controller for tank-style robot.
- TankController(IEmulateParams) - Constructor for class frc.robot.util.hyperdrive.emulation.TankController
- TankGyro - Class in frc.robot.util.hyperdrive.util
-
A class that calculates the heading of a tank-style robot using only the drivetrain encoders.
- TankGyro(double, double) - Constructor for class frc.robot.util.hyperdrive.util.TankGyro
-
Creates a new TankGyro, initializing the left and right positions to be 0, and
inverted
asfalse
. - TankGyro(double, double, boolean) - Constructor for class frc.robot.util.hyperdrive.util.TankGyro
-
Creates a new TankGyro, initializing the left and right positions to be 0.
- TankGyro(double, double, boolean, double, double) - Constructor for class frc.robot.util.hyperdrive.util.TankGyro
-
Creates a new TankGyro.
- TankTrajectory - Class in frc.robot.util.hyperdrive.emulation
-
Represents the trajectory of a tank-style robot as it moves through a Path.
- TankTrajectory(Trajectory, double) - Constructor for class frc.robot.util.hyperdrive.emulation.TankTrajectory
-
Creates a new
TankTrajectory
using the data found in the given Trajectory. - toCommonUnits(double) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Converts a measurement made in motor units (ticks, revolutions, etc) to common units (inches, meters, etc) using the motorUnitsPerUnit measurement provided by the constructor.
- toMotorUnits(double) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Converts a measurement made in common units (inches, meters, etc) to motor units (ticks, revolutions, etc), using the motorUnitsPerUnit measurement provided by the Hyperdrive constructor.
- toString() - Method in class frc.robot.util.hyperdrive.util.Path
-
Converts the Path into a user (and computer) readable String.
- toString() - Method in class frc.robot.util.hyperdrive.util.Point2D
-
Returns a representation of this point in String format.
- Trajectory - Class in frc.robot.util.hyperdrive.emulation
-
Represents the desired path of movement of the robot at any point while driving through a path.
- Trajectory(double, double, double, IEmulateParams, IController, double) - Constructor for class frc.robot.util.hyperdrive.emulation.Trajectory
-
Creates a new Trajectory, defining that the robot should drive at the given velocity for a certain distance ahead, while turning to the angular displacement given by turnAhead.
- Trajectory(Trajectory) - Constructor for class frc.robot.util.hyperdrive.emulation.Trajectory
-
Creates a new Trajectory, copying the specified Trajectory
- turn - Variable in class frc.robot.util.hyperdrive.emulation.Trajectory
U
- Units - Class in frc.robot.util.hyperdrive.util
-
Describes a unit of measurement of length, time, and force.
- Units() - Constructor for class frc.robot.util.hyperdrive.util.Units
- Units.FORCE - Enum in frc.robot.util.hyperdrive.util
-
Describes units of force or weight.
- Units.LENGTH - Enum in frc.robot.util.hyperdrive.util
-
Describes units of length or distance.
- Units.TIME - Enum in frc.robot.util.hyperdrive.util
-
Describes units of time.
- UNKNOWN - frc.robot.util.hyperdrive.pathvisualizer.MessageType
- update(double, double) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Updates the Hyperdrive.
- update(double, double) - Method in class frc.robot.util.hyperdrive.util.PositionTracker
-
Updates the position of the robot using a distance travelled and heading travelled in.
- update(double, double) - Method in class frc.robot.util.hyperdrive.util.TankGyro
-
Updates the heading of the robot based on the positions of the drivetrain motors.
- update(double, double, double) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Updates the Hyperdrive.
- update(double, double, double) - Method in class frc.robot.util.hyperdrive.simulator.SimulatedRobot
-
Calculates the new position of the robot if it was driven for a certain time interval.
- update(Point2D) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Updates the Hyperdrive using a manual position.
- update(Point2D) - Method in class frc.robot.util.hyperdrive.pathvisualizer.PVHost
-
Sends the specified robot position to the PathVisualizer client.
- USE_CHORD_BASED_TRACKING - Static variable in class frc.robot.util.hyperdrive.HyperdriveConstants
V
- valueOf(String) - Static method in enum frc.robot.util.hyperdrive.enumeration.DriveStyle
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum frc.robot.util.hyperdrive.pathvisualizer.MessageType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum frc.robot.util.hyperdrive.util.Units.FORCE
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum frc.robot.util.hyperdrive.util.Units.LENGTH
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum frc.robot.util.hyperdrive.util.Units.TIME
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum frc.robot.util.hyperdrive.enumeration.DriveStyle
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum frc.robot.util.hyperdrive.pathvisualizer.MessageType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum frc.robot.util.hyperdrive.util.Units.FORCE
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum frc.robot.util.hyperdrive.util.Units.LENGTH
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum frc.robot.util.hyperdrive.util.Units.TIME
-
Returns an array containing the constants of this enum type, in the order they are declared.
- velocity - Variable in class frc.robot.util.hyperdrive.emulation.Trajectory
W
- weightFromMassKG(double, Units.FORCE) - Static method in class frc.robot.util.hyperdrive.util.HyperdriveUtil
-
Calculates the weight of an object based on its mass.
Y
- YARDS - frc.robot.util.hyperdrive.util.Units.LENGTH
Z
- zeroHeading() - Method in class frc.robot.util.hyperdrive.util.TankGyro
-
Zeros the heading of the gyro, but does not wait for the drivetrain encoders to be zero.
- zeroHeading(boolean) - Method in class frc.robot.util.hyperdrive.util.TankGyro
-
Sets the heading of the TankGyro to 0.
- zeroPositionAndHeading() - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Sets the position and heading of the robot to 0.
- zeroPositionAndHeading() - Method in class frc.robot.util.hyperdrive.simulator.SimulatedRobot
-
Zeros the position and heading of the robot.
- zeroPositionAndHeading() - Method in class frc.robot.util.hyperdrive.util.PositionTracker
-
Zeroes the position and heading of the robot.
- zeroPositionAndHeading(boolean) - Method in class frc.robot.util.hyperdrive.Hyperdrive
-
Sets the position and heading of the robot to 0.
- zeroPositionAndHeading(boolean) - Method in class frc.robot.util.hyperdrive.util.PositionTracker
-
Zeroes the position and heading of the robot.
All Classes All Packages