From 47fdebe12d200a101308027da425b4e70b3dfee2 Mon Sep 17 00:00:00 2001 From: Sam Belliveau Date: Sat, 8 Feb 2020 19:30:15 -0500 Subject: [PATCH] javadoc --- docs/allclasses-index.html | 59 ++- docs/allclasses.html | 6 +- docs/allpackages-index.html | 4 +- .../stuypulse/stuylib/control/Controller.html | 4 +- .../stuylib/control/PIDCalculator.html | 4 +- .../stuylib/control/PIDController.html | 4 +- .../stuylib/control/package-summary.html | 4 +- .../stuylib/control/package-tree.html | 4 +- .../stuylib/exception/ConstructionError.html | 4 +- .../stuylib/exception/package-summary.html | 4 +- .../stuylib/exception/package-tree.html | 4 +- .../stuylib/file/FRCLogger.Loggable.html | 4 +- .../com/stuypulse/stuylib/file/FRCLogger.html | 4 +- .../stuylib/file/csv/CSVElement.html | 4 +- .../stuypulse/stuylib/file/csv/CSVReader.html | 4 +- .../stuypulse/stuylib/file/csv/CSVType.html | 4 +- .../stuypulse/stuylib/file/csv/CSVWriter.html | 10 +- .../stuylib/file/csv/package-summary.html | 4 +- .../stuylib/file/csv/package-tree.html | 6 +- .../stuylib/file/package-summary.html | 4 +- .../stuypulse/stuylib/file/package-tree.html | 4 +- docs/com/stuypulse/stuylib/input/Gamepad.html | 4 +- .../stuypulse/stuylib/input/WPIGamepad.html | 4 +- .../input/buttons/BooleanProvider.html | 4 +- .../stuylib/input/buttons/ButtonWrapper.html | 4 +- .../stuylib/input/buttons/NewButton.html | 4 +- .../stuylib/input/buttons/OldButton.html | 4 +- .../input/buttons/package-summary.html | 4 +- .../stuylib/input/buttons/package-tree.html | 4 +- .../input/gamepads/Logitech.DMode.html | 4 +- .../input/gamepads/Logitech.XMode.html | 4 +- .../stuylib/input/gamepads/Logitech.html | 4 +- .../stuylib/input/gamepads/NetKeyGamepad.html | 4 +- .../stuypulse/stuylib/input/gamepads/PS4.html | 4 +- .../input/gamepads/package-summary.html | 4 +- .../stuylib/input/gamepads/package-tree.html | 4 +- .../stuylib/input/keyboard/NetKeyboard.html | 4 +- .../keyboard/computer/NetKeyListener.html | 4 +- .../input/keyboard/computer/NetKeyWindow.html | 4 +- .../keyboard/computer/package-summary.html | 4 +- .../input/keyboard/computer/package-tree.html | 4 +- .../input/keyboard/package-summary.html | 4 +- .../stuylib/input/keyboard/package-tree.html | 4 +- .../stuylib/input/package-summary.html | 4 +- .../stuypulse/stuylib/input/package-tree.html | 4 +- docs/com/stuypulse/stuylib/math/SLMath.html | 4 +- docs/com/stuypulse/stuylib/math/Vector2D.html | 4 +- .../stuylib/math/package-summary.html | 4 +- .../stuypulse/stuylib/math/package-tree.html | 4 +- .../stuylib/network/SLNetworkTable.html | 4 +- .../stuylib/network/SmartBoolean.html | 425 ++++++++++++++++++ .../stuylib/network/SmartNumber.html | 4 +- .../stuylib/network/SmartString.html | 425 ++++++++++++++++++ .../network/limelight/Limelight.CamMode.html | 4 +- .../limelight/Limelight.CameraStream.html | 4 +- .../network/limelight/Limelight.LEDMode.html | 4 +- .../limelight/Limelight.SnapshotMode.html | 4 +- .../stuylib/network/limelight/Limelight.html | 4 +- .../network/limelight/Solve3DResult.html | 4 +- .../network/limelight/package-summary.html | 4 +- .../network/limelight/package-tree.html | 4 +- .../stuylib/network/package-summary.html | 16 +- .../stuylib/network/package-tree.html | 6 +- .../stuylib/streams/BufferedIStream.html | 4 +- .../stuylib/streams/CSVIStream.Reader.html | 4 +- .../stuylib/streams/CSVIStream.Writer.html | 4 +- .../stuypulse/stuylib/streams/CSVIStream.html | 4 +- .../stuylib/streams/FilteredIStream.html | 4 +- .../stuypulse/stuylib/streams/IStream.html | 4 +- .../stuylib/streams/PollingIStream.html | 4 +- .../streams/filters/IStreamFilter.html | 6 +- .../streams/filters/IStreamFilterGroup.html | 4 +- .../streams/filters/LowPassFilter.html | 4 +- .../streams/filters/MovingAverage.html | 4 +- .../stuylib/streams/filters/OnDerivative.html | 4 +- .../streams/filters/OrderedLowPassFilter.html | 340 ++++++++++++++ .../filters/OrderedRollingAverage.html | 4 +- .../stuylib/streams/filters/RateLimit.html | 4 +- .../streams/filters/RollingAverage.html | 4 +- .../streams/filters/package-summary.html | 17 +- .../stuylib/streams/filters/package-tree.html | 5 +- .../stuylib/streams/package-summary.html | 4 +- .../stuylib/streams/package-tree.html | 4 +- .../com/stuypulse/stuylib/util/StopWatch.html | 4 +- .../stuylib/util/TankDriveEncoder.html | 407 +++++++++++++++++ .../stuylib/util/package-summary.html | 10 +- .../stuypulse/stuylib/util/package-tree.html | 5 +- docs/constant-values.html | 4 +- docs/deprecated-list.html | 4 +- docs/help-doc.html | 4 +- docs/index-all.html | 101 ++++- docs/index.html | 6 +- docs/member-search-index.js | 2 +- docs/member-search-index.zip | Bin 3896 -> 4074 bytes docs/overview-summary.html | 4 +- docs/overview-tree.html | 10 +- docs/package-search-index.zip | Bin 336 -> 336 bytes docs/serialized-form.html | 4 +- docs/type-search-index.js | 2 +- docs/type-search-index.zip | Bin 728 -> 760 bytes 100 files changed, 1965 insertions(+), 207 deletions(-) create mode 100644 docs/com/stuypulse/stuylib/network/SmartBoolean.html create mode 100644 docs/com/stuypulse/stuylib/network/SmartString.html create mode 100644 docs/com/stuypulse/stuylib/streams/filters/OrderedLowPassFilter.html create mode 100644 docs/com/stuypulse/stuylib/util/TankDriveEncoder.html diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html index a727fbda..adc85a5e 100644 --- a/docs/allclasses-index.html +++ b/docs/allclasses-index.html @@ -3,7 +3,7 @@ -All Classes (StuyLib API) +All Classes (StuyLib 1.0.0 API) @@ -21,13 +21,13 @@ + + + + + + + + + + +
+ +
+ +
+
+
Package com.stuypulse.stuylib.network
+

