mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-07-02 02:51:42 +00:00
Removed @author from comments (#88)
Keeping @author lines in the comments serves no functional purpose.
This commit is contained in:
committed by
Peter Johnson
parent
7a402b4170
commit
2f7eff7091
@@ -1,5 +1,4 @@
|
||||
//Auto Generated
|
||||
//@author Peter Mitrano <peter@osrfoundation.org>
|
||||
#ifndef _FRC_MSGS_H_
|
||||
#define _FRC_MSGS_H_
|
||||
|
||||
|
||||
@@ -16,9 +16,6 @@
|
||||
* in an analog voltage that corresponds to a position. The position is
|
||||
* in whichever units you choose, by way of the scaling and offset
|
||||
* constants passed to the constructor.
|
||||
*
|
||||
* @author Alex Henning
|
||||
* @author Colby Skeggs (rail voltage)
|
||||
*/
|
||||
class AnalogPotentiometer : public Potentiometer, public LiveWindowSendable {
|
||||
public:
|
||||
|
||||
@@ -15,7 +15,6 @@
|
||||
/**
|
||||
* Class for getting voltage, current, temperature, power and energy from the
|
||||
* CAN PDP.
|
||||
* @author Thomas Clark
|
||||
*/
|
||||
class PowerDistributionPanel : public SensorBase, public LiveWindowSendable {
|
||||
public:
|
||||
|
||||
@@ -21,8 +21,6 @@
|
||||
* Trigger objects. This is a simple wrapper around Trigger with the method
|
||||
* names
|
||||
* renamed to fit the Button object use.
|
||||
*
|
||||
* @author brad
|
||||
*/
|
||||
class Button : public Trigger {
|
||||
public:
|
||||
|
||||
@@ -26,8 +26,6 @@ class Command;
|
||||
* only have to write the {@link Trigger#Get()} method to get the full
|
||||
* functionality
|
||||
* of the Trigger class.
|
||||
*
|
||||
* @author Brad Miller, Joe Grinstead
|
||||
*/
|
||||
class Trigger : public Sendable {
|
||||
public:
|
||||
|
||||
@@ -31,8 +31,6 @@ struct LiveWindowComponent {
|
||||
* The LiveWindow class is the public interface for putting sensors and
|
||||
* actuators
|
||||
* on the LiveWindow.
|
||||
*
|
||||
* @author Brad Miller
|
||||
*/
|
||||
class LiveWindow {
|
||||
public:
|
||||
|
||||
@@ -11,8 +11,6 @@
|
||||
|
||||
/**
|
||||
* Live Window Sendable is a special type of object sendable to the live window.
|
||||
*
|
||||
* @author Patrick Plenefisch
|
||||
*/
|
||||
class LiveWindowSendable : public Sendable {
|
||||
public:
|
||||
|
||||
@@ -18,8 +18,6 @@
|
||||
* in an analog voltage that corresponds to a position. Usually the
|
||||
* position is either degrees or meters. However, if no conversion is
|
||||
* given it remains volts.
|
||||
*
|
||||
* @author Alex Henning
|
||||
*/
|
||||
class AnalogPotentiometer : public Potentiometer, public LiveWindowSendable {
|
||||
public:
|
||||
|
||||
@@ -38,7 +38,6 @@ static constexpr double kMotorTime = 0.5;
|
||||
/**
|
||||
* A fixture that includes a PWM speed controller and an encoder connected to
|
||||
* the same motor.
|
||||
* @author Thomas Clark
|
||||
*/
|
||||
class MotorEncoderTest : public testing::TestWithParam<MotorEncoderTestType> {
|
||||
protected:
|
||||
|
||||
@@ -26,7 +26,6 @@ static constexpr double kSensitivity = 0.013;
|
||||
|
||||
/**
|
||||
* A fixture for the camera with two servos and a gyro
|
||||
* @author Thomas Clark
|
||||
*/
|
||||
class TiltPanCameraTest : public testing::Test {
|
||||
protected:
|
||||
|
||||
@@ -20,8 +20,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
|
||||
/**
|
||||
* ADXL345 I2C Accelerometer.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
@SuppressWarnings("TypeName")
|
||||
public class ADXL345_I2C extends SensorBase implements Accelerometer, LiveWindowSendable {
|
||||
|
||||
@@ -20,9 +20,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
|
||||
/**
|
||||
* ADXL345 SPI Accelerometer.
|
||||
*
|
||||
* @author dtjones
|
||||
* @author mwills
|
||||
*/
|
||||
@SuppressWarnings({"TypeName"})
|
||||
public class ADXL345_SPI extends SensorBase implements Accelerometer, LiveWindowSendable {
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj;
|
||||
|
||||
/**
|
||||
* Structure for holding the values stored in an accumulator.
|
||||
*
|
||||
* @author brad
|
||||
*/
|
||||
public class AccumulatorResult {
|
||||
|
||||
|
||||
@@ -15,9 +15,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
* Class for reading analog potentiometers. Analog potentiometers read in an analog voltage that
|
||||
* corresponds to a position. The position is in whichever units you choose, by way of the scaling
|
||||
* and offset constants passed to the constructor.
|
||||
*
|
||||
* @author Alex Henning
|
||||
* @author Colby Skeggs (rail voltage)
|
||||
*/
|
||||
public class AnalogPotentiometer implements Potentiometer, LiveWindowSendable {
|
||||
private AnalogInput m_analogInput;
|
||||
|
||||
@@ -20,8 +20,6 @@ import static java.util.Objects.requireNonNull;
|
||||
|
||||
/**
|
||||
* Class for creating and configuring Analog Triggers.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class AnalogTrigger {
|
||||
|
||||
|
||||
@@ -112,8 +112,6 @@ public class AnalogTriggerOutput extends DigitalSource {
|
||||
|
||||
/**
|
||||
* Defines the state in which the AnalogTrigger triggers.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public enum AnalogTriggerType {
|
||||
kInWindow(AnalogJNI.AnalogTriggerType.kInWindow), kState(AnalogJNI.AnalogTriggerType.kState),
|
||||
|
||||
@@ -19,8 +19,6 @@ import edu.wpi.first.wpilibj.util.CheckedAllocationException;
|
||||
|
||||
/**
|
||||
* Texas Instruments Jaguar Speed Controller as a CAN device.
|
||||
*
|
||||
* @author Thomas Clark
|
||||
*/
|
||||
public class CANJaguar implements MotorSafety, PIDOutput, CANSpeedController {
|
||||
|
||||
|
||||
@@ -16,15 +16,12 @@ import edu.wpi.first.wpilibj.hal.InterruptJNI.InterruptJNIHandlerFunction;
|
||||
*
|
||||
* @param <T> The type of the parameter that should be returned to the the method {@link
|
||||
* #interruptFired(int, Object)}
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public abstract class InterruptHandlerFunction<T> {
|
||||
/**
|
||||
* The entry point for the interrupt. When the interrupt fires the {@link #apply(int, Object)}
|
||||
* method is called. The outer class is provided as an interface to allow the implementer to pass
|
||||
* a generic object to the interrupt fired method.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
private class Function implements InterruptJNIHandlerFunction {
|
||||
@SuppressWarnings("unchecked")
|
||||
|
||||
@@ -12,8 +12,6 @@ package edu.wpi.first.wpilibj;
|
||||
* Safety protocol. The helper object has the code to actually do the timing and call the motors
|
||||
* Stop() method when the timeout expires. The motor object is expected to call the Feed() method
|
||||
* whenever the motors value is updated.
|
||||
*
|
||||
* @author brad
|
||||
*/
|
||||
public final class MotorSafetyHelper {
|
||||
|
||||
|
||||
@@ -13,8 +13,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
|
||||
/**
|
||||
* Class for getting voltage, current, temperature, power and energy from the CAN PDP.
|
||||
*
|
||||
* @author Thomas Clark
|
||||
*/
|
||||
public class PowerDistributionPanel extends SensorBase implements LiveWindowSendable {
|
||||
|
||||
|
||||
@@ -28,8 +28,6 @@ import edu.wpi.first.wpilibj.tables.TableKeyNotDefinedException;
|
||||
*
|
||||
* <p> This will also interact with {@link NetworkTable} by creating a table called "Preferences"
|
||||
* with all the key-value pairs. </p>
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public class Preferences {
|
||||
|
||||
|
||||
@@ -16,8 +16,6 @@ import edu.wpi.first.wpilibj.hal.SPIJNI;
|
||||
|
||||
/**
|
||||
* Represents a SPI bus port.
|
||||
*
|
||||
* @author koconnor
|
||||
*/
|
||||
public class SPI extends SensorBase {
|
||||
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj;
|
||||
|
||||
/**
|
||||
* Manages a PWM object.
|
||||
*
|
||||
* @author brad
|
||||
*/
|
||||
public class SafePWM extends PWM implements MotorSafety {
|
||||
|
||||
|
||||
@@ -13,8 +13,6 @@ import edu.wpi.first.wpilibj.util.SortedVector;
|
||||
|
||||
/**
|
||||
* An image where each pixel is treated as either on or off.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class BinaryImage extends MonoImage {
|
||||
private int m_numParticles = -1;
|
||||
|
||||
@@ -11,8 +11,6 @@ import com.ni.vision.NIVision;
|
||||
|
||||
/**
|
||||
* A class representing a color image.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public abstract class ColorImage extends ImageBase {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ import com.ni.vision.NIVision;
|
||||
|
||||
/**
|
||||
* A color image represented in HSL color space at 3 bytes per pixel.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class HSLImage extends ColorImage {
|
||||
|
||||
|
||||
@@ -12,8 +12,6 @@ import com.ni.vision.NIVision.Image;
|
||||
|
||||
/**
|
||||
* Class representing a generic image.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public abstract class ImageBase {
|
||||
|
||||
|
||||
@@ -16,8 +16,6 @@ import com.ni.vision.NIVision.ShapeDetectionOptions;
|
||||
|
||||
/**
|
||||
* A grey scale image represented at a byte per pixel.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class MonoImage extends ImageBase {
|
||||
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj.image;
|
||||
|
||||
/**
|
||||
* Exception class which looks up nivision error codes.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
@SuppressWarnings("all")
|
||||
public class NIVisionException extends Exception {
|
||||
|
||||
@@ -11,8 +11,6 @@ import com.ni.vision.NIVision;
|
||||
|
||||
/**
|
||||
* Class to store commonly used information about a particle.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class ParticleAnalysisReport {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ import com.ni.vision.NIVision;
|
||||
|
||||
/**
|
||||
* A color image represented in RGB color space at 3 bytes per pixel.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class RGBImage extends ColorImage {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ package edu.wpi.first.wpilibj;
|
||||
* An interface for controllers. Controllers run control loops, the most command are PID controllers
|
||||
* and there variants, but this includes anything that is controlling an actuator in a separate
|
||||
* thread.
|
||||
*
|
||||
* @author alex
|
||||
*/
|
||||
interface Controller {
|
||||
/**
|
||||
|
||||
@@ -11,8 +11,6 @@ import edu.wpi.first.wpilibj.util.BaseSystemNotInitializedException;
|
||||
|
||||
/**
|
||||
* Support for high level usage reporting.
|
||||
*
|
||||
* @author alex
|
||||
*/
|
||||
@SuppressWarnings("JavadocMethod")
|
||||
public class HLUsageReporting {
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj;
|
||||
|
||||
/**
|
||||
* Shuts off motors when their outputs aren't updated often enough.
|
||||
*
|
||||
* @author brad
|
||||
*/
|
||||
public interface MotorSafety {
|
||||
double DEFAULT_SAFETY_EXPIRATION = 0.1;
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj;
|
||||
|
||||
/**
|
||||
* This interface allows PIDController to write it's results to its output.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface PIDOutput {
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj;
|
||||
|
||||
/**
|
||||
* This interface allows for PIDController to automatically read from this object.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public interface PIDSource {
|
||||
/**
|
||||
|
||||
@@ -18,8 +18,6 @@ import edu.wpi.first.wpilibj.command.Command;
|
||||
* <p>This class represents a subclass of Trigger that is specifically aimed at buttons on an
|
||||
* operator interface as a common use case of the more generalized Trigger objects. This is a simple
|
||||
* wrapper around Trigger with the method names renamed to fit the Button object use.
|
||||
*
|
||||
* @author brad
|
||||
*/
|
||||
public abstract class Button extends Trigger {
|
||||
|
||||
|
||||
@@ -10,8 +10,6 @@ package edu.wpi.first.wpilibj.buttons;
|
||||
/**
|
||||
* This class is intended to be used within a program. The programmer can manually set its value.
|
||||
* Also includes a setting for whether or not it should invert its value.
|
||||
*
|
||||
* @author Joe
|
||||
*/
|
||||
public class InternalButton extends Button {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ import edu.wpi.first.wpilibj.GenericHID;
|
||||
|
||||
/**
|
||||
* A {@link Button} that gets its state from a {@link GenericHID}.
|
||||
*
|
||||
* @author bradmiller
|
||||
*/
|
||||
public class JoystickButton extends Button {
|
||||
|
||||
|
||||
@@ -11,7 +11,6 @@ import edu.wpi.first.wpilibj.networktables.NetworkTable;
|
||||
|
||||
/**
|
||||
* A {@link Button} that uses a {@link NetworkTable} boolean field.
|
||||
* @author Joe
|
||||
*/
|
||||
public class NetworkButton extends Button {
|
||||
|
||||
|
||||
@@ -22,8 +22,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
* (for instance, if they want to react to the user holding a button while the robot is reading a
|
||||
* certain sensor input). For this, they only have to write the {@link Trigger#get()} method to get
|
||||
* the full functionality of the Trigger class.
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public abstract class Trigger implements Sendable {
|
||||
|
||||
|
||||
@@ -38,8 +38,6 @@ import edu.wpi.first.wpilibj.tables.ITableListener;
|
||||
* active command is not interruptible, the other one will not even be started, and the active one
|
||||
* will continue functioning.
|
||||
*
|
||||
* @author Brad Miller
|
||||
* @author Joe Grinstead
|
||||
* @see Subsystem
|
||||
* @see CommandGroup
|
||||
* @see IllegalUseOfCommandException
|
||||
|
||||
@@ -25,8 +25,6 @@ import java.util.Vector;
|
||||
* <p> CommandGroups can also execute commands in parallel, simply by adding them using {@link
|
||||
* CommandGroup#addParallel(Command) addParallel(...)}. </p>
|
||||
*
|
||||
* @author Brad Miller
|
||||
* @author Joe Grinstead
|
||||
* @see Command
|
||||
* @see Subsystem
|
||||
* @see IllegalUseOfCommandException
|
||||
|
||||
@@ -17,8 +17,6 @@ package edu.wpi.first.wpilibj.command;
|
||||
* <p> This exception should be thrown if (after a command has been locked) its requirements change,
|
||||
* it is put into multiple command groups, it is started from outside its command group, or it adds
|
||||
* a new child. </p>
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public class IllegalUseOfCommandException extends RuntimeException {
|
||||
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj.command;
|
||||
|
||||
/**
|
||||
* An element that is in a LinkedList.
|
||||
*
|
||||
* @author Greg
|
||||
*/
|
||||
class LinkedListElement {
|
||||
private LinkedListElement m_next;
|
||||
|
||||
@@ -20,8 +20,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
* <p> It provides some convenience methods to run an internal {@link PIDController} . It will also
|
||||
* start and stop said {@link PIDController} when the {@link PIDCommand} is first initialized and
|
||||
* ended/interrupted. </p>
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public abstract class PIDCommand extends Command implements Sendable {
|
||||
|
||||
|
||||
@@ -22,8 +22,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
* <p>It provides some convenience methods to run an internal {@link PIDController} . It also
|
||||
* allows access to the internal {@link PIDController} in order to give total control to the
|
||||
* programmer.
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public abstract class PIDSubsystem extends Subsystem implements Sendable {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ package edu.wpi.first.wpilibj.command;
|
||||
* A {@link PrintCommand} is a command which prints out a string when it is initialized, and then
|
||||
* immediately finishes. It is useful if you want a {@link CommandGroup} to print out a string when
|
||||
* it reaches a certain point.
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public class PrintCommand extends Command {
|
||||
|
||||
|
||||
@@ -26,7 +26,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
* Scheduler#run() run()} often to have {@link Command Commands} function correctly. However, this
|
||||
* is already done for you if you use the CommandBased Robot template. </p>
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
* @see Command
|
||||
*/
|
||||
public class Scheduler implements NamedSendable {
|
||||
|
||||
@@ -12,8 +12,7 @@ import java.util.Vector;
|
||||
|
||||
@SuppressWarnings("all")
|
||||
/**
|
||||
*
|
||||
* @author Greg
|
||||
* A set.
|
||||
*/
|
||||
class Set {
|
||||
private Vector m_set = new Vector();
|
||||
|
||||
@@ -10,8 +10,6 @@ package edu.wpi.first.wpilibj.command;
|
||||
/**
|
||||
* A {@link StartCommand} will call the {@link Command#start() start()} method of another command
|
||||
* when it is initialized and will finish immediately.
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public class StartCommand extends Command {
|
||||
|
||||
|
||||
@@ -24,7 +24,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
* command which requires a subsystem can run at a time. Also, subsystems can have default commands
|
||||
* which are started if there is no command running which requires this subsystem. </p>
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
* @see Command
|
||||
*/
|
||||
public abstract class Subsystem implements NamedSendable {
|
||||
|
||||
@@ -11,7 +11,6 @@ package edu.wpi.first.wpilibj.command;
|
||||
* A {@link WaitCommand} will wait for a certain amount of time before finishing. It is useful if
|
||||
* you want a {@link CommandGroup} to pause for a moment.
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
* @see CommandGroup
|
||||
*/
|
||||
public class WaitCommand extends Command {
|
||||
|
||||
@@ -14,8 +14,6 @@ package edu.wpi.first.wpilibj.command;
|
||||
*
|
||||
* <p>This class is useful for the situation where you want to allow anything running in parallel
|
||||
* to finish, before continuing in the main {@link CommandGroup} sequence.
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public class WaitForChildren extends Command {
|
||||
|
||||
|
||||
@@ -12,8 +12,6 @@ import edu.wpi.first.wpilibj.Timer;
|
||||
/**
|
||||
* WaitUntilCommand - waits until an absolute game time. This will wait until the game clock reaches
|
||||
* some value, then continue to the next command.
|
||||
*
|
||||
* @author brad
|
||||
*/
|
||||
public class WaitUntilCommand extends Command {
|
||||
|
||||
|
||||
@@ -11,7 +11,6 @@ import edu.wpi.first.wpilibj.PIDSource;
|
||||
|
||||
/**
|
||||
* Interface for a Potentiometer.
|
||||
* @author alex
|
||||
*/
|
||||
public interface Potentiometer extends PIDSource {
|
||||
double get();
|
||||
|
||||
@@ -19,8 +19,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
/**
|
||||
* The LiveWindow class is the public interface for putting sensors and actuators on the
|
||||
* LiveWindow.
|
||||
*
|
||||
* @author Alex Henning
|
||||
*/
|
||||
public class LiveWindow {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ package edu.wpi.first.wpilibj.livewindow;
|
||||
* A LiveWindow component is a device (sensor or actuator) that should be added to the
|
||||
* SmartDashboard in test mode. The components are cached until the first time the robot enters Test
|
||||
* mode. This allows the components to be inserted, then renamed.
|
||||
*
|
||||
* @author brad
|
||||
*/
|
||||
/*
|
||||
* This class is intentionally package private.
|
||||
|
||||
@@ -11,8 +11,6 @@ import edu.wpi.first.wpilibj.Sendable;
|
||||
|
||||
/**
|
||||
* Live Window Sendable is a special type of object sendable to the live window.
|
||||
*
|
||||
* @author Alex Henning
|
||||
*/
|
||||
public interface LiveWindowSendable extends Sendable {
|
||||
/**
|
||||
|
||||
@@ -22,8 +22,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
* SendableChooser} and then put it into the {@link SmartDashboard} to have a list of options appear
|
||||
* on the laptop. Once autonomous starts, simply ask the {@link SendableChooser} what the selected
|
||||
* value is.
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public class SendableChooser implements Sendable {
|
||||
|
||||
|
||||
@@ -24,8 +24,6 @@ import edu.wpi.first.wpilibj.tables.TableKeyNotDefinedException;
|
||||
*
|
||||
* <p>When a value is put into the SmartDashboard here, it pops up on the SmartDashboard on the
|
||||
* laptop. Users can put values into and get values from the SmartDashboard.
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public class SmartDashboard {
|
||||
/**
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj.util;
|
||||
|
||||
/**
|
||||
* Exception indicating that the resource is already allocated.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class AllocationException extends RuntimeException {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ package edu.wpi.first.wpilibj.util;
|
||||
/**
|
||||
* Thrown if there is an error caused by a basic system or setting not being properly initialized
|
||||
* before being used.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public class BaseSystemNotInitializedException extends RuntimeException {
|
||||
/**
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj.util;
|
||||
|
||||
/**
|
||||
* This exception represents an error in which a lower limit was set as higher than an upper limit.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class BoundaryException extends RuntimeException {
|
||||
|
||||
|
||||
@@ -10,8 +10,6 @@ package edu.wpi.first.wpilibj.util;
|
||||
/**
|
||||
* Exception indicating that the resource is already allocated This is meant to be thrown by the
|
||||
* resource class.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class CheckedAllocationException extends Exception {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ import java.util.Vector;
|
||||
|
||||
/**
|
||||
* A vector that is sorted.
|
||||
*
|
||||
* @author dtjones
|
||||
*/
|
||||
public class SortedVector extends Vector {
|
||||
|
||||
|
||||
@@ -9,8 +9,6 @@ package edu.wpi.first.wpilibj.util;
|
||||
|
||||
/**
|
||||
* Exception for bad status codes from the chip object.
|
||||
*
|
||||
* @author Brian
|
||||
*/
|
||||
public final class UncleanStatusException extends IllegalStateException {
|
||||
|
||||
|
||||
@@ -15,8 +15,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
* Class for reading analog potentiometers. Analog potentiometers read in an analog voltage that
|
||||
* corresponds to a position. Usually the position is either degrees or meters. However, if no
|
||||
* conversion is given it remains volts.
|
||||
*
|
||||
* @author Alex Henning
|
||||
*/
|
||||
public class AnalogPotentiometer implements Potentiometer, LiveWindowSendable {
|
||||
private double m_scale, m_offset;
|
||||
|
||||
@@ -14,8 +14,6 @@ import edu.wpi.first.wpilibj.Timer;
|
||||
* Safety protocol. The helper object has the code to actually do the timing and call the motors
|
||||
* Stop() method when the timeout expires. The motor object is expected to call the Feed() method
|
||||
* whenever the motors value is updated.
|
||||
*
|
||||
* @author brad
|
||||
*/
|
||||
public class MotorSafetyHelper {
|
||||
|
||||
|
||||
@@ -34,8 +34,6 @@ import edu.wpi.first.wpilibj.tables.ITableListener;
|
||||
* with all the key-value pairs. To save using {@link NetworkTable}, simply set the boolean at
|
||||
* position ~S A V E~ to true. Also, if the value of any variable is " in the {@link NetworkTable},
|
||||
* then that represents non-existence in the {@link Preferences} table</p>
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
*/
|
||||
public class Preferences {
|
||||
|
||||
|
||||
@@ -29,7 +29,6 @@ import edu.wpi.first.wpilibj.tables.ITable;
|
||||
* Scheduler#run() run()} often to have {@link Command Commands} function correctly. However, this
|
||||
* is already done for you if you use the CommandBased Robot template.</p>
|
||||
*
|
||||
* @author Joe Grinstead
|
||||
* @see Command
|
||||
*/
|
||||
public class Scheduler implements NamedSendable {
|
||||
|
||||
@@ -16,8 +16,6 @@ import static org.junit.Assert.fail;
|
||||
|
||||
/**
|
||||
* The basic test for all {@link Command} tests.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public abstract class AbstractCommandTest {
|
||||
|
||||
|
||||
@@ -16,9 +16,6 @@ import edu.wpi.first.wpilibj.buttons.InternalButton;
|
||||
/**
|
||||
* Test that covers the {@link edu.wpi.first.wpilibj.buttons.Button} with the {@link Command}
|
||||
* library.
|
||||
*
|
||||
* @author Mitchell
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class ButtonTest extends AbstractCommandTest {
|
||||
private InternalButton m_button1;
|
||||
|
||||
@@ -11,9 +11,6 @@ import org.junit.Test;
|
||||
|
||||
/**
|
||||
* Ported from the old CrioTest Classes.
|
||||
*
|
||||
* @author Mitchell
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public class CommandParallelGroupTest extends AbstractCommandTest {
|
||||
|
||||
|
||||
@@ -11,9 +11,6 @@ import org.junit.Test;
|
||||
|
||||
/**
|
||||
* Ported from the old CrioTest Classes.
|
||||
*
|
||||
* @author Mitchell
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public class CommandScheduleTest extends AbstractCommandTest {
|
||||
|
||||
|
||||
@@ -13,9 +13,6 @@ import java.util.logging.Logger;
|
||||
|
||||
/**
|
||||
* Ported from the old CrioTest Classes.
|
||||
*
|
||||
* @author Mitchell
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public class CommandSequentialGroupTest extends AbstractCommandTest {
|
||||
private static Logger logger = Logger.getLogger(CommandSequentialGroupTest.class.getName());
|
||||
|
||||
@@ -13,9 +13,6 @@ import java.util.logging.Logger;
|
||||
|
||||
/**
|
||||
* Ported from the old CrioTest Classes.
|
||||
*
|
||||
* @author Mitchell
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public class CommandSupersedeTest extends AbstractCommandTest {
|
||||
private static final Logger logger = Logger.getLogger(CommandSupersedeTest.class.getName());
|
||||
|
||||
@@ -11,9 +11,6 @@ import org.junit.Test;
|
||||
|
||||
/**
|
||||
* Test a {@link Command} that times out.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*
|
||||
*/
|
||||
public class CommandTimeoutTest extends AbstractCommandTest {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ import org.junit.Test;
|
||||
|
||||
/**
|
||||
* Tests the {@link Command} library.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class DefaultCommandTest extends AbstractCommandTest {
|
||||
|
||||
|
||||
@@ -10,8 +10,6 @@ package edu.wpi.first.wpilibj.command;
|
||||
/**
|
||||
* A class to simulate a simple command The command keeps track of how many times each method was
|
||||
* called.
|
||||
*
|
||||
* @author mwills
|
||||
*/
|
||||
public class MockCommand extends Command {
|
||||
private int m_initializeCount = 0;
|
||||
|
||||
@@ -26,8 +26,6 @@ import static org.junit.Assert.assertThat;
|
||||
/**
|
||||
* This class should not be run as a test explicitly. Instead it should be extended by tests that
|
||||
* use the InterruptableSensorBase.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public abstract class AbstractInterruptTest extends AbstractComsSetup {
|
||||
private InterruptableSensorBase m_interruptable = null;
|
||||
|
||||
@@ -24,8 +24,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Test that covers the {@link AnalogCrossConnectFixture}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class AnalogCrossConnectTest extends AbstractInterruptTest {
|
||||
private static final Logger logger = Logger.getLogger(AnalogCrossConnectTest.class.getName());
|
||||
|
||||
@@ -22,8 +22,6 @@ import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Tests the {@link AnalogPotentiometer}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class AnalogPotentiometerTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(AnalogPotentiometerTest.class.getName());
|
||||
|
||||
@@ -27,8 +27,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests to see if the Counter is working properly.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
@RunWith(Parameterized.class)
|
||||
public class CounterTest extends AbstractComsSetup {
|
||||
|
||||
@@ -25,8 +25,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests to see if the Digital ports are working properly.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
@RunWith(Parameterized.class)
|
||||
public class DIOCrossConnectTest extends AbstractInterruptTest {
|
||||
|
||||
@@ -17,8 +17,6 @@ import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Test for the DigitalGlitchFilter class.
|
||||
*
|
||||
* @author Austin Schuh and Jerry Morrison
|
||||
*/
|
||||
public class DigitalGlitchFilterTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(
|
||||
|
||||
@@ -27,8 +27,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Test to see if the FPGA properly recognizes a mock Encoder input.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
@RunWith(Parameterized.class)
|
||||
public class EncoderTest extends AbstractComsSetup {
|
||||
|
||||
@@ -22,8 +22,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Test that covers the {@link Compressor}.
|
||||
*
|
||||
* @author Kacper Puczydlowski
|
||||
*/
|
||||
|
||||
public class PCMTest extends AbstractComsSetup {
|
||||
|
||||
@@ -36,9 +36,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Test that covers the {@link PIDController}.
|
||||
*
|
||||
* @author Kacper Puczydlowski
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
|
||||
@RunWith(Parameterized.class)
|
||||
|
||||
@@ -25,8 +25,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests the {@link Preferences}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class PreferencesTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(PreferencesTest.class.getName());
|
||||
|
||||
@@ -27,8 +27,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests the {@link RelayCrossConnectFixture}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class RelayCrossConnectTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(RelayCrossConnectTest.class.getName());
|
||||
|
||||
@@ -24,8 +24,6 @@ import static org.junit.Assert.assertTrue;
|
||||
* test and use testing fixtures and categories. All tests must extend from {@link
|
||||
* AbstractComsSetup} in order to ensure that Network Communications are set up before the tests are
|
||||
* run.
|
||||
*
|
||||
* @author Fredric Silberberg
|
||||
*/
|
||||
public class SampleTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(SampleTest.class.getName());
|
||||
|
||||
@@ -16,8 +16,6 @@ import edu.wpi.first.wpilibj.test.AbstractTestSuite;
|
||||
/**
|
||||
* Holds all of the tests in the root wpilibj directory. Please list alphabetically so that it is
|
||||
* easy to determine if a test is missing from the list.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
@RunWith(Suite.class)
|
||||
@SuiteClasses({AnalogCrossConnectTest.class, AnalogPotentiometerTest.class,
|
||||
|
||||
@@ -20,8 +20,6 @@ import edu.wpi.first.wpilibj.test.TestBench;
|
||||
/**
|
||||
* Provides a base implementation for CAN Tests that forces a test of a particular mode to provide
|
||||
* tests of a certain type. This also allows for a standardized base setup for each test.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public abstract class AbstractCANTest extends AbstractComsSetup {
|
||||
public static final double kMotorStopTime = 2;
|
||||
@@ -47,8 +45,6 @@ public abstract class AbstractCANTest extends AbstractComsSetup {
|
||||
/**
|
||||
* Extends the default test watcher in order to provide more information about a tests failure at
|
||||
* runtime.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANTestWatcher extends DefaultTestWatcher {
|
||||
@Override
|
||||
|
||||
@@ -20,8 +20,6 @@ import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Tests the CAN Motor Controller in Current Quad Encoder mode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANCurrentQuadEncoderModeTest extends AbstractCANTest {
|
||||
private static Logger logger = Logger.getLogger(CANCurrentQuadEncoderModeTest.class.getName());
|
||||
|
||||
@@ -28,8 +28,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* The default test set to run against the CAN Motor Controllers.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANDefaultTest extends AbstractCANTest {
|
||||
private static final Logger logger = Logger.getLogger(CANDefaultTest.class.getName());
|
||||
|
||||
@@ -31,8 +31,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests the CAN motor in PercentQuadEncoderMode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
@SuppressWarnings("AbbreviationAsWordInName")
|
||||
public class CANPercentQuadEncoderModeTest extends AbstractCANTest {
|
||||
|
||||
@@ -28,8 +28,6 @@ import static org.junit.Assert.assertThat;
|
||||
|
||||
/**
|
||||
* Tests the CAN Motor controller in Potentiometer Mode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANPositionPotentiometerModeTest extends AbstractCANTest {
|
||||
private static final Logger logger = Logger.getLogger(CANPositionPotentiometerModeTest.class
|
||||
|
||||
@@ -21,8 +21,6 @@ import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Tests the CAN Motor Encoders in QuadEncoder mode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANPositionQuadEncoderModeTest extends AbstractCANTest {
|
||||
private static final Logger logger = Logger.getLogger(CANPositionQuadEncoderModeTest.class
|
||||
|
||||
@@ -23,8 +23,6 @@ import static org.junit.Assert.assertThat;
|
||||
|
||||
/**
|
||||
* Tests the CAN Speed controllers in quad mode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANSpeedQuadEncoderModeTest extends AbstractCANTest {
|
||||
private static final Logger logger = Logger.getLogger(CANPercentQuadEncoderModeTest.class
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user