Class SmartBoolean

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.stuypulse.stuylib.network.SmartBoolean
      • +
    +
    • +
+
+
    +
  • +
    +
    public class SmartBoolean
+extends java.lang.Object
    +
    SmartBoolean works as a wrapper for values on SmartDashboard. The idea for + this class was to make getting values on SmartDashboard easier by making them + variables that you know were initialized.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      SmartBoolean​(java.lang.String id) +
      Creates a SmartBoolean for an already existing value.
      +
      SmartBoolean​(java.lang.String id, + boolean value) +
      Creates a SmartBoolean with the element name and a default value.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanget() +
      Gets the value of the boolean from SmartDashboard
      +
      booleangetDefault() +
      Gets the default value of the boolean
      +
      voidreset() +
      Resets the value on SmartDashboard to the default value
      +
      voidset​(boolean value) +
      Sets the value of the boolean on SmartDashboard
      +
      voidsetDefault​(boolean value) +
      Sets the default value of the boolean
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SmartBoolean

        +
        public SmartBoolean​(java.lang.String id,
+                    boolean value)
        +
        Creates a SmartBoolean with the element name and a default value. The value on + SmartDashboard will be reset to the default value on initialization.
        +
        +
        Parameters:
        +
        id - the name of the boolean on SmartDashboard
        +
        value - the default / initialization value for the value
        +
        +
        • +
      + + + +
        +
      • +

        SmartBoolean

        +
        public SmartBoolean​(java.lang.String id)
        +
        Creates a SmartBoolean for an already existing value.
        +
        +
        Parameters:
        +
        id - the name of the boolean on SmartDashboard
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public boolean get()
        +
        Gets the value of the boolean from SmartDashboard
        +
        +
        Returns:
        +
        the value of the boolean from SmartDashboard
        +
        +
        • +
      + + + +
        +
      • +

        getDefault

        +
        public boolean getDefault()
        +
        Gets the default value of the boolean
        +
        +
        Returns:
        +
        the default value of the boolean
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set​(boolean value)
        +
        Sets the value of the boolean on SmartDashboard
        +
        +
        Parameters:
        +
        value - what the value on SmartDashboard will be set to
        +
        +
        • +
      + + + +
        +
      • +

        setDefault

        +
        public void setDefault​(boolean value)
        +
        Sets the default value of the boolean
        +
        +
        Parameters:
        +
        value - what the default value of the boolean will be set to
        +
        +
        • +
      + + + +
        +
      • +

        reset

        +
        public void reset()
        +
        Resets the value on SmartDashboard to the default value
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/com/stuypulse/stuylib/network/SmartNumber.html b/docs/com/stuypulse/stuylib/network/SmartNumber.html index b458f02c..133be210 100644 --- a/docs/com/stuypulse/stuylib/network/SmartNumber.html +++ b/docs/com/stuypulse/stuylib/network/SmartNumber.html @@ -3,7 +3,7 @@ -SmartNumber (StuyLib API) +SmartNumber (StuyLib 1.0.0 API) @@ -21,7 +21,7 @@ + + + + + + + + + + +
+ +
+ +
+
+
Package com.stuypulse.stuylib.network
+

Class SmartString

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.stuypulse.stuylib.network.SmartString
      • +
    +
    • +
+
+
    +
  • +
    +
    public class SmartString
+extends java.lang.Object
    +
    SmartString works as a wrapper for values on SmartDashboard. The idea for + this class was to make getting values on SmartDashboard easier by making them + variables that you know were initialized.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      SmartString​(java.lang.String id) +
      Creates a SmartString for an already existing value.
      +
      SmartString​(java.lang.String id, + java.lang.String value) +
      Creates a SmartString with the element name and a default value.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.Stringget() +
      Gets the value of the String from SmartDashboard
      +
      java.lang.StringgetDefault() +
      Gets the default value of the String
      +
      voidreset() +
      Resets the value on SmartDashboard to the default value
      +
      voidset​(java.lang.String value) +
      Sets the value of the String on SmartDashboard
      +
      voidsetDefault​(java.lang.String value) +
      Sets the default value of the String
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SmartString

        +
        public SmartString​(java.lang.String id,
+                   java.lang.String value)
        +
        Creates a SmartString with the element name and a default value. The value on + SmartDashboard will be reset to the default value on initialization.
        +
        +
        Parameters:
        +
        id - the name of the String on SmartDashboard
        +
        value - the default / initialization value for the value
        +
        +
        • +
      + + + +
        +
      • +

        SmartString

        +
        public SmartString​(java.lang.String id)
        +
        Creates a SmartString for an already existing value.
        +
        +
        Parameters:
        +
        id - the name of the String on SmartDashboard
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public java.lang.String get()
        +
        Gets the value of the String from SmartDashboard
        +
        +
        Returns:
        +
        the value of the String from SmartDashboard
        +
        +
        • +
      + + + +
        +
      • +

        getDefault

        +
        public java.lang.String getDefault()
        +
        Gets the default value of the String
        +
        +
        Returns:
        +
        the default value of the String
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public void set​(java.lang.String value)
        +
        Sets the value of the String on SmartDashboard
        +
        +
        Parameters:
        +
        value - what the value on SmartDashboard will be set to
        +
        +
        • +
      + + + +
        +
      • +

        setDefault

        +
        public void setDefault​(java.lang.String value)
        +
        Sets the default value of the String
        +
        +
        Parameters:
        +
        value - what the default value of the String will be set to
        +
        +
        • +
      + + + +
        +
      • +

        reset

        +
        public void reset()
        +
        Resets the value on SmartDashboard to the default value
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/com/stuypulse/stuylib/network/limelight/Limelight.CamMode.html b/docs/com/stuypulse/stuylib/network/limelight/Limelight.CamMode.html index c7ebe04f..cd00f5dc 100644 --- a/docs/com/stuypulse/stuylib/network/limelight/Limelight.CamMode.html +++ b/docs/com/stuypulse/stuylib/network/limelight/Limelight.CamMode.html @@ -3,7 +3,7 @@ -Limelight.CamMode (StuyLib API) +Limelight.CamMode (StuyLib 1.0.0 API) @@ -21,7 +21,7 @@ + + + + + + + + + + +
+ +
+ +
+
+
Package com.stuypulse.stuylib.streams.filters
+

Class OrderedLowPassFilter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.stuypulse.stuylib.streams.filters.OrderedLowPassFilter
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IStreamFilter
    +
    +
    +
    public class OrderedLowPassFilter
+extends java.lang.Object
+implements IStreamFilter
    +
    Simple implementation of an Exponential Moving Average + + This is not time dependant, so the values will change if you change the rate + that you call this filter, the filter will not adapt for that.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      OrderedLowPassFilter​(double rc, + int order) +
      Multiple low pass filters combined into one filter
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      doubleget​(double next) +
      Get next value in Filter based on the next value given
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        OrderedLowPassFilter

        +
        public OrderedLowPassFilter​(double rc,
+                            int order)
+                     throws ConstructionError
        +
        Multiple low pass filters combined into one filter
        +
        +
        Parameters:
        +
        rc - Time Constant. The time constant is the amount of time in seconds + that it takes to get 63.2% of the way to the target value. 63.2% is + (1 - (1 / e)).
        +
        order - number of rolling averages (greater than or equal to 1)
        +
        Throws:
        +
        ConstructionError
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public double get​(double next)
        +
        Description copied from interface: IStreamFilter
        +
        Get next value in Filter based on the next value given
        +
        +
        Specified by:
        +
        get in interface IStreamFilter
        +
        Parameters:
        +
        next - next input value
        +
        Returns:
        +
        next modified value
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/com/stuypulse/stuylib/streams/filters/OrderedRollingAverage.html b/docs/com/stuypulse/stuylib/streams/filters/OrderedRollingAverage.html index 452e0632..9e04edab 100644 --- a/docs/com/stuypulse/stuylib/streams/filters/OrderedRollingAverage.html +++ b/docs/com/stuypulse/stuylib/streams/filters/OrderedRollingAverage.html @@ -3,7 +3,7 @@ -OrderedRollingAverage (StuyLib API) +OrderedRollingAverage (StuyLib 1.0.0 API) @@ -21,7 +21,7 @@ + + + + + + + + + + +
+ +
+ +
+
+
Package com.stuypulse.stuylib.util
+

Class TankDriveEncoder

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.stuypulse.stuylib.util.TankDriveEncoder
      • +
    +
    • +
+
+
    +
  • +
    +
    public class TankDriveEncoder
+extends java.lang.Object
    +
    The tank drive encoder manages the left and right encoder for the drivetrain. + It does math to get the distance the entire robot has moved, and it can also + detect if an encoder has disconnected, taking that into consideration.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      TankDriveEncoder​(edu.wpi.first.wpilibj.Encoder leftEncoder, + edu.wpi.first.wpilibj.Encoder rightEncoder) 
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TankDriveEncoder

        +
        public TankDriveEncoder​(edu.wpi.first.wpilibj.Encoder leftEncoder,
+                        edu.wpi.first.wpilibj.Encoder rightEncoder)
        +
        +
        Parameters:
        +
        leftEncoder - encoder on left side to record from
        +
        rightEncoder - encoder on right side to record from
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLeftEncoder

        +
        public edu.wpi.first.wpilibj.Encoder getLeftEncoder()
        +
        +
        Returns:
        +
        get encoder for the left side
        +
        +
        • +
      + + + +
        +
      • +

        getRightEncoder

        +
        public edu.wpi.first.wpilibj.Encoder getRightEncoder()
        +
        +
        Returns:
        +
        get encoder for the left side
        +
        +
        • +
      + + + +
        +
      • +

        reset

        +
        public void reset()
        +
        Reset all of the distance values
        +
        • +
      + + + +
        +
      • +

        getLeftDistance

        +
        public double getLeftDistance()
        +
        +
        Returns:
        +
        get distance that the left side of the drivetrain has moved
        +
        +
        • +
      + + + +
        +
      • +

        getRightDistance

        +
        public double getRightDistance()
        +
        +
        Returns:
        +
        get distance that the right side of the drivetrain has moved
        +
        +
        • +
      + + + +
        +
      • +

        getDistance

        +
        public double getDistance()
        +
        +
        Returns:
        +
        get distance that the entire drivetrain has moved
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/com/stuypulse/stuylib/util/package-summary.html b/docs/com/stuypulse/stuylib/util/package-summary.html index f46ae799..1296dc2e 100644 --- a/docs/com/stuypulse/stuylib/util/package-summary.html +++ b/docs/com/stuypulse/stuylib/util/package-summary.html @@ -3,7 +3,7 @@ -com.stuypulse.stuylib.util (StuyLib API) +com.stuypulse.stuylib.util (StuyLib 1.0.0 API) @@ -21,7 +21,7 @@