diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html new file mode 100644 index 00000000..5b7a581a --- /dev/null +++ b/javadoc/allclasses-index.html @@ -0,0 +1,1534 @@ + + + + + +All Classes (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes

+
+
+ +
+
+ + + diff --git a/javadoc/allclasses.html b/javadoc/allclasses.html new file mode 100644 index 00000000..b7043581 --- /dev/null +++ b/javadoc/allclasses.html @@ -0,0 +1,350 @@ + + + + + +All Classes (SeriouslyCommonLib API) + + + + + + + + + + + + +
+

All Classes

+
+ +
+
+ + diff --git a/javadoc/allpackages-index.html b/javadoc/allpackages-index.html new file mode 100644 index 00000000..16ba414d --- /dev/null +++ b/javadoc/allpackages-index.html @@ -0,0 +1,280 @@ + + + + + +All Packages (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
+ +
+
+ + + diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html new file mode 100644 index 00000000..08f31ffc --- /dev/null +++ b/javadoc/constant-values.html @@ -0,0 +1,312 @@ + + + + + +Constant Field Values (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+

Contents

+ +
+
+
+ + +
+

xbot.common.*

+ + + + +
    +
  • + + + + + + + + + + + + + + +
    xbot.common.subsystems.drive.control_logic.HeadingModule 
    Modifier and TypeConstant FieldValue
    + +public final doubledefaultPValue0.0125
    +
    • +
+ +
+
+
+ + + diff --git a/javadoc/deprecated-list.html b/javadoc/deprecated-list.html new file mode 100644 index 00000000..f1308631 --- /dev/null +++ b/javadoc/deprecated-list.html @@ -0,0 +1,188 @@ + + + + + +Deprecated List (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+

Contents

+ +
+
+ + + +
+
+ + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockAnalogInput.MockAnalogInputFactory.html b/javadoc/edu/wpi/first/wpilibj/MockAnalogInput.MockAnalogInputFactory.html new file mode 100644 index 00000000..af781add --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockAnalogInput.MockAnalogInputFactory.html @@ -0,0 +1,319 @@ + + + + + +MockAnalogInput.MockAnalogInputFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockAnalogInput.MockAnalogInputFactory

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract MockAnalogInputcreate​(int channel) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+ +
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockAnalogInput.html b/javadoc/edu/wpi/first/wpilibj/MockAnalogInput.html new file mode 100644 index 00000000..c63eec99 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockAnalogInput.html @@ -0,0 +1,456 @@ + + + + + +MockAnalogInput (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockAnalogInput

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockAnalogInput

        +
        @AssistedInject
+public MockAnalogInput​(@Assisted("channel")
+                       int channel,
+                       DevicePolice police)
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockCompressor.MockCompressorFactory.html b/javadoc/edu/wpi/first/wpilibj/MockCompressor.MockCompressorFactory.html new file mode 100644 index 00000000..ade4a55d --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockCompressor.MockCompressorFactory.html @@ -0,0 +1,318 @@ + + + + + +MockCompressor.MockCompressorFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockCompressor.MockCompressorFactory

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract MockCompressorcreate() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+ +
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockCompressor.html b/javadoc/edu/wpi/first/wpilibj/MockCompressor.html new file mode 100644 index 00000000..203a8172 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockCompressor.html @@ -0,0 +1,380 @@ + + + + + +MockCompressor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockCompressor

+
+
+ +
+
    +
  • +
    +
    public class MockCompressor
+extends XCompressor
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockCompressor

        +
        @AssistedInject
+public MockCompressor()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockDigitalInput.MockDigitalInputFactory.html b/javadoc/edu/wpi/first/wpilibj/MockDigitalInput.MockDigitalInputFactory.html new file mode 100644 index 00000000..e94aed9e --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockDigitalInput.MockDigitalInputFactory.html @@ -0,0 +1,319 @@ + + + + + +MockDigitalInput.MockDigitalInputFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockDigitalInput.MockDigitalInputFactory

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract MockDigitalInputcreate​(int channel) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+ +
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockDigitalInput.html b/javadoc/edu/wpi/first/wpilibj/MockDigitalInput.html new file mode 100644 index 00000000..3fbeba7d --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockDigitalInput.html @@ -0,0 +1,469 @@ + + + + + +MockDigitalInput (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockDigitalInput

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        value

        +
        protected boolean value
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockDigitalInput

        +
        @AssistedInject
+public MockDigitalInput​(@Assisted("channel")
+                        int channel,
+                        DevicePolice police)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setValue

        +
        public void setValue​(boolean value)
        +
        • +
      + + + +
        +
      • +

        setInverted

        +
        public void setInverted​(boolean inverted)
        +
        +
        Overrides:
        +
        setInverted in class XDigitalInput
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getChannel

        +
        public int getChannel()
        +
        +
        Specified by:
        +
        getChannel in interface XBaseIO
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockDigitalOutput.MockDigitalOutputFactory.html b/javadoc/edu/wpi/first/wpilibj/MockDigitalOutput.MockDigitalOutputFactory.html new file mode 100644 index 00000000..da74d6b2 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockDigitalOutput.MockDigitalOutputFactory.html @@ -0,0 +1,319 @@ + + + + + +MockDigitalOutput.MockDigitalOutputFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockDigitalOutput.MockDigitalOutputFactory

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract MockDigitalOutputcreate​(int channel) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+ +
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockDigitalOutput.html b/javadoc/edu/wpi/first/wpilibj/MockDigitalOutput.html new file mode 100644 index 00000000..866c9e17 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockDigitalOutput.html @@ -0,0 +1,510 @@ + + + + + +MockDigitalOutput (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockDigitalOutput

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    XBaseIO
    +
    +
    +
    public class MockDigitalOutput
+extends XDigitalOutput
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        channel

        +
        protected int channel
        +
        • +
      + + + +
        +
      • +

        value

        +
        protected boolean value
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockDigitalOutput

        +
        @AssistedInject
+public MockDigitalOutput​(@Assisted("channel")
+                         int channel,
+                         DevicePolice police)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        set

        +
        public void set​(boolean value)
        +
        +
        Specified by:
        +
        set in class XDigitalOutput
        +
        +
        • +
      + + + +
        +
      • +

        setPWMRate

        +
        public void setPWMRate​(double frequency)
        +
        Description copied from class: XDigitalOutput
        +
        Set the PWM frequency of ALL DIGITAL OUTPUT PWM CHANNELS
        +
        +
        Specified by:
        +
        setPWMRate in class XDigitalOutput
        +
        Parameters:
        +
        frequency - PWM frequency
        +
        +
        • +
      + + + +
        +
      • +

        enablePWM

        +
        public void enablePWM​(double initialDutyCycle)
        +
        +
        Specified by:
        +
        enablePWM in class XDigitalOutput
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        get

        +
        public boolean get()
        +
        +
        Specified by:
        +
        get in class XDigitalOutput
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockDistanceSensor.html b/javadoc/edu/wpi/first/wpilibj/MockDistanceSensor.html new file mode 100644 index 00000000..3f4108f3 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockDistanceSensor.html @@ -0,0 +1,359 @@ + + + + + +MockDistanceSensor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockDistanceSensor

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DistanceSensor
    +
    +
    +
    public class MockDistanceSensor
+extends java.lang.Object
+implements DistanceSensor
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MockDistanceSensor() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      doublegetDistance() 
      voidincrementDistance​(double delta) 
      voidsetAveraging​(boolean shouldAverage) 
      voidsetDistance​(double distance) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MockDistanceSensor

        +
        public MockDistanceSensor()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        setDistance

        +
        public void setDistance​(double distance)
        +
        • +
      + + + +
        +
      • +

        incrementDistance

        +
        public void incrementDistance​(double delta)
        +
        • +
      + + + +
        +
      • +

        setAveraging

        +
        public void setAveraging​(boolean shouldAverage)
        +
        +
        Specified by:
        +
        setAveraging in interface DistanceSensor
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockDistanceSensorPair.html b/javadoc/edu/wpi/first/wpilibj/MockDistanceSensorPair.html new file mode 100644 index 00000000..581574d6 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockDistanceSensorPair.html @@ -0,0 +1,350 @@ + + + + + +MockDistanceSensorPair (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockDistanceSensorPair

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockLidarLite.MockLidarLiteFactory.html b/javadoc/edu/wpi/first/wpilibj/MockLidarLite.MockLidarLiteFactory.html new file mode 100644 index 00000000..af62dbcc --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockLidarLite.MockLidarLiteFactory.html @@ -0,0 +1,322 @@ + + + + + +MockLidarLite.MockLidarLiteFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockLidarLite.MockLidarLiteFactory

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract MockLidarLitecreate​(edu.wpi.first.wpilibj.I2C.Port port, + java.lang.String prefix) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MockLidarLiteFactory

        +
        public MockLidarLiteFactory()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockLidarLite.html b/javadoc/edu/wpi/first/wpilibj/MockLidarLite.html new file mode 100644 index 00000000..ca08dd86 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockLidarLite.html @@ -0,0 +1,394 @@ + + + + + +MockLidarLite (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockLidarLite

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockLidarLite

        +
        @AssistedInject
+public MockLidarLite​(@Assisted("port")
+                     edu.wpi.first.wpilibj.I2C.Port port,
+                     PropertyFactory propMan,
+                     DevicePolice police,
+                     @Assisted("prefix")
+                     java.lang.String prefix)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        update

        +
        protected void update()
        +
        +
        Specified by:
        +
        update in class XLidarLite
        +
        +
        • +
      + + + +
        +
      • +

        setTestDistance

        +
        public void setTestDistance​(int testDistance)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockPWM.MockPWMFactory.html b/javadoc/edu/wpi/first/wpilibj/MockPWM.MockPWMFactory.html new file mode 100644 index 00000000..8fc2f028 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockPWM.MockPWMFactory.html @@ -0,0 +1,319 @@ + + + + + +MockPWM.MockPWMFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockPWM.MockPWMFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    XPWM.XPWMFactory
    +
    +
    +
    Enclosing class:
    +
    MockPWM
    +
    +
    +
    @AssistedFactory
+public abstract static class MockPWM.MockPWMFactory
+extends java.lang.Object
+implements XPWM.XPWMFactory
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MockPWMFactory() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract MockPWMcreate​(int channel) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MockPWMFactory

        +
        public MockPWMFactory()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockPWM.html b/javadoc/edu/wpi/first/wpilibj/MockPWM.html new file mode 100644 index 00000000..4f6e697b --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockPWM.html @@ -0,0 +1,522 @@ + + + + + +MockPWM (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockPWM

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    XBaseIO
    +
    +
    +
    public class MockPWM
+extends XPWM
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClassDescription
      static class MockPWM.MockPWMFactory 
      + +
      • +
    +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      protected intchannel 
      protected doublevalue 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MockPWM​(int channel, + DevicePolice police) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intgetRaw() 
      doublegetSigned() 
      doublegetUnsigned() 
      voidsetRaw​(int value) +
      Sets the PWM duty cycle
      +
      voidsetSigned​(double value) +
      Sets the PWM duty cycle
      +
      voidsetUnsigned​(double value) +
      Sets the PWM duty cycle
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        channel

        +
        protected int channel
        +
        • +
      + + + +
        +
      • +

        value

        +
        protected double value
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockPWM

        +
        @AssistedInject
+public MockPWM​(@Assisted("channel")
+               int channel,
+               DevicePolice police)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setRaw

        +
        public void setRaw​(int value)
        +
        Description copied from class: XPWM
        +
        Sets the PWM duty cycle
        +
        +
        Specified by:
        +
        setRaw in class XPWM
        +
        Parameters:
        +
        value - the value to set, in the range [0, 255]
        +
        +
        • +
      + + + +
        +
      • +

        getRaw

        +
        public int getRaw()
        +
        +
        Specified by:
        +
        getRaw in class XPWM
        +
        +
        • +
      + + + +
        +
      • +

        setSigned

        +
        public void setSigned​(double value)
        +
        Description copied from class: XPWM
        +
        Sets the PWM duty cycle
        +
        +
        Specified by:
        +
        setSigned in class XPWM
        +
        Parameters:
        +
        value - the value to set, in the range [-1, 1]
        +
        +
        • +
      + + + +
        +
      • +

        getSigned

        +
        public double getSigned()
        +
        +
        Specified by:
        +
        getSigned in class XPWM
        +
        +
        • +
      + + + +
        +
      • +

        setUnsigned

        +
        public void setUnsigned​(double value)
        +
        Description copied from class: XPWM
        +
        Sets the PWM duty cycle
        +
        +
        Specified by:
        +
        setUnsigned in class XPWM
        +
        Parameters:
        +
        value - the value to set, in the range [0, 1]
        +
        +
        • +
      + + + +
        +
      • +

        getUnsigned

        +
        public double getUnsigned()
        +
        +
        Specified by:
        +
        getUnsigned in class XPWM
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockPowerDistributionPanel.MockPowerDistributionPanelFactory.html b/javadoc/edu/wpi/first/wpilibj/MockPowerDistributionPanel.MockPowerDistributionPanelFactory.html new file mode 100644 index 00000000..c9df5d8a --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockPowerDistributionPanel.MockPowerDistributionPanelFactory.html @@ -0,0 +1,318 @@ + + + + + +MockPowerDistributionPanel.MockPowerDistributionPanelFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockPowerDistributionPanel.MockPowerDistributionPanelFactory

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockPowerDistributionPanel.html b/javadoc/edu/wpi/first/wpilibj/MockPowerDistributionPanel.html new file mode 100644 index 00000000..7724bae8 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockPowerDistributionPanel.html @@ -0,0 +1,360 @@ + + + + + +MockPowerDistributionPanel (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockPowerDistributionPanel

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockPowerDistributionPanel

        +
        @AssistedInject
+public MockPowerDistributionPanel()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setCurrent

        +
        public void setCurrent​(int channel,
+                       double current)
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockServo.MockServoFactory.html b/javadoc/edu/wpi/first/wpilibj/MockServo.MockServoFactory.html new file mode 100644 index 00000000..2f21a085 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockServo.MockServoFactory.html @@ -0,0 +1,319 @@ + + + + + +MockServo.MockServoFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockServo.MockServoFactory

+
+
+ +
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MockServoFactory() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract MockServocreate​(int channel) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MockServoFactory

        +
        public MockServoFactory()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockServo.html b/javadoc/edu/wpi/first/wpilibj/MockServo.html new file mode 100644 index 00000000..9c0bf676 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockServo.html @@ -0,0 +1,421 @@ + + + + + +MockServo (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockServo

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    XBaseIO
    +
    +
    +
    public class MockServo
+extends XServo
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      protected doublevalue 
      +
        +
      • + + +

        Fields inherited from class xbot.common.controls.actuators.XServo

        +channel
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MockServo​(int channel, + DevicePolice police) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      doublegetValue() 
      voidset​(double value) 
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        value

        +
        protected double value
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockServo

        +
        @AssistedInject
+public MockServo​(@Assisted("channel")
+                 int channel,
+                 DevicePolice police)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        set

        +
        public void set​(double value)
        +
        +
        Specified by:
        +
        set in class XServo
        +
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        public double getValue()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockSolenoid.MockSolenoidFactory.html b/javadoc/edu/wpi/first/wpilibj/MockSolenoid.MockSolenoidFactory.html new file mode 100644 index 00000000..fa93de67 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockSolenoid.MockSolenoidFactory.html @@ -0,0 +1,319 @@ + + + + + +MockSolenoid.MockSolenoidFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockSolenoid.MockSolenoidFactory

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract MockSolenoidcreate​(int channel) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MockSolenoidFactory

        +
        public MockSolenoidFactory()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockSolenoid.html b/javadoc/edu/wpi/first/wpilibj/MockSolenoid.html new file mode 100644 index 00000000..7692617b --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockSolenoid.html @@ -0,0 +1,476 @@ + + + + + +MockSolenoid (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockSolenoid

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        on

        +
        protected boolean on
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockSolenoid

        +
        @AssistedInject
+public MockSolenoid​(@Assisted("channel")
+                    int channel,
+                    DevicePolice police)
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockSpeedController.MockSpeedControllerFactory.html b/javadoc/edu/wpi/first/wpilibj/MockSpeedController.MockSpeedControllerFactory.html new file mode 100644 index 00000000..bf22a4c4 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockSpeedController.MockSpeedControllerFactory.html @@ -0,0 +1,319 @@ + + + + + +MockSpeedController.MockSpeedControllerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockSpeedController.MockSpeedControllerFactory

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract MockSpeedControllercreate​(int channel) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+ +
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockSpeedController.html b/javadoc/edu/wpi/first/wpilibj/MockSpeedController.html new file mode 100644 index 00000000..ba3b0d90 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockSpeedController.html @@ -0,0 +1,425 @@ + + + + + +MockSpeedController (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockSpeedController

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        value

        +
        protected double value
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MockSpeedController

        +
        @AssistedInject
+public MockSpeedController​(@Assisted("channel")
+                           int channel,
+                           DevicePolice police)
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockTimer.html b/javadoc/edu/wpi/first/wpilibj/MockTimer.html new file mode 100644 index 00000000..2680e2a2 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockTimer.html @@ -0,0 +1,405 @@ + + + + + +MockTimer (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockTimer

+
+
+ +
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MockTimer() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidadvanceTimeInSecondsBy​(double time) +
      Advance the timer
      +
      voiddelay​(double seconds) 
      doublegetFPGATimestamp() +
      Return the system clock time in seconds.
      +
      doublegetMatchTime() 
      voidsetTimeInSeconds​(double time) +
      Set the current time
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MockTimer

        +
        @Inject
+public MockTimer()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setTimeInSeconds

        +
        public void setTimeInSeconds​(double time)
        +
        Description copied from interface: XSettableTimerImpl
        +
        Set the current time
        +
        +
        Specified by:
        +
        setTimeInSeconds in interface XSettableTimerImpl
        +
        Parameters:
        +
        time - The current time in seconds
        +
        +
        • +
      + + + +
        +
      • +

        advanceTimeInSecondsBy

        +
        public void advanceTimeInSecondsBy​(double time)
        +
        Description copied from interface: XSettableTimerImpl
        +
        Advance the timer
        +
        +
        Specified by:
        +
        advanceTimeInSecondsBy in interface XSettableTimerImpl
        +
        Parameters:
        +
        time - Duration in seconds to advance by
        +
        +
        • +
      + + + +
        +
      • +

        getFPGATimestamp

        +
        public double getFPGATimestamp()
        +
        Return the system clock time in seconds. Return the time from the FPGA hardware clock in seconds since the FPGA + started.
        +
        +
        Specified by:
        +
        getFPGATimestamp in interface XTimerImpl
        +
        Returns:
        +
        Robot running time in seconds.
        +
        +
        • +
      + + + +
        +
      • +

        getMatchTime

        +
        public double getMatchTime()
        +
        +
        Specified by:
        +
        getMatchTime in interface XTimerImpl
        +
        +
        • +
      + + + +
        +
      • +

        delay

        +
        public void delay​(double seconds)
        +
        +
        Specified by:
        +
        delay in interface XTimerImpl
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockXboxControllerAdapter.MockXboxControllerFactory.html b/javadoc/edu/wpi/first/wpilibj/MockXboxControllerAdapter.MockXboxControllerFactory.html new file mode 100644 index 00000000..97331b17 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockXboxControllerAdapter.MockXboxControllerFactory.html @@ -0,0 +1,319 @@ + + + + + +MockXboxControllerAdapter.MockXboxControllerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockXboxControllerAdapter.MockXboxControllerFactory

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/MockXboxControllerAdapter.html b/javadoc/edu/wpi/first/wpilibj/MockXboxControllerAdapter.html new file mode 100644 index 00000000..f723ae71 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/MockXboxControllerAdapter.html @@ -0,0 +1,726 @@ + + + + + +MockXboxControllerAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package edu.wpi.first.wpilibj
+

Class MockXboxControllerAdapter

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/javadoc/edu/wpi/first/wpilibj/package-summary.html b/javadoc/edu/wpi/first/wpilibj/package-summary.html new file mode 100644 index 00000000..2ca81c53 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/package-summary.html @@ -0,0 +1,260 @@ + + + + + +edu.wpi.first.wpilibj (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package edu.wpi.first.wpilibj

+
+
+ +
+
+ + + diff --git a/javadoc/edu/wpi/first/wpilibj/package-tree.html b/javadoc/edu/wpi/first/wpilibj/package-tree.html new file mode 100644 index 00000000..bf817196 --- /dev/null +++ b/javadoc/edu/wpi/first/wpilibj/package-tree.html @@ -0,0 +1,233 @@ + + + + + +edu.wpi.first.wpilibj Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package edu.wpi.first.wpilibj

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/javadoc/element-list b/javadoc/element-list new file mode 100644 index 00000000..197954dc --- /dev/null +++ b/javadoc/element-list @@ -0,0 +1,30 @@ +edu.wpi.first.wpilibj +xbot.common.command +xbot.common.controls +xbot.common.controls.actuators +xbot.common.controls.actuators.mock_adapters +xbot.common.controls.actuators.wpi_adapters +xbot.common.controls.sensors +xbot.common.controls.sensors.buttons +xbot.common.controls.sensors.mock_adapters +xbot.common.controls.sensors.wpi_adapters +xbot.common.injection +xbot.common.injection.components +xbot.common.injection.electrical_contract +xbot.common.injection.modules +xbot.common.logging +xbot.common.logic +xbot.common.math +xbot.common.networking +xbot.common.properties +xbot.common.resiliency +xbot.common.simulation +xbot.common.subsystems +xbot.common.subsystems.autonomous +xbot.common.subsystems.compressor +xbot.common.subsystems.drive +xbot.common.subsystems.drive.control_logic +xbot.common.subsystems.feedback +xbot.common.subsystems.pose +xbot.common.subsystems.pose.commands +xbot.common.subsystems.simplemotor diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html new file mode 100644 index 00000000..cde16091 --- /dev/null +++ b/javadoc/help-doc.html @@ -0,0 +1,272 @@ + + + + + +API Help (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +
+This help file applies to API documentation generated by the standard doclet.
+
+ + + diff --git a/javadoc/index-all.html b/javadoc/index-all.html new file mode 100644 index 00000000..d55575d7 --- /dev/null +++ b/javadoc/index-all.html @@ -0,0 +1,7513 @@ + + + + + +Index (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
A B C D E F G H I J K L M N O P R S T U V W X Y Z 
All Classes All Packages + + +

A

+
+
A - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
Absolute - xbot.common.subsystems.drive.PurePursuitCommand.PointLoadingMode
+
 
+
absoluteEncoderFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
activateOptions() - Method in class xbot.common.logging.OneLogFilePerRunRollingFileAppender
+
 
+
adapter - Variable in class xbot.common.controls.sensors.wpi_adapters.DigitalInputWPIAdapter
+
 
+
add(XYPair) - Method in class xbot.common.math.XYPair
+
+
Adds the value of a second coordinate to the current coordinate.
+
+
addAnalogButton(int, double, double) - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
addAnalogButton(AnalogHIDButtonTrigger.AnalogHIDDescription) - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
addCommandToSmartDashboard(String, BaseCommand) - Method in class xbot.common.command.MockSmartDashboardCommandPutter
+
 
+
addCommandToSmartDashboard(String, BaseCommand) - Method in class xbot.common.command.RealSmartDashboardCommandPutter
+
 
+
addCommandToSmartDashboard(String, BaseCommand) - Method in interface xbot.common.command.SmartDashboardCommandPutter
+
 
+
addCommandToSmartDashboard(BaseCommand) - Method in class xbot.common.command.MockSmartDashboardCommandPutter
+
 
+
addCommandToSmartDashboard(BaseCommand) - Method in class xbot.common.command.RealSmartDashboardCommandPutter
+
 
+
addCommandToSmartDashboard(BaseCommand) - Method in interface xbot.common.command.SmartDashboardCommandPutter
+
 
+
additionalAtGoalChecks() - Method in class xbot.common.command.BaseMaintainerCommand
+
+
Maintainer systems already check for error tolerance and time stability.
+
+
addMagnitude(double) - Method in class xbot.common.math.XYPair
+
+
Add the magnitude to the vector represented by the coordinate.
+
+
addObserver(Consumer<Latch.EdgeType>) - Method in class xbot.common.logic.Latch
+
 
+
addPoint(FieldPose) - Method in class xbot.common.subsystems.drive.ConfigurablePurePursuitCommand
+
 
+
addPoint(RabbitPoint) - Method in class xbot.common.subsystems.drive.ConfigurablePurePursuitCommand
+
 
+
addPose(FieldPose) - Method in class xbot.common.subsystems.drive.RabbitPointBuilder
+
 
+
addTestBoolean(String, boolean) - Method in class xbot.common.injection.MockPermanentStorage
+
 
+
addTestDouble(String, double) - Method in class xbot.common.injection.MockPermanentStorage
+
 
+
addTestString(String, String) - Method in class xbot.common.injection.MockPermanentStorage
+
 
+
AdvancedJoystickButtonTrigger - Class in xbot.common.controls.sensors.buttons
+
 
+
AdvancedJoystickButtonTrigger(XJoystick, int) - Constructor for class xbot.common.controls.sensors.buttons.AdvancedJoystickButtonTrigger
+
 
+
AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory - Class in xbot.common.controls.sensors.buttons
+
 
+
AdvancedJoystickButtonTriggerFactory() - Constructor for class xbot.common.controls.sensors.buttons.AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory
+
 
+
AdvancedPovButtonTrigger - Class in xbot.common.controls.sensors.buttons
+
 
+
AdvancedPovButtonTrigger(XJoystick, int) - Constructor for class xbot.common.controls.sensors.buttons.AdvancedPovButtonTrigger
+
 
+
AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory - Class in xbot.common.controls.sensors.buttons
+
 
+
AdvancedPovButtonTriggerFactory() - Constructor for class xbot.common.controls.sensors.buttons.AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory
+
 
+
AdvancedTrigger - Class in xbot.common.controls.sensors.buttons
+
 
+
AdvancedTrigger(BooleanSupplier) - Constructor for class xbot.common.controls.sensors.buttons.AdvancedTrigger
+
 
+
AdvancedXboxAxisTrigger - Class in xbot.common.controls.sensors.buttons
+
 
+
AdvancedXboxAxisTrigger(XXboxController, XXboxController.XboxButton, double) - Constructor for class xbot.common.controls.sensors.buttons.AdvancedXboxAxisTrigger
+
 
+
AdvancedXboxButtonTrigger - Class in xbot.common.controls.sensors.buttons
+
 
+
AdvancedXboxButtonTrigger(XXboxController, XXboxController.XboxButton) - Constructor for class xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger
+
 
+
AdvancedXboxButtonTrigger(XXboxController, XXboxController.XboxButton, BooleanSupplier) - Constructor for class xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger
+
 
+
AdvancedXboxButtonTrigger.ButtonTriggerType - Enum in xbot.common.controls.sensors.buttons
+
 
+
advanceTimeInSecondsBy(double) - Method in class edu.wpi.first.wpilibj.MockTimer
+
 
+
advanceTimeInSecondsBy(double) - Method in class xbot.common.controls.sensors.wpi_adapters.TimerWpiAdapter
+
 
+
advanceTimeInSecondsBy(double) - Method in interface xbot.common.controls.sensors.XSettableTimerImpl
+
+
Advance the timer
+
+
allocatedButtons - Variable in class xbot.common.controls.sensors.XXboxController
+
 
+
Analog - xbot.common.injection.DevicePolice.DeviceType
+
 
+
AnalogDistanceSensor - Class in xbot.common.controls.sensors
+
 
+
AnalogDistanceSensor(XAnalogInput.XAnalogInputFactory, int, DoubleFunction<Double>, String, PropertyFactory) - Constructor for class xbot.common.controls.sensors.AnalogDistanceSensor
+
 
+
AnalogDistanceSensor.AnalogDistanceSensorFactory - Class in xbot.common.controls.sensors
+
 
+
analogDistanceSensorFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
AnalogDistanceSensorFactory() - Constructor for class xbot.common.controls.sensors.AnalogDistanceSensor.AnalogDistanceSensorFactory
+
 
+
AnalogHIDButtonConfiguration - Class in xbot.common.controls.sensors.buttons
+
 
+
AnalogHIDButtonConfiguration(XJoystick, int, double, double) - Constructor for class xbot.common.controls.sensors.buttons.AnalogHIDButtonConfiguration
+
 
+
analogHidButtonFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
AnalogHIDButtonTrigger - Class in xbot.common.controls.sensors.buttons
+
 
+
AnalogHIDButtonTrigger(XJoystick, int, double, double) - Constructor for class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger
+
+
Create a joystick button for triggering commands based off of an analog axis
+
+
AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory - Class in xbot.common.controls.sensors.buttons
+
 
+
AnalogHIDButtonTrigger.AnalogHIDDescription - Class in xbot.common.controls.sensors.buttons
+
 
+
AnalogHIDButtonTriggerFactory() - Constructor for class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory
+
 
+
AnalogHIDDescription(int, double, double) - Constructor for class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDDescription
+
 
+
analogInputFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
AnalogInputWPIAdapater - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
AnalogInputWPIAdapater(int, DevicePolice) - Constructor for class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater
+
 
+
AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
AnalogInputWPIAdapaterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory
+
 
+
analogMaxThreshold - Variable in class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDDescription
+
 
+
analogMinThreshold - Variable in class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDDescription
+
 
+
append(LoggingEvent) - Method in class xbot.common.logging.DriverStationAppender
+
 
+
appendPrefix(String) - Method in class xbot.common.properties.PropertyFactory
+
 
+
arcadeDrive(double, double) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Classic arcade drive
+
+
as5600Factory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
assertionManager - Variable in class xbot.common.controls.sensors.XXboxController
+
 
+
assertTrue(boolean, String) - Method in class xbot.common.logging.RobotAssertionManager
+
 
+
asyncJob - Variable in class xbot.common.math.PurePursuitTest
+
 
+
asyncTimer - Variable in class xbot.common.math.PurePursuitTest
+
 
+
atGoal - Variable in class xbot.common.command.BaseSetpointSubsystem
+
 
+
atSpeedProp - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
Attempting - xbot.common.logic.CalibrationDecider.CalibrationMode
+
 
+
autoInit() - Method in class xbot.common.logging.RobotSession
+
 
+
autonomousCommand - Variable in class xbot.common.command.BaseRobot
+
 
+
autonomousCommandSelector - Variable in class xbot.common.command.BaseRobot
+
 
+
autonomousCommandSelector() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
AutonomousCommandSelector - Class in xbot.common.subsystems.autonomous
+
 
+
AutonomousCommandSelector(PropertyFactory) - Constructor for class xbot.common.subsystems.autonomous.AutonomousCommandSelector
+
 
+
autonomousInit() - Method in class xbot.common.command.BaseRobot
+
 
+
autonomousPeriodic() - Method in class xbot.common.command.BaseRobot
+
+
This function is called periodically during autonomous
+
+
axisNumber - Variable in class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDDescription
+
 
+
+ + + +

B

+
+
B - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
Back - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
BaseCommand - Class in xbot.common.command
+
+
Enhanced version of WPILib's Command that allows for extension of existing + functionality.
+
+
BaseCommand() - Constructor for class xbot.common.command.BaseCommand
+
 
+
BaseComponent - Class in xbot.common.injection.components
+
+
Base class for all Components that provides methods to get implementations from DI.
+
+
BaseComponent() - Constructor for class xbot.common.injection.components.BaseComponent
+
 
+
BaseDriveSubsystem - Class in xbot.common.subsystems.drive
+
 
+
BaseDriveSubsystem() - Constructor for class xbot.common.subsystems.drive.BaseDriveSubsystem
+
 
+
BaseMaintainerCommand<T> - Class in xbot.common.command
+
 
+
BaseMaintainerCommand(BaseSetpointSubsystem, PropertyFactory, HumanVsMachineDecider.HumanVsMachineDeciderFactory, double, double) - Constructor for class xbot.common.command.BaseMaintainerCommand
+
 
+
BasePoseSubsystem - Class in xbot.common.subsystems.pose
+
 
+
BasePoseSubsystem(XGyro.XGyroFactory, PropertyFactory) - Constructor for class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
BaseRobot - Class in xbot.common.command
+
+
Core Robot class which configures logging, properties, + scheduling, and the injector.
+
+
BaseRobot() - Constructor for class xbot.common.command.BaseRobot
+
 
+
BaseSetpointCommand - Class in xbot.common.command
+
 
+
BaseSetpointCommand(SupportsSetpointLock...) - Constructor for class xbot.common.command.BaseSetpointCommand
+
 
+
BaseSetpointSubsystem<T> - Class in xbot.common.command
+
 
+
BaseSetpointSubsystem() - Constructor for class xbot.common.command.BaseSetpointSubsystem
+
 
+
BaseSimulationTest - Class in xbot.common.simulation
+
 
+
BaseSimulationTest() - Constructor for class xbot.common.simulation.BaseSimulationTest
+
 
+
BaseSubsystem - Class in xbot.common.command
+
 
+
BaseSubsystem() - Constructor for class xbot.common.command.BaseSubsystem
+
 
+
BaseWaitForMaintainerCommand - Class in xbot.common.command
+
+
Command that waits for a setpoint subsystem to reach its goal
+
+
BaseWaitForMaintainerCommand(BaseSetpointSubsystem, PropertyFactory, double) - Constructor for class xbot.common.command.BaseWaitForMaintainerCommand
+
 
+
BaseWPITest - Class in xbot.common.injection
+
 
+
BaseWPITest() - Constructor for class xbot.common.injection.BaseWPITest
+
 
+
BaseXCANTalonPairSpeedControlledSubsystem - Class in xbot.common.subsystems
+
 
+
BaseXCANTalonPairSpeedControlledSubsystem(String, int, int, boolean, boolean, boolean, XCANTalon.XCANTalonFactory, PIDPropertyManager, PropertyFactory) - Constructor for class xbot.common.subsystems.BaseXCANTalonPairSpeedControlledSubsystem
+
 
+
BaseXCANTalonSpeedControlledSubsystem - Class in xbot.common.subsystems
+
+
We have a few Subsystems that have one primary goal: + -Get a motor to rotate at a specific controlled speed.
+
+
BaseXCANTalonSpeedControlledSubsystem(String, int, boolean, boolean, XCANTalon.XCANTalonFactory, PIDPropertyManager, PropertyFactory) - Constructor for class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
batteryVoltage - Variable in class xbot.common.command.BaseRobot
+
 
+
BooleanProperty - Class in xbot.common.properties
+
+
A property holding a boolean value.
+
+
BooleanProperty(String, boolean, Property.PropertyPersistenceType, XPropertyManager) - Constructor for class xbot.common.properties.BooleanProperty
+
 
+
BooleanProperty(String, boolean, Property.PropertyPersistenceType, XPropertyManager, Property.PropertyLevel) - Constructor for class xbot.common.properties.BooleanProperty
+
 
+
BooleanProperty(String, boolean, XPropertyManager) - Constructor for class xbot.common.properties.BooleanProperty
+
 
+
Both - xbot.common.logic.Latch.EdgeType
+
 
+
build() - Method in class xbot.common.subsystems.drive.RabbitPointBuilder
+
 
+
buildMotorObject(int, boolean) - Method in interface xbot.common.simulation.ISimulatableSolenoid
+
 
+
buildMotorObject(String, float) - Method in interface xbot.common.simulation.ISimulatableMotor
+
 
+
burnFlash() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
burnFlash() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
burnFlash() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Writes all settings to flash.
+
+
buttonName - Variable in class xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger
+
 
+
+ + + +

C

+
+
calculate(double, double) - Method in class xbot.common.math.PIDManager
+
 
+
calculate(double, double, double, double, double) - Method in class xbot.common.math.PID
+
+
Calculates the output value given P,I,D, a process variable and a goal
+
+
calculate(double, double, double, double, double, double) - Method in class xbot.common.math.PID
+
+
Calculates the output value given P,I,D, a process variable and a goal
+
+
calculate(double, double, double, double, double, double, double) - Method in class xbot.common.math.PID
+
+
Calculates the output value given P,I,D, a process variable and a goal
+
+
calculateAverageCurrent() - Method in class xbot.common.controls.sensors.TalonCurrentMonitor
+
 
+
calculateHeadingPower(double) - Method in class xbot.common.subsystems.drive.control_logic.HeadingAssistModule
+
+
Core method of the HeadingAssistModule.
+
+
calculateHeadingPower(double) - Method in class xbot.common.subsystems.drive.control_logic.HeadingModule
+
 
+
calculateHeadingPower(Rotation2d) - Method in class xbot.common.subsystems.drive.control_logic.HeadingModule
+
 
+
calculatePeakCurrent() - Method in class xbot.common.controls.sensors.TalonCurrentMonitor
+
 
+
calculateThrottle(double, double) - Method in class xbot.common.logic.VelocityThrottleModule
+
 
+
Calibrated - xbot.common.logic.CalibrationDecider.CalibrationMode
+
 
+
calibratedMachineControlAction() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
calibrateInherentRioOrientation() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
CalibrationDecider - Class in xbot.common.logic
+
 
+
CalibrationDecider(String, PropertyFactory) - Constructor for class xbot.common.logic.CalibrationDecider
+
 
+
CalibrationDecider.CalibrationDeciderFactory - Class in xbot.common.logic
+
 
+
CalibrationDecider.CalibrationMode - Enum in xbot.common.logic
+
 
+
calibrationDeciderFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
CalibrationDeciderFactory() - Constructor for class xbot.common.logic.CalibrationDecider.CalibrationDeciderFactory
+
 
+
CAN - xbot.common.injection.DevicePolice.DeviceType
+
 
+
CANCoderAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
CANCoderAdapter(DeviceInfo, String, DevicePolice, PropertyFactory) - Constructor for class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
CANCoderAdapter.CANCoderAdapterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
CANCoderAdapterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter.CANCoderAdapterFactory
+
 
+
canCoderFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
canSparkMaxFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
CANSparkMaxWpiAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
CANSparkMaxWpiAdapter(DeviceInfo, String, String, PropertyFactory, DevicePolice, XCANSparkMaxPIDProperties) - Constructor for class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
CANSparkMaxWpiAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory
+
 
+
canTalonFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
CANTalonInfo - Class in xbot.common.injection.electrical_contract
+
 
+
CANTalonInfo(int) - Constructor for class xbot.common.injection.electrical_contract.CANTalonInfo
+
 
+
CANTalonInfo(int, boolean) - Constructor for class xbot.common.injection.electrical_contract.CANTalonInfo
+
 
+
CANTalonInfo(int, boolean, FeedbackDevice, boolean) - Constructor for class xbot.common.injection.electrical_contract.CANTalonInfo
+
 
+
CANTalonInfo(int, boolean, FeedbackDevice, boolean, double) - Constructor for class xbot.common.injection.electrical_contract.CANTalonInfo
+
 
+
CANTalonWPIAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
CANTalonWPIAdapter(CANTalonInfo, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
CANTalonWPIAdapter.CANTalonWPIAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
CANTalonWPIAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter.CANTalonWPIAdapterFactory
+
 
+
canVictorSpxFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
CANVictorSPXWpiAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
CANVictorSPXWpiAdapter(int, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
CANVictorSPXWpiAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory
+
 
+
changeDriveStyle(RabbitPoint.PointDriveStyle) - Method in class xbot.common.subsystems.drive.RabbitPointBuilder
+
 
+
changeIntoMecanum() - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
changeIntoNoDrive() - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
changeIntoTankDrive() - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
changeMotionControlFramePeriod(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
changeMotionControlFramePeriod(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
changeMotionControlFramePeriod(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
changeMotionControlFramePeriod(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
changeMotionControlFramePeriod(int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
changeMotionControlFramePeriod(int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
changePointType(RabbitPoint.PointType) - Method in class xbot.common.subsystems.drive.RabbitPointBuilder
+
 
+
changePositionalPid(PIDManager) - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
changeRotationalPid(PIDManager) - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
changeTerminatingType(RabbitPoint.PointTerminatingType) - Method in class xbot.common.subsystems.drive.RabbitPointBuilder
+
 
+
channel - Variable in class edu.wpi.first.wpilibj.MockDigitalOutput
+
 
+
channel - Variable in class edu.wpi.first.wpilibj.MockPWM
+
 
+
channel - Variable in class xbot.common.controls.actuators.XDigitalOutput
+
 
+
channel - Variable in class xbot.common.controls.actuators.XPWM
+
 
+
channel - Variable in class xbot.common.controls.actuators.XRelay
+
 
+
channel - Variable in class xbot.common.controls.actuators.XServo
+
 
+
channel - Variable in class xbot.common.controls.actuators.XSolenoid
+
 
+
channel - Variable in class xbot.common.controls.actuators.XSpeedController
+
 
+
channel - Variable in class xbot.common.controls.sensors.XAnalogInput
+
 
+
channel - Variable in class xbot.common.controls.sensors.XDutyCycleEncoder
+
 
+
channel - Variable in class xbot.common.injection.electrical_contract.CANTalonInfo
+
 
+
channel - Variable in class xbot.common.injection.electrical_contract.DeviceInfo
+
 
+
chaseData - Variable in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
check() - Method in class xbot.common.logic.WatchdogTimer
+
 
+
checkStable(boolean) - Method in class xbot.common.logic.TimeStableValidator
+
 
+
checkValue(boolean) - Method in class xbot.common.logging.LoggingLatch
+
 
+
cheesyDrive(double, double) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Slightly adapted from 254's 2016 CheesyDriveHelper.java.
+
+
chordButtonFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
ChordTrigger - Class in xbot.common.controls.sensors.buttons
+
 
+
ChordTrigger(Trigger, Trigger) - Constructor for class xbot.common.controls.sensors.buttons.ChordTrigger
+
 
+
ChordTrigger.ChordTriggerFactory - Class in xbot.common.controls.sensors.buttons
+
 
+
ChordTriggerFactory() - Constructor for class xbot.common.controls.sensors.buttons.ChordTrigger.ChordTriggerFactory
+
 
+
classInstantiationTime - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
clear() - Method in class xbot.common.properties.DatabaseStorageBase
+
 
+
clear() - Method in interface xbot.common.properties.ITableProxy
+
 
+
clear() - Method in class xbot.common.properties.PreferenceStorage
+
 
+
clear() - Method in class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
clear() - Method in class xbot.common.properties.TableProxy
+
 
+
clearFaults() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
clearFaults() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
clearFaults() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Clears all sticky faults.
+
+
clearMotionProfileHasUnderrun() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
clearMotionProfileHasUnderrun(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
clearMotionProfileHasUnderrun(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
clearMotionProfileHasUnderrun(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
clearMotionProfileHasUnderrun(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
clearMotionProfileHasUnderrun(int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
clearMotionProfileHasUnderrun(int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
clearMotionProfileTrajectories() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
clearMotionProfileTrajectories() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
clearMotionProfileTrajectories() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
clearMotionProfileTrajectories() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
clearMotionProfileTrajectories() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
clearMotionProfileTrajectories() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
clearStickyFaults() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
clearStickyFaults() - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
clearStickyFaults() - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
clearStickyFaults() - Method in class xbot.common.controls.sensors.XCANCoder
+
 
+
clearStickyFaults(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
clearStickyFaults(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
clearStickyFaults(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
clearStickyFaults(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
clearStickyFaults(int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
clearStickyFaults(int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
clone() - Method in class xbot.common.math.ContiguousDouble
+
 
+
clone() - Method in class xbot.common.math.FieldPose
+
 
+
clone() - Method in class xbot.common.math.XYPair
+
+
Clone the object
+
+
close() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
close() - Method in class xbot.common.logging.DriverStationAppender
+
 
+
Coast - xbot.common.logic.HumanVsMachineDecider.HumanVsMachineMode
+
 
+
coastAction() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
command - Variable in class xbot.common.math.PurePursuitTest
+
 
+
compressorFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
CompressorSubsystem - Class in xbot.common.subsystems.compressor
+
 
+
CompressorSubsystem(XCompressor.XCompressorFactory, PropertyFactory) - Constructor for class xbot.common.subsystems.compressor.CompressorSubsystem
+
 
+
CompressorWPIAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
CompressorWPIAdapter() - Constructor for class xbot.common.controls.actuators.wpi_adapters.CompressorWPIAdapter
+
 
+
CompressorWPIAdapter.CompressorWPIAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
CompressorWPIAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.CompressorWPIAdapter.CompressorWPIAdapterFactory
+
 
+
config_IntegralZone(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
config_IntegralZone(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
config_IntegralZone(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
config_IntegralZone(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_IntegralZone(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
config_IntegralZone(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_IntegralZone(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
config_IntegralZone(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
config_IntegralZone(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
config_IntegralZone(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_IntegralZone(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
config_IntegralZone(int, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
config_kD(int, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_kD(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
config_kD(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
config_kD(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
config_kD(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_kD(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
config_kD(int, double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
config_kF(int, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_kF(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
config_kF(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
config_kF(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
config_kF(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_kF(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
config_kF(int, double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
config_kI(int, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_kI(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
config_kI(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
config_kI(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
config_kI(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_kI(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
config_kI(int, double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
config_kP(int, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_kP(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
config_kP(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
config_kP(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
config_kP(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
config_kP(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
config_kP(int, double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configAllowableClosedloopError(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configAllowableClosedloopError(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configAllowableClosedloopError(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configAllowableClosedloopError(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configAllowableClosedloopError(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configAllowableClosedloopError(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configAllowableClosedloopError(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configAllowableClosedloopError(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configAllowableClosedloopError(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configAllowableClosedloopError(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configAllowableClosedloopError(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configAllowableClosedloopError(int, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configAllSettings(VictorSPXConfiguration) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configAllSettings(VictorSPXConfiguration, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configAuxPIDPolarity(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configAuxPIDPolarity(boolean, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configAuxPIDPolarity(boolean, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configAuxPIDPolarity(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configAuxPIDPolarity(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configAuxPIDPolarity(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configClearPositionOnLimitF(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configClearPositionOnLimitR(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configClearPositionOnQuadIdx(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configClosedLoopPeakOutput(int, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configClosedLoopPeakOutput(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configClosedLoopPeakOutput(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configClosedLoopPeakOutput(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configClosedLoopPeakOutput(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configClosedLoopPeakOutput(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configClosedLoopPeriod(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configClosedLoopPeriod(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configClosedLoopPeriod(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configClosedLoopPeriod(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configClosedLoopPeriod(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configClosedLoopPeriod(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configClosedloopRamp(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configClosedloopRamp(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configClosedloopRamp(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configClosedloopRamp(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configClosedloopRamp(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configClosedloopRamp(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configClosedloopRamp(double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configContinuousCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configContinuousCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configContinuousCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configContinuousCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configContinuousCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configContinuousCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configFactoryDefault() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configFactoryDefault(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configFeedbackNotContinuous(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configForwardLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configForwardLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configForwardLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configForwardLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configForwardLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configForwardLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configForwardLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configForwardLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configForwardLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configForwardSoftLimitEnable(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configForwardSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configForwardSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configForwardSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configForwardSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configForwardSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configForwardSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configForwardSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configForwardSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configForwardSoftLimitThreshold(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configForwardSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configForwardSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configForwardSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configForwardSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configForwardSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configGetCustomParam(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configGetCustomParam(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configGetCustomParam(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configGetCustomParam(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configGetCustomParam(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configGetCustomParam(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configGetCustomParam(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configGetParameter(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configGetParameter(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configGetParameter(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configGetParameter(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configGetParameter(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configGetParameter(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configGetParameter(int, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configGetParameter(ParamEnum, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configGetParameter(ParamEnum, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configGetParameter(ParamEnum, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configGetParameter(ParamEnum, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configGetParameter(ParamEnum, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configGetParameter(ParamEnum, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configGetParameter(ParamEnum, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configLimitSwitchDisableNeutralOnLOS(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMaxIntegralAccumulator(int, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMaxIntegralAccumulator(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configMaxIntegralAccumulator(int, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configMaxIntegralAccumulator(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configMaxIntegralAccumulator(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMaxIntegralAccumulator(int, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configMaxIntegralAccumulator(int, double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configMotionAcceleration(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configMotionAcceleration(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configMotionAcceleration(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configMotionAcceleration(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionAcceleration(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configMotionAcceleration(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionAcceleration(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configMotionAcceleration(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configMotionAcceleration(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configMotionAcceleration(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionAcceleration(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configMotionAcceleration(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configMotionCruiseVelocity(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configMotionCruiseVelocity(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configMotionCruiseVelocity(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configMotionCruiseVelocity(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionCruiseVelocity(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configMotionCruiseVelocity(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionCruiseVelocity(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configMotionCruiseVelocity(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configMotionCruiseVelocity(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configMotionCruiseVelocity(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionCruiseVelocity(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configMotionCruiseVelocity(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configMotionProfileTrajectoryInterpolationEnable(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionProfileTrajectoryInterpolationEnable(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionProfileTrajectoryPeriod(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionProfileTrajectoryPeriod(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configMotionProfileTrajectoryPeriod(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configMotionProfileTrajectoryPeriod(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configMotionProfileTrajectoryPeriod(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionProfileTrajectoryPeriod(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configMotionSCurveStrength(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionSCurveStrength(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configMotionSCurveStrength(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configMotionSCurveStrength(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configMotionSCurveStrength(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configMotionSCurveStrength(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configNeutralDeadband(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configNeutralDeadband(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configNeutralDeadband(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configNeutralDeadband(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configNeutralDeadband(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configNeutralDeadband(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configNeutralDeadband(double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configNominalOutputForward(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configNominalOutputForward(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configNominalOutputForward(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configNominalOutputForward(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configNominalOutputForward(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configNominalOutputForward(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configNominalOutputForward(double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configNominalOutputReverse(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configNominalOutputReverse(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configNominalOutputReverse(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configNominalOutputReverse(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configNominalOutputReverse(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configNominalOutputReverse(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configNominalOutputReverse(double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configOpenloopRamp(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configOpenloopRamp(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configOpenloopRamp(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configOpenloopRamp(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configOpenloopRamp(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configOpenloopRamp(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configOpenloopRamp(double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configPeakCurrentDuration(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configPeakCurrentDuration(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configPeakCurrentDuration(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configPeakCurrentDuration(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configPeakCurrentDuration(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configPeakCurrentDuration(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configPeakCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configPeakCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configPeakCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configPeakCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configPeakCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configPeakCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configPeakOutputForward(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configPeakOutputForward(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configPeakOutputForward(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configPeakOutputForward(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configPeakOutputForward(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configPeakOutputForward(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configPeakOutputForward(double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configPeakOutputReverse(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configPeakOutputReverse(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configPeakOutputReverse(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configPeakOutputReverse(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configPeakOutputReverse(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configPeakOutputReverse(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configPeakOutputReverse(double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configPulseWidthPeriod_EdgesPerRot(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configPulseWidthPeriod_FilterWindowSz(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configRemoteFeedbackFilter(int, RemoteSensorSource, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configRemoteFeedbackFilter(int, RemoteSensorSource, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configRemoteFeedbackFilter(int, RemoteSensorSource, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configRemoteFeedbackFilter(int, RemoteSensorSource, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configRemoteFeedbackFilter(int, RemoteSensorSource, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configRemoteFeedbackFilter(int, RemoteSensorSource, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configRemoteFeedbackFilter(int, RemoteSensorSource, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configRemoteFeedbackFilter(BaseTalon, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configRemoteFeedbackFilter(BaseTalon, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configRemoteFeedbackFilter(BaseTalon, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configRemoteFeedbackFilter(BaseTalon, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configRemoteFeedbackFilter(BaseTalon, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configRemoteFeedbackFilter(CANCoder, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configRemoteFeedbackFilter(CANCoder, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configRemoteFeedbackFilter(CANCoder, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configRemoteFeedbackFilter(CANCoder, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configRemoteFeedbackFilter(CANCoder, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configRemoteSensorClosedLoopDisableNeutralOnLOS(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configReverseLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configReverseLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configReverseLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configReverseLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configReverseLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configReverseLimitSwitchSource(LimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configReverseLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configReverseLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configReverseLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configReverseLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configReverseLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configReverseLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configReverseLimitSwitchSource(RemoteLimitSwitchSource, LimitSwitchNormal, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configReverseSoftLimitEnable(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configReverseSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configReverseSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configReverseSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configReverseSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configReverseSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configReverseSoftLimitEnable(boolean, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configReverseSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configReverseSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configReverseSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configReverseSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configReverseSoftLimitThreshold(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configReverseSoftLimitThreshold(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configReverseSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configReverseSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configReverseSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configReverseSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configReverseSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configReverseSoftLimitThreshold(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configSelectedFeedbackCoefficient(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSelectedFeedbackCoefficient(double, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configSelectedFeedbackCoefficient(double, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configSelectedFeedbackCoefficient(double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configSelectedFeedbackCoefficient(double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSelectedFeedbackCoefficient(double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configSelectedFeedbackSensor(FeedbackDevice) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSelectedFeedbackSensor(FeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configSelectedFeedbackSensor(FeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configSelectedFeedbackSensor(FeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configSelectedFeedbackSensor(FeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSelectedFeedbackSensor(FeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configSelectedFeedbackSensor(FeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configSelectedFeedbackSensor(RemoteFeedbackDevice) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSelectedFeedbackSensor(RemoteFeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configSelectedFeedbackSensor(RemoteFeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configSelectedFeedbackSensor(RemoteFeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configSelectedFeedbackSensor(RemoteFeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSelectedFeedbackSensor(RemoteFeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configSelectedFeedbackSensor(RemoteFeedbackDevice, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configSensorTerm(SensorTerm, FeedbackDevice) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSensorTerm(SensorTerm, FeedbackDevice, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configSensorTerm(SensorTerm, FeedbackDevice, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configSensorTerm(SensorTerm, FeedbackDevice, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configSensorTerm(SensorTerm, FeedbackDevice, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSensorTerm(SensorTerm, FeedbackDevice, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configSensorTerm(SensorTerm, FeedbackDevice, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configSensorTerm(SensorTerm, RemoteFeedbackDevice) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSensorTerm(SensorTerm, RemoteFeedbackDevice, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSetCustomParam(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSetCustomParam(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configSetCustomParam(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configSetCustomParam(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configSetCustomParam(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSetCustomParam(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configSetCustomParam(int, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configSetParameter(int, double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSetParameter(int, double, int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configSetParameter(int, double, int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configSetParameter(int, double, int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configSetParameter(int, double, int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSetParameter(int, double, int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configSetParameter(int, double, int, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configSetParameter(ParamEnum, double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSetParameter(ParamEnum, double, int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configSetParameter(ParamEnum, double, int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configSetParameter(ParamEnum, double, int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configSetParameter(ParamEnum, double, int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSetParameter(ParamEnum, double, int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configSetParameter(ParamEnum, double, int, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configSoftLimitDisableNeutralOnLOS(boolean, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSupplyCurrentLimit(SupplyCurrentLimitConfiguration, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configSupplyCurrentLimit(SupplyCurrentLimitConfiguration, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configSupplyCurrentLimit(SupplyCurrentLimitConfiguration, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configSupplyCurrentLimit(SupplyCurrentLimitConfiguration, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configSupplyCurrentLimit(SupplyCurrentLimitConfiguration, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configurablePurePursuitCommand() - Method in class xbot.common.injection.components.PurePursuitTestComponent
+
 
+
ConfigurablePurePursuitCommand - Class in xbot.common.subsystems.drive
+
 
+
ConfigurablePurePursuitCommand(HeadingModule.HeadingModuleFactory, BasePoseSubsystem, BaseDriveSubsystem, PropertyFactory) - Constructor for class xbot.common.subsystems.drive.ConfigurablePurePursuitCommand
+
 
+
configureAsFollowerMotor(XCANTalon, boolean) - Method in class xbot.common.controls.actuators.XCANTalon
+
+
Convenience function to rapidly configure a XCANTalon to follow another XCANTalon.
+
+
configureAsMasterMotor(String, String, boolean, boolean) - Method in class xbot.common.controls.actuators.XCANTalon
+
+
Convenience function to rapidly configure a CANTalon as a Master motor.
+
+
configureFilter(FilterConfiguration) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
+
Deprecated.
+
+
configureFilter(FilterConfiguration, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
+
Deprecated.
+
+
configureFilter(FilterConfiguration, int, int, boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
+
Deprecated.
+
+
configureMotorTeam(String, String, XCANTalon, XCANTalon, boolean, boolean, boolean) - Static method in class xbot.common.controls.actuators.XCANTalon
+
+
Convenience function to rapidly configure two CANTalons to work in tandem; often used for drive motors.
+
+
configureMotorTeam(String, String, XCANTalon, XCANTalon, XCANTalon, boolean, boolean, boolean, boolean) - Static method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configureMotorTeam(String, String, XCANTalon, XCANTalon, XCANTalon, XCANTalon, boolean, boolean, boolean, boolean, boolean) - Static method in class xbot.common.controls.actuators.XCANTalon
+
 
+
ConfigurePropertiesCommand - Class in xbot.common.properties
+
 
+
ConfigurePropertiesCommand(ITableProxy) - Constructor for class xbot.common.properties.ConfigurePropertiesCommand
+
 
+
configureSlot(SlotConfiguration) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
+
Deprecated.
+
+
configureSlot(SlotConfiguration, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
+
Deprecated.
+
+
configVelocityMeasurementPeriod(VelocityMeasPeriod) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configVelocityMeasurementPeriod(VelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configVelocityMeasurementPeriod(VelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configVelocityMeasurementPeriod(VelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configVelocityMeasurementPeriod(VelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configVelocityMeasurementPeriod(VelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configVelocityMeasurementPeriod(SensorVelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configVelocityMeasurementPeriod(SensorVelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configVelocityMeasurementPeriod(SensorVelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configVelocityMeasurementPeriod(SensorVelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configVelocityMeasurementPeriod(SensorVelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configVelocityMeasurementPeriod(SensorVelocityMeasPeriod, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configVelocityMeasurementWindow(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configVelocityMeasurementWindow(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configVelocityMeasurementWindow(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configVelocityMeasurementWindow(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configVelocityMeasurementWindow(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configVelocityMeasurementWindow(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configVelocityMeasurementWindow(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configVoltageCompSaturation(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configVoltageCompSaturation(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configVoltageCompSaturation(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configVoltageCompSaturation(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configVoltageCompSaturation(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configVoltageCompSaturation(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configVoltageCompSaturation(double, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
configVoltageMeasurementFilter(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configVoltageMeasurementFilter(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
configVoltageMeasurementFilter(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
configVoltageMeasurementFilter(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
configVoltageMeasurementFilter(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
configVoltageMeasurementFilter(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
configVoltageMeasurementFilter(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
constrainDouble(double, double, double) - Static method in class xbot.common.math.MathUtils
+
 
+
constrainDoubleToRobotScale(double) - Static method in class xbot.common.math.MathUtils
+
 
+
constrainInt(int, int, int) - Static method in class xbot.common.math.MathUtils
+
 
+
ContiguousDouble - Class in xbot.common.math
+
+
Wraps a double to allow easy comparison and manipulation of sensor readings + that wrap (e.g.
+
+
ContiguousDouble() - Constructor for class xbot.common.math.ContiguousDouble
+
 
+
ContiguousDouble(double, double) - Constructor for class xbot.common.math.ContiguousDouble
+
 
+
ContiguousDouble(double, double, double) - Constructor for class xbot.common.math.ContiguousDouble
+
 
+
Continue - xbot.common.subsystems.drive.RabbitPoint.PointTerminatingType
+
 
+
controller - Variable in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
controlPanel - Variable in class xbot.common.math.PlanarTestVisualizer
+
 
+
create() - Method in class edu.wpi.first.wpilibj.MockCompressor.MockCompressorFactory
+
 
+
create() - Method in class edu.wpi.first.wpilibj.MockPowerDistributionPanel.MockPowerDistributionPanelFactory
+
 
+
create() - Method in class xbot.common.controls.actuators.wpi_adapters.CompressorWPIAdapter.CompressorWPIAdapterFactory
+
 
+
create() - Method in interface xbot.common.controls.actuators.XCompressor.XCompressorFactory
+
 
+
create() - Method in class xbot.common.controls.sensors.buttons.VirtualTrigger.VirtualTriggerFactory
+
 
+
create() - Method in class xbot.common.controls.sensors.wpi_adapters.PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory
+
 
+
create() - Method in class xbot.common.controls.sensors.XGyro.XGyroFactory
+
 
+
create() - Method in interface xbot.common.controls.sensors.XPowerDistributionPanel.XPowerDistributionPanelFactory
+
 
+
create(boolean) - Method in class xbot.common.controls.sensors.buttons.VirtualTrigger.VirtualTriggerFactory
+
 
+
create(int) - Method in class edu.wpi.first.wpilibj.MockAnalogInput.MockAnalogInputFactory
+
 
+
create(int) - Method in class edu.wpi.first.wpilibj.MockDigitalInput.MockDigitalInputFactory
+
 
+
create(int) - Method in class edu.wpi.first.wpilibj.MockDigitalOutput.MockDigitalOutputFactory
+
 
+
create(int) - Method in class edu.wpi.first.wpilibj.MockPWM.MockPWMFactory
+
 
+
create(int) - Method in class edu.wpi.first.wpilibj.MockServo.MockServoFactory
+
 
+
create(int) - Method in class edu.wpi.first.wpilibj.MockSolenoid.MockSolenoidFactory
+
 
+
create(int) - Method in class edu.wpi.first.wpilibj.MockSpeedController.MockSpeedControllerFactory
+
 
+
create(int) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter.MockXboxControllerFactory
+
 
+
create(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX.MockCANVictorSPXFactory
+
 
+
create(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockRelay.MockRelayFactory
+
 
+
create(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory
+
 
+
create(int) - Method in class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory
+
 
+
create(int) - Method in class xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter.PWMWPIAdapterFactory
+
 
+
create(int) - Method in class xbot.common.controls.actuators.wpi_adapters.RelayWPIAdapter.RelayWPIAdapterFactory
+
 
+
create(int) - Method in class xbot.common.controls.actuators.wpi_adapters.ServoWPIAdapter.ServoWPIAdapterFactory
+
 
+
create(int) - Method in class xbot.common.controls.actuators.wpi_adapters.SolenoidWPIAdapter.SolenoidWPIAdapterFactory
+
 
+
create(int) - Method in class xbot.common.controls.actuators.wpi_adapters.SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory
+
 
+
create(int) - Method in interface xbot.common.controls.actuators.XCANVictorSPX.XCANVictorSPXFactory
+
 
+
create(int) - Method in interface xbot.common.controls.actuators.XDigitalOutput.XDigitalOutputFactory
+
 
+
create(int) - Method in interface xbot.common.controls.actuators.XPWM.XPWMFactory
+
 
+
create(int) - Method in interface xbot.common.controls.actuators.XRelay.XRelayFactory
+
 
+
create(int) - Method in interface xbot.common.controls.actuators.XServo.XServoFactory
+
 
+
create(int) - Method in interface xbot.common.controls.actuators.XSolenoid.XSolenoidFactory
+
 
+
create(int) - Method in interface xbot.common.controls.actuators.XSpeedController.XSpeedControllerFactory
+
 
+
create(int) - Method in class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory
+
 
+
create(int) - Method in class xbot.common.controls.sensors.wpi_adapters.DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory
+
 
+
create(int) - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory
+
 
+
create(int) - Method in interface xbot.common.controls.sensors.XAnalogInput.XAnalogInputFactory
+
 
+
create(int) - Method in interface xbot.common.controls.sensors.XDigitalInput.XDigitalInputFactory
+
 
+
create(int) - Method in interface xbot.common.controls.sensors.XXboxController.XXboxControllerFactory
+
 
+
create(int, int) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad.MockFTCGamepadFactory
+
 
+
create(int, int) - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick.MockJoystickFactory
+
 
+
create(int, int) - Method in class xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory
+
 
+
create(int, int) - Method in class xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter.JoystickWPIAdapterFactory
+
 
+
create(int, int) - Method in interface xbot.common.controls.sensors.XFTCGamepad.XFTCGamepadFactory
+
 
+
create(int, int) - Method in interface xbot.common.controls.sensors.XJoystick.XJoystickFactory
+
 
+
create(int, DoubleFunction<Double>, String) - Method in class xbot.common.controls.sensors.AnalogDistanceSensor.AnalogDistanceSensorFactory
+
 
+
create(int, DoubleFunction<Double>, String) - Method in class xbot.common.controls.sensors.SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory
+
 
+
create(int, DoubleFunction<Double>, String) - Method in interface xbot.common.controls.sensors.XAnalogDistanceSensor.XAnalogDistanceSensorFactory
+
 
+
create(I2C.Port) - Method in class xbot.common.controls.sensors.XGyro.XGyroFactory
+
 
+
create(I2C.Port, String) - Method in class edu.wpi.first.wpilibj.MockLidarLite.MockLidarLiteFactory
+
 
+
create(I2C.Port, String) - Method in class xbot.common.controls.sensors.wpi_adapters.LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory
+
 
+
create(I2C.Port, String) - Method in interface xbot.common.controls.sensors.XLidarLite.XLidarLiteFactory
+
 
+
create(SerialPort.Port) - Method in class xbot.common.controls.sensors.XGyro.XGyroFactory
+
 
+
create(SPI.Port) - Method in class xbot.common.controls.sensors.XGyro.XGyroFactory
+
 
+
create(SPI.Port, SerialPort.Port, I2C.Port) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro.MockGyroFactory
+
 
+
create(SPI.Port, SerialPort.Port, I2C.Port) - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory
+
 
+
create(SPI.Port, SerialPort.Port, I2C.Port) - Method in class xbot.common.controls.sensors.XGyro.XGyroFactory
+
 
+
create(Trigger, Trigger) - Method in class xbot.common.controls.sensors.buttons.ChordTrigger.ChordTriggerFactory
+
 
+
create(String) - Method in class xbot.common.logic.CalibrationDecider.CalibrationDeciderFactory
+
 
+
create(String) - Method in class xbot.common.logic.HumanVsMachineDecider.HumanVsMachineDeciderFactory
+
 
+
create(String) - Method in class xbot.common.logic.StallDetector.StallDetectorFactory
+
 
+
create(String) - Method in class xbot.common.math.PIDManager.PIDManagerFactory
+
 
+
create(String, double, double, double) - Method in class xbot.common.math.FieldPosePropertyManager.FieldPosePropertyManagerFactory
+
 
+
create(String, double, double, double) - Method in class xbot.common.math.PIDManager.PIDManagerFactory
+
 
+
create(String, double, double, double, double) - Method in class xbot.common.math.PIDPropertyManager.PIDPropertyManagerFactory
+
 
+
create(String, double, double, double, double, double) - Method in class xbot.common.math.PIDManager.PIDManagerFactory
+
 
+
create(String, double, double, double, double, double, double) - Method in class xbot.common.math.PIDManager.PIDManagerFactory
+
 
+
create(String, double, double, double, double, double, double, double) - Method in class xbot.common.math.PIDPropertyManager.PIDPropertyManagerFactory
+
 
+
create(String, double, double, double, double, double, double, double, double) - Method in class xbot.common.math.PIDPropertyManager.PIDPropertyManagerFactory
+
 
+
create(String, double, double, double, double, double, double, double, double, double) - Method in class xbot.common.math.PIDManager.PIDManagerFactory
+
 
+
create(String, double, double, double, double, double, double, double, double, double, double) - Method in class xbot.common.math.PIDManager.PIDManagerFactory
+
 
+
create(String, int, int, double) - Method in class xbot.common.controls.sensors.mock_adapters.MockEncoder.MockEncoderFactory
+
 
+
create(String, int, int, double) - Method in class xbot.common.controls.sensors.wpi_adapters.EncoderWPIAdapter.EncoderWPIAdapterFactory
+
 
+
create(String, int, int, double) - Method in interface xbot.common.controls.sensors.XEncoder.XEncoderFactory
+
 
+
create(String, String) - Method in class xbot.common.networking.MockZeromqListener.MockZeromqListenerFactory
+
 
+
create(String, String) - Method in interface xbot.common.networking.XZeromqListener.XZeromqListenerFactory
+
 
+
create(String, String) - Method in class xbot.common.networking.ZeromqListener.ZeromqListenerFactory
+
 
+
create(String, FieldPose) - Method in class xbot.common.math.FieldPosePropertyManager.FieldPosePropertyManagerFactory
+
 
+
create(String, PIDManager) - Method in class xbot.common.logic.VelocityThrottleModule.VelocityThrottleModuleFactory
+
 
+
create(XCANTalon) - Method in class xbot.common.controls.sensors.XAS5600.XAS5600Factory
+
 
+
create(XSolenoid, XSolenoid) - Method in class xbot.common.controls.actuators.XDoubleSolenoid.XDoubleSolenoidFactory
+
 
+
create(XJoystick) - Method in class xbot.common.subsystems.feedback.RumbleManager.RumbleManagerFactory
+
 
+
create(XJoystick) - Method in interface xbot.common.subsystems.feedback.XRumbleManager.XRumbleManagerFactory
+
 
+
create(XJoystick, int) - Method in class xbot.common.controls.sensors.buttons.AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory
+
 
+
create(XJoystick, int) - Method in class xbot.common.controls.sensors.buttons.AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory
+
 
+
create(XJoystick, int, double, double) - Method in class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory
+
 
+
create(XJoystick, AnalogHIDButtonTrigger.AnalogHIDDescription) - Method in class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory
+
 
+
create(CANTalonInfo) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon.MockCANTalonFactory
+
 
+
create(CANTalonInfo) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter.CANTalonWPIAdapterFactory
+
 
+
create(CANTalonInfo) - Method in interface xbot.common.controls.actuators.XCANTalon.XCANTalonFactory
+
 
+
create(DeviceInfo) - Method in class xbot.common.controls.sensors.mock_adapters.MockDutyCycleEncoder.MockDutyCycleEncoderFactory
+
 
+
create(DeviceInfo) - Method in class xbot.common.controls.sensors.wpi_adapters.DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory
+
 
+
create(DeviceInfo) - Method in interface xbot.common.controls.sensors.XDutyCycleEncoder.XDutyCycleEncoderFactory
+
 
+
create(DeviceInfo, String) - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder.MockAbsoluteEncoderFactory
+
 
+
create(DeviceInfo, String) - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder.MockCANCoderFactory
+
 
+
create(DeviceInfo, String) - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter.CANCoderAdapterFactory
+
 
+
create(DeviceInfo, String) - Method in interface xbot.common.controls.sensors.XAbsoluteEncoder.XAbsoluteEncoderFactory
+
 
+
create(DeviceInfo, String) - Method in interface xbot.common.controls.sensors.XCANCoder.XCANCoderFactory
+
 
+
create(DeviceInfo, String, String) - Method in class xbot.common.controls.actuators.XCANSparkMax.XCANSparkMaxFactory
+
 
+
create(DeviceInfo, String, String, XCANSparkMaxPIDProperties) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax.MockCANSparkMaxFactory
+
 
+
create(DeviceInfo, String, String, XCANSparkMaxPIDProperties) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory
+
 
+
create(DeviceInfo, String, String, XCANSparkMaxPIDProperties) - Method in class xbot.common.controls.actuators.XCANSparkMax.XCANSparkMaxFactory
+
 
+
create(PIDManager) - Method in class xbot.common.subsystems.drive.control_logic.HeadingModule.HeadingModuleFactory
+
 
+
create(HeadingModule, String) - Method in class xbot.common.subsystems.drive.control_logic.HeadingAssistModule.HeadingAssistModuleFactory
+
 
+
create(HeadingModule, HeadingModule, String) - Method in class xbot.common.subsystems.drive.control_logic.HeadingAssistModule.HeadingAssistModuleFactory
+
+
Creates a heading assist module.
+
+
createDaggerComponent() - Method in class xbot.common.command.BaseRobot
+
+
Returns the BaseComponent instance used for dependency injection
+
+
createDaggerComponent() - Method in class xbot.common.injection.BaseWPITest
+
+
Returns the BaseComponent instance used for dependency injection
+
+
createDaggerComponent() - Method in class xbot.common.math.PurePursuitTest
+
 
+
createEphemeralProperty(String, boolean) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a boolean ephemeral property
+
+
createEphemeralProperty(String, boolean, Property.PropertyLevel) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a boolean ephemeral property
+
+
createEphemeralProperty(String, double) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a double ephemeral property
+
+
createEphemeralProperty(String, double, Property.PropertyLevel) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a double ephemeral property
+
+
createEphemeralProperty(String, String) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a string ephemeral property
+
+
createEphemeralProperty(String, String, Property.PropertyLevel) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a string ephemeral property
+
+
createFullKey(String) - Method in class xbot.common.properties.PropertyFactory
+
 
+
createPersistentProperty(String, boolean) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a double persistent property
+
+
createPersistentProperty(String, boolean, Property.PropertyLevel) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a double persistent property
+
+
createPersistentProperty(String, double) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a double persistent property
+
+
createPersistentProperty(String, double, Property.PropertyLevel) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a double persistent property
+
+
createPersistentProperty(String, String) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a double persistent property
+
+
createPersistentProperty(String, String, Property.PropertyLevel) - Method in class xbot.common.properties.PropertyFactory
+
+
Method for creating a double persistent property
+
+
createSimpleSensorPayload(String, JSONObject) - Method in class xbot.common.simulation.BaseSimulationTest
+
 
+
createSimpleWorldPosePayload(JSONObject) - Method in class xbot.common.simulation.BaseSimulationTest
+
 
+
createTelemetryProperties(String, String) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
createWithoutProperties(DeviceInfo, String, String) - Method in class xbot.common.controls.actuators.XCANSparkMax.XCANSparkMaxFactory
+
 
+
currentAutonomousCommandName - Variable in class xbot.common.subsystems.autonomous.AutonomousCommandSelector
+
 
+
currentAutonomousState - Variable in class xbot.common.subsystems.autonomous.AutonomousCommandSelector
+
 
+
currentCompassHeadingProp - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
currentHeading - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
currentHeadingProp - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
currentPitch - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
currentRoll - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
+ + + +

D

+
+
d - Variable in class xbot.common.controls.actuators.XCANSparkMaxPIDProperties
+
 
+
DatabaseStorageBase - Class in xbot.common.properties
+
 
+
DatabaseStorageBase(String) - Constructor for class xbot.common.properties.DatabaseStorageBase
+
 
+
deadband(double, double) - Static method in class xbot.common.math.MathUtils
+
 
+
deadband(double, double, Function<Double, Double>) - Static method in class xbot.common.math.MathUtils
+
 
+
Debug - xbot.common.properties.Property.PropertyLevel
+
 
+
DebugFlag - Class in xbot.common.properties
+
 
+
DebugFlag() - Constructor for class xbot.common.properties.DebugFlag
+
 
+
DecayVelocity - xbot.common.subsystems.drive.control_logic.HeadingAssistModule.HeadingAssistMode
+
 
+
decideMode(boolean) - Method in class xbot.common.logic.CalibrationDecider
+
 
+
decider - Variable in class xbot.common.command.BaseMaintainerCommand
+
 
+
defaultPValue - Variable in class xbot.common.subsystems.drive.control_logic.HeadingModule
+
 
+
delay(double) - Method in class edu.wpi.first.wpilibj.MockTimer
+
 
+
delay(double) - Method in class xbot.common.controls.sensors.wpi_adapters.TimerWpiAdapter
+
 
+
delay(double) - Static method in class xbot.common.controls.sensors.XTimer
+
 
+
delay(double) - Method in interface xbot.common.controls.sensors.XTimerImpl
+
 
+
delaySupplier - Variable in class xbot.common.command.DelayViaSupplierCommand
+
 
+
DelayViaSupplierCommand - Class in xbot.common.command
+
 
+
DelayViaSupplierCommand(Supplier<Double>) - Constructor for class xbot.common.command.DelayViaSupplierCommand
+
 
+
DerivativeTooLarge - xbot.common.math.PID.OffTargetReason
+
 
+
DestroyObject() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
DeviceHealth - Enum in xbot.common.resiliency
+
 
+
deviceId - Variable in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
deviceId - Variable in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
deviceId - Variable in class xbot.common.controls.actuators.XCANTalon
+
 
+
DeviceInfo - Class in xbot.common.injection.electrical_contract
+
 
+
DeviceInfo(int) - Constructor for class xbot.common.injection.electrical_contract.DeviceInfo
+
 
+
DeviceInfo(int, boolean) - Constructor for class xbot.common.injection.electrical_contract.DeviceInfo
+
 
+
DeviceInfo(int, boolean, double) - Constructor for class xbot.common.injection.electrical_contract.DeviceInfo
+
 
+
devicePolice - Variable in class xbot.common.command.BaseRobot
+
 
+
devicePolice() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
DevicePolice - Class in xbot.common.injection
+
+
Tracks how many devices are registered and prevents incorrectly re-using devices
+
+
DevicePolice(RobotAssertionManager) - Constructor for class xbot.common.injection.DevicePolice
+
+
Creates a new DevicePolice instance
+
+
DevicePolice.DeviceType - Enum in xbot.common.injection
+
+
Types of devices
+
+
difference(double) - Method in class xbot.common.math.ContiguousDouble
+
+
Computes the difference between two values (other - this), accounting for + wrapping.
+
+
difference(ContiguousDouble) - Method in class xbot.common.math.ContiguousDouble
+
+
Computes the difference between two values (other - this), accounting for + wrapping
+
+
digitalInputFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
DigitalInputWPIAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
DigitalInputWPIAdapter(int, DevicePolice) - Constructor for class xbot.common.controls.sensors.wpi_adapters.DigitalInputWPIAdapter
+
+
Create an instance of a Digital Input class.
+
+
DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
DigitalInputWPIAdapterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory
+
 
+
DigitalIO - xbot.common.injection.DevicePolice.DeviceType
+
 
+
digitalOutputFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
DigitalOutputWPIAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
DigitalOutputWPIAdapter(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter
+
 
+
DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
DigitalOutputWPIAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory
+
 
+
disable() - Method in class edu.wpi.first.wpilibj.MockCompressor
+
 
+
disable() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
disable() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
disable() - Method in class xbot.common.controls.actuators.wpi_adapters.CompressorWPIAdapter
+
 
+
disable() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Common interface for disabling a motor.
+
+
disable() - Method in class xbot.common.controls.actuators.XCompressor
+
 
+
disable() - Method in class xbot.common.subsystems.compressor.CompressorSubsystem
+
 
+
disabledInit() - Method in class xbot.common.command.BaseRobot
+
 
+
disabledPeriodic() - Method in class xbot.common.command.BaseRobot
+
 
+
disablePWM() - Method in class edu.wpi.first.wpilibj.MockDigitalOutput
+
 
+
disablePWM() - Method in class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter
+
 
+
disablePWM() - Method in class xbot.common.controls.actuators.XDigitalOutput
+
 
+
disableVoltageCompensation() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
disableVoltageCompensation() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
disableVoltageCompensation() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Disables the voltage compensation setting for all modes on the SPARK MAX.
+
+
distance - Variable in class xbot.common.controls.sensors.XLidarLite
+
 
+
distancePerPulse - Variable in class xbot.common.controls.sensors.XEncoder
+
 
+
distancePerPulseSupplier - Variable in class xbot.common.controls.sensors.XEncoder
+
 
+
distanceRemaining - Variable in class xbot.common.subsystems.drive.PurePursuitCommand.RabbitChaseInfo
+
 
+
DistanceSensor - Interface in xbot.common.controls.sensors
+
 
+
DistanceSensorPair - Interface in xbot.common.controls.sensors
+
 
+
distributeSimulationPayload(JSONObject) - Method in class xbot.common.simulation.SimulationPayloadDistributor
+
+
Fans out data from a simulation (like Webots) to all the simulatable devices registered on the robot.
+
+
dotProduct(XYPair) - Method in class xbot.common.math.XYPair
+
+
Calculate the dot-product between this and another point.
+
+
DoubleProperty - Class in xbot.common.properties
+
+
This manages a double in the property system.
+
+
DoubleProperty(String, double, Property.PropertyPersistenceType, XPropertyManager) - Constructor for class xbot.common.properties.DoubleProperty
+
 
+
DoubleProperty(String, double, Property.PropertyPersistenceType, XPropertyManager, Property.PropertyLevel) - Constructor for class xbot.common.properties.DoubleProperty
+
 
+
DoubleProperty(String, double, XPropertyManager) - Constructor for class xbot.common.properties.DoubleProperty
+
 
+
doubleSolenoidFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
downgradeRabbitPointList(List<RabbitPoint>) - Static method in class xbot.common.subsystems.drive.RabbitPoint
+
 
+
drawArrow(String, XYPair, XYPair, Color, float) - Method in class xbot.common.simulation.WebotsClient
+
 
+
drawCircle(String, XYPair, float, Color, float) - Method in class xbot.common.simulation.WebotsClient
+
 
+
drawLine(String, XYPair, XYPair, Color, float) - Method in class xbot.common.simulation.WebotsClient
+
 
+
drive - Variable in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
drive(double, double) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Classic tank drive.
+
+
drive(XYPair, double) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Commands each of the XCANTalons to respond to translation/rotation input.
+
+
drive(XYPair, double, boolean) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Commands each of the XCANTalons to respond to translation/rotation input.
+
+
DriverStationAppender - Class in xbot.common.logging
+
 
+
DriverStationAppender() - Constructor for class xbot.common.logging.DriverStationAppender
+
 
+
driveStyle - Variable in class xbot.common.subsystems.drive.RabbitPoint
+
 
+
driveSubsystem() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
dutyCycleEncoderFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
DutyCycleEncoderWpiAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
DutyCycleEncoderWpiAdapter(DeviceInfo, DevicePolice) - Constructor for class xbot.common.controls.sensors.wpi_adapters.DutyCycleEncoderWpiAdapter
+
 
+
DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
DutyCycleEncoderWpiAdapterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory
+
 
+
+ + + +

E

+
+
edu.wpi.first.wpilibj - package edu.wpi.first.wpilibj
+
 
+
enable() - Method in class edu.wpi.first.wpilibj.MockCompressor
+
 
+
enable() - Method in class xbot.common.controls.actuators.wpi_adapters.CompressorWPIAdapter
+
 
+
enable() - Method in class xbot.common.controls.actuators.XCompressor
+
 
+
enable() - Method in class xbot.common.subsystems.compressor.CompressorSubsystem
+
 
+
enableCurrentLimit(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
enableCurrentLimit(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
enableCurrentLimit(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
enableCurrentLimit(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
enableCurrentLimit(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
enableCurrentLimit(boolean) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
enablePWM(double) - Method in class edu.wpi.first.wpilibj.MockDigitalOutput
+
 
+
enablePWM(double) - Method in class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter
+
 
+
enablePWM(double) - Method in class xbot.common.controls.actuators.XDigitalOutput
+
 
+
enableSoftLimit(CANSparkMax.SoftLimitDirection, boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
enableSoftLimit(CANSparkMax.SoftLimitDirection, boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
enableSoftLimit(CANSparkMax.SoftLimitDirection, boolean) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Enable soft limits
+
+
enablesystemLogging - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
enableVoltageCompensation(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
enableVoltageCompensation(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
enableVoltageCompensation(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
enableVoltageCompensation(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
enableVoltageCompensation(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
enableVoltageCompensation(boolean) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
enableVoltageCompensation(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
enableVoltageCompensation(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
enableVoltageCompensation(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the voltage compensation setting for all modes on the SPARK MAX and + enables voltage compensation.
+
+
encoderFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
EncoderWPIAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
EncoderWPIAdapter(String, int, int, double, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.sensors.wpi_adapters.EncoderWPIAdapter
+
 
+
EncoderWPIAdapter.EncoderWPIAdapterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
EncoderWPIAdapterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.EncoderWPIAdapter.EncoderWPIAdapterFactory
+
 
+
end(boolean) - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
end(boolean) - Method in class xbot.common.subsystems.drive.SimulatedPurePursuitCommand
+
 
+
Ephemeral - xbot.common.properties.Property.PropertyPersistenceType
+
 
+
equals(Object) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
equals(Object) - Method in class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDDescription
+
 
+
errorIsTimeStableProp - Variable in class xbot.common.command.BaseMaintainerCommand
+
 
+
errorTimeStableWindowProp - Variable in class xbot.common.command.BaseMaintainerCommand
+
 
+
errorToleranceProp - Variable in class xbot.common.command.BaseMaintainerCommand
+
 
+
ErrorTooLarge - xbot.common.math.PID.OffTargetReason
+
 
+
errorWithinToleranceProp - Variable in class xbot.common.command.BaseMaintainerCommand
+
 
+
evaluateCurrentPoint() - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
+
This is the core method that looks at the point list, figures out which point to be heading towards, + and doing the math on how to get there.
+
+
evaluateCurrentPoint(FieldPose) - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
execute() - Method in class xbot.common.command.BaseCommand
+
 
+
execute() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
execute() - Method in class xbot.common.command.BaseWaitForMaintainerCommand
+
 
+
execute() - Method in class xbot.common.command.DelayViaSupplierCommand
+
 
+
execute() - Method in class xbot.common.command.SimpleWaitForMaintainerCommand
+
 
+
execute() - Method in class xbot.common.properties.ConfigurePropertiesCommand
+
 
+
execute() - Method in class xbot.common.simulation.ResetSimulatorPositionCommand
+
 
+
execute() - Method in class xbot.common.subsystems.autonomous.SetAutonomousCommand
+
 
+
execute() - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
execute() - Method in class xbot.common.subsystems.drive.SimulatedPurePursuitCommand
+
 
+
execute() - Method in class xbot.common.subsystems.pose.commands.ResetDistanceCommand
+
 
+
execute() - Method in class xbot.common.subsystems.pose.commands.SetRobotHeadingCommand
+
 
+
exponentAndRetainSign(double, int) - Static method in class xbot.common.math.MathUtils
+
 
+
+ + + +

F

+
+
FACING_AWAY_FROM_DRIVERS - Static variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
FACING_TOWARDS_DRIVERS - Static variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
fail(String) - Method in class xbot.common.logging.RobotAssertionManager
+
 
+
FallingEdge - xbot.common.logic.Latch.EdgeType
+
 
+
feedbackDevice - Variable in class xbot.common.injection.electrical_contract.CANTalonInfo
+
 
+
feedbackDeviceInverted - Variable in class xbot.common.injection.electrical_contract.CANTalonInfo
+
 
+
feedForward - Variable in class xbot.common.controls.actuators.XCANSparkMaxPIDProperties
+
 
+
fieldOrientedDrive(XYPair, double, double, boolean) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
 
+
FieldPose - Class in xbot.common.math
+
+
The FieldPose class represents a point on the field as well as a heading.
+
+
FieldPose() - Constructor for class xbot.common.math.FieldPose
+
 
+
FieldPose(double, double, double) - Constructor for class xbot.common.math.FieldPose
+
 
+
FieldPose(XYPair, Rotation2d) - Constructor for class xbot.common.math.FieldPose
+
 
+
FieldPosePropertyManager - Class in xbot.common.math
+
 
+
FieldPosePropertyManager(String, double, double, double, PropertyFactory) - Constructor for class xbot.common.math.FieldPosePropertyManager
+
 
+
FieldPosePropertyManager.FieldPosePropertyManagerFactory - Class in xbot.common.math
+
 
+
fieldPosePropertyManagerFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
FieldPosePropertyManagerFactory() - Constructor for class xbot.common.math.FieldPosePropertyManager.FieldPosePropertyManagerFactory
+
 
+
firstPeriodicCall - Variable in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
firstUpdate - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
fl - Variable in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
follow(IMotorController) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
follow(IMotorController) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
follow(IMotorController) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
follow(IMotorController) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
follow(IMotorController) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
follow(IMotorController) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
follow(IMotorController, FollowerType) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
follow(CANSparkMax) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
follow(CANSparkMax.ExternalFollower, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
follow(CANSparkMax.ExternalFollower, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
follow(CANSparkMax.ExternalFollower, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Causes this controller's output to mirror the provided leader.
+
+
follow(CANSparkMax.ExternalFollower, int, boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
follow(CANSparkMax.ExternalFollower, int, boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
follow(CANSparkMax.ExternalFollower, int, boolean) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Causes this controller's output to mirror the provided leader.
+
+
follow(CANSparkMax, boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
follow(XCANSparkMax) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
follow(XCANSparkMax) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
follow(XCANSparkMax) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Causes this controller's output to mirror the provided leader.
+
+
follow(XCANSparkMax, boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
follow(XCANSparkMax, boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
follow(XCANSparkMax, boolean) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Causes this controller's output to mirror the provided leader.
+
+
followerMotor - Variable in class xbot.common.subsystems.BaseXCANTalonPairSpeedControlledSubsystem
+
 
+
followerMotor - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
forceTotalXandY(double, double) - Method in class xbot.common.subsystems.pose.MockBasePoseSubsystem
+
 
+
FORWARD - xbot.common.controls.actuators.XDoubleSolenoid.DoubleSolenoidMode
+
 
+
forwardSolenoid - Variable in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
fr - Variable in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
frequencyReportInterval - Variable in class xbot.common.command.BaseRobot
+
 
+
frmLinearTestVisualizer - Variable in class xbot.common.math.PlanarTestVisualizer
+
 
+
fromDegrees(double) - Static method in class xbot.common.math.WrappedRotation2d
+
+
Constructs and returns a Rotation2d with the given degree value.
+
+
fromPolar(double, double) - Static method in class xbot.common.math.XYPair
+
+
Create a coordinate from an angle and magnitude
+
+
fromRotation2d(Rotation2d) - Static method in class xbot.common.math.WrappedRotation2d
+
+
Converts a Rotation2d to the wrapped equivalent.
+
+
fromUnitPolar(double) - Static method in class xbot.common.math.XYPair
+
+
Create a coordinate of magnitude 1 with an angle
+
+
ftcGamepadFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
FTCGamepadWpiAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
FTCGamepadWpiAdapter(int, int, AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory, AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory, AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory, RobotAssertionManager, DevicePolice) - Constructor for class xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter
+
 
+
FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
FTCGamepadWpiAdapterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory
+
 
+
+ + + +

G

+
+
GaveUp - xbot.common.logic.CalibrationDecider.CalibrationMode
+
 
+
get() - Method in class edu.wpi.first.wpilibj.MockDigitalOutput
+
 
+
get() - Method in class edu.wpi.first.wpilibj.MockSolenoid
+
 
+
get() - Method in class edu.wpi.first.wpilibj.MockSpeedController
+
 
+
get() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
get() - Method in class xbot.common.controls.actuators.mock_adapters.MockRelay
+
 
+
get() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
get() - Method in class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter
+
 
+
get() - Method in class xbot.common.controls.actuators.wpi_adapters.SolenoidWPIAdapter
+
 
+
get() - Method in class xbot.common.controls.actuators.wpi_adapters.SpeedControllerWPIAdapter
+
 
+
get() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Common interface for getting the current set speed of a speed controller.
+
+
get() - Method in class xbot.common.controls.actuators.XDigitalOutput
+
 
+
get() - Method in class xbot.common.controls.actuators.XSolenoid
+
 
+
get() - Method in class xbot.common.controls.actuators.XSpeedController
+
 
+
get() - Method in class xbot.common.controls.sensors.XDigitalInput
+
 
+
get() - Method in class xbot.common.properties.BooleanProperty
+
 
+
get() - Method in class xbot.common.properties.DoubleProperty
+
 
+
get() - Method in class xbot.common.properties.StringProperty
+
 
+
getAbsoluteDegrees() - Method in class xbot.common.controls.sensors.XDutyCycleEncoder
+
 
+
getAbsoluteEncoderFactory(MockAbsoluteEncoder.MockAbsoluteEncoderFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getAbsoluteEncoderFactory(CANCoderAdapter.CANCoderAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getAbsolutePosition() - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
getAbsolutePosition() - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
getAbsolutePosition() - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
getAbsolutePosition() - Method in class xbot.common.controls.sensors.XAbsoluteEncoder
+
 
+
getAbsolutePosition() - Method in class xbot.common.controls.sensors.XDutyCycleEncoder
+
+
Typically not recommended - use XDutyCycleEncoder.getWrappedPosition() instead.
+
+
getAbsoluteRawPosition() - Method in class xbot.common.controls.sensors.mock_adapters.MockDutyCycleEncoder
+
 
+
getAbsoluteRawPosition() - Method in class xbot.common.controls.sensors.wpi_adapters.DutyCycleEncoderWpiAdapter
+
 
+
getAbsoluteRawPosition() - Method in class xbot.common.controls.sensors.XDutyCycleEncoder
+
 
+
getActiveTrajectoryArbFeedFwd() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getActiveTrajectoryArbFeedFwd(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getActiveTrajectoryHeading() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getActiveTrajectoryHeading() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getActiveTrajectoryHeading() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getActiveTrajectoryHeading() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getActiveTrajectoryHeading() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getActiveTrajectoryHeading() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getActiveTrajectoryPosition() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getActiveTrajectoryPosition() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getActiveTrajectoryPosition() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getActiveTrajectoryPosition() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getActiveTrajectoryPosition() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getActiveTrajectoryPosition() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getActiveTrajectoryPosition(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getActiveTrajectoryVelocity() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getActiveTrajectoryVelocity() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getActiveTrajectoryVelocity() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getActiveTrajectoryVelocity() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getActiveTrajectoryVelocity() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getActiveTrajectoryVelocity() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getActiveTrajectoryVelocity(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getAdjusted() - Method in class xbot.common.controls.actuators.XSolenoid
+
 
+
getAdjustedDistance() - Method in class xbot.common.controls.sensors.XEncoder
+
 
+
getAdjustedRate() - Method in class xbot.common.controls.sensors.XEncoder
+
 
+
getAllConfigs(VictorSPXConfiguration) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getAllConfigs(VictorSPXConfiguration, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getAlternateEncoder(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getAlternateEncoder(SparkMaxAlternateEncoder.Type, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getAnalog(SparkMaxAnalogSensor.Mode) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getAnalogDistanceSensorFactory(AnalogDistanceSensor.AnalogDistanceSensorFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getAnalogDistanceSensorFactory(SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getAnalogIfAvailable(AnalogHIDButtonTrigger.AnalogHIDDescription) - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
getAnalogInputFactory(MockAnalogInput.MockAnalogInputFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getAnalogInputFactory(AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getAngle() - Method in class xbot.common.math.XYPair
+
+
Get the angle of the vector in degrees
+
+
getAngleToPoint(XYPair) - Method in class xbot.common.math.FieldPose
+
 
+
getAppliedOutput() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getAppliedOutput() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getAppliedOutput() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getAsBoolean() - Method in class xbot.common.controls.sensors.buttons.InvertingBooleanSupplier
+
 
+
getAsBoolean() - Method in class xbot.common.controls.sensors.buttons.SettableBooleanSuppler
+
 
+
getAsDigital(double) - Method in class edu.wpi.first.wpilibj.MockAnalogInput
+
 
+
getAsDigital(double) - Method in class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater
+
 
+
getAsDigital(double) - Method in class xbot.common.controls.sensors.XAnalogInput
+
 
+
getAverageDepth() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getAverageDepth() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getAverageDepth() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getAverageVoltage() - Method in class edu.wpi.first.wpilibj.MockAnalogInput
+
 
+
getAverageVoltage() - Method in class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater
+
 
+
getAverageVoltage() - Method in class xbot.common.controls.sensors.XAnalogInput
+
 
+
getAxisInverted(int) - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
getBaseID() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getBaseID() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getBaseID() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getBaseID() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getBaseID() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getBaseID() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getBoolean(String) - Method in class xbot.common.properties.DatabaseStorageBase
+
 
+
getBoolean(String) - Method in interface xbot.common.properties.ITableProxy
+
 
+
getBoolean(String) - Method in class xbot.common.properties.PreferenceStorage
+
 
+
getBoolean(String) - Method in class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
getBoolean(String) - Method in class xbot.common.properties.TableProxy
+
 
+
getBusVoltage() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getBusVoltage() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getBusVoltage() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getBusVoltage() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getBusVoltage() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getBusVoltage() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getBusVoltage() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getBusVoltage() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getBusVoltage() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getButton(int) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getButton(int) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
getButton(int) - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
getButton(int) - Method in class xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter
+
 
+
getButton(int) - Method in class xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter
+
 
+
getButton(int) - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getButton(int) - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
getCANCoderFactory(MockCANCoder.MockCANCoderFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getCANCoderFactory(CANCoderAdapter.CANCoderAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getCANSparkMaxFactory(MockCANSparkMax.MockCANSparkMaxFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getCANSparkMaxFactory(CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getCANTalonFactory(MockCANTalon.MockCANTalonFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getCANTalonFactory(CANTalonWPIAdapter.CANTalonWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getCANVictorSPXFactory(MockCANVictorSPX.MockCANVictorSPXFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getCANVictorSPXFactory(CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getChannel() - Method in class edu.wpi.first.wpilibj.MockAnalogInput
+
 
+
getChannel() - Method in class edu.wpi.first.wpilibj.MockDigitalInput
+
 
+
getChannel() - Method in class xbot.common.controls.actuators.XDigitalOutput
+
 
+
getChannel() - Method in class xbot.common.controls.actuators.XPWM
+
 
+
getChannel() - Method in class xbot.common.controls.actuators.XServo
+
 
+
getChannel() - Method in class xbot.common.controls.actuators.XSolenoid
+
 
+
getChannel() - Method in class xbot.common.controls.actuators.XSpeedController
+
 
+
getChannel() - Method in class xbot.common.controls.sensors.mock_adapters.MockDutyCycleEncoder
+
 
+
getChannel() - Method in class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater
+
 
+
getChannel() - Method in class xbot.common.controls.sensors.wpi_adapters.DigitalInputWPIAdapter
+
+
Get the channel of the digital input
+
+
getChannel() - Method in class xbot.common.controls.sensors.XDutyCycleEncoder
+
 
+
getChannel() - Method in interface xbot.common.controls.XBaseIO
+
 
+
getClosedLoopError() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getClosedLoopError(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getClosedLoopError(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getClosedLoopError(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getClosedLoopError(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getClosedLoopError(int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getClosedLoopError(int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getClosedLoopRampRate() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getClosedLoopRampRate() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getClosedLoopRampRate() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Get the configured closed loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
+
+
getClosedLoopTarget() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getClosedLoopTarget(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getClosedLoopTarget(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getClosedLoopTarget(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getClosedLoopTarget(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getClosedLoopTarget(int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getCompassHeading(Rotation2d) - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getCompressorFactory(MockCompressor.MockCompressorFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getCompressorFactory(CompressorWPIAdapter.CompressorWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getContinuousCurrentLimit() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getControlMode() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getControlMode() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getControlMode() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getControlMode() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getControlMode() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getControlType() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getCountsPerRevolution() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getCountsPerRevolution() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getCountsPerRevolution() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getCurrent(int) - Method in class edu.wpi.first.wpilibj.MockPowerDistributionPanel
+
 
+
getCurrent(int) - Method in class xbot.common.controls.sensors.wpi_adapters.PowerDistributionPanelWPIAdapter
+
 
+
getCurrent(int) - Method in class xbot.common.controls.sensors.XPowerDistributionPanel
+
 
+
getCurrentAutonomousCommand() - Method in class xbot.common.subsystems.autonomous.AutonomousCommandSelector
+
 
+
getCurrentFieldPose() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getCurrentHeading() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getCurrentHeadingAngularVelocity() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getCurrentPose2d() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getCurrentValue() - Method in class xbot.common.command.BaseSetpointSubsystem
+
 
+
getCurrentVelocity() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getD() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getD() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getD() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getD() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getD(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getD(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getD(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getDeadband() - Method in class xbot.common.logic.HumanVsMachineDecider
+
 
+
getDeltaAngleToRabbit(FieldPose, double) - Method in class xbot.common.math.FieldPose
+
 
+
getDerivativeThreshold() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getDescription() - Method in class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger
+
 
+
getDeviceId() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getDeviceId() - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
getDeviceId() - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
getDeviceId() - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
getDeviceId() - Method in class xbot.common.controls.sensors.XAbsoluteEncoder
+
 
+
getDeviceID() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getDeviceID() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getDeviceID() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getDeviceID() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getDeviceID() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getDeviceID() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getDevicePitch() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDevicePitch() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
getDevicePitch() - Method in class xbot.common.controls.sensors.XGyro
+
+
In degrees
+
+
getDeviceRawAccelX() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDeviceRawAccelX() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
getDeviceRawAccelX() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getDeviceRawAccelY() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDeviceRawAccelY() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
getDeviceRawAccelY() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getDeviceRawAccelZ() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDeviceRawAccelZ() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
getDeviceRawAccelZ() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getDeviceRoll() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDeviceRoll() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
getDeviceRoll() - Method in class xbot.common.controls.sensors.XGyro
+
+
In degrees
+
+
getDeviceVelocityX() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDeviceVelocityX() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
getDeviceVelocityX() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getDeviceVelocityY() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDeviceVelocityY() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
getDeviceVelocityY() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getDeviceVelocityZ() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDeviceVelocityZ() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
getDeviceVelocityZ() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getDeviceYaw() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDeviceYaw() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
getDeviceYaw() - Method in class xbot.common.controls.sensors.XGyro
+
+
In degrees
+
+
getDeviceYawAngularVelocity() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
getDeviceYawAngularVelocity() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
+
Note: this is in degrees per second.
+
+
getDeviceYawAngularVelocity() - Method in class xbot.common.controls.sensors.XGyro
+
+
In degrees per second
+
+
getDFilter(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getDFilter(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getDFilter(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getDigitalInputFactory(MockDigitalInput.MockDigitalInputFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getDigitalInputFactory(DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getDigitalOutputFactory(MockDigitalOutput.MockDigitalOutputFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getDigitalOutputFactory(DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getDisableCommand() - Method in class xbot.common.subsystems.compressor.CompressorSubsystem
+
 
+
getDistance() - Method in class edu.wpi.first.wpilibj.MockDistanceSensor
+
 
+
getDistance() - Method in class xbot.common.controls.sensors.AnalogDistanceSensor
+
 
+
getDistance() - Method in interface xbot.common.controls.sensors.DistanceSensor
+
 
+
getDistance() - Method in class xbot.common.controls.sensors.mock_adapters.MockEncoder
+
 
+
getDistance() - Method in class xbot.common.controls.sensors.SimulatedAnalogDistanceSensor
+
 
+
getDistance() - Method in class xbot.common.controls.sensors.wpi_adapters.EncoderWPIAdapter
+
 
+
getDistance() - Method in class xbot.common.controls.sensors.XAnalogDistanceSensor
+
 
+
getDistance() - Method in class xbot.common.controls.sensors.XEncoder
+
 
+
getDistance() - Method in class xbot.common.controls.sensors.XLidarLite
+
 
+
getDistanceAlongPoseLine(XYPair) - Method in class xbot.common.math.FieldPose
+
 
+
getDistanceToLineFromPoint(XYPair) - Method in class xbot.common.math.FieldPose
+
 
+
getDistanceToPoint(XYPair) - Method in class xbot.common.math.XYPair
+
+
Get the distance between the current point and a second point.
+
+
getDouble(String) - Method in class xbot.common.properties.DatabaseStorageBase
+
 
+
getDouble(String) - Method in interface xbot.common.properties.ITableProxy
+
 
+
getDouble(String) - Method in class xbot.common.properties.PreferenceStorage
+
 
+
getDouble(String) - Method in class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
getDouble(String) - Method in class xbot.common.properties.TableProxy
+
 
+
getDoubleSolenoidMode() - Method in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
getDutyCycleEncoderFactory(MockDutyCycleEncoder.MockDutyCycleEncoderFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getDutyCycleEncoderFactory(DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getEnableCommand() - Method in class xbot.common.subsystems.compressor.CompressorSubsystem
+
 
+
getEnableDerivativeThreshold() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getEnableErrorThreshold() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getEnableTimeThreshold() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getEnableTypeString() - Method in class xbot.common.command.BaseRobot
+
 
+
getEncoder(SparkMaxRelativeEncoder.Type, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getEncoderFactory(MockEncoder.MockEncoderFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getEncoderFactory(EncoderWPIAdapter.EncoderWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getErrorDerivative() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getErrorDerivative(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getErrorDerivative(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getErrorDerivative(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getErrorDerivative(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getErrorDerivative(int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getErrorDerivative(int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getErrorMagnitude() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
getErrorThreshold() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getErrorWithinTolerance() - Method in class xbot.common.command.BaseMaintainerCommand
+
+
Performs a simple difference between goal and target in order to see if we + are close.
+
+
getF() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getFault(CANSparkMax.FaultID) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getFault(CANSparkMax.FaultID) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getFault(CANSparkMax.FaultID) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Get the value of a specific fault
+
+
getFaults() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getFaults() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getFaults() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getFaults(Faults) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getFaults(Faults) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getFaults(Faults) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getFaults(Faults) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getFaults(Faults) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getFaults(Faults) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getFaults(CANCoderFaults) - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
getFaults(CANCoderFaults) - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
getFaults(CANCoderFaults) - Method in class xbot.common.controls.sensors.XCANCoder
+
 
+
getFF() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getFF() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getFF() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getFF(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getFF(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getFF(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getFieldOrientedTotalDistanceTraveled() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getFieldPoseOffsetBy(FieldPose) - Method in class xbot.common.math.FieldPose
+
+
Returns a FieldPose that's "subtracted" by the offset FieldPose.
+
+
getFilterConfigs(FilterConfiguration) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getFilterConfigs(FilterConfiguration, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getFirmwareString() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getFirmwareVersion() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getFirmwareVersion() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getFirmwareVersion() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getFirmwareVersion() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getFirmwareVersion() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getFirmwareVersion() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getFirmwareVersion() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getForwardCommand() - Method in class xbot.common.subsystems.simplemotor.SimpleMotorSubsystem
+
 
+
getForwardLimitSwitch(SparkMaxLimitSwitch.Type) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getForwardLimitSwitchPressed(SparkMaxLimitSwitch.Type) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getForwardLimitSwitchPressed(SparkMaxLimitSwitch.Type) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getForwardLimitSwitchPressed(SparkMaxLimitSwitch.Type) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getFPGATimestamp() - Method in class edu.wpi.first.wpilibj.MockTimer
+
+
Return the system clock time in seconds.
+
+
getFPGATimestamp() - Method in class xbot.common.controls.sensors.wpi_adapters.TimerWpiAdapter
+
 
+
getFPGATimestamp() - Static method in class xbot.common.controls.sensors.XTimer
+
+
Returns the current time in seconds since the FPGA was powered on.
+
+
getFPGATimestamp() - Method in interface xbot.common.controls.sensors.XTimerImpl
+
 
+
getFTCGamepadFactory(MockFTCGamepad.MockFTCGamepadFactory) - Method in class xbot.common.injection.modules.MockControlsModule
+
 
+
getFTCGamepadFactory(FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory) - Method in class xbot.common.injection.modules.RealControlsModule
+
 
+
getGenericHID() - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getGenericHID() - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
getGenericHID() - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
getGenericHID() - Method in class xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter
+
 
+
getGenericHID() - Method in class xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter
+
 
+
getGenericHID() - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getGenericHID() - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
getGoalPoint() - Method in class xbot.common.math.PlanarEngine
+
 
+
getGyroFactory(MockGyro.MockGyroFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getGyroFactory(InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getHandle() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getHandle() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getHeading() - Method in class xbot.common.controls.sensors.XGyro
+
+
In degrees
+
+
getHeading() - Method in class xbot.common.math.FieldPose
+
 
+
getHeadingResetRecently() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getHealth() - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
getHealth() - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
getHealth() - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
getHealth() - Method in class xbot.common.controls.sensors.XAbsoluteEncoder
+
 
+
getHumanInput() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
getHumanInputMagnitude() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
getI() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getI() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getI() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getI() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getI(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getI(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getI(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getIAccum() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getIAccum() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getIAccum() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getIdleMode() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getIdleMode() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getIdleMode() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Gets the idle mode setting for the SPARK MAX.
+
+
getifAvailable(int) - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
getifAvailable(XXboxController.XboxButton) - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getIMask() - Method in class xbot.common.math.PIDManager
+
 
+
getIMaxAccum(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getIMaxAccum(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getIMaxAccum(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getImuType() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getInjectorComponent() - Method in class xbot.common.command.BaseRobot
+
+
Get the dependency injection component
+
+
getInjectorComponent() - Method in class xbot.common.injection.BaseWPITest
+
 
+
getInjectorComponent() - Method in class xbot.common.math.PurePursuitTest
+
 
+
getIntegralAccumulator() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getIntegralAccumulator(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getIntegralAccumulator(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getIntegralAccumulator(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getIntegralAccumulator(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getIntegralAccumulator(int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getIntegralAccumulator(int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getInternalDevice() - Method in class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater
+
 
+
getInternalSparkMax() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getInternalSparkMax() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getInternalSparkMax() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getInverted() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getInverted() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getInverted() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getInverted() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getInverted() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getInverted() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getInverted() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getInverted() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Common interface for returning the inversion state of a speed controller.
+
+
getInverted() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getInverted() - Method in class xbot.common.controls.actuators.XSpeedController
+
 
+
getInverted() - Method in class xbot.common.controls.sensors.buttons.AdvancedTrigger
+
 
+
getInverted() - Method in class xbot.common.controls.sensors.buttons.InvertingBooleanSupplier
+
 
+
getInverted() - Method in class xbot.common.controls.sensors.XDigitalInput
+
 
+
getIsForward() - Method in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
getIsOff() - Method in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
getIsReverse() - Method in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
getIsRumbling() - Method in class xbot.common.subsystems.feedback.RumbleManager
+
 
+
getIsRumbling() - Method in interface xbot.common.subsystems.feedback.XRumbleManager
+
+
Gets the current rumble state.
+
+
getIsStalled(double, double, double) - Method in class xbot.common.logic.StallDetector
+
 
+
getIZone() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getIZone() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getIZone() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getIZone() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getIZone(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getIZone(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getIZone(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getJoystickFactory(MockJoystick.MockJoystickFactory) - Method in class xbot.common.injection.modules.MockControlsModule
+
 
+
getJoystickFactory(JoystickWPIAdapter.JoystickWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealControlsModule
+
 
+
getLastError() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getLastError() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getLastError() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getLastError() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getLastError() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getLastError() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getLastError() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getLastError() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
All device errors are tracked on a per thread basis for all devices in that + thread.
+
+
getLastError() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getLeftDriveDistance() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getLeftDriveDistance() - Method in class xbot.common.subsystems.pose.MockBasePoseSubsystem
+
 
+
getLeftJoystickXAxis() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getLeftJoystickYAxis() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getLeftRawTriggerAxis() - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getLeftRawTriggerAxis() - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getLeftRawTriggerAxis() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getLeftRawX() - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getLeftRawX() - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getLeftRawX() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getLeftRawY() - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getLeftRawY() - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getLeftRawY() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getLeftStickX() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getLeftStickY() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getLeftTotalDistance() - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Returns the total distance tracked by the encoder + - On the LEFT side of the robot + - Pointing in the direction of +Y travel
+
+
getLeftTotalDistance() - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
getLeftTrigger() - Method in interface xbot.common.controls.sensors.IGamepad
+
 
+
getLeftTrigger() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getLeftTrigger() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getLeftTriggerAxis() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getLeftVector() - Method in interface xbot.common.controls.sensors.IGamepad
+
 
+
getLeftVector() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getLeftVector() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getLidarLiteFactory(MockLidarLite.MockLidarLiteFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getLidarLiteFactory(LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getLoops() - Method in class xbot.common.math.PlanarEngine
+
 
+
getLowerBound() - Method in class xbot.common.math.ContiguousDouble
+
 
+
getMagnetOffset() - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
+
Gets the magnet offset configured on the encoder device.
+
+
getMagnitude() - Method in class xbot.common.math.XYPair
+
+
Get the magnitude of the vector (i.e.
+
+
getMatchContextString() - Method in class xbot.common.command.BaseRobot
+
 
+
getMatchTime() - Method in class edu.wpi.first.wpilibj.MockTimer
+
 
+
getMatchTime() - Method in class xbot.common.controls.sensors.wpi_adapters.TimerWpiAdapter
+
 
+
getMatchTime() - Static method in class xbot.common.controls.sensors.XTimer
+
 
+
getMatchTime() - Method in interface xbot.common.controls.sensors.XTimerImpl
+
 
+
getMaxOutput() - Method in class xbot.common.math.PIDManager
+
 
+
getMaxOutput(XYPair, double) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Determine the largest commanded output for a given wheel for a given + translation/rotation input.
+
+
getMaxSupportedChannel() - Method in class edu.wpi.first.wpilibj.MockSolenoid
+
 
+
getMaxSupportedChannel() - Method in class xbot.common.controls.actuators.wpi_adapters.SolenoidWPIAdapter
+
 
+
getMaxSupportedChannel() - Method in class xbot.common.controls.actuators.XSolenoid
+
 
+
getMeasurementPeriod() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getMeasurementPeriod() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getMeasurementPeriod() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getMinimumSize() - Method in class xbot.common.math.PlanarVisualizationPanel
+
 
+
getMinOutput() - Method in class xbot.common.math.PIDManager
+
 
+
getMotionBudget() - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
getMotionProfileStatus(MotionProfileStatus) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getMotionProfileStatus(MotionProfileStatus) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getMotionProfileStatus(MotionProfileStatus) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getMotionProfileStatus(MotionProfileStatus) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getMotionProfileStatus(MotionProfileStatus) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getMotionProfileStatus(MotionProfileStatus) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getMotionProfileTopLevelBufferCount() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getMotionProfileTopLevelBufferCount() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getMotionProfileTopLevelBufferCount() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getMotionProfileTopLevelBufferCount() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getMotionProfileTopLevelBufferCount() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getMotionProfileTopLevelBufferCount() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getMotorOutputPercent() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getMotorOutputPercent() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getMotorOutputPercent() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getMotorOutputPercent() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getMotorOutputPercent() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getMotorOutputPercent() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getMotorOutputVoltage() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getMotorOutputVoltage() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getMotorOutputVoltage() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getMotorOutputVoltage() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getMotorOutputVoltage() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getMotorOutputVoltage() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getMotorTemperature() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getMotorTemperature() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getMotorTemperature() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getMotorType() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getNavXReady() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getNumberOfCrashes() - Method in class xbot.common.command.XScheduler
+
 
+
getOffTargetReason() - Method in class xbot.common.math.PID
+
+
Returns an enum explaining the reason the PID is not on target.
+
+
getOffTargetReason() - Method in class xbot.common.math.PIDManager
+
 
+
getOpenLoopRamp() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getOpenLoopRampRate() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getOpenLoopRampRate() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getOpenLoopRampRate() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Get the configured open loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
+
+
getOriginalPoints() - Method in class xbot.common.subsystems.drive.ConfigurablePurePursuitCommand
+
 
+
getOriginalPoints() - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
getOutputCurrent() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getOutputCurrent() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getOutputCurrent() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getOutputCurrent() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getOutputCurrent() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getOutputCurrent() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getOutputCurrent() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getOutputCurrent() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getOutputCurrent() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getOutputMax() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getOutputMax() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getOutputMax() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getOutputMax(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getOutputMax(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getOutputMax(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getOutputMin() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getOutputMin() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getOutputMin() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getOutputMin(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getOutputMin(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getOutputMin(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getP() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getP() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getP() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getP() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getP(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getP(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getP(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getPeriod() - Method in class xbot.common.command.BaseRobot
+
 
+
getPerpendicularHeadingTowardsPoint(FieldPose) - Method in class xbot.common.math.FieldPose
+
 
+
getPIDConfigs(VictorSPXPIDSetConfiguration) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getPIDConfigs(VictorSPXPIDSetConfiguration, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getPIDController() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getPitch() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getPlannedPointsToVisit() - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
+
If you want to see where this command is heading in the future (for visualization purposes, perhaps) you can + get that information here.
+
+
getPoint() - Method in class xbot.common.math.FieldPose
+
 
+
getPointAlongPoseClosestToPoint(XYPair) - Method in class xbot.common.math.FieldPose
+
 
+
getPointAlongPoseLine(double) - Method in class xbot.common.math.FieldPose
+
+
Projects along the line created by the X,Y pair and the Heading.
+
+
getPort() - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
getPose() - Method in class xbot.common.math.FieldPosePropertyManager
+
 
+
getPoseAtTime(double) - Method in class xbot.common.math.InterpolatingFieldPoseBuffer
+
 
+
getPoseRelativeDisplacement(FieldPose) - Method in class xbot.common.math.FieldPose
+
 
+
getPosition() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getPosition() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getPosition() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getPosition() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getPosition() - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
getPosition() - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
getPosition() - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
getPosition() - Method in class xbot.common.controls.sensors.XAbsoluteEncoder
+
 
+
getPosition() - Method in class xbot.common.controls.sensors.XAS5600
+
 
+
getPositionalPid() - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
 
+
getPositionalPid() - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
getPositionConversionFactor() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getPositionConversionFactor() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getPositionConversionFactor() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getPositionOffset() - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
getPositionOffset() - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
getPOV() - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getPOV() - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
getPOV() - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
getPOV() - Method in class xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter
+
 
+
getPOV() - Method in class xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter
+
 
+
getPOV() - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getPOV() - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
getPovIfAvailable(int) - Method in class xbot.common.controls.sensors.XJoystick
+
+
Uses the d-pad as a button source.
+
+
getPower() - Method in class xbot.common.controls.actuators.XSpeedController
+
 
+
getPower() - Method in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
+
Returns the current "robot power" (e.g.
+
+
getPowerDistributionPanelFactory(MockPowerDistributionPanel.MockPowerDistributionPanelFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getPowerDistributionPanelFactory(PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getPreferredSize() - Method in class xbot.common.math.PlanarVisualizationPanel
+
 
+
getPrefix() - Method in class xbot.common.command.BaseCommand
+
 
+
getPrefix() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
getPrefix() - Method in class xbot.common.command.BaseSubsystem
+
 
+
getPrefix() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getPrefix() - Method in interface xbot.common.properties.IPropertySupport
+
 
+
getPrefix() - Method in class xbot.common.properties.PropertyFactory
+
 
+
getPulseWidthRiseToFallUs() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getPulseWidthRiseToFallUs() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getPulseWidthRiseToFallUs() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getPulseWidthRiseToFallUs() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getPulseWidthRiseToFallUs() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getPulseWidthRiseToFallUs() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getPursuitMode() - Method in class xbot.common.subsystems.drive.ConfigurablePurePursuitCommand
+
 
+
getPursuitMode() - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
getPwmFactory(MockPWM.MockPWMFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getPwmFactory(PWMWPIAdapter.PWMWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getRabbitPose(XYPair, double) - Method in class xbot.common.math.FieldPose
+
 
+
getRandomWordChain(int, String) - Method in class xbot.common.logging.WordGenerator
+
 
+
getRate() - Method in class xbot.common.controls.sensors.mock_adapters.MockEncoder
+
 
+
getRate() - Method in class xbot.common.controls.sensors.wpi_adapters.EncoderWPIAdapter
+
 
+
getRate() - Method in class xbot.common.controls.sensors.XEncoder
+
 
+
getRaw() - Method in class edu.wpi.first.wpilibj.MockDigitalInput
+
 
+
getRaw() - Method in class edu.wpi.first.wpilibj.MockPWM
+
 
+
getRaw() - Method in class xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter
+
 
+
getRaw() - Method in class xbot.common.controls.actuators.XPWM
+
 
+
getRaw() - Method in class xbot.common.controls.sensors.wpi_adapters.DigitalInputWPIAdapter
+
+
Get the value from a digital input channel.
+
+
getRaw() - Method in class xbot.common.controls.sensors.XDigitalInput
+
 
+
getRawAxis(int) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getRawAxis(int) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
getRawAxis(int) - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
getRawAxis(int) - Method in class xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter
+
 
+
getRawAxis(int) - Method in class xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter
+
 
+
getRawAxis(int) - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getRawAxis(int) - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
getRecommendedMode(double) - Method in class xbot.common.logic.HumanVsMachineDecider
+
 
+
getReference() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getRelayFactory(MockRelay.MockRelayFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getRelayFactory(RelayWPIAdapter.RelayWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getResourceFileAsString(String) - Method in class xbot.common.logging.WordGenerator
+
 
+
getReverseCommand() - Method in class xbot.common.subsystems.simplemotor.SimpleMotorSubsystem
+
 
+
getReverseLimitSwitch(SparkMaxLimitSwitch.Type) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getReverseLimitSwitchPressed(SparkMaxLimitSwitch.Type) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getReverseLimitSwitchPressed(SparkMaxLimitSwitch.Type) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getReverseLimitSwitchPressed(SparkMaxLimitSwitch.Type) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getRightDriveDistance() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getRightDriveDistance() - Method in class xbot.common.subsystems.pose.MockBasePoseSubsystem
+
 
+
getRightJoystickXAxis() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getRightJoystickYAxis() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getRightRawTriggerAxis() - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getRightRawTriggerAxis() - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getRightRawTriggerAxis() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getRightRawX() - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getRightRawX() - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getRightRawX() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getRightRawY() - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getRightRawY() - Method in class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
getRightRawY() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getRightStickX() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getRightStickY() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getRightTotalDistance() - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Returns the total distance tracked by the encoder + - On the RIGHT side of the robot + - Pointing in the direction of +Y travel
+
+
getRightTotalDistance() - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
getRightTrigger() - Method in interface xbot.common.controls.sensors.IGamepad
+
 
+
getRightTrigger() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getRightTrigger() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getRightTriggerAxis() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getRightVector() - Method in interface xbot.common.controls.sensors.IGamepad
+
 
+
getRightVector() - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
getRightVector() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getRobotOrientedTotalDistanceTraveled() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
+
Returns the distance the robot has traveled forward.
+
+
getRobotPitch() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getRobotPose() - Method in class xbot.common.math.PlanarEngine
+
 
+
getRobotRoll() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getRobotYaw() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
+
If the RoboRIO is mounted in a position other than "flat" (e.g.
+
+
getRoll() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getRotateDecayPid() - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
 
+
getRotateDecayPid() - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
getRotateToHeadingPid() - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
 
+
getRotateToHeadingPid() - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
getRumbleManager() - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
getRumbleManager() - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getRumbleManager() - Method in interface xbot.common.subsystems.feedback.IRumbler
+
 
+
getRumbleManagerFactory(RumbleManager.RumbleManagerFactory) - Method in class xbot.common.injection.modules.MockControlsModule
+
 
+
getRumbleManagerFactory(RumbleManager.RumbleManagerFactory) - Method in class xbot.common.injection.modules.RealControlsModule
+
 
+
getSafeFloat(float) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getSelectedSensorPosition() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getSelectedSensorPosition(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getSelectedSensorPosition(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getSelectedSensorPosition(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getSelectedSensorPosition(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getSelectedSensorPosition(int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getSelectedSensorPosition(int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getSelectedSensorVelocity() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getSelectedSensorVelocity(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getSelectedSensorVelocity(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getSelectedSensorVelocity(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getSelectedSensorVelocity(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getSelectedSensorVelocity(int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getSelectedSensorVelocity(int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getSensorA() - Method in class edu.wpi.first.wpilibj.MockDistanceSensorPair
+
 
+
getSensorA() - Method in interface xbot.common.controls.sensors.DistanceSensorPair
+
 
+
getSensorA() - Method in class xbot.common.controls.sensors.MultiplexedLidarPair
+
 
+
getSensorB() - Method in class edu.wpi.first.wpilibj.MockDistanceSensorPair
+
 
+
getSensorB() - Method in interface xbot.common.controls.sensors.DistanceSensorPair
+
 
+
getSensorB() - Method in class xbot.common.controls.sensors.MultiplexedLidarPair
+
 
+
getSensorCollection() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getSerialNumber() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getServoFactory(MockServo.MockServoFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getServoFactory(ServoWPIAdapter.ServoWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getSessionId() - Method in class xbot.common.logging.RobotSession
+
 
+
getSetpoint() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getSetpointLock() - Method in class xbot.common.command.BaseSetpointSubsystem
+
 
+
getSetpointLock() - Method in interface xbot.common.command.SupportsSetpointLock
+
 
+
getSigned() - Method in class edu.wpi.first.wpilibj.MockPWM
+
 
+
getSigned() - Method in class xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter
+
 
+
getSigned() - Method in class xbot.common.controls.actuators.XPWM
+
 
+
getSimulationData() - Method in class edu.wpi.first.wpilibj.MockSolenoid
+
 
+
getSimulationData() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getSimulationData() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getSimulationData() - Method in interface xbot.common.simulation.ISimulatableMotor
+
 
+
getSimulationData() - Method in interface xbot.common.simulation.ISimulatableSolenoid
+
 
+
getSlotConfigs(SlotConfiguration) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getSlotConfigs(SlotConfiguration, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getSmartMotionAccelStrategy(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getSmartMotionAllowedClosedLoopError(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getSmartMotionAllowedClosedLoopError(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getSmartMotionAllowedClosedLoopError(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getSmartMotionMaxAccel(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getSmartMotionMaxAccel(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getSmartMotionMaxAccel(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getSmartMotionMaxVelocity(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getSmartMotionMaxVelocity(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getSmartMotionMaxVelocity(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getSmartMotionMinOutputVelocity(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getSmartMotionMinOutputVelocity(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getSmartMotionMinOutputVelocity(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getSoftLimit(CANSparkMax.SoftLimitDirection) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getSoftLimit(CANSparkMax.SoftLimitDirection) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getSoftLimit(CANSparkMax.SoftLimitDirection) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Get the soft limit setting in the controller
+
+
getSolenoidFactory(MockSolenoid.MockSolenoidFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getSolenoidFactory(SolenoidWPIAdapter.SolenoidWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getSpeed() - Method in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
getSpeedControllerFactory(MockSpeedController.MockSpeedControllerFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getSpeedControllerFactory(SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
getStatusFramePeriod(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getStatusFramePeriod(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getStatusFramePeriod(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getStatusFramePeriod(StatusFrame) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getStatusFramePeriod(StatusFrameEnhanced) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getStatusFramePeriod(StatusFrameEnhanced, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getStatusFramePeriod(StatusFrameEnhanced, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getStatusFramePeriod(StatusFrameEnhanced, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getStatusFramePeriod(StatusFrameEnhanced, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getStatusFramePeriod(StatusFrameEnhanced, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getStatusFramePeriod(StatusFrameEnhanced, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getStatusFramePeriod(StatusFrame, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getStatusFramePeriod(StatusFrame, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getStatusFramePeriod(StatusFrame, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getStatusFramePeriod(StatusFrame, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getStatusFramePeriod(StatusFrame, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getStatusFramePeriod(StatusFrame, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getStatusFramePeriod(CANCoderStatusFrame) - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
getStatusFramePeriod(CANCoderStatusFrame) - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
getStatusFramePeriod(CANCoderStatusFrame) - Method in class xbot.common.controls.sensors.XCANCoder
+
 
+
getStickyFault(CANSparkMax.FaultID) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getStickyFault(CANSparkMax.FaultID) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getStickyFault(CANSparkMax.FaultID) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Get the value of a specific sticky fault
+
+
getStickyFaults() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getStickyFaults() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getStickyFaults() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getStickyFaults(StickyFaults) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getStickyFaults(StickyFaults) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getStickyFaults(StickyFaults) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getStickyFaults(StickyFaults) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getStickyFaults(StickyFaults) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getStickyFaults(StickyFaults) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getStickyFaults(CANCoderStickyFaults) - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
getStickyFaults(CANCoderStickyFaults) - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
getStickyFaults(CANCoderStickyFaults) - Method in class xbot.common.controls.sensors.XCANCoder
+
 
+
getStopCommand() - Method in class xbot.common.subsystems.simplemotor.SimpleMotorSubsystem
+
 
+
getString(String) - Method in class xbot.common.properties.DatabaseStorageBase
+
 
+
getString(String) - Method in interface xbot.common.properties.ITableProxy
+
 
+
getString(String) - Method in class xbot.common.properties.PreferenceStorage
+
 
+
getString(String) - Method in class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
getString(String) - Method in class xbot.common.properties.TableProxy
+
 
+
getSupplier() - Method in class xbot.common.controls.sensors.buttons.AnalogHIDButtonConfiguration
+
+
Supplier indicates whether the analog value is in the button's range
+
+
getTargetSpeed() - Method in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
getTargetValue() - Method in class xbot.common.command.BaseSetpointSubsystem
+
 
+
getTemperature() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
getTemperature() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
getTemperature() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
getTemperature() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
getTemperature() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
getTemperature() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
getThrottlePercent() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
+
Returns the low-level throttle percentage that would typically be sent to a motor.
+
+
getTimeThreshold() - Method in class xbot.common.math.PIDPropertyManager
+
 
+
getTransverseDistance() - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Returns the total distance tracked by the encoder + - In the center of the robot + - Pointing in the direction of +X travel
+
+
getTransverseDistance() - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
getTravelVector() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getUnsigned() - Method in class edu.wpi.first.wpilibj.MockPWM
+
 
+
getUnsigned() - Method in class xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter
+
 
+
getUnsigned() - Method in class xbot.common.controls.actuators.XPWM
+
 
+
getUntrimmedPitch() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getUntrimmedRoll() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getUpperBound() - Method in class xbot.common.math.ContiguousDouble
+
 
+
getValAtTime(double) - Method in class xbot.common.math.InterpolatingHistoryBuffer
+
+
Returns the value at a given time, linearlly interpolated.
+
+
getValue() - Method in class edu.wpi.first.wpilibj.MockServo
+
 
+
getValue() - Method in enum xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger.ButtonTriggerType
+
 
+
getValue() - Method in class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater
+
 
+
getValue() - Method in enum xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
getValue() - Method in class xbot.common.math.ContiguousDouble
+
 
+
getVectorForAxisPair(int, int) - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
getVectorToRabbit(FieldPose, double) - Method in class xbot.common.math.FieldPose
+
 
+
getVelocity() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getVelocity() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getVelocity() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getVelocity() - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
getVelocity() - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
getVelocity() - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
getVelocity() - Method in class xbot.common.controls.sensors.XAbsoluteEncoder
+
 
+
getVelocity() - Method in class xbot.common.math.PlanarEngine
+
 
+
getVelocityConversionFactor() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getVelocityConversionFactor() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getVelocityConversionFactor() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
getVoltage() - Method in class edu.wpi.first.wpilibj.MockAnalogInput
+
 
+
getVoltage() - Method in class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater
+
 
+
getVoltage() - Method in class xbot.common.controls.sensors.XAnalogInput
+
 
+
getVoltageCompensationNominalVoltage() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
getVoltageCompensationNominalVoltage() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
getVoltageCompensationNominalVoltage() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Get the configured voltage compensation nominal voltage value
+
+
getWPIDigitalOutput() - Method in class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter
+
 
+
getWrappedPosition() - Method in class xbot.common.controls.sensors.XDutyCycleEncoder
+
 
+
getX() - Method in class xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter
+
 
+
getX() - Method in class xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter
+
 
+
getXboxButton(XXboxController.XboxButton) - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
getXboxControllerFactory(MockXboxControllerAdapter.MockXboxControllerFactory) - Method in class xbot.common.injection.modules.MockControlsModule
+
 
+
getXboxControllerFactory(XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory) - Method in class xbot.common.injection.modules.RealControlsModule
+
 
+
getY() - Method in class xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter
+
 
+
getY() - Method in class xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter
+
 
+
getYawAngularVelocity() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
getYawAngularVelocity() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
getZeromqListenerFactory(MockZeromqListener.MockZeromqListenerFactory) - Method in class xbot.common.injection.modules.MockDevicesModule
+
 
+
getZeromqListenerFactory(ZeromqListener.ZeromqListenerFactory) - Method in class xbot.common.injection.modules.RealDevicesModule
+
 
+
goal - Variable in class xbot.common.math.PurePursuitTest.PursuitEnvironmentState
+
 
+
gyroFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
+ + + +

H

+
+
handlePlatformException(RuntimeException) - Method in class xbot.common.logging.LoudRobotAssertionManager
+
 
+
handlePlatformException(RuntimeException) - Method in class xbot.common.logging.RobotAssertionManager
+
 
+
handlePlatformException(RuntimeException) - Method in class xbot.common.logging.SilentRobotAssertionManager
+
 
+
handleSimulatorPose(JSONObject) - Method in class xbot.common.simulation.WebotsClient
+
 
+
hasChangedSinceLastCheck(Consumer<Double>) - Method in class xbot.common.properties.DoubleProperty
+
 
+
hashCode() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
hashCode() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
hashCode() - Method in class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDDescription
+
 
+
hasResetOccurred() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
hasResetOccurred() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
hasResetOccurred() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
hasResetOccurred() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
hasResetOccurred() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
hasResetOccurred() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
hasResetOccurred() - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
hasResetOccurred() - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
hasResetOccurred() - Method in class xbot.common.controls.sensors.XCANCoder
+
 
+
headingAngularVelocityProp - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
HeadingAssistModule - Class in xbot.common.subsystems.drive.control_logic
+
+
Encaspulates a useful bit of driving logic: - The robot should attempt to + hold its current heading, even if it's temporarily rotated by outside forces.
+
+
HeadingAssistModule(HeadingModule, HeadingModule, String, PropertyFactory, BasePoseSubsystem) - Constructor for class xbot.common.subsystems.drive.control_logic.HeadingAssistModule
+
 
+
HeadingAssistModule.HeadingAssistMode - Enum in xbot.common.subsystems.drive.control_logic
+
 
+
HeadingAssistModule.HeadingAssistModuleFactory - Class in xbot.common.subsystems.drive.control_logic
+
 
+
headingAssistModuleFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
HeadingAssistModuleFactory() - Constructor for class xbot.common.subsystems.drive.control_logic.HeadingAssistModule.HeadingAssistModuleFactory
+
 
+
headingModule - Variable in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
HeadingModule - Class in xbot.common.subsystems.drive.control_logic
+
+
Encapsulates the logic needed to rotate the robot to a specific angle.
+
+
HeadingModule(PIDManager, BasePoseSubsystem, PropertyFactory) - Constructor for class xbot.common.subsystems.drive.control_logic.HeadingModule
+
 
+
HeadingModule.HeadingModuleFactory - Class in xbot.common.subsystems.drive.control_logic
+
 
+
headingModuleFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
HeadingModuleFactory() - Constructor for class xbot.common.subsystems.drive.control_logic.HeadingModule.HeadingModuleFactory
+
 
+
headingOffset - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
HeadingOnly - xbot.common.subsystems.drive.RabbitPoint.PointType
+
 
+
Healthy - xbot.common.resiliency.DeviceHealth
+
 
+
HoldOrientation - xbot.common.subsystems.drive.control_logic.HeadingAssistModule.HeadingAssistMode
+
 
+
HumanControl - xbot.common.logic.HumanVsMachineDecider.HumanVsMachineMode
+
 
+
humanControlAction() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
HumanVsMachineDecider - Class in xbot.common.logic
+
 
+
HumanVsMachineDecider(String, PropertyFactory) - Constructor for class xbot.common.logic.HumanVsMachineDecider
+
 
+
HumanVsMachineDecider.HumanVsMachineDeciderFactory - Class in xbot.common.logic
+
 
+
HumanVsMachineDecider.HumanVsMachineMode - Enum in xbot.common.logic
+
 
+
humanVsMachineDeciderFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
HumanVsMachineDeciderFactory() - Constructor for class xbot.common.logic.HumanVsMachineDecider.HumanVsMachineDeciderFactory
+
 
+
+ + + +

I

+
+
i - Variable in class xbot.common.controls.actuators.XCANSparkMaxPIDProperties
+
 
+
I2C - xbot.common.injection.DevicePolice.DeviceType
+
 
+
IGamepad - Interface in xbot.common.controls.sensors
+
 
+
Important - xbot.common.properties.Property.PropertyLevel
+
 
+
imu - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
IMU - xbot.common.injection.DevicePolice.DeviceType
+
 
+
imuType - Variable in class xbot.common.controls.sensors.XGyro
+
 
+
IN_MEMORY_STORE_NAME - Static variable in class xbot.common.properties.XPropertyManager
+
 
+
INCHES_IN_A_METER - Static variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
includeOnSmartDashboard() - Method in class xbot.common.command.BaseCommand
+
 
+
includeOnSmartDashboard(String) - Method in class xbot.common.command.BaseCommand
+
 
+
incrementDistance(double) - Method in class edu.wpi.first.wpilibj.MockDistanceSensor
+
 
+
InertialMeasurementUnitAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
InertialMeasurementUnitAdapter(DevicePolice, SPI.Port, SerialPort.Port, I2C.Port) - Constructor for class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
InertialMeasurementUnitAdapterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory
+
 
+
ingestSimulationData(JSONObject) - Method in class edu.wpi.first.wpilibj.MockAnalogInput
+
 
+
ingestSimulationData(JSONObject) - Method in class edu.wpi.first.wpilibj.MockDigitalInput
+
 
+
ingestSimulationData(JSONObject) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
ingestSimulationData(JSONObject) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
ingestSimulationData(JSONObject) - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
ingestSimulationData(JSONObject) - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
ingestSimulationData(JSONObject) - Method in class xbot.common.controls.sensors.mock_adapters.MockEncoder
+
 
+
ingestSimulationData(JSONObject) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
ingestSimulationData(JSONObject) - Method in class xbot.common.controls.sensors.SimulatedAnalogDistanceSensor
+
 
+
ingestSimulationData(JSONObject) - Method in interface xbot.common.simulation.ISimulatableSensor
+
 
+
inherentRioPitch - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
inherentRioRoll - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
initialize() - Method in class xbot.common.command.BaseCommand
+
 
+
initialize() - Method in class xbot.common.command.BaseWaitForMaintainerCommand
+
 
+
initialize() - Method in class xbot.common.command.DelayViaSupplierCommand
+
 
+
initialize() - Method in class xbot.common.command.NamedRunCommand
+
 
+
initialize() - Method in class xbot.common.command.SimpleWaitForMaintainerCommand
+
 
+
initialize() - Method in class xbot.common.properties.ConfigurePropertiesCommand
+
 
+
initialize() - Method in class xbot.common.simulation.ResetSimulatorPositionCommand
+
 
+
initialize() - Method in class xbot.common.simulation.WebotsClient
+
 
+
initialize() - Method in class xbot.common.subsystems.autonomous.SetAutonomousCommand
+
 
+
initialize() - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
initialize() - Method in class xbot.common.subsystems.pose.commands.ResetDistanceCommand
+
 
+
initialize() - Method in class xbot.common.subsystems.pose.commands.SetRobotHeadingCommand
+
 
+
initializeFollowerMotorConfiguration(boolean) - Method in class xbot.common.subsystems.BaseXCANTalonPairSpeedControlledSubsystem
+
 
+
InitializeMachineControl - xbot.common.logic.HumanVsMachineDecider.HumanVsMachineMode
+
 
+
initializeMachineControlAction() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
initializeMasterMotorConfiguration(boolean, boolean) - Method in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
initializeSystems() - Method in class xbot.common.command.BaseRobot
+
 
+
injectorComponent - Variable in class xbot.common.simulation.BaseSimulationTest
+
 
+
inMemoryRandomAccessStore - Variable in class xbot.common.properties.XPropertyManager
+
 
+
inMemoryTableProxy() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
input - Variable in class xbot.common.controls.sensors.AnalogDistanceSensor
+
 
+
insert(double, double) - Method in class xbot.common.math.InterpolatingHistoryBuffer
+
+
Insert a new value into the buffer.
+
+
insert(FieldPose) - Method in class xbot.common.math.InterpolatingFieldPoseBuffer
+
 
+
IntermittentConsoleLogger - Class in xbot.common.logging
+
 
+
IntermittentConsoleLogger() - Constructor for class xbot.common.logging.IntermittentConsoleLogger
+
 
+
internalEncoder - Variable in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
internalEncoder - Variable in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
InterpolatingFieldPoseBuffer - Class in xbot.common.math
+
 
+
InterpolatingFieldPoseBuffer(FieldPose) - Constructor for class xbot.common.math.InterpolatingFieldPoseBuffer
+
 
+
InterpolatingHistoryBuffer - Class in xbot.common.math
+
 
+
InterpolatingHistoryBuffer(int, double) - Constructor for class xbot.common.math.InterpolatingHistoryBuffer
+
+
This class implements a set of circular buffers that can be used to store + values of signals in the past, and retrieve values at arbitrary previous time + indexes.
+
+
inversionFactor() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
inversionFactor() - Method in class xbot.common.controls.sensors.XDutyCycleEncoder
+
 
+
inverted - Variable in class xbot.common.controls.actuators.XRelay
+
 
+
inverted - Variable in class xbot.common.controls.sensors.XDutyCycleEncoder
+
 
+
inverted - Variable in class xbot.common.injection.electrical_contract.CANTalonInfo
+
 
+
inverted - Variable in class xbot.common.injection.electrical_contract.DeviceInfo
+
 
+
InvertingBooleanSupplier - Class in xbot.common.controls.sensors.buttons
+
 
+
InvertingBooleanSupplier(BooleanSupplier) - Constructor for class xbot.common.controls.sensors.buttons.InvertingBooleanSupplier
+
 
+
IPropertySupport - Interface in xbot.common.properties
+
 
+
IRumbler - Interface in xbot.common.subsystems.feedback
+
 
+
isAtSpeed() - Method in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
isBroken() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
isBroken() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
isBroken() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
isCalibrated() - Method in class xbot.common.command.BaseSetpointSubsystem
+
 
+
isConnected() - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
isConnected() - Method in class xbot.common.controls.sensors.wpi_adapters.InertialMeasurementUnitAdapter
+
 
+
isConnected() - Method in class xbot.common.controls.sensors.XGyro
+
 
+
isDebug() - Method in class xbot.common.properties.DebugFlag
+
 
+
isEnabled() - Method in class edu.wpi.first.wpilibj.MockCompressor
+
 
+
isEnabled() - Method in class xbot.common.controls.actuators.wpi_adapters.CompressorWPIAdapter
+
 
+
isEnabled() - Method in class xbot.common.controls.actuators.XCompressor
+
 
+
isExceptionsEnabled() - Method in class xbot.common.logging.LoudRobotAssertionManager
+
 
+
isExceptionsEnabled() - Method in class xbot.common.logging.RobotAssertionManager
+
 
+
isExceptionsEnabled() - Method in class xbot.common.logging.SilentRobotAssertionManager
+
 
+
isFinished() - Method in class xbot.common.command.BaseSetpointCommand
+
 
+
isFinished() - Method in class xbot.common.command.BaseWaitForMaintainerCommand
+
 
+
isFinished() - Method in class xbot.common.command.DelayViaSupplierCommand
+
 
+
isFinished() - Method in class xbot.common.command.SimpleWaitForMaintainerCommand
+
 
+
isFinished() - Method in class xbot.common.properties.ConfigurePropertiesCommand
+
 
+
isFinished() - Method in class xbot.common.simulation.ResetSimulatorPositionCommand
+
 
+
isFinished() - Method in class xbot.common.subsystems.autonomous.SetAutonomousCommand
+
 
+
isFinished() - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
isFinished() - Method in class xbot.common.subsystems.pose.commands.ResetDistanceCommand
+
 
+
isFinished() - Method in class xbot.common.subsystems.pose.commands.SetRobotHeadingCommand
+
 
+
isFollower() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
isFollower() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
isFollower() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Returns whether the controller is following another controller
+
+
isFwdLimitSwitchClosed() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
isFwdLimitSwitchClosed() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
isFwdLimitSwitchClosed() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
isFwdLimitSwitchClosed() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
isFwdLimitSwitchClosed() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
isFwdLimitSwitchClosed() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
ISimulatableMotor - Interface in xbot.common.simulation
+
 
+
ISimulatableSensor - Interface in xbot.common.simulation
+
 
+
ISimulatableSolenoid - Interface in xbot.common.simulation
+
 
+
isInverted - Variable in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
isInverted - Variable in class xbot.common.controls.actuators.XSolenoid
+
 
+
isInverted - Variable in class xbot.common.controls.actuators.XSpeedController
+
 
+
isInverted - Variable in class xbot.common.controls.sensors.XEncoder
+
 
+
isMaintainerAtGoal() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
isMaintainerAtGoal() - Method in class xbot.common.command.BaseSetpointSubsystem
+
 
+
isMotionProfileFinished() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
isMotionProfileTopLevelBufferFull() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
isMotionProfileTopLevelBufferFull() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
isMotionProfileTopLevelBufferFull() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
isMotionProfileTopLevelBufferFull() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
isMotionProfileTopLevelBufferFull() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
isMotionProfileTopLevelBufferFull() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
isNavXReady - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
isOnTarget() - Method in class xbot.common.math.PID
+
 
+
isOnTarget() - Method in class xbot.common.math.PIDManager
+
+
Determines if you are on target.
+
+
isOnTarget() - Method in class xbot.common.subsystems.drive.control_logic.HeadingModule
+
 
+
isOnTarget(double) - Method in class xbot.common.math.PIDManager
+
+
Deprecated.
+
+
isRevLimitSwitchClosed() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
isRevLimitSwitchClosed() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
isRevLimitSwitchClosed() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
isRevLimitSwitchClosed() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
isRevLimitSwitchClosed() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
isRevLimitSwitchClosed() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
isSetToDefault() - Method in class xbot.common.properties.BooleanProperty
+
 
+
isSetToDefault() - Method in class xbot.common.properties.DoubleProperty
+
 
+
isSetToDefault() - Method in class xbot.common.properties.Property
+
+
Checks if the property's current value matches the default.
+
+
isSetToDefault() - Method in class xbot.common.properties.StringProperty
+
 
+
isSoftLimitEnabled(CANSparkMax.SoftLimitDirection) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
isSoftLimitEnabled(CANSparkMax.SoftLimitDirection) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
isSoftLimitEnabled(CANSparkMax.SoftLimitDirection) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
ITableProxy - Interface in xbot.common.properties
+
+
This interface defines a simple table interface, where you can set and retrieve + values.
+
+
iZone - Variable in class xbot.common.controls.actuators.XCANSparkMaxPIDProperties
+
 
+
+ + + +

J

+
+
joystickButtonFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
joystickFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
JoystickWPIAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
JoystickWPIAdapter(int, int, AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory, AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory, AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory, RobotAssertionManager, DevicePolice) - Constructor for class xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter
+
 
+
JoystickWPIAdapter.JoystickWPIAdapterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
JoystickWPIAdapterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter.JoystickWPIAdapterFactory
+
 
+
+ + + +

K

+
+
key - Variable in class xbot.common.properties.Property
+
 
+
kick() - Method in class xbot.common.logic.WatchdogTimer
+
 
+
kThrottleDeadband - Static variable in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
 
+
+ + + +

L

+
+
lastFreqCounterResetTime - Variable in class xbot.common.command.BaseRobot
+
 
+
lastSetHeadingTime - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
Latch - Class in xbot.common.logic
+
+
Logical switch which consumes booleans and signals when the given value + changes.
+
+
Latch(boolean, Latch.EdgeType) - Constructor for class xbot.common.logic.Latch
+
 
+
Latch(boolean, Latch.EdgeType, Consumer<Latch.EdgeType>) - Constructor for class xbot.common.logic.Latch
+
 
+
Latch.EdgeType - Enum in xbot.common.logic
+
 
+
LeftBumper - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
leftDriveDistance - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
LeftJoystickYAxis - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
LeftStick - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
leftTank - Variable in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
leftTotalDistance - Variable in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
LeftTrigger - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
leftXInversion - Variable in class xbot.common.controls.sensors.XXboxController
+
 
+
leftYInversion - Variable in class xbot.common.controls.sensors.XXboxController
+
 
+
level - Variable in class xbot.common.properties.Property
+
 
+
lidar_address - Variable in class xbot.common.controls.sensors.XLidarLite
+
 
+
lidar_config_register - Variable in class xbot.common.controls.sensors.XLidarLite
+
 
+
lidar_distance_register - Variable in class xbot.common.controls.sensors.XLidarLite
+
 
+
lidarLiteFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
LidarLiteWpiAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
LidarLiteWpiAdapter(I2C.Port, PropertyFactory, DevicePolice, String) - Constructor for class xbot.common.controls.sensors.wpi_adapters.LidarLiteWpiAdapter
+
 
+
LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
LidarLiteWpiAdapterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory
+
 
+
lineSeperator - Variable in class xbot.common.injection.MockPermanentStorage
+
+
Permanent storage line seperator
+
+
load() - Method in class xbot.common.properties.BooleanProperty
+
+
Load the boolean value from the permanent store.
+
+
load() - Method in class xbot.common.properties.DoubleProperty
+
 
+
load() - Method in class xbot.common.properties.Property
+
+
Load the property from storage.
+
+
load() - Method in class xbot.common.properties.StringProperty
+
 
+
loadPropertiesFromStorage() - Method in class xbot.common.properties.XPropertyManager
+
+
Loads all properties from storage into the PermanentStore's table.
+
+
log - Variable in class xbot.common.command.BaseCommand
+
 
+
log - Variable in class xbot.common.command.BaseSubsystem
+
 
+
log - Variable in class xbot.common.command.NamedRunCommand
+
 
+
log - Variable in class xbot.common.controls.sensors.XAS5600
+
 
+
log - Static variable in class xbot.common.properties.PreferenceStorage
+
 
+
log - Static variable in class xbot.common.properties.Property
+
 
+
log - Variable in class xbot.common.properties.PropertyFactory
+
 
+
LoggingLatch - Class in xbot.common.logging
+
 
+
LoggingLatch(String, String, Latch.EdgeType) - Constructor for class xbot.common.logging.LoggingLatch
+
 
+
logSometimes(String) - Method in class xbot.common.logging.IntermittentConsoleLogger
+
 
+
loopCycleCounter - Variable in class xbot.common.command.BaseRobot
+
 
+
loopFunc() - Method in class xbot.common.command.BaseRobot
+
 
+
loops - Variable in class xbot.common.math.PurePursuitTest.PursuitEnvironmentState
+
 
+
LoudRobotAssertionManager - Class in xbot.common.logging
+
+
Version of RobotAssertionManager that allows exceptions to be thrown.
+
+
LoudRobotAssertionManager() - Constructor for class xbot.common.logging.LoudRobotAssertionManager
+
 
+
+ + + +

M

+
+
MachineControl - xbot.common.logic.HumanVsMachineDecider.HumanVsMachineMode
+
 
+
Macro - xbot.common.subsystems.drive.RabbitPoint.PointDriveStyle
+
 
+
main(String[]) - Static method in class xbot.common.math.PlanarTestVisualizer
+
 
+
maintain() - Method in class xbot.common.command.BaseMaintainerCommand
+
+
Contains all the logic associated with keeping the subsystem + at its goal.
+
+
masterChannel - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
masterMotor - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
MathUtils - Class in xbot.common.math
+
 
+
MathUtils() - Constructor for class xbot.common.math.MathUtils
+
 
+
maxOutput - Variable in class xbot.common.controls.actuators.XCANSparkMaxPIDProperties
+
 
+
Micro - xbot.common.subsystems.drive.RabbitPoint.PointDriveStyle
+
 
+
minOutput - Variable in class xbot.common.controls.actuators.XCANSparkMaxPIDProperties
+
 
+
mock - xbot.common.controls.sensors.XGyro.ImuType
+
 
+
MockAbsoluteEncoder - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockAbsoluteEncoder(DeviceInfo, String, DevicePolice, PropertyFactory) - Constructor for class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
MockAbsoluteEncoder.MockAbsoluteEncoderFactory - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockAbsoluteEncoderFactory() - Constructor for class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder.MockAbsoluteEncoderFactory
+
 
+
MockAnalogInput - Class in edu.wpi.first.wpilibj
+
 
+
MockAnalogInput(int, DevicePolice) - Constructor for class edu.wpi.first.wpilibj.MockAnalogInput
+
 
+
MockAnalogInput.MockAnalogInputFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockAnalogInputFactory() - Constructor for class edu.wpi.first.wpilibj.MockAnalogInput.MockAnalogInputFactory
+
 
+
MockBasePoseSubsystem - Class in xbot.common.subsystems.pose
+
 
+
MockBasePoseSubsystem(XGyro.XGyroFactory, PropertyFactory) - Constructor for class xbot.common.subsystems.pose.MockBasePoseSubsystem
+
 
+
MockCANCoder - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockCANCoder(DeviceInfo, String, DevicePolice, PropertyFactory) - Constructor for class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
MockCANCoder.MockCANCoderFactory - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockCANCoderFactory() - Constructor for class xbot.common.controls.sensors.mock_adapters.MockCANCoder.MockCANCoderFactory
+
 
+
MockCANSparkMax - Class in xbot.common.controls.actuators.mock_adapters
+
 
+
MockCANSparkMax(DeviceInfo, String, String, PropertyFactory, DevicePolice, XCANSparkMaxPIDProperties) - Constructor for class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
MockCANSparkMax.MockCANSparkMaxFactory - Class in xbot.common.controls.actuators.mock_adapters
+
 
+
MockCANSparkMaxFactory() - Constructor for class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax.MockCANSparkMaxFactory
+
 
+
MockCANTalon - Class in xbot.common.controls.actuators.mock_adapters
+
 
+
MockCANTalon(CANTalonInfo, PropertyFactory, DevicePolice, RobotAssertionManager) - Constructor for class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
MockCANTalon.MockCANTalonFactory - Class in xbot.common.controls.actuators.mock_adapters
+
 
+
MockCANTalonFactory() - Constructor for class xbot.common.controls.actuators.mock_adapters.MockCANTalon.MockCANTalonFactory
+
 
+
MockCANVictorSPX - Class in xbot.common.controls.actuators.mock_adapters
+
 
+
MockCANVictorSPX(int, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
MockCANVictorSPX.MockCANVictorSPXFactory - Class in xbot.common.controls.actuators.mock_adapters
+
 
+
MockCANVictorSPXFactory() - Constructor for class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX.MockCANVictorSPXFactory
+
 
+
MockCompressor - Class in edu.wpi.first.wpilibj
+
 
+
MockCompressor() - Constructor for class edu.wpi.first.wpilibj.MockCompressor
+
 
+
MockCompressor.MockCompressorFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockCompressorFactory() - Constructor for class edu.wpi.first.wpilibj.MockCompressor.MockCompressorFactory
+
 
+
MockControlsModule - Class in xbot.common.injection.modules
+
 
+
MockControlsModule() - Constructor for class xbot.common.injection.modules.MockControlsModule
+
 
+
MockDevicesModule - Class in xbot.common.injection.modules
+
 
+
MockDevicesModule() - Constructor for class xbot.common.injection.modules.MockDevicesModule
+
 
+
MockDigitalInput - Class in edu.wpi.first.wpilibj
+
 
+
MockDigitalInput(int, DevicePolice) - Constructor for class edu.wpi.first.wpilibj.MockDigitalInput
+
 
+
MockDigitalInput.MockDigitalInputFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockDigitalInputFactory() - Constructor for class edu.wpi.first.wpilibj.MockDigitalInput.MockDigitalInputFactory
+
 
+
MockDigitalOutput - Class in edu.wpi.first.wpilibj
+
 
+
MockDigitalOutput(int, DevicePolice) - Constructor for class edu.wpi.first.wpilibj.MockDigitalOutput
+
 
+
MockDigitalOutput.MockDigitalOutputFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockDigitalOutputFactory() - Constructor for class edu.wpi.first.wpilibj.MockDigitalOutput.MockDigitalOutputFactory
+
 
+
MockDistanceSensor - Class in edu.wpi.first.wpilibj
+
 
+
MockDistanceSensor() - Constructor for class edu.wpi.first.wpilibj.MockDistanceSensor
+
 
+
MockDistanceSensorPair - Class in edu.wpi.first.wpilibj
+
 
+
MockDistanceSensorPair() - Constructor for class edu.wpi.first.wpilibj.MockDistanceSensorPair
+
 
+
MockDriveSubsystem - Class in xbot.common.subsystems.drive
+
 
+
MockDriveSubsystem(XCANTalon.XCANTalonFactory, PIDManager.PIDManagerFactory) - Constructor for class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
MockDutyCycleEncoder - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockDutyCycleEncoder(DeviceInfo, DevicePolice) - Constructor for class xbot.common.controls.sensors.mock_adapters.MockDutyCycleEncoder
+
 
+
MockDutyCycleEncoder.MockDutyCycleEncoderFactory - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockDutyCycleEncoderFactory() - Constructor for class xbot.common.controls.sensors.mock_adapters.MockDutyCycleEncoder.MockDutyCycleEncoderFactory
+
 
+
MockEncoder - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockEncoder(String, int, int, double, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.sensors.mock_adapters.MockEncoder
+
 
+
MockEncoder(String, PropertyFactory) - Constructor for class xbot.common.controls.sensors.mock_adapters.MockEncoder
+
 
+
MockEncoder.MockEncoderFactory - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockEncoderFactory() - Constructor for class xbot.common.controls.sensors.mock_adapters.MockEncoder.MockEncoderFactory
+
 
+
MockFTCGamepad - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockFTCGamepad(int, AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory, AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory, AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory, RobotAssertionManager, int, DevicePolice) - Constructor for class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
MockFTCGamepad.MockFTCGamepadFactory - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockFTCGamepadFactory() - Constructor for class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad.MockFTCGamepadFactory
+
 
+
MockGyro - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockGyro(DevicePolice, SPI.Port, SerialPort.Port, I2C.Port) - Constructor for class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
MockGyro.MockGyroFactory - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockGyroFactory() - Constructor for class xbot.common.controls.sensors.mock_adapters.MockGyro.MockGyroFactory
+
 
+
MockJoystick - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockJoystick(int, AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory, AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory, AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory, RobotAssertionManager, int, DevicePolice) - Constructor for class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
MockJoystick.MockJoystickFactory - Class in xbot.common.controls.sensors.mock_adapters
+
 
+
MockJoystickFactory() - Constructor for class xbot.common.controls.sensors.mock_adapters.MockJoystick.MockJoystickFactory
+
 
+
MockLidarLite - Class in edu.wpi.first.wpilibj
+
 
+
MockLidarLite(I2C.Port, PropertyFactory, DevicePolice, String) - Constructor for class edu.wpi.first.wpilibj.MockLidarLite
+
 
+
MockLidarLite.MockLidarLiteFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockLidarLiteFactory() - Constructor for class edu.wpi.first.wpilibj.MockLidarLite.MockLidarLiteFactory
+
 
+
MockPermamentStorage - Class in xbot.common.properties
+
 
+
MockPermamentStorage() - Constructor for class xbot.common.properties.MockPermamentStorage
+
 
+
MockPermanentStorage - Class in xbot.common.injection
+
 
+
MockPermanentStorage() - Constructor for class xbot.common.injection.MockPermanentStorage
+
 
+
MockPowerDistributionPanel - Class in edu.wpi.first.wpilibj
+
 
+
MockPowerDistributionPanel() - Constructor for class edu.wpi.first.wpilibj.MockPowerDistributionPanel
+
 
+
MockPowerDistributionPanel.MockPowerDistributionPanelFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockPowerDistributionPanelFactory() - Constructor for class edu.wpi.first.wpilibj.MockPowerDistributionPanel.MockPowerDistributionPanelFactory
+
 
+
MockPWM - Class in edu.wpi.first.wpilibj
+
 
+
MockPWM(int, DevicePolice) - Constructor for class edu.wpi.first.wpilibj.MockPWM
+
 
+
MockPWM.MockPWMFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockPWMFactory() - Constructor for class edu.wpi.first.wpilibj.MockPWM.MockPWMFactory
+
 
+
MockRelay - Class in xbot.common.controls.actuators.mock_adapters
+
 
+
MockRelay(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.mock_adapters.MockRelay
+
 
+
MockRelay.MockRelayFactory - Class in xbot.common.controls.actuators.mock_adapters
+
 
+
MockRelayFactory() - Constructor for class xbot.common.controls.actuators.mock_adapters.MockRelay.MockRelayFactory
+
 
+
MockServo - Class in edu.wpi.first.wpilibj
+
 
+
MockServo(int, DevicePolice) - Constructor for class edu.wpi.first.wpilibj.MockServo
+
 
+
MockServo.MockServoFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockServoFactory() - Constructor for class edu.wpi.first.wpilibj.MockServo.MockServoFactory
+
 
+
MockSmartDashboardCommandPutter - Class in xbot.common.command
+
 
+
MockSmartDashboardCommandPutter() - Constructor for class xbot.common.command.MockSmartDashboardCommandPutter
+
 
+
MockSolenoid - Class in edu.wpi.first.wpilibj
+
 
+
MockSolenoid(int, DevicePolice) - Constructor for class edu.wpi.first.wpilibj.MockSolenoid
+
 
+
MockSolenoid.MockSolenoidFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockSolenoidFactory() - Constructor for class edu.wpi.first.wpilibj.MockSolenoid.MockSolenoidFactory
+
 
+
MockSpeedController - Class in edu.wpi.first.wpilibj
+
 
+
MockSpeedController(int, DevicePolice) - Constructor for class edu.wpi.first.wpilibj.MockSpeedController
+
 
+
MockSpeedController.MockSpeedControllerFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockSpeedControllerFactory() - Constructor for class edu.wpi.first.wpilibj.MockSpeedController.MockSpeedControllerFactory
+
 
+
MockTimer - Class in edu.wpi.first.wpilibj
+
 
+
MockTimer() - Constructor for class edu.wpi.first.wpilibj.MockTimer
+
 
+
MockXboxControllerAdapter - Class in edu.wpi.first.wpilibj
+
 
+
MockXboxControllerAdapter(int, AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory, AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory, AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory, XRumbleManager.XRumbleManagerFactory, RobotAssertionManager, DevicePolice) - Constructor for class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
MockXboxControllerAdapter.MockXboxControllerFactory - Class in edu.wpi.first.wpilibj
+
 
+
MockXboxControllerFactory() - Constructor for class edu.wpi.first.wpilibj.MockXboxControllerAdapter.MockXboxControllerFactory
+
 
+
MockZeromqListener - Class in xbot.common.networking
+
 
+
MockZeromqListener(String, String) - Constructor for class xbot.common.networking.MockZeromqListener
+
 
+
MockZeromqListener.MockZeromqListenerFactory - Class in xbot.common.networking
+
 
+
MockZeromqListenerFactory() - Constructor for class xbot.common.networking.MockZeromqListener.MockZeromqListenerFactory
+
 
+
monitor - Variable in class xbot.common.command.BaseCommand
+
 
+
move(XYPair, double) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
 
+
move(XYPair, double) - Method in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
MultiplexedLidarPair - Class in xbot.common.controls.sensors
+
 
+
MultiplexedLidarPair(I2C.Port, byte, byte, PropertyFactory) - Constructor for class xbot.common.controls.sensors.MultiplexedLidarPair
+
 
+
+ + + +

N

+
+
NamedInstantCommand - Class in xbot.common.command
+
+
Convenience wrapper of InstantCommand that allows setting a human readable name for + smartdashboard/logging readability.
+
+
NamedInstantCommand(String, Runnable, Subsystem...) - Constructor for class xbot.common.command.NamedInstantCommand
+
 
+
NamedRunCommand - Class in xbot.common.command
+
 
+
NamedRunCommand(String, Runnable, Subsystem...) - Constructor for class xbot.common.command.NamedRunCommand
+
 
+
nav6 - xbot.common.controls.sensors.XGyro.ImuType
+
 
+
navX - xbot.common.controls.sensors.XGyro.ImuType
+
 
+
neutralOutput() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
neutralOutput() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
neutralOutput() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
neutralOutput() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
neutralOutput() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
neutralOutput() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
NOT_STALLED - xbot.common.logic.StallDetector.StallState
+
 
+
NotTimeStable - xbot.common.math.PID.OffTargetReason
+
 
+
+ + + +

O

+
+
obliterateStorage() - Method in class xbot.common.properties.DatabaseStorageBase
+
 
+
OFF - xbot.common.controls.actuators.XDoubleSolenoid.DoubleSolenoidMode
+
 
+
OffTargetNotConfigured - xbot.common.math.PID.OffTargetReason
+
 
+
on - Variable in class edu.wpi.first.wpilibj.MockSolenoid
+
 
+
OneLogFilePerRunRollingFileAppender - Class in xbot.common.logging
+
 
+
OneLogFilePerRunRollingFileAppender() - Constructor for class xbot.common.logging.OneLogFilePerRunRollingFileAppender
+
 
+
OneLogFilePerRunRollingFileAppender(Layout, String) - Constructor for class xbot.common.logging.OneLogFilePerRunRollingFileAppender
+
 
+
OneLogFilePerRunRollingFileAppender(Layout, String, boolean) - Constructor for class xbot.common.logging.OneLogFilePerRunRollingFileAppender
+
 
+
onFalse(Command) - Method in class xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger
+
 
+
onNewStep(PurePursuitTest.PursuitEnvironmentState) - Method in interface xbot.common.math.PurePursuitTest.AsyncLinearIntervalJob
+
 
+
OnTarget - xbot.common.math.PID.OffTargetReason
+
 
+
onTrue(Command) - Method in class xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger
+
 
+
overrideLimitSwitchesEnable(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
overrideLimitSwitchesEnable(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
overrideLimitSwitchesEnable(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
overrideLimitSwitchesEnable(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
overrideLimitSwitchesEnable(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
overrideLimitSwitchesEnable(boolean) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
overrideSoftLimitsEnable(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
overrideSoftLimitsEnable(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
overrideSoftLimitsEnable(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
overrideSoftLimitsEnable(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
overrideSoftLimitsEnable(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
overrideSoftLimitsEnable(boolean) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
+ + + +

P

+
+
p - Variable in class xbot.common.controls.actuators.XCANSparkMaxPIDProperties
+
 
+
paintComponent(Graphics) - Method in class xbot.common.math.PlanarVisualizationPanel
+
 
+
periodic() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
periodic() - Method in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
periodic() - Method in class xbot.common.subsystems.compressor.CompressorSubsystem
+
 
+
periodic() - Method in class xbot.common.subsystems.feedback.RumbleManager
+
 
+
periodic() - Method in interface xbot.common.subsystems.feedback.XRumbleManager
+
+
Called periodically to update the rumble state.
+
+
periodic() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
periodMultiplier - Variable in class xbot.common.math.PurePursuitTest
+
 
+
permanentStorage() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
PermanentStorage - Interface in xbot.common.properties
+
 
+
permanentStore - Variable in class xbot.common.properties.XPropertyManager
+
 
+
perpindicularRatioProp - Variable in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
persistenceType - Variable in class xbot.common.properties.Property
+
 
+
Persistent - xbot.common.properties.Property.PropertyPersistenceType
+
 
+
pf - Variable in class xbot.common.injection.BaseWPITest
+
 
+
pf - Variable in class xbot.common.simulation.BaseSimulationTest
+
 
+
PID - Class in xbot.common.math
+
+
This PID was extracted from WPILib.
+
+
PID() - Constructor for class xbot.common.math.PID
+
 
+
PID.OffTargetReason - Enum in xbot.common.math
+
 
+
pidFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
pidGet() - Method in class xbot.common.controls.sensors.XLidarLite
+
 
+
PIDManager - Class in xbot.common.math
+
+
Wrapper for PID class which automatically puts the P, I and D values on + the SmartDashboard.
+
+
PIDManager(String, PropertyFactory, RobotAssertionManager, double, double, double, double, double, double, double, double, double, double) - Constructor for class xbot.common.math.PIDManager
+
 
+
PIDManager.PIDManagerFactory - Class in xbot.common.math
+
 
+
PIDManagerFactory() - Constructor for class xbot.common.math.PIDManager.PIDManagerFactory
+
 
+
pidPropertyManager - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
PIDPropertyManager - Class in xbot.common.math
+
 
+
PIDPropertyManager(String, PropertyFactory, RobotAssertionManager, double, double, double, double, double, double, double, double) - Constructor for class xbot.common.math.PIDPropertyManager
+
 
+
PIDPropertyManager.PIDPropertyManagerFactory - Class in xbot.common.math
+
 
+
pidPropertyManagerFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
PIDPropertyManagerFactory() - Constructor for class xbot.common.math.PIDPropertyManager.PIDPropertyManagerFactory
+
 
+
PlanarEngine - Class in xbot.common.math
+
 
+
PlanarEngine() - Constructor for class xbot.common.math.PlanarEngine
+
 
+
PlanarTestVisualizer - Class in xbot.common.math
+
 
+
PlanarTestVisualizer(List<RabbitPoint>) - Constructor for class xbot.common.math.PlanarTestVisualizer
+
 
+
PlanarVisualizationPanel - Class in xbot.common.math
+
 
+
PlanarVisualizationPanel() - Constructor for class xbot.common.math.PlanarVisualizationPanel
+
 
+
PlanarVisualizationPanel(int, int) - Constructor for class xbot.common.math.PlanarVisualizationPanel
+
 
+
pointIndex - Variable in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
pointType - Variable in class xbot.common.subsystems.drive.RabbitPoint
+
 
+
policeTicket - Variable in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
policeTicket - Variable in class xbot.common.controls.actuators.XCANTalon
+
 
+
port - Variable in class xbot.common.controls.sensors.XJoystick
+
 
+
port - Variable in class xbot.common.controls.sensors.XXboxController
+
 
+
pose - Variable in class xbot.common.subsystems.drive.RabbitPoint
+
 
+
poseSubsystem - Variable in class xbot.common.subsystems.pose.commands.ResetDistanceCommand
+
 
+
poseSubsystem - Variable in class xbot.common.subsystems.pose.commands.SetRobotHeadingCommand
+
 
+
poseSubsystem() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
poseSystem - Variable in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
positionalPid - Variable in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
PositionAndHeading - xbot.common.subsystems.drive.RabbitPoint.PointType
+
 
+
PositionOnly - xbot.common.subsystems.drive.RabbitPoint.PointType
+
 
+
POV - xbot.common.controls.sensors.XJoystick.ButtonSource
+
 
+
povButtonFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
powerDistributionPanelFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
PowerDistributionPanelWPIAdapaterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory
+
 
+
PowerDistributionPanelWPIAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
PowerDistributionPanelWPIAdapter() - Constructor for class xbot.common.controls.sensors.wpi_adapters.PowerDistributionPanelWPIAdapter
+
 
+
PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
PreferenceStorage - Class in xbot.common.properties
+
 
+
PreferenceStorage() - Constructor for class xbot.common.properties.PreferenceStorage
+
 
+
prefix - Variable in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
pressButton(int) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
pressButton(int) - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
previousLeftDistance - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
previousRightDistance - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
processMotionProfileBuffer() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
processMotionProfileBuffer() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
processMotionProfileBuffer() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
processMotionProfileBuffer() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
processMotionProfileBuffer() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
processMotionProfileBuffer() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
properties - Variable in class xbot.common.properties.XPropertyManager
+
 
+
Property - Class in xbot.common.properties
+
+
There are many values on the robot that we want to configure on the fly as + well as persist once we're happy with the result.
+
+
Property(String, XPropertyManager) - Constructor for class xbot.common.properties.Property
+
+
The name of the property.
+
+
Property(String, XPropertyManager, Property.PropertyPersistenceType) - Constructor for class xbot.common.properties.Property
+
+
The name of the property.
+
+
Property(String, XPropertyManager, Property.PropertyPersistenceType, Property.PropertyLevel) - Constructor for class xbot.common.properties.Property
+
+
The name of the property.
+
+
Property.PropertyLevel - Enum in xbot.common.properties
+
 
+
Property.PropertyPersistenceType - Enum in xbot.common.properties
+
+
New enum to determine property persistence + Ephemeral properties will not be saved or load from a persistent storage + Persistent properties will be saved and load from a persistent storage
+
+
propertyDelimiter - Variable in class xbot.common.injection.MockPermanentStorage
+
+
Permanent storage property storage delimiter
+
+
propertyFactory - Variable in class xbot.common.injection.BaseWPITest
+
 
+
propertyFactory - Variable in class xbot.common.simulation.BaseSimulationTest
+
 
+
propertyFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
PropertyFactory - Class in xbot.common.properties
+
 
+
propertyManager - Variable in class xbot.common.command.BaseRobot
+
 
+
propertyManager() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
propMan - Variable in class xbot.common.controls.actuators.XCANTalon
+
 
+
PurePursuitCommand - Class in xbot.common.subsystems.drive
+
 
+
PurePursuitCommand(HeadingModule.HeadingModuleFactory, BasePoseSubsystem, BaseDriveSubsystem, PropertyFactory) - Constructor for class xbot.common.subsystems.drive.PurePursuitCommand
+
+
An implementation of Pure Pursuit for FRC.
+
+
PurePursuitCommand.PointLoadingMode - Enum in xbot.common.subsystems.drive
+
 
+
PurePursuitCommand.RabbitChaseInfo - Class in xbot.common.subsystems.drive
+
 
+
PurePursuitTest - Class in xbot.common.math
+
 
+
PurePursuitTest(List<RabbitPoint>) - Constructor for class xbot.common.math.PurePursuitTest
+
 
+
PurePursuitTest.AsyncLinearIntervalJob - Interface in xbot.common.math
+
 
+
PurePursuitTest.PursuitEnvironmentState - Class in xbot.common.math
+
 
+
PurePursuitTestComponent - Class in xbot.common.injection.components
+
+
Do not use this directly.
+
+
PurePursuitTestComponent() - Constructor for class xbot.common.injection.components.PurePursuitTestComponent
+
 
+
PursuitEnvironmentState(FieldPose, FieldPose, FieldPose, int, double, double, double) - Constructor for class xbot.common.math.PurePursuitTest.PursuitEnvironmentState
+
 
+
pushMotionProfileTrajectory(TrajectoryPoint) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
pushMotionProfileTrajectory(TrajectoryPoint) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
pushMotionProfileTrajectory(TrajectoryPoint) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
pushMotionProfileTrajectory(TrajectoryPoint) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
pushMotionProfileTrajectory(TrajectoryPoint) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
pushMotionProfileTrajectory(TrajectoryPoint) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
PWM - xbot.common.injection.DevicePolice.DeviceType
+
 
+
pwmFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
PWMWPIAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
PWMWPIAdapter(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter
+
 
+
PWMWPIAdapter.PWMWPIAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
PWMWPIAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter.PWMWPIAdapterFactory
+
 
+
+ + + +

R

+
+
rabbit - Variable in class xbot.common.math.PurePursuitTest.PursuitEnvironmentState
+
 
+
rabbit - Variable in class xbot.common.subsystems.drive.PurePursuitCommand.RabbitChaseInfo
+
 
+
rabbitAngle - Variable in class xbot.common.math.PurePursuitTest.PursuitEnvironmentState
+
 
+
RabbitChaseInfo(double, double) - Constructor for class xbot.common.subsystems.drive.PurePursuitCommand.RabbitChaseInfo
+
 
+
RabbitChaseInfo(double, double, FieldPose, FieldPose) - Constructor for class xbot.common.subsystems.drive.PurePursuitCommand.RabbitChaseInfo
+
 
+
RabbitChaseInfo(double, double, FieldPose, FieldPose, double) - Constructor for class xbot.common.subsystems.drive.PurePursuitCommand.RabbitChaseInfo
+
 
+
rabbitLookAhead - Variable in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
RabbitPoint - Class in xbot.common.subsystems.drive
+
 
+
RabbitPoint(double, double, double) - Constructor for class xbot.common.subsystems.drive.RabbitPoint
+
 
+
RabbitPoint(FieldPose) - Constructor for class xbot.common.subsystems.drive.RabbitPoint
+
 
+
RabbitPoint(FieldPose, RabbitPoint.PointType, RabbitPoint.PointTerminatingType) - Constructor for class xbot.common.subsystems.drive.RabbitPoint
+
 
+
RabbitPoint(FieldPose, RabbitPoint.PointType, RabbitPoint.PointTerminatingType, RabbitPoint.PointDriveStyle) - Constructor for class xbot.common.subsystems.drive.RabbitPoint
+
 
+
RabbitPoint.PointDriveStyle - Enum in xbot.common.subsystems.drive
+
 
+
RabbitPoint.PointTerminatingType - Enum in xbot.common.subsystems.drive
+
 
+
RabbitPoint.PointType - Enum in xbot.common.subsystems.drive
+
 
+
RabbitPointBuilder - Class in xbot.common.subsystems.drive
+
 
+
RabbitPointBuilder() - Constructor for class xbot.common.subsystems.drive.RabbitPointBuilder
+
 
+
randomAccessStore - Variable in class xbot.common.properties.XPropertyManager
+
 
+
readFromFile() - Method in class xbot.common.injection.MockPermanentStorage
+
 
+
RealControlsModule - Class in xbot.common.injection.modules
+
 
+
RealControlsModule() - Constructor for class xbot.common.injection.modules.RealControlsModule
+
 
+
RealDevicesModule - Class in xbot.common.injection.modules
+
 
+
RealDevicesModule() - Constructor for class xbot.common.injection.modules.RealDevicesModule
+
 
+
RealSmartDashboardCommandPutter - Class in xbot.common.command
+
 
+
RealSmartDashboardCommandPutter() - Constructor for class xbot.common.command.RealSmartDashboardCommandPutter
+
 
+
reboundValue() - Method in class xbot.common.math.ContiguousDouble
+
+
Shifts the value so that it still represents the same position but is + within the current bounds.
+
+
reboundValue(double, double, double) - Static method in class xbot.common.math.ContiguousDouble
+
 
+
registerDevice(DevicePolice.DeviceType, int) - Method in class xbot.common.injection.DevicePolice
+
+
Deprecated.
+
+
registerDevice(DevicePolice.DeviceType, int, int, int) - Method in class xbot.common.injection.DevicePolice
+
+
Register a device with an id falling into an allowable range
+
+
registerDevice(DevicePolice.DeviceType, int, int, int, Object) - Method in class xbot.common.injection.DevicePolice
+
+
Register a device with an id falling into an allowable range
+
+
registerDevice(DevicePolice.DeviceType, int, Object) - Method in class xbot.common.injection.DevicePolice
+
+
Register a device
+
+
registeredChannels - Variable in class xbot.common.injection.DevicePolice
+
+
A list of all the channels in use, and what device is using them.
+
+
registeredDevices - Variable in class xbot.common.injection.DevicePolice
+
+
A list of all the devices in use
+
+
registerProperty(Property) - Method in class xbot.common.properties.XPropertyManager
+
+
Adds the property to the local collection.
+
+
registerSubsystem(Subsystem...) - Method in class xbot.common.command.XScheduler
+
 
+
Relative - xbot.common.subsystems.drive.PurePursuitCommand.PointLoadingMode
+
 
+
relayFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
RelayWPIAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
RelayWPIAdapter(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.wpi_adapters.RelayWPIAdapter
+
 
+
RelayWPIAdapter.RelayWPIAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
RelayWPIAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.RelayWPIAdapter.RelayWPIAdapterFactory
+
 
+
releaseButton(int) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
releaseButton(int) - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
remove(String) - Method in interface xbot.common.properties.ITableProxy
+
 
+
remove(String) - Method in class xbot.common.properties.PreferenceStorage
+
 
+
remove(String) - Method in class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
remove(String) - Method in class xbot.common.properties.TableProxy
+
 
+
removeAll() - Method in class xbot.common.command.XScheduler
+
 
+
requires(BaseSubsystem) - Method in class xbot.common.command.BaseCommand
+
+
Deprecated. +
Suggest use CommandBase.addRequirements(edu.wpi.first.wpilibj2.command.Subsystem...) instead.
+
+
+
requiresLayout() - Method in class xbot.common.logging.DriverStationAppender
+
 
+
reset() - Method in class xbot.common.logging.RobotSession
+
 
+
reset() - Method in class xbot.common.logic.CalibrationDecider
+
 
+
reset() - Method in class xbot.common.logic.HumanVsMachineDecider
+
 
+
reset() - Method in class xbot.common.logic.VelocityThrottleModule
+
 
+
reset() - Method in class xbot.common.math.PID
+
+
Resets the PID controller.
+
+
reset() - Method in class xbot.common.math.PIDManager
+
 
+
reset() - Method in class xbot.common.subsystems.drive.control_logic.HeadingAssistModule
+
 
+
reset() - Method in class xbot.common.subsystems.drive.control_logic.HeadingModule
+
 
+
reset(boolean) - Method in class xbot.common.logic.HumanVsMachineDecider
+
 
+
resetDecider(boolean) - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
ResetDistanceCommand - Class in xbot.common.subsystems.pose.commands
+
 
+
ResetDistanceCommand(BasePoseSubsystem) - Constructor for class xbot.common.subsystems.pose.commands.ResetDistanceCommand
+
 
+
resetDistanceTraveled() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
resetPosition() - Method in class xbot.common.simulation.WebotsClient
+
 
+
resetPosition(double, double, double) - Method in class xbot.common.simulation.WebotsClient
+
 
+
ResetSimulatorPositionCommand - Class in xbot.common.simulation
+
 
+
ResetSimulatorPositionCommand(WebotsClient, BasePoseSubsystem, SimulationPayloadDistributor) - Constructor for class xbot.common.simulation.ResetSimulatorPositionCommand
+
 
+
restoreFactoryDefaults() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
restoreFactoryDefaults() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
restoreFactoryDefaults() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
restoreFactoryDefaults(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
REVERSE - xbot.common.controls.actuators.XDoubleSolenoid.DoubleSolenoidMode
+
 
+
reverseSolenoid - Variable in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
RightBumper - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
rightDriveDistance - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
RightJoystickYAxis - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
RightStick - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
rightTank - Variable in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
rightTotalDistance - Variable in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
RightTrigger - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
rightXInversion - Variable in class xbot.common.controls.sensors.XXboxController
+
 
+
rightYInversion - Variable in class xbot.common.controls.sensors.XXboxController
+
 
+
rioRotated - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
RisingEdge - xbot.common.logic.Latch.EdgeType
+
 
+
rl - Variable in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
robot - Variable in class xbot.common.math.PurePursuitTest.PursuitEnvironmentState
+
 
+
RobotAssertionException - Exception in xbot.common.logging
+
 
+
RobotAssertionException(String) - Constructor for exception xbot.common.logging.RobotAssertionException
+
 
+
robotAssertionManager() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
RobotAssertionManager - Class in xbot.common.logging
+
+
Base class for safe assertion manager.
+
+
RobotAssertionManager() - Constructor for class xbot.common.logging.RobotAssertionManager
+
 
+
robotInit() - Method in class xbot.common.command.BaseRobot
+
+
This function is run when the robot is first started up and should be used for any initialization code.
+
+
RobotModule - Class in xbot.common.injection.modules
+
+
Module mapping interfaces to implementations for a real robot.
+
+
RobotModule() - Constructor for class xbot.common.injection.modules.RobotModule
+
 
+
robotSession - Variable in class xbot.common.command.BaseRobot
+
 
+
robotSession() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
RobotSession - Class in xbot.common.logging
+
 
+
RobotSession(WordGenerator, PropertyFactory) - Constructor for class xbot.common.logging.RobotSession
+
 
+
rollOverManually() - Method in class xbot.common.logging.OneLogFilePerRunRollingFileAppender
+
 
+
rotate(double) - Method in class xbot.common.math.XYPair
+
+
Rotates the vector by a given angle.
+
+
rotation - Variable in class xbot.common.subsystems.drive.PurePursuitCommand.RabbitChaseInfo
+
 
+
rr - Variable in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
rumbleGamepad(double, double) - Method in class xbot.common.subsystems.feedback.RumbleManager
+
 
+
rumbleGamepad(double, double) - Method in interface xbot.common.subsystems.feedback.XRumbleManager
+
+
Rumbles the gamepad at the specified intensity for the given duration.
+
+
rumbleManager - Variable in class xbot.common.controls.sensors.XXboxController
+
 
+
RumbleManager - Class in xbot.common.subsystems.feedback
+
+
Wrappers around gamepad rumble behavior to control intensity and duration.
+
+
RumbleManager(XJoystick) - Constructor for class xbot.common.subsystems.feedback.RumbleManager
+
+
Creates a new RumbleManager instance.
+
+
RumbleManager.RumbleManagerFactory - Class in xbot.common.subsystems.feedback
+
 
+
rumbleManagerFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
RumbleManagerFactory() - Constructor for class xbot.common.subsystems.feedback.RumbleManager.RumbleManagerFactory
+
 
+
run() - Method in class xbot.common.command.XScheduler
+
 
+
runsWhenDisabled() - Method in class xbot.common.command.BaseCommand
+
 
+
runsWhenDisabled() - Method in class xbot.common.properties.ConfigurePropertiesCommand
+
 
+
runsWhenDisabled() - Method in class xbot.common.subsystems.autonomous.SetAutonomousCommand
+
 
+
runsWhenDisabled() - Method in class xbot.common.subsystems.pose.commands.ResetDistanceCommand
+
 
+
runsWhenDisabled() - Method in class xbot.common.subsystems.pose.commands.SetRobotHeadingCommand
+
 
+
+ + + +

S

+
+
save() - Method in class xbot.common.properties.BooleanProperty
+
+
Saves the value permanently (presumably to the Robot).
+
+
save() - Method in class xbot.common.properties.DoubleProperty
+
+
We only save the property if it's from a persistent type
+
+
save() - Method in class xbot.common.properties.Property
+
+
Save the property permanently.
+
+
save() - Method in class xbot.common.properties.StringProperty
+
+
We only save the property if it's from a persistent type
+
+
saveOutAllProperties() - Method in class xbot.common.properties.XPropertyManager
+
+
Save all properties into permanent storage.
+
+
scale(double) - Method in class xbot.common.math.XYPair
+
+
Scales the current coordinate by a magnitude equally in both dimensions.
+
+
scale(double, double) - Method in class xbot.common.math.XYPair
+
+
Scales the coordinate by an x- and y- magnitude.
+
+
scaleDouble(double, double, double, double, double) - Static method in class xbot.common.math.MathUtils
+
 
+
scheduler() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
selectProfileSlot(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
selectProfileSlot(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
selectProfileSlot(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
selectProfileSlot(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
selectProfileSlot(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
selectProfileSlot(int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
sendMotors(List<JSONObject>) - Method in class xbot.common.simulation.WebotsClient
+
 
+
sendPacket(String) - Method in class xbot.common.networking.MockZeromqListener
+
 
+
servoFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
ServoWPIAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
ServoWPIAdapter(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.wpi_adapters.ServoWPIAdapter
+
 
+
ServoWPIAdapter.ServoWPIAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
ServoWPIAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.ServoWPIAdapter.ServoWPIAdapterFactory
+
 
+
set(boolean) - Method in class edu.wpi.first.wpilibj.MockDigitalOutput
+
 
+
set(boolean) - Method in class edu.wpi.first.wpilibj.MockSolenoid
+
 
+
set(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter
+
 
+
set(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.SolenoidWPIAdapter
+
 
+
set(boolean) - Method in class xbot.common.controls.actuators.XDigitalOutput
+
 
+
set(boolean) - Method in class xbot.common.controls.actuators.XSolenoid
+
 
+
set(boolean) - Method in class xbot.common.controls.sensors.buttons.SettableBooleanSuppler
+
 
+
set(boolean) - Method in class xbot.common.controls.sensors.buttons.VirtualTrigger
+
 
+
set(boolean) - Method in class xbot.common.properties.BooleanProperty
+
 
+
set(double) - Method in class edu.wpi.first.wpilibj.MockServo
+
 
+
set(double) - Method in class edu.wpi.first.wpilibj.MockSpeedController
+
 
+
set(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
set(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
set(double) - Method in class xbot.common.controls.actuators.wpi_adapters.ServoWPIAdapter
+
 
+
set(double) - Method in class xbot.common.controls.actuators.wpi_adapters.SpeedControllerWPIAdapter
+
 
+
set(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Common interface for setting the speed of a speed controller.
+
+
set(double) - Method in class xbot.common.controls.actuators.XServo
+
 
+
set(double) - Method in class xbot.common.controls.actuators.XSpeedController
+
 
+
set(double) - Method in class xbot.common.properties.DoubleProperty
+
 
+
set(ControlMode, double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
set(ControlMode, double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
set(ControlMode, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
set(ControlMode, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
set(ControlMode, double) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
set(ControlMode, double) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
set(ControlMode, double, double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
set(ControlMode, double, double) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
set(ControlMode, double, double) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
set(ControlMode, double, DemandType, double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
set(ControlMode, double, DemandType, double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
set(ControlMode, double, DemandType, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
set(ControlMode, double, DemandType, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
set(ControlMode, double, DemandType, double) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
set(Relay.Value) - Method in class xbot.common.controls.actuators.mock_adapters.MockRelay
+
 
+
set(Relay.Value) - Method in class xbot.common.controls.actuators.wpi_adapters.RelayWPIAdapter
+
 
+
set(Relay.Value) - Method in class xbot.common.controls.actuators.XRelay
+
 
+
set(String) - Method in class xbot.common.properties.StringProperty
+
 
+
setAbsolutePosition(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
setAbsolutePosition(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
setAllParameters(double, double, double, double, double, double) - Method in class xbot.common.logic.StallDetector
+
 
+
setAsAsync(PurePursuitTest.AsyncLinearIntervalJob) - Method in class xbot.common.math.PurePursuitTest
+
 
+
setAsyncPeriodMultiplier(double) - Method in class xbot.common.math.PurePursuitTest
+
 
+
setAutoCommand(Command) - Method in class xbot.common.subsystems.autonomous.SetAutonomousCommand
+
 
+
SetAutonomousCommand - Class in xbot.common.subsystems.autonomous
+
 
+
SetAutonomousCommand(AutonomousCommandSelector) - Constructor for class xbot.common.subsystems.autonomous.SetAutonomousCommand
+
 
+
setAutonomousState(String) - Method in class xbot.common.subsystems.autonomous.AutonomousCommandSelector
+
 
+
setAverageBits(int) - Method in class edu.wpi.first.wpilibj.MockAnalogInput
+
 
+
setAverageBits(int) - Method in class xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater
+
 
+
setAverageBits(int) - Method in class xbot.common.controls.sensors.XAnalogInput
+
 
+
setAverageDepth(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setAverageDepth(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setAverageDepth(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setAveraging(boolean) - Method in class edu.wpi.first.wpilibj.MockDistanceSensor
+
 
+
setAveraging(boolean) - Method in class xbot.common.controls.sensors.AnalogDistanceSensor
+
 
+
setAveraging(boolean) - Method in interface xbot.common.controls.sensors.DistanceSensor
+
 
+
setAveraging(boolean) - Method in class xbot.common.controls.sensors.SimulatedAnalogDistanceSensor
+
 
+
setAveraging(boolean) - Method in class xbot.common.controls.sensors.XAnalogDistanceSensor
+
 
+
setAveraging(boolean) - Method in class xbot.common.controls.sensors.XLidarLite
+
 
+
setAxisInverted(int, boolean) - Method in class xbot.common.controls.sensors.XJoystick
+
 
+
setBoolean(String, boolean) - Method in class xbot.common.properties.DatabaseStorageBase
+
 
+
setBoolean(String, boolean) - Method in interface xbot.common.properties.ITableProxy
+
 
+
setBoolean(String, boolean) - Method in class xbot.common.properties.PreferenceStorage
+
 
+
setBoolean(String, boolean) - Method in class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
setBoolean(String, boolean) - Method in class xbot.common.properties.TableProxy
+
 
+
setCANTimeout(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setCANTimeout(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setCANTimeout(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets timeout for sending CAN messages with SetParameter* and GetParameter* + calls.
+
+
setClosedLoopRampRate(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setClosedLoopRampRate(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setClosedLoopRampRate(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the ramp rate for closed loop control modes.
+
+
setControlFramePeriod(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setControlFramePeriod(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setControlFramePeriod(ControlFrame, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setControlFramePeriod(ControlFrame, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setControlFramePeriod(ControlFrame, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setControlFramePeriod(ControlFrame, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setControlFramePeriod(ControlFrame, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setControlFramePeriod(ControlFrame, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
setControlFramePeriodMs(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setCurrent(int, double) - Method in class edu.wpi.first.wpilibj.MockPowerDistributionPanel
+
 
+
setCurrentAutonomousCommand(Command) - Method in class xbot.common.subsystems.autonomous.AutonomousCommandSelector
+
 
+
setCurrentAutonomousCommandSupplier(Supplier<Command>) - Method in class xbot.common.subsystems.autonomous.AutonomousCommandSelector
+
 
+
setCurrentHeading(double) - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
setCurrentPosition(double, double) - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
setD(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setD(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setD(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setD(double) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setD(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setD(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setD(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setDebug(boolean) - Method in class xbot.common.properties.DebugFlag
+
 
+
setDefaultCommand(Subsystem, Command) - Method in class xbot.common.command.XScheduler
+
 
+
setDefaultLevel(Property.PropertyLevel) - Method in class xbot.common.properties.PropertyFactory
+
 
+
setDerivativeThreshold(double) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setDeviceRawAccelX(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setDeviceRawAccelY(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setDeviceRawAccelZ(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setDeviceVelocityX(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setDeviceVelocityY(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setDeviceVelocityZ(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setDFilter(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setDFilter(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setDFilter(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setDFilter(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setDFilter(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setDFilter(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setDistance(double) - Method in class edu.wpi.first.wpilibj.MockDistanceSensor
+
 
+
setDistance(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockEncoder
+
 
+
setDistance(double) - Method in class xbot.common.controls.sensors.SimulatedAnalogDistanceSensor
+
 
+
setDistanceOffset(double) - Method in class xbot.common.controls.sensors.AnalogDistanceSensor
+
 
+
setDistanceOffset(double) - Method in class xbot.common.controls.sensors.SimulatedAnalogDistanceSensor
+
 
+
setDistanceOffset(double) - Method in class xbot.common.controls.sensors.XAnalogDistanceSensor
+
 
+
setDistancePerPulseSupplier(Supplier<Double>) - Method in class xbot.common.controls.sensors.XEncoder
+
 
+
setDotProductDrivingEnabled(boolean) - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
setDouble(String, double) - Method in class xbot.common.properties.DatabaseStorageBase
+
 
+
setDouble(String, double) - Method in interface xbot.common.properties.ITableProxy
+
 
+
setDouble(String, double) - Method in class xbot.common.properties.PreferenceStorage
+
 
+
setDouble(String, double) - Method in class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
setDouble(String, double) - Method in class xbot.common.properties.TableProxy
+
 
+
setDoubleSolenoid(XDoubleSolenoid.DoubleSolenoidMode) - Method in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
setDriveEncoderDistances(int, int) - Method in class xbot.common.subsystems.pose.MockBasePoseSubsystem
+
 
+
setDriveTalons(XCANTalon, XCANTalon) - Method in class xbot.common.subsystems.pose.MockBasePoseSubsystem
+
 
+
setEnableDerivativeThreshold(boolean) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setEnableErrorThreshold(boolean) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setEnableTimeThreshold(boolean) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setEncoderInverted(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setEncoderInverted(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setEncoderInverted(boolean) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setErrorThreshold(double) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setErrorTolerance(double) - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
setF(double) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setFastMode(boolean) - Method in class xbot.common.properties.ConfigurePropertiesCommand
+
 
+
setFastMode(boolean) - Method in interface xbot.common.properties.ITableProxy
+
 
+
setFastMode(boolean) - Method in class xbot.common.properties.PreferenceStorage
+
 
+
setFastMode(boolean) - Method in class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
setFastMode(boolean) - Method in class xbot.common.properties.TableProxy
+
 
+
setFeedbackDevice(MotorFeedbackSensor) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setFF(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setFF(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setFF(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setFF(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setFF(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setFF(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setFieldPoseOffset(FieldPose) - Method in class xbot.common.simulation.WebotsClient
+
+
In the case where the origin of the field doesn't match our traditional convention (with 0,0 + on the bottom-left vertex of the rectangular FRC field if viewed from above with your alliance + driver station at the bottom), then we need to shift X,Y coordinates to get everything to line up.
+
+
setForward() - Method in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
setForward() - Method in class xbot.common.controls.actuators.XRelay
+
 
+
setForward() - Method in class xbot.common.subsystems.simplemotor.SimpleMotorSubsystem
+
 
+
setForwardLimitSwitch(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setForwardLimitSwitch(SparkMaxLimitSwitch.Type, boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setForwardLimitSwitch(SparkMaxLimitSwitch.Type, boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setForwardLimitSwitch(SparkMaxLimitSwitch.Type, boolean) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setHeadingToApply(double) - Method in class xbot.common.subsystems.pose.commands.SetRobotHeadingCommand
+
 
+
setHeadingToApply(Supplier<Double>) - Method in class xbot.common.subsystems.pose.commands.SetRobotHeadingCommand
+
 
+
setI(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setI(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setI(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setI(double) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setI(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setI(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setI(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setIAccum(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setIAccum(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setIAccum(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setIdleMode(CANSparkMax.IdleMode) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setIdleMode(CANSparkMax.IdleMode) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setIdleMode(CANSparkMax.IdleMode) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the idle mode setting for the SPARK MAX.
+
+
setIMask(boolean) - Method in class xbot.common.math.PIDManager
+
 
+
setIMaxAccum(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setIMaxAccum(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setIMaxAccum(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setImplementation(XTimerImpl) - Static method in class xbot.common.controls.sensors.XTimer
+
 
+
setIntegralAccumulator(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setIntegralAccumulator(double, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setIntegralAccumulator(double, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setIntegralAccumulator(double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setIntegralAccumulator(double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setIntegralAccumulator(double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setIntegralAccumulator(double, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
setInverted(boolean) - Method in class edu.wpi.first.wpilibj.MockDigitalInput
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Common interface for inverting direction of a speed controller.
+
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.XRelay
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.XSolenoid
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.actuators.XSpeedController
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.sensors.buttons.AdvancedTrigger
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.sensors.buttons.InvertingBooleanSupplier
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.sensors.XDigitalInput
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.sensors.XDutyCycleEncoder
+
 
+
setInverted(boolean) - Method in class xbot.common.controls.sensors.XEncoder
+
 
+
setInverted(InvertType) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setInverted(InvertType) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setInverted(InvertType) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setInverted(InvertType) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setInverted(InvertType) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setIsBroken(boolean) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setIZone(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setIZone(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setIZone(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setIZone(double) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setIZone(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setIZone(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setIZone(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setLeftInversion(boolean, boolean) - Method in interface xbot.common.controls.sensors.IGamepad
+
 
+
setLeftInversion(boolean, boolean) - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
setLeftInversion(boolean, boolean) - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
setLeftStick(double, double) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
setLeftStick(XYPair) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
setLeftStick(XYPair) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
setLeftTrigger(double) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
setLowerBound(double) - Method in class xbot.common.math.ContiguousDouble
+
 
+
setMagnetOffset(double) - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
+
Sets the magnet offset configured on the encoder device.
+
+
setMaintainerIsAtGoal(boolean) - Method in class xbot.common.command.BaseSetpointSubsystem
+
 
+
setMaxOutput(double) - Method in class xbot.common.math.PIDManager
+
 
+
setMeasurementPeriod(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setMeasurementPeriod(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setMeasurementPeriod(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setMinOutput(double) - Method in class xbot.common.math.PIDManager
+
 
+
setMode(HeadingAssistModule.HeadingAssistMode) - Method in class xbot.common.subsystems.drive.control_logic.HeadingAssistModule
+
 
+
setMode(PurePursuitCommand.PointLoadingMode) - Method in class xbot.common.subsystems.drive.ConfigurablePurePursuitCommand
+
 
+
setModulus(int) - Method in class xbot.common.logging.IntermittentConsoleLogger
+
 
+
setNeutralMode(NeutralMode) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setNeutralMode(NeutralMode) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setNeutralMode(NeutralMode) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setNeutralMode(NeutralMode) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setNeutralMode(NeutralMode) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setNeutralMode(NeutralMode) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
setNewPacketHandler(Consumer<String>) - Method in class xbot.common.networking.MockZeromqListener
+
 
+
setNewPacketHandler(Consumer<String>) - Method in interface xbot.common.networking.XZeromqListener
+
 
+
setNewPacketHandler(Consumer<String>) - Method in class xbot.common.networking.ZeromqListener
+
 
+
setOff() - Method in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
setOn(boolean) - Method in class xbot.common.controls.actuators.XSolenoid
+
 
+
setOpenLoopRampRate(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setOpenLoopRampRate(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setOpenLoopRampRate(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the ramp rate for open loop control modes.
+
+
setOutputCurrent(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setOutputRange(double, double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setOutputRange(double, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setOutputRange(double, double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setOutputRange(double, double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setOutputRange(double, double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setOutputRange(double, double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setP(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setP(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setP(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setP(double) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setP(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setP(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setP(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setPeriodicFramePeriod(CANSparkMaxLowLevel.PeriodicFrame, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setPIDs(HeadingModule, PIDManager) - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
+
By default, the PurePursuitCommand uses the HeadingModule and PositionalPid from the DriveSubsystem.
+
+
setPIDsToDefault() - Method in class xbot.common.subsystems.drive.PurePursuitCommand
+
 
+
setPitch(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setPoints() - Method in class xbot.common.math.PurePursuitTest
+
 
+
setPoints(List<RabbitPoint>) - Method in class xbot.common.subsystems.drive.ConfigurablePurePursuitCommand
+
 
+
setPointSupplier(Supplier<List<RabbitPoint>>) - Method in class xbot.common.subsystems.drive.ConfigurablePurePursuitCommand
+
 
+
setPosition(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setPosition(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setPosition(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setPosition(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setPosition(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder
+
 
+
setPosition(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
setPosition(double) - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
setPosition(double) - Method in class xbot.common.controls.sensors.XAbsoluteEncoder
+
 
+
setPositionConversionFactor(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setPositionConversionFactor(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setPositionConversionFactor(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setPower(double) - Method in class xbot.common.controls.actuators.XSpeedController
+
 
+
setPower(double) - Method in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
+
Sets the output power of the system directly - no PID of any kind
+
+
setPower(double) - Method in class xbot.common.subsystems.simplemotor.SimpleMotorSubsystem
+
+
Sets the motor output power.
+
+
setPower(T) - Method in class xbot.common.command.BaseSetpointSubsystem
+
 
+
setPrefix(String) - Method in class xbot.common.properties.PropertyFactory
+
 
+
setPrefix(IPropertySupport) - Method in class xbot.common.properties.PropertyFactory
+
 
+
setPulseWidthRiseToFallUs(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setPWMRate(double) - Method in class edu.wpi.first.wpilibj.MockDigitalOutput
+
 
+
setPWMRate(double) - Method in class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter
+
 
+
setPWMRate(double) - Method in class xbot.common.controls.actuators.XDigitalOutput
+
+
Set the PWM frequency of ALL DIGITAL OUTPUT PWM CHANNELS
+
+
setQuickTurn(boolean) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
 
+
setRate(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setRate(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockEncoder
+
 
+
setRaw(int) - Method in class edu.wpi.first.wpilibj.MockPWM
+
 
+
setRaw(int) - Method in class xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter
+
 
+
setRaw(int) - Method in class xbot.common.controls.actuators.XPWM
+
+
Sets the PWM duty cycle
+
+
setRawAxis(int, double) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
setRawAxis(int, double) - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
setRawLeftStick(XYPair) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
+
Needed for a few scenarios where we want to emulate the underlying joystick + behavior + and not the intent after inversion.
+
+
setRawPosition(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockDutyCycleEncoder
+
 
+
setRawRightStick(XYPair) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
+
Needed for a few scenarios where we want to emulate the underlying joystick + behavior + and not the intent after inversion.
+
+
setReference(double, CANSparkMax.ControlType) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setReference(double, CANSparkMax.ControlType) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setReference(double, CANSparkMax.ControlType) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setReference(double, CANSparkMax.ControlType, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setReference(double, CANSparkMax.ControlType, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setReference(double, CANSparkMax.ControlType, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setReference(double, CANSparkMax.ControlType, int, double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setReference(double, CANSparkMax.ControlType, int, double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setReference(double, CANSparkMax.ControlType, int, double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setReference(double, CANSparkMax.ControlType, int, double, SparkMaxPIDController.ArbFFUnits) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setReference(double, CANSparkMax.ControlType, int, double, SparkMaxPIDController.ArbFFUnits) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setReference(double, CANSparkMax.ControlType, int, double, SparkMaxPIDController.ArbFFUnits) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setReverse() - Method in class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
setReverse() - Method in class xbot.common.controls.actuators.XRelay
+
 
+
setReverse() - Method in class xbot.common.subsystems.simplemotor.SimpleMotorSubsystem
+
 
+
setReverseLimitSwitch(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setReverseLimitSwitch(SparkMaxLimitSwitch.Type, boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setReverseLimitSwitch(SparkMaxLimitSwitch.Type, boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setReverseLimitSwitch(SparkMaxLimitSwitch.Type, boolean) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setRightInversion(boolean, boolean) - Method in interface xbot.common.controls.sensors.IGamepad
+
 
+
setRightInversion(boolean, boolean) - Method in class xbot.common.controls.sensors.XFTCGamepad
+
 
+
setRightInversion(boolean, boolean) - Method in class xbot.common.controls.sensors.XXboxController
+
 
+
setRightStick(double, double) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
setRightStick(XYPair) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
setRightStick(XYPair) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
setRightTrigger(double) - Method in class edu.wpi.first.wpilibj.MockXboxControllerAdapter
+
 
+
SetRobotHeadingCommand - Class in xbot.common.subsystems.pose.commands
+
 
+
SetRobotHeadingCommand(BasePoseSubsystem) - Constructor for class xbot.common.subsystems.pose.commands.SetRobotHeadingCommand
+
 
+
setRoll(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setRunsWhenDisabled(boolean) - Method in class xbot.common.command.BaseCommand
+
 
+
setSamplesToAverage(int) - Method in class xbot.common.controls.sensors.mock_adapters.MockEncoder
+
 
+
setSamplesToAverage(int) - Method in class xbot.common.controls.sensors.wpi_adapters.EncoderWPIAdapter
+
 
+
setSamplesToAverage(int) - Method in class xbot.common.controls.sensors.XEncoder
+
 
+
setSecondaryCurrentLimit(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSecondaryCurrentLimit(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSecondaryCurrentLimit(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the secondary current limit in Amps.
+
+
setSecondaryCurrentLimit(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSecondaryCurrentLimit(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSecondaryCurrentLimit(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the secondary current limit in Amps.
+
+
setSelectedSensorPosition(double, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setSelectedSensorPosition(double, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setSelectedSensorPosition(double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setSelectedSensorPosition(double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setSelectedSensorPosition(double, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setSelectedSensorPosition(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setSelectedSensorPosition(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setSelectedSensorPosition(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setSelectedSensorPosition(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setSelectedSensorPosition(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setSelectedSensorPosition(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setSelectedSensorPosition(int, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
setSensorPhase(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setSensorPhase(boolean) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setSensorPhase(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setSensorPhase(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setSensorPhase(boolean) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setSensorPhase(boolean) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
setShouldCheckTolerances(boolean, boolean, boolean) - Method in class xbot.common.math.PID
+
+
Controls whether or not the tolerances are checked as part of isOnTarget().
+
+
setSigned(double) - Method in class edu.wpi.first.wpilibj.MockPWM
+
 
+
setSigned(double) - Method in class xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter
+
 
+
setSigned(double) - Method in class xbot.common.controls.actuators.XPWM
+
+
Sets the PWM duty cycle
+
+
setSmartCurrentLimit(int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSmartCurrentLimit(int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSmartCurrentLimit(int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the current limit in Amps.
+
+
setSmartCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSmartCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSmartCurrentLimit(int, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the current limit in Amps.
+
+
setSmartCurrentLimit(int, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSmartCurrentLimit(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSmartCurrentLimit(int, int, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the current limit in Amps.
+
+
setSmartMotionAccelStrategy(SparkMaxPIDController.AccelStrategy, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSmartMotionAllowedClosedLoopError(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSmartMotionAllowedClosedLoopError(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSmartMotionAllowedClosedLoopError(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setSmartMotionMaxAccel(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSmartMotionMaxAccel(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSmartMotionMaxAccel(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setSmartMotionMaxVelocity(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSmartMotionMaxVelocity(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSmartMotionMaxVelocity(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setSmartMotionMinOutputVelocity(double, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSmartMotionMinOutputVelocity(double, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSmartMotionMinOutputVelocity(double, int) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setSoftLimit(CANSparkMax.SoftLimitDirection, float) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setSoftLimit(CANSparkMax.SoftLimitDirection, float) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setSoftLimit(CANSparkMax.SoftLimitDirection, float) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Set the soft limit based on position.
+
+
setStable() - Method in class xbot.common.logic.TimeStableValidator
+
+
Used if you want the validator to start in a stable state
+
+
setStableWindow(double) - Method in class xbot.common.logic.TimeStableValidator
+
 
+
setStableWindowProvider(Supplier<Double>) - Method in class xbot.common.logic.TimeStableValidator
+
 
+
setStatusFramePeriod(int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setStatusFramePeriod(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setStatusFramePeriod(int, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setStatusFramePeriod(StatusFrameEnhanced, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setStatusFramePeriod(StatusFrameEnhanced, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setStatusFramePeriod(StatusFrameEnhanced, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setStatusFramePeriod(StatusFrameEnhanced, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setStatusFramePeriod(StatusFrameEnhanced, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setStatusFramePeriod(StatusFrameEnhanced, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
setStatusFramePeriod(StatusFrame, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setStatusFramePeriod(StatusFrame, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
setStatusFramePeriod(StatusFrame, int, int) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
setStatusFramePeriod(StatusFrame, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
setStatusFramePeriod(StatusFrame, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
setStatusFramePeriod(StatusFrame, int, int) - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
setStatusFramePeriod(StatusFrame, int, int) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
setStatusFramePeriod(CANCoderStatusFrame, int) - Method in class xbot.common.controls.sensors.mock_adapters.MockCANCoder
+
 
+
setStatusFramePeriod(CANCoderStatusFrame, int) - Method in class xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter
+
 
+
setStatusFramePeriod(CANCoderStatusFrame, int) - Method in class xbot.common.controls.sensors.XCANCoder
+
 
+
setString(String, String) - Method in class xbot.common.properties.DatabaseStorageBase
+
 
+
setString(String, String) - Method in interface xbot.common.properties.ITableProxy
+
 
+
setString(String, String) - Method in class xbot.common.properties.PreferenceStorage
+
 
+
setString(String, String) - Method in class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
setString(String, String) - Method in class xbot.common.properties.TableProxy
+
 
+
SettableBooleanSuppler - Class in xbot.common.controls.sensors.buttons
+
 
+
SettableBooleanSuppler(boolean) - Constructor for class xbot.common.controls.sensors.buttons.SettableBooleanSuppler
+
 
+
settableTimerImplementation() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
setTargetPose(FieldPose) - Method in class xbot.common.simulation.ResetSimulatorPositionCommand
+
 
+
setTargetSpeed(double) - Method in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
+
Gives the system a new speed goal.
+
+
setTargetValue(T) - Method in class xbot.common.command.BaseSetpointSubsystem
+
 
+
setTestDistance(int) - Method in class edu.wpi.first.wpilibj.MockLidarLite
+
 
+
setThrottleLimits(double, double) - Method in class xbot.common.logic.VelocityThrottleModule
+
 
+
setTimeInSeconds(double) - Method in class edu.wpi.first.wpilibj.MockTimer
+
 
+
setTimeInSeconds(double) - Method in class xbot.common.controls.sensors.wpi_adapters.TimerWpiAdapter
+
 
+
setTimeInSeconds(double) - Method in interface xbot.common.controls.sensors.XSettableTimerImpl
+
+
Set the current time
+
+
setTimeThreshold(double) - Method in class xbot.common.math.PIDPropertyManager
+
 
+
setTolerances(double, double, double) - Method in class xbot.common.math.PID
+
+
Set tolerances for the PID system.
+
+
setTopLevelPrefix() - Method in class xbot.common.properties.PropertyFactory
+
 
+
setUnsigned(double) - Method in class edu.wpi.first.wpilibj.MockPWM
+
 
+
setUnsigned(double) - Method in class xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter
+
 
+
setUnsigned(double) - Method in class xbot.common.controls.actuators.XPWM
+
+
Sets the PWM duty cycle
+
+
setUp() - Method in class xbot.common.injection.BaseWPITest
+
 
+
setUp() - Method in class xbot.common.simulation.BaseSimulationTest
+
 
+
setupInjectionModule() - Method in class xbot.common.command.BaseRobot
+
+
Override if you need a different module
+
+
setUpperBound(double) - Method in class xbot.common.math.ContiguousDouble
+
 
+
setValue(boolean) - Method in class edu.wpi.first.wpilibj.MockDigitalInput
+
 
+
setValue(boolean) - Method in class xbot.common.logic.Latch
+
 
+
setValue(double) - Method in class xbot.common.math.ContiguousDouble
+
 
+
setVelocity(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setVelocityConversionFactor(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setVelocityConversionFactor(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setVelocityConversionFactor(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
setVoltage(double) - Method in class edu.wpi.first.wpilibj.MockAnalogInput
+
 
+
setVoltage(double) - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
setVoltage(double) - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
setVoltage(double) - Method in class xbot.common.controls.actuators.XCANSparkMax
+
+
Sets the voltage output of the SpeedController.
+
+
setVoltageOffset(double) - Method in class xbot.common.controls.sensors.AnalogDistanceSensor
+
 
+
setVoltageOffset(double) - Method in class xbot.common.controls.sensors.SimulatedAnalogDistanceSensor
+
 
+
setVoltageOffset(double) - Method in class xbot.common.controls.sensors.XAnalogDistanceSensor
+
 
+
setX(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
setX(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
setY(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockFTCGamepad
+
 
+
setY(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockJoystick
+
 
+
setYaw(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
setYawAngularVelocity(double) - Method in class xbot.common.controls.sensors.mock_adapters.MockGyro
+
 
+
sharedPeriodic() - Method in class xbot.common.command.BaseRobot
+
 
+
sharp0A51SK(double) - Static method in class xbot.common.controls.sensors.XAnalogDistanceSensor.VoltageMaps
+
 
+
shiftBounds(double) - Method in class xbot.common.math.ContiguousDouble
+
+
Shifts both bounds by the specified amount
+
+
shiftValue(double) - Method in class xbot.common.math.ContiguousDouble
+
+
Shifts value by the specified amount (addition)
+
+
SilentRobotAssertionManager - Class in xbot.common.logging
+
+
Version of RobotAssertionManager that prevents throwing of exceptions.
+
+
SilentRobotAssertionManager() - Constructor for class xbot.common.logging.SilentRobotAssertionManager
+
 
+
SimpleMotorSubsystem - Class in xbot.common.subsystems.simplemotor
+
+
Generic subsystem that handles a single motor which can be drivven in forward and reverse.
+
+
SimpleMotorSubsystem(String, PropertyFactory) - Constructor for class xbot.common.subsystems.simplemotor.SimpleMotorSubsystem
+
+
Create an instance with default power settings.
+
+
SimpleMotorSubsystem(String, PropertyFactory, double, double) - Constructor for class xbot.common.subsystems.simplemotor.SimpleMotorSubsystem
+
+
Create an instance with the specified default forward and reverse power.
+
+
simpleSet(double) - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
SimpleWaitForMaintainerCommand - Class in xbot.common.command
+
 
+
SimpleWaitForMaintainerCommand(BaseSetpointSubsystem, Supplier<Double>) - Constructor for class xbot.common.command.SimpleWaitForMaintainerCommand
+
 
+
SimulatedAnalogDistanceSensor - Class in xbot.common.controls.sensors
+
 
+
SimulatedAnalogDistanceSensor(int, DoubleFunction<Double>, String, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.sensors.SimulatedAnalogDistanceSensor
+
 
+
SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory - Class in xbot.common.controls.sensors
+
 
+
SimulatedAnalogDistanceSensorFactory() - Constructor for class xbot.common.controls.sensors.SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory
+
 
+
SimulatedPurePursuitCommand - Class in xbot.common.subsystems.drive
+
 
+
SimulatedPurePursuitCommand(HeadingModule.HeadingModuleFactory, BasePoseSubsystem, BaseDriveSubsystem, PropertyFactory, WebotsClient) - Constructor for class xbot.common.subsystems.drive.SimulatedPurePursuitCommand
+
 
+
SimulationComponent - Class in xbot.common.injection.components
+
+
Do not use this directly.
+
+
SimulationComponent() - Constructor for class xbot.common.injection.components.SimulationComponent
+
 
+
simulationInit() - Method in class xbot.common.command.BaseRobot
+
 
+
SimulationModule - Class in xbot.common.injection.modules
+
+
Module mapping interfaces to implementations for a simulated robot.
+
+
SimulationModule() - Constructor for class xbot.common.injection.modules.SimulationModule
+
 
+
simulationPayloadDistributor - Variable in class xbot.common.command.BaseRobot
+
 
+
simulationPayloadDistributor() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
SimulationPayloadDistributor - Class in xbot.common.simulation
+
 
+
SimulationPayloadDistributor(DevicePolice, XSettableTimerImpl) - Constructor for class xbot.common.simulation.SimulationPayloadDistributor
+
 
+
simulationPeriodic() - Method in class xbot.common.command.BaseRobot
+
 
+
simulationScalingValue - Variable in class xbot.common.injection.electrical_contract.CANTalonInfo
+
 
+
simulationScalingValue - Variable in class xbot.common.injection.electrical_contract.DeviceInfo
+
 
+
smartDashboardCommandPutter() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
SmartDashboardCommandPutter - Interface in xbot.common.command
+
 
+
SmartDashboardTableWrapper - Class in xbot.common.properties
+
 
+
SmartDashboardTableWrapper() - Constructor for class xbot.common.properties.SmartDashboardTableWrapper
+
 
+
Solenoid - xbot.common.injection.DevicePolice.DeviceType
+
 
+
SOLENOID_POWER_MODE - Static variable in interface xbot.common.simulation.ISimulatableSolenoid
+
 
+
solenoidFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
SolenoidWPIAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
SolenoidWPIAdapter(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.wpi_adapters.SolenoidWPIAdapter
+
 
+
SolenoidWPIAdapter.SolenoidWPIAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
SolenoidWPIAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.SolenoidWPIAdapter.SolenoidWPIAdapterFactory
+
 
+
speedControllerFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
SpeedControllerWPIAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
SpeedControllerWPIAdapter(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.wpi_adapters.SpeedControllerWPIAdapter
+
 
+
SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
SpeedControllerWPIAdapterFactory() - Constructor for class xbot.common.controls.actuators.wpi_adapters.SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory
+
 
+
speedSlider - Variable in class xbot.common.math.PlanarTestVisualizer
+
 
+
SPI - xbot.common.injection.DevicePolice.DeviceType
+
 
+
squareAndRetainSign(double) - Static method in class xbot.common.math.MathUtils
+
 
+
StallDetector - Class in xbot.common.logic
+
 
+
StallDetector(PropertyFactory, String) - Constructor for class xbot.common.logic.StallDetector
+
 
+
StallDetector.StallDetectorFactory - Class in xbot.common.logic
+
 
+
StallDetector.StallState - Enum in xbot.common.logic
+
 
+
stallDetectorFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
StallDetectorFactory() - Constructor for class xbot.common.logic.StallDetector.StallDetectorFactory
+
 
+
STALLED - xbot.common.logic.StallDetector.StallState
+
 
+
Standard - xbot.common.controls.sensors.XJoystick.ButtonSource
+
 
+
start() - Method in class xbot.common.controls.sensors.XLidarLite
+
 
+
start() - Method in class xbot.common.logging.TimeLogger
+
 
+
start() - Method in class xbot.common.networking.MockZeromqListener
+
 
+
start() - Method in interface xbot.common.networking.XZeromqListener
+
 
+
start() - Method in class xbot.common.networking.ZeromqListener
+
 
+
Start - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
startAsyncTimer() - Method in class xbot.common.math.PurePursuitTest
+
 
+
startMotionProfile(BufferedTrajectoryPointStream, int, ControlMode) - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
startTime - Variable in class xbot.common.command.DelayViaSupplierCommand
+
 
+
step(double, double) - Method in class xbot.common.math.PlanarEngine
+
 
+
stop() - Method in class xbot.common.controls.actuators.XRelay
+
 
+
stop() - Method in class xbot.common.controls.sensors.XLidarLite
+
 
+
stop() - Method in class xbot.common.logging.TimeLogger
+
 
+
stop() - Method in class xbot.common.networking.ZeromqListener
+
 
+
stop() - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
 
+
stop() - Method in class xbot.common.subsystems.simplemotor.SimpleMotorSubsystem
+
 
+
Stop - xbot.common.subsystems.drive.RabbitPoint.PointTerminatingType
+
 
+
stopGamepadRumble() - Method in class xbot.common.subsystems.feedback.RumbleManager
+
 
+
stopGamepadRumble() - Method in interface xbot.common.subsystems.feedback.XRumbleManager
+
+
Immediately stops rumbling on the gamepad.
+
+
stopMotor() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANSparkMax
+
 
+
stopMotor() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
stopMotor() - Method in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
stopMotor() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
stopTestEnv() - Method in class xbot.common.math.PurePursuitTest
+
 
+
StringProperty - Class in xbot.common.properties
+
+
A type of Property that manages a String value.
+
+
StringProperty(String, String, Property.PropertyPersistenceType, XPropertyManager) - Constructor for class xbot.common.properties.StringProperty
+
 
+
StringProperty(String, String, Property.PropertyPersistenceType, XPropertyManager, Property.PropertyLevel) - Constructor for class xbot.common.properties.StringProperty
+
 
+
StringProperty(String, String, XPropertyManager) - Constructor for class xbot.common.properties.StringProperty
+
 
+
subsystemReportsReadyProp - Variable in class xbot.common.command.BaseMaintainerCommand
+
 
+
supplier - Variable in class xbot.common.controls.sensors.buttons.AdvancedTrigger
+
 
+
SupportsSetpointLock - Interface in xbot.common.command
+
 
+
systemCurrentSpeed - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
systemOutputPower - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
systemTalonError - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
systemTargetSpeed - Variable in class xbot.common.subsystems.BaseXCANTalonSpeedControlledSubsystem
+
 
+
+ + + +

T

+
+
table - Variable in class xbot.common.properties.TableProxy
+
 
+
tableProxy() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
TableProxy - Class in xbot.common.properties
+
+
A simple implementation of ITableProxy.
+
+
TableProxy() - Constructor for class xbot.common.properties.TableProxy
+
 
+
TalonCurrentMonitor - Class in xbot.common.controls.sensors
+
 
+
TalonCurrentMonitor(XCANTalon) - Constructor for class xbot.common.controls.sensors.TalonCurrentMonitor
+
 
+
tankDrive(double, double) - Method in class xbot.common.subsystems.drive.BaseDriveSubsystem
+
+
Classic tank drive.
+
+
target - Variable in class xbot.common.subsystems.drive.PurePursuitCommand.RabbitChaseInfo
+
 
+
Tau - Static variable in class xbot.common.math.MathUtils
+
 
+
teleopInit() - Method in class xbot.common.command.BaseRobot
+
 
+
teleopInit() - Method in class xbot.common.logging.RobotSession
+
 
+
teleopPeriodic() - Method in class xbot.common.command.BaseRobot
+
+
This function is called periodically during operator control
+
+
terminatingType - Variable in class xbot.common.subsystems.drive.RabbitPoint
+
 
+
testPeriodic() - Method in class xbot.common.command.BaseRobot
+
+
This function is called periodically during test mode
+
+
throwException(RuntimeException) - Method in class xbot.common.logging.RobotAssertionManager
+
 
+
throwException(String, Throwable) - Method in class xbot.common.logging.RobotAssertionManager
+
 
+
TimeLogger - Class in xbot.common.logging
+
 
+
TimeLogger(String, int) - Constructor for class xbot.common.logging.TimeLogger
+
 
+
timer - Variable in class xbot.common.injection.BaseWPITest
+
 
+
timer - Variable in class xbot.common.simulation.BaseSimulationTest
+
 
+
timerImplementation() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
TimerWpiAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
TimerWpiAdapter() - Constructor for class xbot.common.controls.sensors.wpi_adapters.TimerWpiAdapter
+
 
+
timeStableValidator - Variable in class xbot.common.command.BaseMaintainerCommand
+
 
+
TimeStableValidator - Class in xbot.common.logic
+
 
+
TimeStableValidator(double) - Constructor for class xbot.common.logic.TimeStableValidator
+
 
+
TimeStableValidator(Supplier<Double>) - Constructor for class xbot.common.logic.TimeStableValidator
+
 
+
toggle() - Method in class xbot.common.controls.sensors.buttons.SettableBooleanSuppler
+
 
+
toggle() - Method in class xbot.common.controls.sensors.buttons.VirtualTrigger
+
 
+
toString() - Method in class xbot.common.controls.actuators.wpi_adapters.CANSparkMaxWpiAdapter
+
 
+
toString() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
toString() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
toString() - Method in class xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDDescription
+
 
+
toString() - Method in class xbot.common.math.ContiguousDouble
+
 
+
toString() - Method in class xbot.common.math.FieldPose
+
 
+
toString() - Method in class xbot.common.math.XYPair
+
 
+
totalDistanceX - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
totalDistanceY - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
totalDistanceYRobotPerspective - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
totalVelocity - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
toTranslation2d() - Method in class xbot.common.math.XYPair
+
 
+
translatePower - Variable in class xbot.common.math.PurePursuitTest.PursuitEnvironmentState
+
 
+
translation - Variable in class xbot.common.subsystems.drive.PurePursuitCommand.RabbitChaseInfo
+
 
+
transverseTotalDistance - Variable in class xbot.common.subsystems.drive.MockDriveSubsystem
+
 
+
triggeredCommands - Variable in class xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger
+
 
+
turnPower - Variable in class xbot.common.math.PurePursuitTest.PursuitEnvironmentState
+
 
+
+ + + +

U

+
+
uncalibratedMachineControlAction() - Method in class xbot.common.command.BaseMaintainerCommand
+
 
+
Unhealthy - xbot.common.resiliency.DeviceHealth
+
 
+
UnitTestModule - Class in xbot.common.injection.modules
+
+
Module mapping interfaces to implementations for unit tests.
+
+
UnitTestModule() - Constructor for class xbot.common.injection.modules.UnitTestModule
+
 
+
UnitTestRobotModule - Class in xbot.common.injection.modules
+
 
+
UnitTestRobotModule() - Constructor for class xbot.common.injection.modules.UnitTestRobotModule
+
 
+
Unknown - xbot.common.math.PID.OffTargetReason
+
 
+
unwrapAbove() - Method in class xbot.common.math.ContiguousDouble
+
+
Calculates a number representing the current value that is higher than + (or equal to) the upper bound.
+
+
unwrapBelow() - Method in class xbot.common.math.ContiguousDouble
+
+
Calculates a number representing the current value that is lower than (or + equal to) the lower bound.
+
+
update() - Method in class edu.wpi.first.wpilibj.MockDistanceSensorPair
+
 
+
update() - Method in class edu.wpi.first.wpilibj.MockLidarLite
+
 
+
update() - Method in interface xbot.common.controls.sensors.DistanceSensorPair
+
 
+
update() - Method in class xbot.common.controls.sensors.MultiplexedLidarPair
+
 
+
update() - Method in class xbot.common.controls.sensors.wpi_adapters.LidarLiteWpiAdapter
+
 
+
update() - Method in class xbot.common.controls.sensors.XLidarLite
+
 
+
updateCurrent() - Method in class xbot.common.controls.sensors.TalonCurrentMonitor
+
 
+
updateCurrentHeading() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
updateDutyCycle(double) - Method in class edu.wpi.first.wpilibj.MockDigitalOutput
+
 
+
updateDutyCycle(double) - Method in class xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter
+
 
+
updateDutyCycle(double) - Method in class xbot.common.controls.actuators.XDigitalOutput
+
 
+
updateLoggingContext() - Method in class xbot.common.command.BaseRobot
+
 
+
updateOdometry() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
updatePose() - Method in class xbot.common.subsystems.pose.BasePoseSubsystem
+
+
This should be called as often as reasonably possible, to increase accuracy + of the "distance traveled" calculation.
+
+
updateTelemetryProperties() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
updateViz(PurePursuitTest.PursuitEnvironmentState) - Method in class xbot.common.math.PlanarVisualizationPanel
+
 
+
upgradeFieldPoseList(List<FieldPose>) - Static method in class xbot.common.subsystems.drive.RabbitPoint
+
 
+
USB - xbot.common.injection.DevicePolice.DeviceType
+
 
+
usesPropertySystem - Variable in class xbot.common.controls.actuators.XCANSparkMax
+
 
+
+ + + +

V

+
+
value - Variable in class edu.wpi.first.wpilibj.MockDigitalInput
+
 
+
value - Variable in class edu.wpi.first.wpilibj.MockDigitalOutput
+
 
+
value - Variable in class edu.wpi.first.wpilibj.MockPWM
+
 
+
value - Variable in class edu.wpi.first.wpilibj.MockServo
+
 
+
value - Variable in class edu.wpi.first.wpilibj.MockSpeedController
+
 
+
valueOf(String) - Static method in enum xbot.common.controls.actuators.XDoubleSolenoid.DoubleSolenoidMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger.ButtonTriggerType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.controls.sensors.XGyro.ImuType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.controls.sensors.XJoystick.ButtonSource
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.controls.sensors.XXboxController.XboxButton
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.injection.DevicePolice.DeviceType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.logic.CalibrationDecider.CalibrationMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.logic.HumanVsMachineDecider.HumanVsMachineMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.logic.Latch.EdgeType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.logic.StallDetector.StallState
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.math.PID.OffTargetReason
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.properties.Property.PropertyLevel
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.properties.Property.PropertyPersistenceType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.resiliency.DeviceHealth
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.subsystems.drive.control_logic.HeadingAssistModule.HeadingAssistMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.subsystems.drive.PurePursuitCommand.PointLoadingMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.subsystems.drive.RabbitPoint.PointDriveStyle
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.subsystems.drive.RabbitPoint.PointTerminatingType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum xbot.common.subsystems.drive.RabbitPoint.PointType
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum xbot.common.controls.actuators.XDoubleSolenoid.DoubleSolenoidMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger.ButtonTriggerType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.controls.sensors.XGyro.ImuType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.controls.sensors.XJoystick.ButtonSource
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.controls.sensors.XXboxController.XboxButton
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.injection.DevicePolice.DeviceType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.logic.CalibrationDecider.CalibrationMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.logic.HumanVsMachineDecider.HumanVsMachineMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.logic.Latch.EdgeType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.logic.StallDetector.StallState
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.math.PID.OffTargetReason
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.properties.Property.PropertyLevel
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.properties.Property.PropertyPersistenceType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.resiliency.DeviceHealth
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.subsystems.drive.control_logic.HeadingAssistModule.HeadingAssistMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.subsystems.drive.PurePursuitCommand.PointLoadingMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.subsystems.drive.RabbitPoint.PointDriveStyle
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.subsystems.drive.RabbitPoint.PointTerminatingType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum xbot.common.subsystems.drive.RabbitPoint.PointType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
valueUpdated() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANTalon
+
 
+
valueUpdated() - Method in class xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX
+
 
+
valueUpdated() - Method in class xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter
+
 
+
valueUpdated() - Method in class xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter
+
 
+
valueUpdated() - Method in class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
valueUpdated() - Method in class xbot.common.controls.actuators.XCANTalon
+
 
+
VelocityThrottleModule - Class in xbot.common.logic
+
 
+
VelocityThrottleModule(String, PIDManager, PropertyFactory) - Constructor for class xbot.common.logic.VelocityThrottleModule
+
 
+
VelocityThrottleModule.VelocityThrottleModuleFactory - Class in xbot.common.logic
+
 
+
velocityThrottleModuleFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
VelocityThrottleModuleFactory() - Constructor for class xbot.common.logic.VelocityThrottleModule.VelocityThrottleModuleFactory
+
 
+
velocityX - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
velocityY - Variable in class xbot.common.subsystems.pose.BasePoseSubsystem
+
 
+
VictorAppearingAsTalonWPIAdapter - Class in xbot.common.controls.actuators.wpi_adapters
+
 
+
VictorAppearingAsTalonWPIAdapter(int, RobotAssertionManager, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.actuators.wpi_adapters.VictorAppearingAsTalonWPIAdapter
+
 
+
virtualButtonFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
VirtualTrigger - Class in xbot.common.controls.sensors.buttons
+
+
A virtual button under program control that can be used for creating chords.
+
+
VirtualTrigger(boolean) - Constructor for class xbot.common.controls.sensors.buttons.VirtualTrigger
+
 
+
VirtualTrigger(SettableBooleanSuppler) - Constructor for class xbot.common.controls.sensors.buttons.VirtualTrigger
+
 
+
VirtualTrigger.VirtualTriggerFactory - Class in xbot.common.controls.sensors.buttons
+
 
+
VirtualTriggerFactory() - Constructor for class xbot.common.controls.sensors.buttons.VirtualTrigger.VirtualTriggerFactory
+
 
+
vizPanel - Variable in class xbot.common.math.PlanarTestVisualizer
+
 
+
vizRun() - Method in class xbot.common.math.PurePursuitTest
+
 
+
VoltageMaps() - Constructor for class xbot.common.controls.sensors.XAnalogDistanceSensor.VoltageMaps
+
 
+
+ + + +

W

+
+
WAS_STALLED_RECENTLY - xbot.common.logic.StallDetector.StallState
+
 
+
wasStalledRecently() - Method in class xbot.common.logic.StallDetector
+
 
+
WatchdogTimer - Class in xbot.common.logic
+
 
+
WatchdogTimer(double, Runnable, Runnable) - Constructor for class xbot.common.logic.WatchdogTimer
+
 
+
WatchdogTimer(double, Runnable, Runnable, String, PropertyFactory) - Constructor for class xbot.common.logic.WatchdogTimer
+
 
+
WatchdogTimer(double, String, PropertyFactory) - Constructor for class xbot.common.logic.WatchdogTimer
+
 
+
webots - Variable in class xbot.common.command.BaseRobot
+
 
+
webotsClient() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
WebotsClient - Class in xbot.common.simulation
+
 
+
WebotsClient(PropertyFactory) - Constructor for class xbot.common.simulation.WebotsClient
+
 
+
WhenPressed - xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger.ButtonTriggerType
+
 
+
WhenReleased - xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger.ButtonTriggerType
+
 
+
WhileHeld - xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger.ButtonTriggerType
+
 
+
whileTrue(Command) - Method in class xbot.common.controls.sensors.buttons.AdvancedXboxButtonTrigger
+
 
+
WordGenerator - Class in xbot.common.logging
+
 
+
WordGenerator() - Constructor for class xbot.common.logging.WordGenerator
+
 
+
WrappedRotation2d - Class in xbot.common.math
+
+
A rotation in a 2d coordinate frame, with its rotation wrapped from -pi to pi radians (-180 to 180 degrees).
+
+
WrappedRotation2d(double) - Constructor for class xbot.common.math.WrappedRotation2d
+
+
Constructs a WrappedRotation2d with the given radian value.
+
+
WrappedRotation2d(double, double) - Constructor for class xbot.common.math.WrappedRotation2d
+
+
Constructs a WrappedRotation2d with the given x and y (cosine and sine) components.
+
+
writeToFile(String) - Method in class xbot.common.injection.MockPermanentStorage
+
 
+
+ + + +

X

+
+
x - Variable in class xbot.common.math.XYPair
+
 
+
X - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
XAbsoluteEncoder - Class in xbot.common.controls.sensors
+
 
+
XAbsoluteEncoder() - Constructor for class xbot.common.controls.sensors.XAbsoluteEncoder
+
 
+
XAbsoluteEncoder.XAbsoluteEncoderFactory - Interface in xbot.common.controls.sensors
+
 
+
XAnalogDistanceSensor - Class in xbot.common.controls.sensors
+
 
+
XAnalogDistanceSensor(int, DoubleFunction<Double>) - Constructor for class xbot.common.controls.sensors.XAnalogDistanceSensor
+
 
+
XAnalogDistanceSensor.VoltageMaps - Class in xbot.common.controls.sensors
+
 
+
XAnalogDistanceSensor.XAnalogDistanceSensorFactory - Interface in xbot.common.controls.sensors
+
 
+
XAnalogInput - Class in xbot.common.controls.sensors
+
 
+
XAnalogInput(int, DevicePolice) - Constructor for class xbot.common.controls.sensors.XAnalogInput
+
 
+
XAnalogInput.XAnalogInputFactory - Interface in xbot.common.controls.sensors
+
 
+
XAS5600 - Class in xbot.common.controls.sensors
+
 
+
XAS5600(XCANTalon) - Constructor for class xbot.common.controls.sensors.XAS5600
+
 
+
XAS5600.XAS5600Factory - Class in xbot.common.controls.sensors
+
 
+
XAS5600Factory() - Constructor for class xbot.common.controls.sensors.XAS5600.XAS5600Factory
+
 
+
XBaseIO - Interface in xbot.common.controls
+
 
+
xbot.common.command - package xbot.common.command
+
 
+
xbot.common.controls - package xbot.common.controls
+
 
+
xbot.common.controls.actuators - package xbot.common.controls.actuators
+
 
+
xbot.common.controls.actuators.mock_adapters - package xbot.common.controls.actuators.mock_adapters
+
 
+
xbot.common.controls.actuators.wpi_adapters - package xbot.common.controls.actuators.wpi_adapters
+
 
+
xbot.common.controls.sensors - package xbot.common.controls.sensors
+
 
+
xbot.common.controls.sensors.buttons - package xbot.common.controls.sensors.buttons
+
 
+
xbot.common.controls.sensors.mock_adapters - package xbot.common.controls.sensors.mock_adapters
+
 
+
xbot.common.controls.sensors.wpi_adapters - package xbot.common.controls.sensors.wpi_adapters
+
 
+
xbot.common.injection - package xbot.common.injection
+
 
+
xbot.common.injection.components - package xbot.common.injection.components
+
 
+
xbot.common.injection.electrical_contract - package xbot.common.injection.electrical_contract
+
 
+
xbot.common.injection.modules - package xbot.common.injection.modules
+
 
+
xbot.common.logging - package xbot.common.logging
+
 
+
xbot.common.logic - package xbot.common.logic
+
 
+
xbot.common.math - package xbot.common.math
+
 
+
xbot.common.networking - package xbot.common.networking
+
 
+
xbot.common.properties - package xbot.common.properties
+
 
+
xbot.common.resiliency - package xbot.common.resiliency
+
 
+
xbot.common.simulation - package xbot.common.simulation
+
 
+
xbot.common.subsystems - package xbot.common.subsystems
+
 
+
xbot.common.subsystems.autonomous - package xbot.common.subsystems.autonomous
+
 
+
xbot.common.subsystems.compressor - package xbot.common.subsystems.compressor
+
 
+
xbot.common.subsystems.drive - package xbot.common.subsystems.drive
+
 
+
xbot.common.subsystems.drive.control_logic - package xbot.common.subsystems.drive.control_logic
+
 
+
xbot.common.subsystems.feedback - package xbot.common.subsystems.feedback
+
 
+
xbot.common.subsystems.pose - package xbot.common.subsystems.pose
+
 
+
xbot.common.subsystems.pose.commands - package xbot.common.subsystems.pose.commands
+
 
+
xbot.common.subsystems.simplemotor - package xbot.common.subsystems.simplemotor
+
 
+
xboxControllerFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
XboxControllerWpiAdapter - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
XboxControllerWpiAdapter(int, AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory, AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory, AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory, XRumbleManager.XRumbleManagerFactory, RobotAssertionManager, DevicePolice) - Constructor for class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter
+
 
+
XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory - Class in xbot.common.controls.sensors.wpi_adapters
+
 
+
XboxControllerWpiAdapterFactory() - Constructor for class xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory
+
 
+
XCANCoder - Class in xbot.common.controls.sensors
+
 
+
XCANCoder() - Constructor for class xbot.common.controls.sensors.XCANCoder
+
 
+
XCANCoder.XCANCoderFactory - Interface in xbot.common.controls.sensors
+
 
+
XCANSparkMax - Class in xbot.common.controls.actuators
+
 
+
XCANSparkMax(DeviceInfo, String, String, PropertyFactory, DevicePolice, XCANSparkMaxPIDProperties) - Constructor for class xbot.common.controls.actuators.XCANSparkMax
+
 
+
XCANSparkMax.XCANSparkMaxFactory - Class in xbot.common.controls.actuators
+
 
+
XCANSparkMaxFactory() - Constructor for class xbot.common.controls.actuators.XCANSparkMax.XCANSparkMaxFactory
+
 
+
XCANSparkMaxPIDProperties - Class in xbot.common.controls.actuators
+
 
+
XCANSparkMaxPIDProperties() - Constructor for class xbot.common.controls.actuators.XCANSparkMaxPIDProperties
+
 
+
XCANSparkMaxPIDProperties(double, double, double, double, double, double, double) - Constructor for class xbot.common.controls.actuators.XCANSparkMaxPIDProperties
+
 
+
XCANTalon - Class in xbot.common.controls.actuators
+
 
+
XCANTalon(int, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.actuators.XCANTalon
+
 
+
XCANTalon.XCANTalonFactory - Interface in xbot.common.controls.actuators
+
 
+
XCANVictorSPX - Class in xbot.common.controls.actuators
+
 
+
XCANVictorSPX(int, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.actuators.XCANVictorSPX
+
 
+
XCANVictorSPX.XCANVictorSPXFactory - Interface in xbot.common.controls.actuators
+
 
+
XCompressor - Class in xbot.common.controls.actuators
+
 
+
XCompressor() - Constructor for class xbot.common.controls.actuators.XCompressor
+
 
+
XCompressor.XCompressorFactory - Interface in xbot.common.controls.actuators
+
 
+
XDigitalInput - Class in xbot.common.controls.sensors
+
 
+
XDigitalInput(DevicePolice, int) - Constructor for class xbot.common.controls.sensors.XDigitalInput
+
 
+
XDigitalInput.XDigitalInputFactory - Interface in xbot.common.controls.sensors
+
 
+
XDigitalOutput - Class in xbot.common.controls.actuators
+
 
+
XDigitalOutput(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.XDigitalOutput
+
 
+
XDigitalOutput.XDigitalOutputFactory - Interface in xbot.common.controls.actuators
+
 
+
XDoubleSolenoid - Class in xbot.common.controls.actuators
+
 
+
XDoubleSolenoid(XSolenoid, XSolenoid) - Constructor for class xbot.common.controls.actuators.XDoubleSolenoid
+
 
+
XDoubleSolenoid.DoubleSolenoidMode - Enum in xbot.common.controls.actuators
+
 
+
XDoubleSolenoid.XDoubleSolenoidFactory - Class in xbot.common.controls.actuators
+
 
+
XDoubleSolenoidFactory() - Constructor for class xbot.common.controls.actuators.XDoubleSolenoid.XDoubleSolenoidFactory
+
 
+
XDutyCycleEncoder - Class in xbot.common.controls.sensors
+
 
+
XDutyCycleEncoder(DeviceInfo, DevicePolice) - Constructor for class xbot.common.controls.sensors.XDutyCycleEncoder
+
 
+
XDutyCycleEncoder.XDutyCycleEncoderFactory - Interface in xbot.common.controls.sensors
+
 
+
XEncoder - Class in xbot.common.controls.sensors
+
 
+
XEncoder(String, int, int, double, PropertyFactory, DevicePolice) - Constructor for class xbot.common.controls.sensors.XEncoder
+
 
+
XEncoder(String, PropertyFactory) - Constructor for class xbot.common.controls.sensors.XEncoder
+
 
+
XEncoder(Supplier<Double>) - Constructor for class xbot.common.controls.sensors.XEncoder
+
 
+
XEncoder.XEncoderFactory - Interface in xbot.common.controls.sensors
+
 
+
XFTCGamepad - Class in xbot.common.controls.sensors
+
 
+
XFTCGamepad(int, AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory, AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory, AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory, RobotAssertionManager, int, DevicePolice) - Constructor for class xbot.common.controls.sensors.XFTCGamepad
+
 
+
XFTCGamepad.XFTCGamepadFactory - Interface in xbot.common.controls.sensors
+
 
+
XGyro - Class in xbot.common.controls.sensors
+
 
+
XGyro(XGyro.ImuType) - Constructor for class xbot.common.controls.sensors.XGyro
+
 
+
XGyro.ImuType - Enum in xbot.common.controls.sensors
+
 
+
XGyro.XGyroFactory - Class in xbot.common.controls.sensors
+
 
+
XGyroFactory() - Constructor for class xbot.common.controls.sensors.XGyro.XGyroFactory
+
 
+
XJoystick - Class in xbot.common.controls.sensors
+
 
+
XJoystick(int, AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory, AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory, AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory, RobotAssertionManager, int, DevicePolice) - Constructor for class xbot.common.controls.sensors.XJoystick
+
 
+
XJoystick.ButtonSource - Enum in xbot.common.controls.sensors
+
 
+
XJoystick.XJoystickFactory - Interface in xbot.common.controls.sensors
+
 
+
XLidarLite - Class in xbot.common.controls.sensors
+
 
+
XLidarLite(I2C.Port, PropertyFactory, DevicePolice, String) - Constructor for class xbot.common.controls.sensors.XLidarLite
+
 
+
XLidarLite.XLidarLiteFactory - Interface in xbot.common.controls.sensors
+
 
+
XPowerDistributionPanel - Class in xbot.common.controls.sensors
+
 
+
XPowerDistributionPanel() - Constructor for class xbot.common.controls.sensors.XPowerDistributionPanel
+
 
+
XPowerDistributionPanel.XPowerDistributionPanelFactory - Interface in xbot.common.controls.sensors
+
 
+
XPropertyManager - Class in xbot.common.properties
+
+
The PropertyManager keeps track of all properties in CoreCode.
+
+
XPropertyManager(PermanentStorage, ITableProxy, ITableProxy) - Constructor for class xbot.common.properties.XPropertyManager
+
 
+
XPWM - Class in xbot.common.controls.actuators
+
 
+
XPWM(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.XPWM
+
 
+
XPWM.XPWMFactory - Interface in xbot.common.controls.actuators
+
 
+
XRelay - Class in xbot.common.controls.actuators
+
 
+
XRelay(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.XRelay
+
 
+
XRelay.XRelayFactory - Interface in xbot.common.controls.actuators
+
 
+
XRumbleManager - Interface in xbot.common.subsystems.feedback
+
 
+
XRumbleManager.XRumbleManagerFactory - Interface in xbot.common.subsystems.feedback
+
 
+
xScheduler - Variable in class xbot.common.command.BaseRobot
+
 
+
XScheduler - Class in xbot.common.command
+
+
Wrapper for base Scheduler which intelligently manages exceptions.
+
+
XScheduler() - Constructor for class xbot.common.command.XScheduler
+
 
+
XServo - Class in xbot.common.controls.actuators
+
 
+
XServo(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.XServo
+
 
+
XServo.XServoFactory - Interface in xbot.common.controls.actuators
+
 
+
XSettableTimerImpl - Interface in xbot.common.controls.sensors
+
 
+
XSolenoid - Class in xbot.common.controls.actuators
+
 
+
XSolenoid(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.XSolenoid
+
 
+
XSolenoid.XSolenoidFactory - Interface in xbot.common.controls.actuators
+
 
+
XSpeedController - Class in xbot.common.controls.actuators
+
 
+
XSpeedController(int, DevicePolice) - Constructor for class xbot.common.controls.actuators.XSpeedController
+
 
+
XSpeedController.XSpeedControllerFactory - Interface in xbot.common.controls.actuators
+
 
+
XTimer - Class in xbot.common.controls.sensors
+
 
+
XTimer() - Constructor for class xbot.common.controls.sensors.XTimer
+
 
+
XTimerImpl - Interface in xbot.common.controls.sensors
+
 
+
XXboxController - Class in xbot.common.controls.sensors
+
 
+
XXboxController(int, AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory, AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory, AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory, XRumbleManager.XRumbleManagerFactory, RobotAssertionManager, DevicePolice) - Constructor for class xbot.common.controls.sensors.XXboxController
+
 
+
XXboxController.XboxButton - Enum in xbot.common.controls.sensors
+
 
+
XXboxController.XXboxControllerFactory - Interface in xbot.common.controls.sensors
+
 
+
XYPair - Class in xbot.common.math
+
+
Pair of X and Y coordinates.
+
+
XYPair() - Constructor for class xbot.common.math.XYPair
+
+
Create a coordinate at the origin.
+
+
XYPair(double, double) - Constructor for class xbot.common.math.XYPair
+
+
Create a coordinate with the specified x and y value.
+
+
XYPair(Rotation2d) - Constructor for class xbot.common.math.XYPair
+
+
Creates a coordinate representing the unit vector for a rotation.
+
+
XZeromqListener - Interface in xbot.common.networking
+
 
+
XZeromqListener.XZeromqListenerFactory - Interface in xbot.common.networking
+
 
+
+ + + +

Y

+
+
y - Variable in class xbot.common.math.XYPair
+
 
+
Y - xbot.common.controls.sensors.XXboxController.XboxButton
+
 
+
+ + + +

Z

+
+
ZERO - Static variable in class xbot.common.math.XYPair
+
 
+
ZeromqListener - Class in xbot.common.networking
+
 
+
ZeromqListener(String, String) - Constructor for class xbot.common.networking.ZeromqListener
+
+
This is the wrapper class for the actual ZeroMQ subscriber, based on + http://zguide.zeromq.org/java:wuclient and our 2017 ethernet implementation.
+
+
ZeromqListener.ZeromqListenerFactory - Class in xbot.common.networking
+
 
+
zeromqListenerFactory() - Method in class xbot.common.injection.components.BaseComponent
+
 
+
ZeromqListenerFactory() - Constructor for class xbot.common.networking.ZeromqListener.ZeromqListenerFactory
+
 
+
+A B C D E F G H I J K L M N O P R S T U V W X Y Z 
All Classes All Packages
+
+ + + diff --git a/javadoc/index.html b/javadoc/index.html new file mode 100644 index 00000000..479a5a47 --- /dev/null +++ b/javadoc/index.html @@ -0,0 +1,276 @@ + + + + + +Overview (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
+

SeriouslyCommonLib API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
edu.wpi.first.wpilibj 
xbot.common.command 
xbot.common.controls 
xbot.common.controls.actuators 
xbot.common.controls.actuators.mock_adapters 
xbot.common.controls.actuators.wpi_adapters 
xbot.common.controls.sensors 
xbot.common.controls.sensors.buttons 
xbot.common.controls.sensors.mock_adapters 
xbot.common.controls.sensors.wpi_adapters 
xbot.common.injection 
xbot.common.injection.components 
xbot.common.injection.electrical_contract 
xbot.common.injection.modules 
xbot.common.logging 
xbot.common.logic 
xbot.common.math 
xbot.common.networking 
xbot.common.properties 
xbot.common.resiliency 
xbot.common.simulation 
xbot.common.subsystems 
xbot.common.subsystems.autonomous 
xbot.common.subsystems.compressor 
xbot.common.subsystems.drive 
xbot.common.subsystems.drive.control_logic 
xbot.common.subsystems.feedback 
xbot.common.subsystems.pose 
xbot.common.subsystems.pose.commands 
xbot.common.subsystems.simplemotor 
+
+
+ + + diff --git a/javadoc/jquery-ui.overrides.css b/javadoc/jquery-ui.overrides.css new file mode 100644 index 00000000..12fe6192 --- /dev/null +++ b/javadoc/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/javadoc/jquery/external/jquery/jquery.js b/javadoc/jquery/external/jquery/jquery.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/javadoc/jquery/external/jquery/jquery.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/javadoc/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/javadoc/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 00000000..93d8bc8e --- /dev/null +++ b/javadoc/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/javadoc/jquery/jszip-utils/dist/jszip-utils.js b/javadoc/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 00000000..775895ec --- /dev/null +++ b/javadoc/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker: function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if (this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker: function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compression. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":37}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":38}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with information about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing information + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emitted metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + // NOTE: we use a null prototype because we do not + // want filenames like "toString" coming from a zip file + // to overwrite methods and attributes in a normal Object. + this.files = Object.create(null); + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.7.1"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function (data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function (data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment: input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions: input.unixPermissions, + dosPermissions: input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + if (Buffer.from && Buffer.from !== Uint8Array.from) { + return Buffer.from(data, encoding); + } else { + if (typeof data === "number") { + // Safeguard for old Node.js versions. On newer versions, + // Buffer.from(number) / Buffer(number, encoding) already throw. + throw new Error("The \"data\" argument must not be a number"); + } + return new Buffer(data, encoding); + } + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + var buf = new Buffer(size); + buf.fill(0); + return buf; + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + /* jshint ignore:start */ + // ignore warning about unwanted properties because this.files is a null prototype object + for (filename in this.files) { + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + /* jshint ignore:end */ + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is preferred but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurrence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurrence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('set-immediate-shim'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static information and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"set-immediate-shim":54}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough information from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index + 4 < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + + reader.setIndex(end); + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + +
+ +

index.html

+
+ + diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html new file mode 100644 index 00000000..f6cc2ebb --- /dev/null +++ b/javadoc/overview-tree.html @@ -0,0 +1,742 @@ + + + + + +Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+
+ +
+ + diff --git a/javadoc/package-search-index.js b/javadoc/package-search-index.js new file mode 100644 index 00000000..ae1c85ec --- /dev/null +++ b/javadoc/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"edu.wpi.first.wpilibj"},{"l":"xbot.common.command"},{"l":"xbot.common.controls"},{"l":"xbot.common.controls.actuators"},{"l":"xbot.common.controls.actuators.mock_adapters"},{"l":"xbot.common.controls.actuators.wpi_adapters"},{"l":"xbot.common.controls.sensors"},{"l":"xbot.common.controls.sensors.buttons"},{"l":"xbot.common.controls.sensors.mock_adapters"},{"l":"xbot.common.controls.sensors.wpi_adapters"},{"l":"xbot.common.injection"},{"l":"xbot.common.injection.components"},{"l":"xbot.common.injection.electrical_contract"},{"l":"xbot.common.injection.modules"},{"l":"xbot.common.logging"},{"l":"xbot.common.logic"},{"l":"xbot.common.math"},{"l":"xbot.common.networking"},{"l":"xbot.common.properties"},{"l":"xbot.common.resiliency"},{"l":"xbot.common.simulation"},{"l":"xbot.common.subsystems"},{"l":"xbot.common.subsystems.autonomous"},{"l":"xbot.common.subsystems.compressor"},{"l":"xbot.common.subsystems.drive"},{"l":"xbot.common.subsystems.drive.control_logic"},{"l":"xbot.common.subsystems.feedback"},{"l":"xbot.common.subsystems.pose"},{"l":"xbot.common.subsystems.pose.commands"},{"l":"xbot.common.subsystems.simplemotor"}] \ No newline at end of file diff --git a/javadoc/package-search-index.zip b/javadoc/package-search-index.zip new file mode 100644 index 00000000..a7704f45 Binary files /dev/null and b/javadoc/package-search-index.zip differ diff --git a/javadoc/resources/glass.png b/javadoc/resources/glass.png new file mode 100644 index 00000000..a7f591f4 Binary files /dev/null and b/javadoc/resources/glass.png differ diff --git a/javadoc/resources/x.png b/javadoc/resources/x.png new file mode 100644 index 00000000..30548a75 Binary files /dev/null and b/javadoc/resources/x.png differ diff --git a/javadoc/script.js b/javadoc/script.js new file mode 100644 index 00000000..53f3ea0d --- /dev/null +++ b/javadoc/script.js @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("module-search-index.json").async("text").then(function(content){ + moduleSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("package-search-index.json").async("text").then(function(content){ + packageSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("type-search-index.json").async("text").then(function(content){ + typeSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("member-search-index.json").async("text").then(function(content){ + memberSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("tag-search-index.json").async("text").then(function(content){ + tagSearchIndex = JSON.parse(content); + }); + }); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[key] & type) !== 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) { + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/javadoc/search.js b/javadoc/search.js new file mode 100644 index 00000000..786f6a74 --- /dev/null +++ b/javadoc/search.js @@ -0,0 +1,326 @@ +/* + * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var camelCaseRegexp = ""; +var secondaryMatcher = ""; +function getHighlightedText(item) { + var ccMatcher = new RegExp(camelCaseRegexp); + var label = item.replace(ccMatcher, highlight); + if (label === item) { + label = item.replace(secondaryMatcher, highlight); + } + return label; +} +function getURLPrefix(ui) { + var urlPrefix=""; + if (useModuleDirectories) { + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if ((ui.item.category === catTypes && ui.item.p) || ui.item.category === catMembers) { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p == item.l) { + urlPrefix = item.m + slash; + } + }); + return urlPrefix; + } else { + return urlPrefix; + } + } + return urlPrefix; +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this, + currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.l !== noResult.l && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
    • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "resultItem"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "resultItem"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + if (item.category === catModules) { + label = getHighlightedText(item.l); + } else if (item.category === catPackages) { + label = (item.m) + ? getHighlightedText(item.m + "/" + item.l) + : getHighlightedText(item.l); + } else if (item.category === catTypes) { + label = (item.p) + ? getHighlightedText(item.p + "." + item.l) + : getHighlightedText(item.l); + } else if (item.category === catMembers) { + label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l); + } else { + label = item.l; + } + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + if (item.category === catSearchTags) { + if (item.d) { + div.html(label + " (" + item.h + ")
    " + + item.d + "
    "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 100, + source: function(request, response) { + var result = new Array(); + var presult = new Array(); + var tresult = new Array(); + var mresult = new Array(); + var tgresult = new Array(); + var secondaryresult = new Array(); + var displayCount = 0; + var exactMatcher = new RegExp("^" + $.ui.autocomplete.escapeRegex(request.term) + "$", "i"); + camelCaseRegexp = ($.ui.autocomplete.escapeRegex(request.term)).split(/(?=[A-Z])/).join("([a-z0-9_$]*?)"); + var camelCaseMatcher = new RegExp("^" + camelCaseRegexp); + secondaryMatcher = new RegExp($.ui.autocomplete.escapeRegex(request.term), "i"); + + // Return the nested innermost name from the specified object + function nestedName(e) { + return e.l.substring(e.l.lastIndexOf(".") + 1); + } + + function concatResults(a1, a2) { + a1 = a1.concat(a2); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + var mdleCount = 0; + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + if (exactMatcher.test(item.l)) { + result.push(item); + mdleCount++; + } else if (camelCaseMatcher.test(item.l)) { + result.push(item); + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + displayCount = mdleCount; + result = concatResults(result, secondaryresult); + } + if (packageSearchIndex) { + var pCount = 0; + var pkg = ""; + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + pkg = (item.m) + ? (item.m + "/" + item.l) + : item.l; + if (exactMatcher.test(item.l)) { + presult.push(item); + pCount++; + } else if (camelCaseMatcher.test(pkg)) { + presult.push(item); + } else if (secondaryMatcher.test(pkg)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(presult, secondaryresult)); + displayCount = (pCount > displayCount) ? pCount : displayCount; + } + if (typeSearchIndex) { + var tCount = 0; + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var s = nestedName(item); + if (exactMatcher.test(s)) { + tresult.push(item); + tCount++; + } else if (camelCaseMatcher.test(s)) { + tresult.push(item); + } else if (secondaryMatcher.test(item.p + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tresult, secondaryresult)); + displayCount = (tCount > displayCount) ? tCount : displayCount; + } + if (memberSearchIndex) { + var mCount = 0; + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var s = nestedName(item); + if (exactMatcher.test(s)) { + mresult.push(item); + mCount++; + } else if (camelCaseMatcher.test(s)) { + mresult.push(item); + } else if (secondaryMatcher.test(item.c + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(mresult, secondaryresult)); + displayCount = (mCount > displayCount) ? mCount : displayCount; + } + if (tagSearchIndex) { + var tgCount = 0; + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + if (exactMatcher.test(item.l)) { + tgresult.push(item); + tgCount++; + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tgresult, secondaryresult)); + displayCount = (tgCount > displayCount) ? tgCount : displayCount; + } + displayCount = (displayCount > 500) ? displayCount : 500; + var counter = function() { + var count = {Modules: 0, Packages: 0, Types: 0, Members: 0, SearchTags: 0}; + var f = function(item) { + count[item.category] += 1; + return (count[item.category] <= displayCount); + }; + return f; + }(); + response(result.filter(counter)); + }, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.l !== noResult.l) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + if (useModuleDirectories) { + url += "module-summary.html"; + } else { + url = ui.item.l + "-summary.html"; + } + } else if (ui.item.category === catPackages) { + if (ui.item.url) { + url = ui.item.url; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.url) { + url = ui.item.url; + } else if (ui.item.p === "") { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === "") { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.url) { + url += ui.item.url; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search").focus(); + } + } + }); +}); diff --git a/javadoc/serialized-form.html b/javadoc/serialized-form.html new file mode 100644 index 00000000..ab2ea711 --- /dev/null +++ b/javadoc/serialized-form.html @@ -0,0 +1,242 @@ + + + + + +Serialized Form (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
    +
      +
    • +
      +

      Package edu.wpi.first.wpilibj

      +
        +
      • + + +

        Class edu.wpi.first.wpilibj.AnalogTrigger.AnalogTriggerException extends java.lang.RuntimeException implements Serializable

        +
        • +
      • + + +

        Class edu.wpi.first.wpilibj.AnalogTriggerOutput.AnalogTriggerOutputException extends java.lang.RuntimeException implements Serializable

        +
        • +
      • + + +

        Class edu.wpi.first.wpilibj.Relay.InvalidValueException extends java.lang.RuntimeException implements Serializable

        +
        • +
      +
      +
      • +
    • +
      +

      Package xbot.common.logging

      + +
      +
      • +
    • +
      +

      Package xbot.common.math

      +
        +
      • + + +

        Class xbot.common.math.PlanarVisualizationPanel extends javax.swing.JPanel implements Serializable

        +
          +
        • +

          Serialized Fields

          +
            +
          • +

            centerX

            +
            int centerX
            +
            • +
          • +

            centerY

            +
            int centerY
            +
            • +
          • +

            goalPosition

            +
            XYPair goalPosition
            +
            • +
          • +

            loops

            +
            java.lang.String loops
            +
            • +
          • +

            minimumWidth

            +
            int minimumWidth
            +
            • +
          • +

            preferredWidth

            +
            int preferredWidth
            +
            • +
          • +

            rabbitPosition

            +
            FieldPose rabbitPosition
            +
            • +
          • +

            rabbitStats

            +
            java.lang.String rabbitStats
            +
            • +
          • +

            robotCurrentPosition

            +
            FieldPose robotCurrentPosition
            +
            • +
          • +

            robotStats

            +
            java.lang.String robotStats
            +
            • +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/stylesheet.css b/javadoc/stylesheet.css new file mode 100644 index 00000000..a377b108 --- /dev/null +++ b/javadoc/stylesheet.css @@ -0,0 +1,910 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} + +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch { + float:right; + margin:0 0 0 0; + padding:0; +} +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { + position:relative; + right:-16px; +} +ul.subNavList li { + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Styles for page header and footer. + */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* + * Styles for page layout containers. + */ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* + * Styles for tables. + */ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.constantsSummary caption a:link, .constantsSummary caption a:visited, +.useSummary caption a:link, .useSummary caption a:visited { + color:#1f389c; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; +} +.constantsSummary th, .packagesSummary th { + font-size:13px; +} +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { + vertical-align:top; +} +.packagesSummary th.colLast, .packagesSummary td.colLast { + white-space:normal; +} +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor, .altColor th { + background-color:#FFFFFF; +} +.rowColor, .rowColor th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +td.colLast div { + padding-top:0px; +} +td.colLast a { + padding-bottom:3px; +} +/* + * Styles for formatting effect. + */ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} +.deprecationBlock { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} +div.contentContainer ul.blockList li.blockList h2 { + padding-bottom:0px; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.resultItem { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.resultHighlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:17px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.searchTagDescResult { + font-style:italic; + font-size:11px; +} +.searchTagHolderResult { + font-style:italic; + font-size:12px; +} +.searchTagResult:before, .searchTagResult:target { + color:red; +} +.moduleGraph span { + display:none; + position:absolute; +} +.moduleGraph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.methodSignature { + white-space:normal; +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/javadoc/type-search-index.js b/javadoc/type-search-index.js new file mode 100644 index 00000000..16cf0637 --- /dev/null +++ b/javadoc/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"xbot.common.controls.sensors.buttons","l":"AdvancedJoystickButtonTrigger"},{"p":"xbot.common.controls.sensors.buttons","l":"AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory"},{"p":"xbot.common.controls.sensors.buttons","l":"AdvancedPovButtonTrigger"},{"p":"xbot.common.controls.sensors.buttons","l":"AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory"},{"p":"xbot.common.controls.sensors.buttons","l":"AdvancedTrigger"},{"p":"xbot.common.controls.sensors.buttons","l":"AdvancedXboxAxisTrigger"},{"p":"xbot.common.controls.sensors.buttons","l":"AdvancedXboxButtonTrigger"},{"l":"All Classes","url":"allclasses-index.html"},{"p":"xbot.common.controls.sensors","l":"AnalogDistanceSensor"},{"p":"xbot.common.controls.sensors","l":"AnalogDistanceSensor.AnalogDistanceSensorFactory"},{"p":"xbot.common.controls.sensors.buttons","l":"AnalogHIDButtonConfiguration"},{"p":"xbot.common.controls.sensors.buttons","l":"AnalogHIDButtonTrigger"},{"p":"xbot.common.controls.sensors.buttons","l":"AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory"},{"p":"xbot.common.controls.sensors.buttons","l":"AnalogHIDButtonTrigger.AnalogHIDDescription"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"AnalogInputWPIAdapater"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory"},{"p":"xbot.common.math","l":"PurePursuitTest.AsyncLinearIntervalJob"},{"p":"xbot.common.subsystems.autonomous","l":"AutonomousCommandSelector"},{"p":"xbot.common.command","l":"BaseCommand"},{"p":"xbot.common.injection.components","l":"BaseComponent"},{"p":"xbot.common.subsystems.drive","l":"BaseDriveSubsystem"},{"p":"xbot.common.command","l":"BaseMaintainerCommand"},{"p":"xbot.common.subsystems.pose","l":"BasePoseSubsystem"},{"p":"xbot.common.command","l":"BaseRobot"},{"p":"xbot.common.command","l":"BaseSetpointCommand"},{"p":"xbot.common.command","l":"BaseSetpointSubsystem"},{"p":"xbot.common.simulation","l":"BaseSimulationTest"},{"p":"xbot.common.command","l":"BaseSubsystem"},{"p":"xbot.common.command","l":"BaseWaitForMaintainerCommand"},{"p":"xbot.common.injection","l":"BaseWPITest"},{"p":"xbot.common.subsystems","l":"BaseXCANTalonPairSpeedControlledSubsystem"},{"p":"xbot.common.subsystems","l":"BaseXCANTalonSpeedControlledSubsystem"},{"p":"xbot.common.properties","l":"BooleanProperty"},{"p":"xbot.common.controls.sensors","l":"XJoystick.ButtonSource"},{"p":"xbot.common.controls.sensors.buttons","l":"AdvancedXboxButtonTrigger.ButtonTriggerType"},{"p":"xbot.common.logic","l":"CalibrationDecider"},{"p":"xbot.common.logic","l":"CalibrationDecider.CalibrationDeciderFactory"},{"p":"xbot.common.logic","l":"CalibrationDecider.CalibrationMode"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"CANCoderAdapter"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"CANCoderAdapter.CANCoderAdapterFactory"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"CANSparkMaxWpiAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory"},{"p":"xbot.common.injection.electrical_contract","l":"CANTalonInfo"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"CANTalonWPIAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"CANTalonWPIAdapter.CANTalonWPIAdapterFactory"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"CANVictorSPXWpiAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory"},{"p":"xbot.common.controls.sensors.buttons","l":"ChordTrigger"},{"p":"xbot.common.controls.sensors.buttons","l":"ChordTrigger.ChordTriggerFactory"},{"p":"xbot.common.subsystems.compressor","l":"CompressorSubsystem"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"CompressorWPIAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"CompressorWPIAdapter.CompressorWPIAdapterFactory"},{"p":"xbot.common.subsystems.drive","l":"ConfigurablePurePursuitCommand"},{"p":"xbot.common.properties","l":"ConfigurePropertiesCommand"},{"p":"xbot.common.math","l":"ContiguousDouble"},{"p":"xbot.common.properties","l":"DatabaseStorageBase"},{"p":"xbot.common.properties","l":"DebugFlag"},{"p":"xbot.common.command","l":"DelayViaSupplierCommand"},{"p":"xbot.common.resiliency","l":"DeviceHealth"},{"p":"xbot.common.injection.electrical_contract","l":"DeviceInfo"},{"p":"xbot.common.injection","l":"DevicePolice"},{"p":"xbot.common.injection","l":"DevicePolice.DeviceType"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"DigitalInputWPIAdapter"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"DigitalOutputWPIAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory"},{"p":"xbot.common.controls.sensors","l":"DistanceSensor"},{"p":"xbot.common.controls.sensors","l":"DistanceSensorPair"},{"p":"xbot.common.properties","l":"DoubleProperty"},{"p":"xbot.common.controls.actuators","l":"XDoubleSolenoid.DoubleSolenoidMode"},{"p":"xbot.common.logging","l":"DriverStationAppender"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"DutyCycleEncoderWpiAdapter"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory"},{"p":"xbot.common.logic","l":"Latch.EdgeType"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"EncoderWPIAdapter"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"EncoderWPIAdapter.EncoderWPIAdapterFactory"},{"p":"xbot.common.math","l":"FieldPose"},{"p":"xbot.common.math","l":"FieldPosePropertyManager"},{"p":"xbot.common.math","l":"FieldPosePropertyManager.FieldPosePropertyManagerFactory"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"FTCGamepadWpiAdapter"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory"},{"p":"xbot.common.subsystems.drive.control_logic","l":"HeadingAssistModule.HeadingAssistMode"},{"p":"xbot.common.subsystems.drive.control_logic","l":"HeadingAssistModule"},{"p":"xbot.common.subsystems.drive.control_logic","l":"HeadingAssistModule.HeadingAssistModuleFactory"},{"p":"xbot.common.subsystems.drive.control_logic","l":"HeadingModule"},{"p":"xbot.common.subsystems.drive.control_logic","l":"HeadingModule.HeadingModuleFactory"},{"p":"xbot.common.logic","l":"HumanVsMachineDecider"},{"p":"xbot.common.logic","l":"HumanVsMachineDecider.HumanVsMachineDeciderFactory"},{"p":"xbot.common.logic","l":"HumanVsMachineDecider.HumanVsMachineMode"},{"p":"xbot.common.controls.sensors","l":"IGamepad"},{"p":"xbot.common.controls.sensors","l":"XGyro.ImuType"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"InertialMeasurementUnitAdapter"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory"},{"p":"xbot.common.logging","l":"IntermittentConsoleLogger"},{"p":"xbot.common.math","l":"InterpolatingFieldPoseBuffer"},{"p":"xbot.common.math","l":"InterpolatingHistoryBuffer"},{"p":"xbot.common.controls.sensors.buttons","l":"InvertingBooleanSupplier"},{"p":"xbot.common.properties","l":"IPropertySupport"},{"p":"xbot.common.subsystems.feedback","l":"IRumbler"},{"p":"xbot.common.simulation","l":"ISimulatableMotor"},{"p":"xbot.common.simulation","l":"ISimulatableSensor"},{"p":"xbot.common.simulation","l":"ISimulatableSolenoid"},{"p":"xbot.common.properties","l":"ITableProxy"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"JoystickWPIAdapter"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"JoystickWPIAdapter.JoystickWPIAdapterFactory"},{"p":"xbot.common.logic","l":"Latch"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"LidarLiteWpiAdapter"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory"},{"p":"xbot.common.logging","l":"LoggingLatch"},{"p":"xbot.common.logging","l":"LoudRobotAssertionManager"},{"p":"xbot.common.math","l":"MathUtils"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockAbsoluteEncoder"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockAbsoluteEncoder.MockAbsoluteEncoderFactory"},{"p":"edu.wpi.first.wpilibj","l":"MockAnalogInput"},{"p":"edu.wpi.first.wpilibj","l":"MockAnalogInput.MockAnalogInputFactory"},{"p":"xbot.common.subsystems.pose","l":"MockBasePoseSubsystem"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockCANCoder"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockCANCoder.MockCANCoderFactory"},{"p":"xbot.common.controls.actuators.mock_adapters","l":"MockCANSparkMax"},{"p":"xbot.common.controls.actuators.mock_adapters","l":"MockCANSparkMax.MockCANSparkMaxFactory"},{"p":"xbot.common.controls.actuators.mock_adapters","l":"MockCANTalon"},{"p":"xbot.common.controls.actuators.mock_adapters","l":"MockCANTalon.MockCANTalonFactory"},{"p":"xbot.common.controls.actuators.mock_adapters","l":"MockCANVictorSPX"},{"p":"xbot.common.controls.actuators.mock_adapters","l":"MockCANVictorSPX.MockCANVictorSPXFactory"},{"p":"edu.wpi.first.wpilibj","l":"MockCompressor"},{"p":"edu.wpi.first.wpilibj","l":"MockCompressor.MockCompressorFactory"},{"p":"xbot.common.injection.modules","l":"MockControlsModule"},{"p":"xbot.common.injection.modules","l":"MockDevicesModule"},{"p":"edu.wpi.first.wpilibj","l":"MockDigitalInput"},{"p":"edu.wpi.first.wpilibj","l":"MockDigitalInput.MockDigitalInputFactory"},{"p":"edu.wpi.first.wpilibj","l":"MockDigitalOutput"},{"p":"edu.wpi.first.wpilibj","l":"MockDigitalOutput.MockDigitalOutputFactory"},{"p":"edu.wpi.first.wpilibj","l":"MockDistanceSensor"},{"p":"edu.wpi.first.wpilibj","l":"MockDistanceSensorPair"},{"p":"xbot.common.subsystems.drive","l":"MockDriveSubsystem"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockDutyCycleEncoder"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockDutyCycleEncoder.MockDutyCycleEncoderFactory"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockEncoder"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockEncoder.MockEncoderFactory"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockFTCGamepad"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockFTCGamepad.MockFTCGamepadFactory"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockGyro"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockGyro.MockGyroFactory"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockJoystick"},{"p":"xbot.common.controls.sensors.mock_adapters","l":"MockJoystick.MockJoystickFactory"},{"p":"edu.wpi.first.wpilibj","l":"MockLidarLite"},{"p":"edu.wpi.first.wpilibj","l":"MockLidarLite.MockLidarLiteFactory"},{"p":"xbot.common.properties","l":"MockPermamentStorage"},{"p":"xbot.common.injection","l":"MockPermanentStorage"},{"p":"edu.wpi.first.wpilibj","l":"MockPowerDistributionPanel"},{"p":"edu.wpi.first.wpilibj","l":"MockPowerDistributionPanel.MockPowerDistributionPanelFactory"},{"p":"edu.wpi.first.wpilibj","l":"MockPWM"},{"p":"edu.wpi.first.wpilibj","l":"MockPWM.MockPWMFactory"},{"p":"xbot.common.controls.actuators.mock_adapters","l":"MockRelay"},{"p":"xbot.common.controls.actuators.mock_adapters","l":"MockRelay.MockRelayFactory"},{"p":"edu.wpi.first.wpilibj","l":"MockServo"},{"p":"edu.wpi.first.wpilibj","l":"MockServo.MockServoFactory"},{"p":"xbot.common.command","l":"MockSmartDashboardCommandPutter"},{"p":"edu.wpi.first.wpilibj","l":"MockSolenoid"},{"p":"edu.wpi.first.wpilibj","l":"MockSolenoid.MockSolenoidFactory"},{"p":"edu.wpi.first.wpilibj","l":"MockSpeedController"},{"p":"edu.wpi.first.wpilibj","l":"MockSpeedController.MockSpeedControllerFactory"},{"p":"edu.wpi.first.wpilibj","l":"MockTimer"},{"p":"edu.wpi.first.wpilibj","l":"MockXboxControllerAdapter"},{"p":"edu.wpi.first.wpilibj","l":"MockXboxControllerAdapter.MockXboxControllerFactory"},{"p":"xbot.common.networking","l":"MockZeromqListener"},{"p":"xbot.common.networking","l":"MockZeromqListener.MockZeromqListenerFactory"},{"p":"xbot.common.controls.sensors","l":"MultiplexedLidarPair"},{"p":"xbot.common.command","l":"NamedInstantCommand"},{"p":"xbot.common.command","l":"NamedRunCommand"},{"p":"xbot.common.math","l":"PID.OffTargetReason"},{"p":"xbot.common.logging","l":"OneLogFilePerRunRollingFileAppender"},{"p":"xbot.common.properties","l":"PermanentStorage"},{"p":"xbot.common.math","l":"PID"},{"p":"xbot.common.math","l":"PIDManager"},{"p":"xbot.common.math","l":"PIDManager.PIDManagerFactory"},{"p":"xbot.common.math","l":"PIDPropertyManager"},{"p":"xbot.common.math","l":"PIDPropertyManager.PIDPropertyManagerFactory"},{"p":"xbot.common.math","l":"PlanarEngine"},{"p":"xbot.common.math","l":"PlanarTestVisualizer"},{"p":"xbot.common.math","l":"PlanarVisualizationPanel"},{"p":"xbot.common.subsystems.drive","l":"RabbitPoint.PointDriveStyle"},{"p":"xbot.common.subsystems.drive","l":"PurePursuitCommand.PointLoadingMode"},{"p":"xbot.common.subsystems.drive","l":"RabbitPoint.PointTerminatingType"},{"p":"xbot.common.subsystems.drive","l":"RabbitPoint.PointType"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"PowerDistributionPanelWPIAdapter"},{"p":"xbot.common.properties","l":"PreferenceStorage"},{"p":"xbot.common.properties","l":"Property"},{"p":"xbot.common.properties","l":"PropertyFactory"},{"p":"xbot.common.properties","l":"Property.PropertyLevel"},{"p":"xbot.common.properties","l":"Property.PropertyPersistenceType"},{"p":"xbot.common.subsystems.drive","l":"PurePursuitCommand"},{"p":"xbot.common.math","l":"PurePursuitTest"},{"p":"xbot.common.injection.components","l":"PurePursuitTestComponent"},{"p":"xbot.common.math","l":"PurePursuitTest.PursuitEnvironmentState"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"PWMWPIAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"PWMWPIAdapter.PWMWPIAdapterFactory"},{"p":"xbot.common.subsystems.drive","l":"PurePursuitCommand.RabbitChaseInfo"},{"p":"xbot.common.subsystems.drive","l":"RabbitPoint"},{"p":"xbot.common.subsystems.drive","l":"RabbitPointBuilder"},{"p":"xbot.common.injection.modules","l":"RealControlsModule"},{"p":"xbot.common.injection.modules","l":"RealDevicesModule"},{"p":"xbot.common.command","l":"RealSmartDashboardCommandPutter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"RelayWPIAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"RelayWPIAdapter.RelayWPIAdapterFactory"},{"p":"xbot.common.subsystems.pose.commands","l":"ResetDistanceCommand"},{"p":"xbot.common.simulation","l":"ResetSimulatorPositionCommand"},{"p":"xbot.common.logging","l":"RobotAssertionException"},{"p":"xbot.common.logging","l":"RobotAssertionManager"},{"p":"xbot.common.injection.modules","l":"RobotModule"},{"p":"xbot.common.logging","l":"RobotSession"},{"p":"xbot.common.subsystems.feedback","l":"RumbleManager"},{"p":"xbot.common.subsystems.feedback","l":"RumbleManager.RumbleManagerFactory"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"ServoWPIAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"ServoWPIAdapter.ServoWPIAdapterFactory"},{"p":"xbot.common.subsystems.autonomous","l":"SetAutonomousCommand"},{"p":"xbot.common.subsystems.pose.commands","l":"SetRobotHeadingCommand"},{"p":"xbot.common.controls.sensors.buttons","l":"SettableBooleanSuppler"},{"p":"xbot.common.logging","l":"SilentRobotAssertionManager"},{"p":"xbot.common.subsystems.simplemotor","l":"SimpleMotorSubsystem"},{"p":"xbot.common.command","l":"SimpleWaitForMaintainerCommand"},{"p":"xbot.common.controls.sensors","l":"SimulatedAnalogDistanceSensor"},{"p":"xbot.common.controls.sensors","l":"SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory"},{"p":"xbot.common.subsystems.drive","l":"SimulatedPurePursuitCommand"},{"p":"xbot.common.injection.components","l":"SimulationComponent"},{"p":"xbot.common.injection.modules","l":"SimulationModule"},{"p":"xbot.common.simulation","l":"SimulationPayloadDistributor"},{"p":"xbot.common.command","l":"SmartDashboardCommandPutter"},{"p":"xbot.common.properties","l":"SmartDashboardTableWrapper"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"SolenoidWPIAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"SolenoidWPIAdapter.SolenoidWPIAdapterFactory"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"SpeedControllerWPIAdapter"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory"},{"p":"xbot.common.logic","l":"StallDetector"},{"p":"xbot.common.logic","l":"StallDetector.StallDetectorFactory"},{"p":"xbot.common.logic","l":"StallDetector.StallState"},{"p":"xbot.common.properties","l":"StringProperty"},{"p":"xbot.common.command","l":"SupportsSetpointLock"},{"p":"xbot.common.properties","l":"TableProxy"},{"p":"xbot.common.controls.sensors","l":"TalonCurrentMonitor"},{"p":"xbot.common.logging","l":"TimeLogger"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"TimerWpiAdapter"},{"p":"xbot.common.logic","l":"TimeStableValidator"},{"p":"xbot.common.injection.modules","l":"UnitTestModule"},{"p":"xbot.common.injection.modules","l":"UnitTestRobotModule"},{"p":"xbot.common.logic","l":"VelocityThrottleModule"},{"p":"xbot.common.logic","l":"VelocityThrottleModule.VelocityThrottleModuleFactory"},{"p":"xbot.common.controls.actuators.wpi_adapters","l":"VictorAppearingAsTalonWPIAdapter"},{"p":"xbot.common.controls.sensors.buttons","l":"VirtualTrigger"},{"p":"xbot.common.controls.sensors.buttons","l":"VirtualTrigger.VirtualTriggerFactory"},{"p":"xbot.common.controls.sensors","l":"XAnalogDistanceSensor.VoltageMaps"},{"p":"xbot.common.logic","l":"WatchdogTimer"},{"p":"xbot.common.simulation","l":"WebotsClient"},{"p":"xbot.common.logging","l":"WordGenerator"},{"p":"xbot.common.math","l":"WrappedRotation2d"},{"p":"xbot.common.controls.sensors","l":"XAbsoluteEncoder"},{"p":"xbot.common.controls.sensors","l":"XAbsoluteEncoder.XAbsoluteEncoderFactory"},{"p":"xbot.common.controls.sensors","l":"XAnalogDistanceSensor"},{"p":"xbot.common.controls.sensors","l":"XAnalogDistanceSensor.XAnalogDistanceSensorFactory"},{"p":"xbot.common.controls.sensors","l":"XAnalogInput"},{"p":"xbot.common.controls.sensors","l":"XAnalogInput.XAnalogInputFactory"},{"p":"xbot.common.controls.sensors","l":"XAS5600"},{"p":"xbot.common.controls.sensors","l":"XAS5600.XAS5600Factory"},{"p":"xbot.common.controls","l":"XBaseIO"},{"p":"xbot.common.controls.sensors","l":"XXboxController.XboxButton"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"XboxControllerWpiAdapter"},{"p":"xbot.common.controls.sensors.wpi_adapters","l":"XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory"},{"p":"xbot.common.controls.sensors","l":"XCANCoder"},{"p":"xbot.common.controls.sensors","l":"XCANCoder.XCANCoderFactory"},{"p":"xbot.common.controls.actuators","l":"XCANSparkMax"},{"p":"xbot.common.controls.actuators","l":"XCANSparkMax.XCANSparkMaxFactory"},{"p":"xbot.common.controls.actuators","l":"XCANSparkMaxPIDProperties"},{"p":"xbot.common.controls.actuators","l":"XCANTalon"},{"p":"xbot.common.controls.actuators","l":"XCANTalon.XCANTalonFactory"},{"p":"xbot.common.controls.actuators","l":"XCANVictorSPX"},{"p":"xbot.common.controls.actuators","l":"XCANVictorSPX.XCANVictorSPXFactory"},{"p":"xbot.common.controls.actuators","l":"XCompressor"},{"p":"xbot.common.controls.actuators","l":"XCompressor.XCompressorFactory"},{"p":"xbot.common.controls.sensors","l":"XDigitalInput"},{"p":"xbot.common.controls.sensors","l":"XDigitalInput.XDigitalInputFactory"},{"p":"xbot.common.controls.actuators","l":"XDigitalOutput"},{"p":"xbot.common.controls.actuators","l":"XDigitalOutput.XDigitalOutputFactory"},{"p":"xbot.common.controls.actuators","l":"XDoubleSolenoid"},{"p":"xbot.common.controls.actuators","l":"XDoubleSolenoid.XDoubleSolenoidFactory"},{"p":"xbot.common.controls.sensors","l":"XDutyCycleEncoder"},{"p":"xbot.common.controls.sensors","l":"XDutyCycleEncoder.XDutyCycleEncoderFactory"},{"p":"xbot.common.controls.sensors","l":"XEncoder"},{"p":"xbot.common.controls.sensors","l":"XEncoder.XEncoderFactory"},{"p":"xbot.common.controls.sensors","l":"XFTCGamepad"},{"p":"xbot.common.controls.sensors","l":"XFTCGamepad.XFTCGamepadFactory"},{"p":"xbot.common.controls.sensors","l":"XGyro"},{"p":"xbot.common.controls.sensors","l":"XGyro.XGyroFactory"},{"p":"xbot.common.controls.sensors","l":"XJoystick"},{"p":"xbot.common.controls.sensors","l":"XJoystick.XJoystickFactory"},{"p":"xbot.common.controls.sensors","l":"XLidarLite"},{"p":"xbot.common.controls.sensors","l":"XLidarLite.XLidarLiteFactory"},{"p":"xbot.common.controls.sensors","l":"XPowerDistributionPanel"},{"p":"xbot.common.controls.sensors","l":"XPowerDistributionPanel.XPowerDistributionPanelFactory"},{"p":"xbot.common.properties","l":"XPropertyManager"},{"p":"xbot.common.controls.actuators","l":"XPWM"},{"p":"xbot.common.controls.actuators","l":"XPWM.XPWMFactory"},{"p":"xbot.common.controls.actuators","l":"XRelay"},{"p":"xbot.common.controls.actuators","l":"XRelay.XRelayFactory"},{"p":"xbot.common.subsystems.feedback","l":"XRumbleManager"},{"p":"xbot.common.subsystems.feedback","l":"XRumbleManager.XRumbleManagerFactory"},{"p":"xbot.common.command","l":"XScheduler"},{"p":"xbot.common.controls.actuators","l":"XServo"},{"p":"xbot.common.controls.actuators","l":"XServo.XServoFactory"},{"p":"xbot.common.controls.sensors","l":"XSettableTimerImpl"},{"p":"xbot.common.controls.actuators","l":"XSolenoid"},{"p":"xbot.common.controls.actuators","l":"XSolenoid.XSolenoidFactory"},{"p":"xbot.common.controls.actuators","l":"XSpeedController"},{"p":"xbot.common.controls.actuators","l":"XSpeedController.XSpeedControllerFactory"},{"p":"xbot.common.controls.sensors","l":"XTimer"},{"p":"xbot.common.controls.sensors","l":"XTimerImpl"},{"p":"xbot.common.controls.sensors","l":"XXboxController"},{"p":"xbot.common.controls.sensors","l":"XXboxController.XXboxControllerFactory"},{"p":"xbot.common.math","l":"XYPair"},{"p":"xbot.common.networking","l":"XZeromqListener"},{"p":"xbot.common.networking","l":"XZeromqListener.XZeromqListenerFactory"},{"p":"xbot.common.networking","l":"ZeromqListener"},{"p":"xbot.common.networking","l":"ZeromqListener.ZeromqListenerFactory"}] \ No newline at end of file diff --git a/javadoc/type-search-index.zip b/javadoc/type-search-index.zip new file mode 100644 index 00000000..12fa44e0 Binary files /dev/null and b/javadoc/type-search-index.zip differ diff --git a/javadoc/xbot/common/command/BaseCommand.html b/javadoc/xbot/common/command/BaseCommand.html new file mode 100644 index 00000000..77938b2c --- /dev/null +++ b/javadoc/xbot/common/command/BaseCommand.html @@ -0,0 +1,540 @@ + + + + + +BaseCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class BaseCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • edu.wpi.first.wpilibj2.command.CommandBase
        • +
      • +
          +
        • xbot.common.command.BaseCommand
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected org.apache.log4j.Loggerlog 
        protected TimeLoggermonitor 
        +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        BaseCommand() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
        Modifier and TypeMethodDescription
        abstract voidexecute() 
        java.lang.StringgetPrefix() 
        voidincludeOnSmartDashboard() 
        voidincludeOnSmartDashboard​(java.lang.String label) 
        abstract voidinitialize() 
        voidrequires​(BaseSubsystem subsystem) +
        Deprecated. +
        Suggest use CommandBase.addRequirements(edu.wpi.first.wpilibj2.command.Subsystem...) instead.
        +
        +
        booleanrunsWhenDisabled() 
        voidsetRunsWhenDisabled​(boolean value) 
        +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isFinished, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          log

          +
          protected org.apache.log4j.Logger log
          +
          • +
        + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BaseCommand

          +
          public BaseCommand()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          runsWhenDisabled

          +
          public boolean runsWhenDisabled()
          +
          +
          Specified by:
          +
          runsWhenDisabled in interface edu.wpi.first.wpilibj2.command.Command
          +
          +
          • +
        + + + +
          +
        • +

          setRunsWhenDisabled

          +
          public void setRunsWhenDisabled​(boolean value)
          +
          • +
        + + + + + + + +
          +
        • +

          initialize

          +
          public abstract void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public abstract void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          +
          • +
        + + + +
          +
        • +

          includeOnSmartDashboard

          +
          public void includeOnSmartDashboard()
          +
          • +
        + + + +
          +
        • +

          includeOnSmartDashboard

          +
          public void includeOnSmartDashboard​(java.lang.String label)
          +
          • +
        + + + +
          +
        • +

          requires

          +
          @Deprecated
+public void requires​(BaseSubsystem subsystem)
          +
          Deprecated. +
          Suggest use CommandBase.addRequirements(edu.wpi.first.wpilibj2.command.Subsystem...) instead.
          +
          +
          +
          Parameters:
          +
          subsystem - Requirement to add
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/BaseMaintainerCommand.html b/javadoc/xbot/common/command/BaseMaintainerCommand.html new file mode 100644 index 00000000..3e5e29ca --- /dev/null +++ b/javadoc/xbot/common/command/BaseMaintainerCommand.html @@ -0,0 +1,751 @@ + + + + + +BaseMaintainerCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class BaseMaintainerCommand<T>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public abstract class BaseMaintainerCommand<T>
+extends BaseCommand
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          resetDecider

          +
          protected void resetDecider​(boolean startInAutomaticMode)
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          maintain

          +
          protected void maintain()
          +
          Contains all the logic associated with keeping the subsystem + at its goal.
          +
          • +
        + + + +
          +
        • +

          coastAction

          +
          protected abstract void coastAction()
          +
          • +
        + + + +
          +
        • +

          humanControlAction

          +
          protected void humanControlAction()
          +
          • +
        + + + +
          +
        • +

          initializeMachineControlAction

          +
          protected void initializeMachineControlAction()
          +
          • +
        + + + +
          +
        • +

          calibratedMachineControlAction

          +
          protected abstract void calibratedMachineControlAction()
          +
          • +
        + + + +
          +
        • +

          uncalibratedMachineControlAction

          +
          protected void uncalibratedMachineControlAction()
          +
          • +
        + + + +
          +
        • +

          isMaintainerAtGoal

          +
          protected boolean isMaintainerAtGoal()
          +
          • +
        + + + +
          +
        • +

          additionalAtGoalChecks

          +
          protected boolean additionalAtGoalChecks()
          +
          Maintainer systems already check for error tolerance and time stability. If + there + are any other checks that should be made, override this method and place them + here.
          +
          +
          Returns:
          +
          true by default, can be overridden by child classes.
          +
          +
          • +
        + + + +
          +
        • +

          getErrorWithinTolerance

          +
          protected boolean getErrorWithinTolerance()
          +
          Performs a simple difference between goal and target in order to see if we + are close. + if your subsystem needs to do something more complicated (for example, if you + needed to + compute difference via a ContiguousDouble) then override this method with a + better + computation.
          +
          • +
        + + + +
          +
        • +

          getErrorMagnitude

          +
          protected abstract double getErrorMagnitude()
          +
          • +
        + + + +
          +
        • +

          getHumanInput

          +
          protected abstract T getHumanInput()
          +
          • +
        + + + +
          +
        • +

          getHumanInputMagnitude

          +
          protected abstract double getHumanInputMagnitude()
          +
          • +
        + + + + + + + +
          +
        • +

          setErrorTolerance

          +
          protected void setErrorTolerance​(double tolerance)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/BaseRobot.html b/javadoc/xbot/common/command/BaseRobot.html new file mode 100644 index 00000000..11174854 --- /dev/null +++ b/javadoc/xbot/common/command/BaseRobot.html @@ -0,0 +1,889 @@ + + + + + +BaseRobot (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class BaseRobot

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • edu.wpi.first.wpilibj.RobotBase
        • +
      • +
          +
        • edu.wpi.first.wpilibj.IterativeRobotBase
          • +
        • +
            +
          • edu.wpi.first.wpilibj.TimedRobot
            • +
          • +
              +
            • xbot.common.command.BaseRobot
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.AutoCloseable
      +
      +
      +
      public abstract class BaseRobot
+extends edu.wpi.first.wpilibj.TimedRobot
      +
      Core Robot class which configures logging, properties, + scheduling, and the injector. Required for a fair amount + of CommonLib functionality.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + + + + + +
          +
        • +

          xScheduler

          +
          protected XScheduler xScheduler
          +
          • +
        + + + +
          +
        • +

          autonomousCommand

          +
          protected edu.wpi.first.wpilibj2.command.Command autonomousCommand
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          frequencyReportInterval

          +
          protected DoubleProperty frequencyReportInterval
          +
          • +
        + + + +
          +
        • +

          lastFreqCounterResetTime

          +
          protected double lastFreqCounterResetTime
          +
          • +
        + + + +
          +
        • +

          loopCycleCounter

          +
          protected int loopCycleCounter
          +
          • +
        + + + + + + + + + + + + + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BaseRobot

          +
          public BaseRobot()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          loopFunc

          +
          protected void loopFunc()
          +
          +
          Overrides:
          +
          loopFunc in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          getPeriod

          +
          public double getPeriod()
          +
          +
          Overrides:
          +
          getPeriod in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          setupInjectionModule

          +
          protected void setupInjectionModule()
          +
          Override if you need a different module
          +
          • +
        + + + +
          +
        • +

          createDaggerComponent

          +
          protected abstract BaseComponent createDaggerComponent()
          +
          Returns the BaseComponent instance used for dependency injection
          +
          • +
        + + + +
          +
        • +

          getInjectorComponent

          +
          protected BaseComponent getInjectorComponent()
          +
          Get the dependency injection component
          +
          +
          Returns:
          +
          an implementation of BaseComponent that will be used throughout the robot.
          +
          +
          • +
        + + + +
          +
        • +

          robotInit

          +
          public void robotInit()
          +
          This function is run when the robot is first started up and should be used for any initialization code.
          +
          +
          Overrides:
          +
          robotInit in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          getEnableTypeString

          +
          protected java.lang.String getEnableTypeString()
          +
          • +
        + + + +
          +
        • +

          updateLoggingContext

          +
          protected void updateLoggingContext()
          +
          • +
        + + + +
          +
        • +

          initializeSystems

          +
          protected void initializeSystems()
          +
          • +
        + + + +
          +
        • +

          disabledInit

          +
          public void disabledInit()
          +
          +
          Overrides:
          +
          disabledInit in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          disabledPeriodic

          +
          public void disabledPeriodic()
          +
          +
          Overrides:
          +
          disabledPeriodic in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          getMatchContextString

          +
          protected java.lang.String getMatchContextString()
          +
          • +
        + + + +
          +
        • +

          autonomousInit

          +
          public void autonomousInit()
          +
          +
          Overrides:
          +
          autonomousInit in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          autonomousPeriodic

          +
          public void autonomousPeriodic()
          +
          This function is called periodically during autonomous
          +
          +
          Overrides:
          +
          autonomousPeriodic in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          teleopInit

          +
          public void teleopInit()
          +
          +
          Overrides:
          +
          teleopInit in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          teleopPeriodic

          +
          public void teleopPeriodic()
          +
          This function is called periodically during operator control
          +
          +
          Overrides:
          +
          teleopPeriodic in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          testPeriodic

          +
          public void testPeriodic()
          +
          This function is called periodically during test mode
          +
          +
          Overrides:
          +
          testPeriodic in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          sharedPeriodic

          +
          protected void sharedPeriodic()
          +
          • +
        + + + +
          +
        • +

          simulationInit

          +
          public void simulationInit()
          +
          +
          Overrides:
          +
          simulationInit in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        + + + +
          +
        • +

          simulationPeriodic

          +
          public void simulationPeriodic()
          +
          +
          Overrides:
          +
          simulationPeriodic in class edu.wpi.first.wpilibj.IterativeRobotBase
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/BaseSetpointCommand.html b/javadoc/xbot/common/command/BaseSetpointCommand.html new file mode 100644 index 00000000..35a46a9b --- /dev/null +++ b/javadoc/xbot/common/command/BaseSetpointCommand.html @@ -0,0 +1,380 @@ + + + + + +BaseSetpointCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class BaseSetpointCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public abstract class BaseSetpointCommand
+extends BaseCommand
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanisFinished() 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/BaseSetpointSubsystem.html b/javadoc/xbot/common/command/BaseSetpointSubsystem.html new file mode 100644 index 00000000..0baea6f7 --- /dev/null +++ b/javadoc/xbot/common/command/BaseSetpointSubsystem.html @@ -0,0 +1,495 @@ + + + + + +BaseSetpointSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class BaseSetpointSubsystem<T>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected booleanatGoal 
        + +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        abstract TgetCurrentValue() 
        edu.wpi.first.wpilibj2.command.SubsystemgetSetpointLock() 
        abstract TgetTargetValue() 
        abstract booleanisCalibrated() 
        booleanisMaintainerAtGoal() 
        voidsetMaintainerIsAtGoal​(boolean atGoal) 
        abstract voidsetPower​(T power) 
        abstract voidsetTargetValue​(T value) 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.SubsystemBase

          +addChild, getName, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Subsystem

          +getCurrentCommand, getDefaultCommand, periodic, register, removeDefaultCommand, run, runEnd, runOnce, setDefaultCommand, simulationPeriodic, startEnd
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          atGoal

          +
          protected boolean atGoal
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BaseSetpointSubsystem

          +
          public BaseSetpointSubsystem()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          isMaintainerAtGoal

          +
          public boolean isMaintainerAtGoal()
          +
          • +
        + + + +
          +
        • +

          setMaintainerIsAtGoal

          +
          public void setMaintainerIsAtGoal​(boolean atGoal)
          +
          • +
        + + + +
          +
        • +

          getCurrentValue

          +
          public abstract T getCurrentValue()
          +
          • +
        + + + +
          +
        • +

          getTargetValue

          +
          public abstract T getTargetValue()
          +
          • +
        + + + + + +
          +
        • +

          setTargetValue

          +
          public abstract void setTargetValue​(T value)
          +
          • +
        + + + + + +
          +
        • +

          setPower

          +
          public abstract void setPower​(T power)
          +
          • +
        + + + +
          +
        • +

          isCalibrated

          +
          public abstract boolean isCalibrated()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/BaseSubsystem.html b/javadoc/xbot/common/command/BaseSubsystem.html new file mode 100644 index 00000000..05a43da0 --- /dev/null +++ b/javadoc/xbot/common/command/BaseSubsystem.html @@ -0,0 +1,378 @@ + + + + + +BaseSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class BaseSubsystem

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • edu.wpi.first.wpilibj2.command.SubsystemBase
        • +
      • +
          +
        • xbot.common.command.BaseSubsystem
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected org.apache.log4j.Loggerlog 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        BaseSubsystem() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringgetPrefix() 
        +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.SubsystemBase

          +addChild, getName, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Subsystem

          +getCurrentCommand, getDefaultCommand, periodic, register, removeDefaultCommand, run, runEnd, runOnce, setDefaultCommand, simulationPeriodic, startEnd
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          log

          +
          protected org.apache.log4j.Logger log
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BaseSubsystem

          +
          public BaseSubsystem()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/BaseWaitForMaintainerCommand.html b/javadoc/xbot/common/command/BaseWaitForMaintainerCommand.html new file mode 100644 index 00000000..ee43ef6c --- /dev/null +++ b/javadoc/xbot/common/command/BaseWaitForMaintainerCommand.html @@ -0,0 +1,425 @@ + + + + + +BaseWaitForMaintainerCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class BaseWaitForMaintainerCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public abstract class BaseWaitForMaintainerCommand
+extends BaseCommand
      +
      Command that waits for a setpoint subsystem to reach its goal
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute() 
        voidinitialize() 
        booleanisFinished() 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          initialize in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/DelayViaSupplierCommand.html b/javadoc/xbot/common/command/DelayViaSupplierCommand.html new file mode 100644 index 00000000..ced1349f --- /dev/null +++ b/javadoc/xbot/common/command/DelayViaSupplierCommand.html @@ -0,0 +1,466 @@ + + + + + +DelayViaSupplierCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class DelayViaSupplierCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public class DelayViaSupplierCommand
+extends BaseCommand
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected java.util.function.Supplier<java.lang.Double>delaySupplier 
        protected doublestartTime 
        + +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        DelayViaSupplierCommand​(java.util.function.Supplier<java.lang.Double> delaySupplier) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute() 
        voidinitialize() 
        booleanisFinished() 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          startTime

          +
          protected double startTime
          +
          • +
        + + + +
          +
        • +

          delaySupplier

          +
          protected java.util.function.Supplier<java.lang.Double> delaySupplier
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DelayViaSupplierCommand

          +
          public DelayViaSupplierCommand​(java.util.function.Supplier<java.lang.Double> delaySupplier)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          initialize in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/MockSmartDashboardCommandPutter.html b/javadoc/xbot/common/command/MockSmartDashboardCommandPutter.html new file mode 100644 index 00000000..65ba7344 --- /dev/null +++ b/javadoc/xbot/common/command/MockSmartDashboardCommandPutter.html @@ -0,0 +1,334 @@ + + + + + +MockSmartDashboardCommandPutter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class MockSmartDashboardCommandPutter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.command.MockSmartDashboardCommandPutter
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/NamedInstantCommand.html b/javadoc/xbot/common/command/NamedInstantCommand.html new file mode 100644 index 00000000..441b5e0d --- /dev/null +++ b/javadoc/xbot/common/command/NamedInstantCommand.html @@ -0,0 +1,353 @@ + + + + + +NamedInstantCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class NamedInstantCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • edu.wpi.first.wpilibj2.command.CommandBase
        • +
      • +
          +
        • edu.wpi.first.wpilibj2.command.FunctionalCommand
          • +
        • +
            +
          • edu.wpi.first.wpilibj2.command.InstantCommand
            • +
          • +
              +
            • xbot.common.command.NamedInstantCommand
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command
      +
      +
      +
      public class NamedInstantCommand
+extends edu.wpi.first.wpilibj2.command.InstantCommand
      +
      Convenience wrapper of InstantCommand that allows setting a human readable name for + smartdashboard/logging readability.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.FunctionalCommand

          +m_isFinished, m_onEnd, m_onExecute, m_onInit
          • +
        +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        NamedInstantCommand​(java.lang.String name, + java.lang.Runnable toRun, + edu.wpi.first.wpilibj2.command.Subsystem... requirements) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.FunctionalCommand

          +end, execute, initialize, isFinished
          • +
        +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, runsWhenDisabled, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NamedInstantCommand

          +
          public NamedInstantCommand​(java.lang.String name,
+                           java.lang.Runnable toRun,
+                           edu.wpi.first.wpilibj2.command.Subsystem... requirements)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/NamedRunCommand.html b/javadoc/xbot/common/command/NamedRunCommand.html new file mode 100644 index 00000000..23545592 --- /dev/null +++ b/javadoc/xbot/common/command/NamedRunCommand.html @@ -0,0 +1,427 @@ + + + + + +NamedRunCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class NamedRunCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • edu.wpi.first.wpilibj2.command.CommandBase
        • +
      • +
          +
        • edu.wpi.first.wpilibj2.command.FunctionalCommand
          • +
        • +
            +
          • edu.wpi.first.wpilibj2.command.RunCommand
            • +
          • +
              +
            • xbot.common.command.NamedRunCommand
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command
      +
      +
      +
      public class NamedRunCommand
+extends edu.wpi.first.wpilibj2.command.RunCommand
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected org.apache.log4j.Loggerlog 
        +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.FunctionalCommand

          +m_isFinished, m_onEnd, m_onExecute, m_onInit
          • +
        +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        NamedRunCommand​(java.lang.String name, + java.lang.Runnable toRun, + edu.wpi.first.wpilibj2.command.Subsystem... requirements) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidinitialize() 
        +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.FunctionalCommand

          +end, execute, isFinished
          • +
        +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, runsWhenDisabled, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          log

          +
          protected org.apache.log4j.Logger log
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NamedRunCommand

          +
          public NamedRunCommand​(java.lang.String name,
+                       java.lang.Runnable toRun,
+                       edu.wpi.first.wpilibj2.command.Subsystem... requirements)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Overrides:
          +
          initialize in class edu.wpi.first.wpilibj2.command.FunctionalCommand
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/RealSmartDashboardCommandPutter.html b/javadoc/xbot/common/command/RealSmartDashboardCommandPutter.html new file mode 100644 index 00000000..57fdc86f --- /dev/null +++ b/javadoc/xbot/common/command/RealSmartDashboardCommandPutter.html @@ -0,0 +1,334 @@ + + + + + +RealSmartDashboardCommandPutter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class RealSmartDashboardCommandPutter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.command.RealSmartDashboardCommandPutter
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/SimpleWaitForMaintainerCommand.html b/javadoc/xbot/common/command/SimpleWaitForMaintainerCommand.html new file mode 100644 index 00000000..2fa674d2 --- /dev/null +++ b/javadoc/xbot/common/command/SimpleWaitForMaintainerCommand.html @@ -0,0 +1,422 @@ + + + + + +SimpleWaitForMaintainerCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class SimpleWaitForMaintainerCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public class SimpleWaitForMaintainerCommand
+extends BaseCommand
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute() 
        voidinitialize() 
        booleanisFinished() 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SimpleWaitForMaintainerCommand

          +
          public SimpleWaitForMaintainerCommand​(BaseSetpointSubsystem subsystem,
+                                      java.util.function.Supplier<java.lang.Double> delaySupplier)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          initialize in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/SmartDashboardCommandPutter.html b/javadoc/xbot/common/command/SmartDashboardCommandPutter.html new file mode 100644 index 00000000..d81ed0c2 --- /dev/null +++ b/javadoc/xbot/common/command/SmartDashboardCommandPutter.html @@ -0,0 +1,268 @@ + + + + + +SmartDashboardCommandPutter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Interface SmartDashboardCommandPutter

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          addCommandToSmartDashboard

          +
          void addCommandToSmartDashboard​(BaseCommand command)
          +
          • +
        + + + +
          +
        • +

          addCommandToSmartDashboard

          +
          void addCommandToSmartDashboard​(java.lang.String label,
+                                BaseCommand command)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/command/SupportsSetpointLock.html b/javadoc/xbot/common/command/SupportsSetpointLock.html new file mode 100644 index 00000000..135dd3b6 --- /dev/null +++ b/javadoc/xbot/common/command/SupportsSetpointLock.html @@ -0,0 +1,252 @@ + + + + + +SupportsSetpointLock (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Interface SupportsSetpointLock

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      BaseSetpointSubsystem
      +
      +
      +
      public interface SupportsSetpointLock
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSetpointLock

          +
          edu.wpi.first.wpilibj2.command.Subsystem getSetpointLock()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/command/XScheduler.html b/javadoc/xbot/common/command/XScheduler.html new file mode 100644 index 00000000..0f8719a0 --- /dev/null +++ b/javadoc/xbot/common/command/XScheduler.html @@ -0,0 +1,365 @@ + + + + + +XScheduler (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.command
    +

    Class XScheduler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.command.XScheduler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Singleton
+public class XScheduler
+extends java.lang.Object
      +
      Wrapper for base Scheduler which intelligently manages exceptions.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        XScheduler() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        intgetNumberOfCrashes() 
        voidregisterSubsystem​(edu.wpi.first.wpilibj2.command.Subsystem... subsystems) 
        voidremoveAll() 
        voidrun() 
        voidsetDefaultCommand​(edu.wpi.first.wpilibj2.command.Subsystem subsystem, + edu.wpi.first.wpilibj2.command.Command defaultCommand) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          XScheduler

          +
          @Inject
+public XScheduler()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getNumberOfCrashes

          +
          public int getNumberOfCrashes()
          +
          • +
        + + + +
          +
        • +

          run

          +
          public void run()
          +
          • +
        + + + +
          +
        • +

          removeAll

          +
          public void removeAll()
          +
          • +
        + + + +
          +
        • +

          registerSubsystem

          +
          public void registerSubsystem​(edu.wpi.first.wpilibj2.command.Subsystem... subsystems)
          +
          • +
        + + + +
          +
        • +

          setDefaultCommand

          +
          public void setDefaultCommand​(edu.wpi.first.wpilibj2.command.Subsystem subsystem,
+                              edu.wpi.first.wpilibj2.command.Command defaultCommand)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/command/package-summary.html b/javadoc/xbot/common/command/package-summary.html new file mode 100644 index 00000000..5840028e --- /dev/null +++ b/javadoc/xbot/common/command/package-summary.html @@ -0,0 +1,248 @@ + + + + + +xbot.common.command (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.command

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/command/package-tree.html b/javadoc/xbot/common/command/package-tree.html new file mode 100644 index 00000000..f819eff0 --- /dev/null +++ b/javadoc/xbot/common/command/package-tree.html @@ -0,0 +1,219 @@ + + + + + +xbot.common.command Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.command

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/controls/XBaseIO.html b/javadoc/xbot/common/controls/XBaseIO.html new file mode 100644 index 00000000..8ce799e9 --- /dev/null +++ b/javadoc/xbot/common/controls/XBaseIO.html @@ -0,0 +1,252 @@ + + + + + +XBaseIO (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls
    +

    Interface XBaseIO

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getChannel

          +
          int getChannel()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XCANSparkMax.XCANSparkMaxFactory.html b/javadoc/xbot/common/controls/actuators/XCANSparkMax.XCANSparkMaxFactory.html new file mode 100644 index 00000000..41b7cf2c --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XCANSparkMax.XCANSparkMaxFactory.html @@ -0,0 +1,354 @@ + + + + + +XCANSparkMax.XCANSparkMaxFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XCANSparkMax.XCANSparkMaxFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XCANSparkMax.XCANSparkMaxFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XCANSparkMaxFactory

          +
          public XCANSparkMaxFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          create

          +
          public XCANSparkMax create​(DeviceInfo deviceInfo,
+                           java.lang.String owningSystemPrefix,
+                           java.lang.String name)
          +
          • +
        + + + +
          +
        • +

          createWithoutProperties

          +
          public XCANSparkMax createWithoutProperties​(DeviceInfo deviceInfo,
+                                            java.lang.String owningSystemPrefix,
+                                            java.lang.String name)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XCANSparkMax.html b/javadoc/xbot/common/controls/actuators/XCANSparkMax.html new file mode 100644 index 00000000..886aa17e --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XCANSparkMax.html @@ -0,0 +1,2477 @@ + + + + + +XCANSparkMax (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XCANSparkMax

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XCANSparkMax
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        abstract com.revrobotics.REVLibErrorburnFlash() +
        Writes all settings to flash.
        +
        abstract com.revrobotics.REVLibErrorclearFaults() +
        Clears all sticky faults.
        +
        abstract voiddisable() +
        Common interface for disabling a motor.
        +
        abstract com.revrobotics.REVLibErrordisableVoltageCompensation() +
        Disables the voltage compensation setting for all modes on the SPARK MAX.
        +
        abstract com.revrobotics.REVLibErrorenableSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction, + boolean enable) +
        Enable soft limits
        +
        abstract com.revrobotics.REVLibErrorenableVoltageCompensation​(double nominalVoltage) +
        Sets the voltage compensation setting for all modes on the SPARK MAX and + enables voltage compensation.
        +
        abstract com.revrobotics.REVLibErrorfollow​(com.revrobotics.CANSparkMax.ExternalFollower leader, + int deviceID) +
        Causes this controller's output to mirror the provided leader.
        +
        abstract com.revrobotics.REVLibErrorfollow​(com.revrobotics.CANSparkMax.ExternalFollower leader, + int deviceID, + boolean invert) +
        Causes this controller's output to mirror the provided leader.
        +
        abstract com.revrobotics.REVLibErrorfollow​(XCANSparkMax leader) +
        Causes this controller's output to mirror the provided leader.
        +
        abstract com.revrobotics.REVLibErrorfollow​(XCANSparkMax leader, + boolean invert) +
        Causes this controller's output to mirror the provided leader.
        +
        abstract doubleget() +
        Common interface for getting the current set speed of a speed controller.
        +
        abstract doublegetAppliedOutput() 
        abstract intgetAverageDepth() 
        abstract doublegetBusVoltage() 
        abstract doublegetClosedLoopRampRate() +
        Get the configured closed loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
        +
        abstract intgetCountsPerRevolution() 
        abstract doublegetD() 
        abstract doublegetD​(int slotID) 
        abstract doublegetDFilter​(int slotID) 
        abstract booleangetFault​(com.revrobotics.CANSparkMax.FaultID faultID) +
        Get the value of a specific fault
        +
        abstract shortgetFaults() 
        abstract doublegetFF() 
        abstract doublegetFF​(int slotID) 
        abstract booleangetForwardLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType) 
        abstract doublegetI() 
        abstract doublegetI​(int slotID) 
        abstract doublegetIAccum() 
        abstract com.revrobotics.CANSparkMax.IdleModegetIdleMode() +
        Gets the idle mode setting for the SPARK MAX.
        +
        abstract doublegetIMaxAccum​(int slotID) 
        abstract com.revrobotics.CANSparkMaxgetInternalSparkMax() 
        abstract booleangetInverted() +
        Common interface for returning the inversion state of a speed controller.
        +
        abstract doublegetIZone() 
        abstract doublegetIZone​(int slotID) 
        abstract com.revrobotics.REVLibErrorgetLastError() +
        All device errors are tracked on a per thread basis for all devices in that + thread.
        +
        abstract intgetMeasurementPeriod() 
        abstract doublegetMotorTemperature() 
        abstract doublegetOpenLoopRampRate() +
        Get the configured open loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
        +
        abstract doublegetOutputCurrent() 
        abstract doublegetOutputMax() 
        abstract doublegetOutputMax​(int slotID) 
        abstract doublegetOutputMin() 
        abstract doublegetOutputMin​(int slotID) 
        abstract doublegetP() 
        abstract doublegetP​(int slotID) 
        abstract doublegetPosition() 
        abstract doublegetPositionConversionFactor() 
        java.lang.StringgetPrefix() 
        abstract booleangetReverseLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType) 
        abstract doublegetSmartMotionAllowedClosedLoopError​(int slotID) 
        abstract doublegetSmartMotionMaxAccel​(int slotID) 
        abstract doublegetSmartMotionMaxVelocity​(int slotID) 
        abstract doublegetSmartMotionMinOutputVelocity​(int slotID) 
        abstract doublegetSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction) +
        Get the soft limit setting in the controller
        +
        abstract booleangetStickyFault​(com.revrobotics.CANSparkMax.FaultID faultID) +
        Get the value of a specific sticky fault
        +
        abstract shortgetStickyFaults() 
        abstract doublegetVelocity() 
        abstract doublegetVelocityConversionFactor() 
        abstract doublegetVoltageCompensationNominalVoltage() +
        Get the configured voltage compensation nominal voltage value
        +
        abstract booleanisFollower() +
        Returns whether the controller is following another controller
        +
        abstract booleanisSoftLimitEnabled​(com.revrobotics.CANSparkMax.SoftLimitDirection direction) 
        voidperiodic() 
        abstract com.revrobotics.REVLibErrorrestoreFactoryDefaults() 
        abstract voidset​(double speed) +
        Common interface for setting the speed of a speed controller.
        +
        abstract com.revrobotics.REVLibErrorsetAverageDepth​(int depth) 
        abstract com.revrobotics.REVLibErrorsetCANTimeout​(int milliseconds) +
        Sets timeout for sending CAN messages with SetParameter* and GetParameter* + calls.
        +
        abstract com.revrobotics.REVLibErrorsetClosedLoopRampRate​(double rate) +
        Sets the ramp rate for closed loop control modes.
        +
        abstract com.revrobotics.REVLibErrorsetD​(double gain) 
        abstract com.revrobotics.REVLibErrorsetD​(double gain, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetDFilter​(double gain) 
        abstract com.revrobotics.REVLibErrorsetDFilter​(double gain, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetEncoderInverted​(boolean inverted) 
        abstract com.revrobotics.REVLibErrorsetFF​(double gain) 
        abstract com.revrobotics.REVLibErrorsetFF​(double gain, + int slotID) 
        abstract voidsetForwardLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType, + boolean enabled) 
        abstract com.revrobotics.REVLibErrorsetI​(double gain) 
        abstract com.revrobotics.REVLibErrorsetI​(double gain, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetIAccum​(double iAccum) 
        abstract com.revrobotics.REVLibErrorsetIdleMode​(com.revrobotics.CANSparkMax.IdleMode mode) +
        Sets the idle mode setting for the SPARK MAX.
        +
        abstract com.revrobotics.REVLibErrorsetIMaxAccum​(double iMaxAccum, + int slotID) 
        abstract voidsetInverted​(boolean isInverted) +
        Common interface for inverting direction of a speed controller.
        +
        abstract com.revrobotics.REVLibErrorsetIZone​(double iZone) 
        abstract com.revrobotics.REVLibErrorsetIZone​(double iZone, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetMeasurementPeriod​(int period_us) 
        abstract com.revrobotics.REVLibErrorsetOpenLoopRampRate​(double rate) +
        Sets the ramp rate for open loop control modes.
        +
        abstract com.revrobotics.REVLibErrorsetOutputRange​(double min, + double max) 
        abstract com.revrobotics.REVLibErrorsetOutputRange​(double min, + double max, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetP​(double gain) 
        abstract com.revrobotics.REVLibErrorsetP​(double gain, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetPosition​(double position) 
        abstract com.revrobotics.REVLibErrorsetPositionConversionFactor​(double factor) 
        abstract com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl) 
        abstract com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl, + int pidSlot) 
        abstract com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl, + int pidSlot, + double arbFeedforward) 
        abstract com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl, + int pidSlot, + double arbFeedforward, + com.revrobotics.SparkMaxPIDController.ArbFFUnits arbFFUnits) 
        abstract voidsetReverseLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType, + boolean enabled) 
        abstract com.revrobotics.REVLibErrorsetSecondaryCurrentLimit​(double limit) +
        Sets the secondary current limit in Amps.
        +
        abstract com.revrobotics.REVLibErrorsetSecondaryCurrentLimit​(double limit, + int chopCycles) +
        Sets the secondary current limit in Amps.
        +
        abstract com.revrobotics.REVLibErrorsetSmartCurrentLimit​(int limit) +
        Sets the current limit in Amps.
        +
        abstract com.revrobotics.REVLibErrorsetSmartCurrentLimit​(int stallLimit, + int freeLimit) +
        Sets the current limit in Amps.
        +
        abstract com.revrobotics.REVLibErrorsetSmartCurrentLimit​(int stallLimit, + int freeLimit, + int limitRPM) +
        Sets the current limit in Amps.
        +
        abstract com.revrobotics.REVLibErrorsetSmartMotionAllowedClosedLoopError​(double allowedErr, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetSmartMotionMaxAccel​(double maxAccel, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetSmartMotionMaxVelocity​(double maxVel, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetSmartMotionMinOutputVelocity​(double minVel, + int slotID) 
        abstract com.revrobotics.REVLibErrorsetSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction, + float limit) +
        Set the soft limit based on position.
        +
        abstract com.revrobotics.REVLibErrorsetVelocityConversionFactor​(double factor) 
        abstract voidsetVoltage​(double outputVolts) +
        Sets the voltage output of the SpeedController.
        +
        abstract voidstopMotor() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          deviceId

          +
          protected int deviceId
          +
          • +
        + + + +
          +
        • +

          prefix

          +
          protected java.lang.String prefix
          +
          • +
        + + + +
          +
        • +

          usesPropertySystem

          +
          protected boolean usesPropertySystem
          +
          • +
        + + + +
          +
        • +

          policeTicket

          +
          protected final java.lang.String policeTicket
          +
          • +
        + + + +
          +
        • +

          firstPeriodicCall

          +
          protected boolean firstPeriodicCall
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPrefix

          +
          public java.lang.String getPrefix()
          +
          • +
        + + + +
          +
        • +

          periodic

          +
          public void periodic()
          +
          • +
        + + + +
          +
        • +

          set

          +
          public abstract void set​(double speed)
          +
          Common interface for setting the speed of a speed controller.
          +
          +
          Parameters:
          +
          speed - The speed to set. Value should be between -1.0 and 1.0.
          +
          +
          • +
        + + + +
          +
        • +

          setVoltage

          +
          public abstract void setVoltage​(double outputVolts)
          +
          Sets the voltage output of the SpeedController. This is equivillant to a call + to SetReference(output, rev::ControlType::kVoltage). The behavior of this + call differs slightly from the WPILib documetation for this call since the + device internally sets the desired voltage (not a compensation value). That + means that this *can* be a 'set-and-forget' call.
          +
          +
          Parameters:
          +
          outputVolts - The voltage to output.
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public abstract double get()
          +
          Common interface for getting the current set speed of a speed controller.
          +
          +
          Returns:
          +
          The current set speed. Value is between -1.0 and 1.0.
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public abstract void setInverted​(boolean isInverted)
          +
          Common interface for inverting direction of a speed controller. + + This call has no effect if the controller is a follower.
          +
          +
          Parameters:
          +
          isInverted - The state of inversion, true is inverted.
          +
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public abstract boolean getInverted()
          +
          Common interface for returning the inversion state of a speed controller. + + This call has no effect if the controller is a follower.
          +
          +
          Returns:
          +
          isInverted The state of inversion, true is inverted.
          +
          +
          • +
        + + + +
          +
        • +

          disable

          +
          public abstract void disable()
          +
          Common interface for disabling a motor.
          +
          • +
        + + + +
          +
        • +

          stopMotor

          +
          public abstract void stopMotor()
          +
          • +
        + + + +
          +
        • +

          setSmartCurrentLimit

          +
          public abstract com.revrobotics.REVLibError setSmartCurrentLimit​(int limit)
          +
          Sets the current limit in Amps. + + The motor controller will reduce the controller voltage output to avoid + surpassing this limit. This limit is enabled by default and used for + brushless only. This limit is highly recommended when using the NEO brushless + motor. + + The NEO Brushless Motor has a low internal resistance, which can mean large + current spikes that could be enough to cause damage to the motor and + controller. This current limit provides a smarter strategy to deal with high + current draws and keep the motor and controller operating in a safe region.
          +
          +
          Parameters:
          +
          limit - The current limit in Amps.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSmartCurrentLimit

          +
          public abstract com.revrobotics.REVLibError setSmartCurrentLimit​(int stallLimit,
+                                                                 int freeLimit)
          +
          Sets the current limit in Amps. + + The motor controller will reduce the controller voltage output to avoid + surpassing this limit. This limit is enabled by default and used for + brushless only. This limit is highly recommended when using the NEO brushless + motor. + + The NEO Brushless Motor has a low internal resistance, which can mean large + current spikes that could be enough to cause damage to the motor and + controller. This current limit provides a smarter strategy to deal with high + current draws and keep the motor and controller operating in a safe region. + + The controller can also limit the current based on the RPM of the motor in a + linear fashion to help with controllability in closed loop control. For a + response that is linear the entire RPM range leave limit RPM at 0.
          +
          +
          Parameters:
          +
          stallLimit - The current limit in Amps at 0 RPM.
          +
          freeLimit - The current limit at free speed (5700RPM for NEO).
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSmartCurrentLimit

          +
          public abstract com.revrobotics.REVLibError setSmartCurrentLimit​(int stallLimit,
+                                                                 int freeLimit,
+                                                                 int limitRPM)
          +
          Sets the current limit in Amps. + + The motor controller will reduce the controller voltage output to avoid + surpassing this limit. This limit is enabled by default and used for + brushless only. This limit is highly recommended when using the NEO brushless + motor. + + The NEO Brushless Motor has a low internal resistance, which can mean large + current spikes that could be enough to cause damage to the motor and + controller. This current limit provides a smarter strategy to deal with high + current draws and keep the motor and controller operating in a safe region. + + The controller can also limit the current based on the RPM of the motor in a + linear fashion to help with controllability in closed loop control. For a + response that is linear the entire RPM range leave limit RPM at 0.
          +
          +
          Parameters:
          +
          stallLimit - The current limit in Amps at 0 RPM.
          +
          freeLimit - The current limit at free speed (5700RPM for NEO).
          +
          limitRPM - RPM less than this value will be set to the stallLimit, RPM + values greater than limitRPM will scale linearly to + freeLimit
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSecondaryCurrentLimit

          +
          public abstract com.revrobotics.REVLibError setSecondaryCurrentLimit​(double limit)
          +
          Sets the secondary current limit in Amps. + + The motor controller will disable the output of the controller briefly if the + current limit is exceeded to reduce the current. This limit is a simplified + 'on/off' controller. This limit is enabled by default but is set higher than + the default Smart Current Limit. + + The time the controller is off after the current limit is reached is + determined by the parameter limitCycles, which is the number of PWM cycles + (20kHz). The recommended value is the default of 0 which is the minimum time + and is part of a PWM cycle from when the over current is detected. This + allows the controller to regulate the current close to the limit value. + + The total time is set by the equation + + + t = (50us - t0) + 50us * limitCycles + t = total off time after over current + t0 = time from the start of the PWM cycle until over current is detected +
          +
          +
          Parameters:
          +
          limit - The current limit in Amps.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSecondaryCurrentLimit

          +
          public abstract com.revrobotics.REVLibError setSecondaryCurrentLimit​(double limit,
+                                                                     int chopCycles)
          +
          Sets the secondary current limit in Amps. + + The motor controller will disable the output of the controller briefly if the + current limit is exceeded to reduce the current. This limit is a simplified + 'on/off' controller. This limit is enabled by default but is set higher than + the default Smart Current Limit. + + The time the controller is off after the current limit is reached is + determined by the parameter limitCycles, which is the number of PWM cycles + (20kHz). The recommended value is the default of 0 which is the minimum time + and is part of a PWM cycle from when the over current is detected. This + allows the controller to regulate the current close to the limit value. + + The total time is set by the equation + + + t = (50us - t0) + 50us * limitCycles + t = total off time after over current + t0 = time from the start of the PWM cycle until over current is detected +
          +
          +
          Parameters:
          +
          limit - The current limit in Amps.
          +
          chopCycles - The number of additional PWM cycles to turn the driver off + after overcurrent is detected.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setIdleMode

          +
          public abstract com.revrobotics.REVLibError setIdleMode​(com.revrobotics.CANSparkMax.IdleMode mode)
          +
          Sets the idle mode setting for the SPARK MAX.
          +
          +
          Parameters:
          +
          mode - Idle mode (coast or brake).
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getIdleMode

          +
          public abstract com.revrobotics.CANSparkMax.IdleMode getIdleMode()
          +
          Gets the idle mode setting for the SPARK MAX. + + This uses the Get Parameter API and should be used infrequently. This + function uses a non-blocking call and will return a cached value if the + parameter is not returned by the timeout. The timeout can be changed by + calling SetCANTimeout(int milliseconds)
          +
          +
          Returns:
          +
          IdleMode Idle mode setting
          +
          +
          • +
        + + + +
          +
        • +

          enableVoltageCompensation

          +
          public abstract com.revrobotics.REVLibError enableVoltageCompensation​(double nominalVoltage)
          +
          Sets the voltage compensation setting for all modes on the SPARK MAX and + enables voltage compensation.
          +
          +
          Parameters:
          +
          nominalVoltage - Nominal voltage to compensate output to
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          disableVoltageCompensation

          +
          public abstract com.revrobotics.REVLibError disableVoltageCompensation()
          +
          Disables the voltage compensation setting for all modes on the SPARK MAX.
          +
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getVoltageCompensationNominalVoltage

          +
          public abstract double getVoltageCompensationNominalVoltage()
          +
          Get the configured voltage compensation nominal voltage value
          +
          +
          Returns:
          +
          The nominal voltage for voltage compensation mode.
          +
          +
          • +
        + + + +
          +
        • +

          setOpenLoopRampRate

          +
          public abstract com.revrobotics.REVLibError setOpenLoopRampRate​(double rate)
          +
          Sets the ramp rate for open loop control modes. + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Parameters:
          +
          rate - Time in seconds to go from 0 to full throttle.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setClosedLoopRampRate

          +
          public abstract com.revrobotics.REVLibError setClosedLoopRampRate​(double rate)
          +
          Sets the ramp rate for closed loop control modes. + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Parameters:
          +
          rate - Time in seconds to go from 0 to full throttle.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getOpenLoopRampRate

          +
          public abstract double getOpenLoopRampRate()
          +
          Get the configured open loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Returns:
          +
          ramp rate time in seconds to go from 0 to full throttle.
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopRampRate

          +
          public abstract double getClosedLoopRampRate()
          +
          Get the configured closed loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Returns:
          +
          ramp rate time in seconds to go from 0 to full throttle.
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public abstract com.revrobotics.REVLibError follow​(XCANSparkMax leader)
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + The motor will spin in the same direction as the leader. This can be changed + by passing a true constant after the leader parameter. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Parameters:
          +
          leader - The motor controller to follow.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public abstract com.revrobotics.REVLibError follow​(XCANSparkMax leader,
+                                                   boolean invert)
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Parameters:
          +
          leader - The motor controller to follow.
          +
          invert - Set the follower to output opposite of the leader
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public abstract com.revrobotics.REVLibError follow​(com.revrobotics.CANSparkMax.ExternalFollower leader,
+                                                   int deviceID)
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + The motor will spin in the same direction as the leader. This can be changed + by passing a true constant after the deviceID parameter. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Parameters:
          +
          leader - The type of motor controller to follow (Talon SRX, Spark Max, + etc.).
          +
          deviceID - The CAN ID of the device to follow.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public abstract com.revrobotics.REVLibError follow​(com.revrobotics.CANSparkMax.ExternalFollower leader,
+                                                   int deviceID,
+                                                   boolean invert)
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Parameters:
          +
          leader - The type of motor controller to follow (Talon SRX, Spark Max, + etc.).
          +
          deviceID - The CAN ID of the device to follow.
          +
          invert - Set the follower to output opposite of the leader
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          isFollower

          +
          public abstract boolean isFollower()
          +
          Returns whether the controller is following another controller
          +
          +
          Returns:
          +
          True if this device is following another controller false otherwise
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public abstract short getFaults()
          +
          +
          Returns:
          +
          All fault bits as a short
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public abstract short getStickyFaults()
          +
          +
          Returns:
          +
          All sticky fault bits as a short
          +
          +
          • +
        + + + +
          +
        • +

          getFault

          +
          public abstract boolean getFault​(com.revrobotics.CANSparkMax.FaultID faultID)
          +
          Get the value of a specific fault
          +
          +
          Parameters:
          +
          faultID - The ID of the fault to retrive
          +
          Returns:
          +
          True if the fault with the given ID occurred.
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFault

          +
          public abstract boolean getStickyFault​(com.revrobotics.CANSparkMax.FaultID faultID)
          +
          Get the value of a specific sticky fault
          +
          +
          Parameters:
          +
          faultID - The ID of the sticky fault to retrive
          +
          Returns:
          +
          True if the sticky fault with the given ID occurred.
          +
          +
          • +
        + + + +
          +
        • +

          getBusVoltage

          +
          public abstract double getBusVoltage()
          +
          +
          Returns:
          +
          The voltage fed into the motor controller.
          +
          +
          • +
        + + + +
          +
        • +

          getAppliedOutput

          +
          public abstract double getAppliedOutput()
          +
          +
          Returns:
          +
          The motor controller's applied output duty cycle.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputCurrent

          +
          public abstract double getOutputCurrent()
          +
          +
          Returns:
          +
          The motor controller's output current in Amps.
          +
          +
          • +
        + + + +
          +
        • +

          getMotorTemperature

          +
          public abstract double getMotorTemperature()
          +
          +
          Returns:
          +
          The motor temperature in Celsius.
          +
          +
          • +
        + + + +
          +
        • +

          clearFaults

          +
          public abstract com.revrobotics.REVLibError clearFaults()
          +
          Clears all sticky faults.
          +
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          burnFlash

          +
          public abstract com.revrobotics.REVLibError burnFlash()
          +
          Writes all settings to flash.
          +
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setCANTimeout

          +
          public abstract com.revrobotics.REVLibError setCANTimeout​(int milliseconds)
          +
          Sets timeout for sending CAN messages with SetParameter* and GetParameter* + calls. These calls will block for up to this amoutn of time before returning + a timeout erro. A timeout of 0 will make the SetParameter* calls + non-blocking, and instead will check the response in a separate thread. With + this configuration, any error messages will appear on the drivestration but + will not be returned by the GetLastError() call.
          +
          +
          Parameters:
          +
          milliseconds - The timeout in milliseconds.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          enableSoftLimit

          +
          public abstract com.revrobotics.REVLibError enableSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction,
+                                                            boolean enable)
          +
          Enable soft limits
          +
          +
          Parameters:
          +
          direction - the direction of motion to restrict
          +
          enable - set true to enable soft limits
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSoftLimit

          +
          public abstract com.revrobotics.REVLibError setSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction,
+                                                         float limit)
          +
          Set the soft limit based on position. The default unit is rotations, but will + match the unit scaling set by the user. + + Note that this value is not scaled internally so care must be taken to make + sure these units match the desired conversion
          +
          +
          Parameters:
          +
          direction - the direction of motion to restrict
          +
          limit - position soft limit of the controller
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getSoftLimit

          +
          public abstract double getSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction)
          +
          Get the soft limit setting in the controller
          +
          +
          Parameters:
          +
          direction - the direction of motion to restrict
          +
          Returns:
          +
          position soft limit setting of the controller
          +
          +
          • +
        + + + +
          +
        • +

          isSoftLimitEnabled

          +
          public abstract boolean isSoftLimitEnabled​(com.revrobotics.CANSparkMax.SoftLimitDirection direction)
          +
          +
          Parameters:
          +
          direction - The direction of the motion to restrict
          +
          Returns:
          +
          true if the soft limit is enabled.
          +
          +
          • +
        + + + +
          +
        • +

          getLastError

          +
          public abstract com.revrobotics.REVLibError getLastError()
          +
          All device errors are tracked on a per thread basis for all devices in that + thread. This is meant to be called immediately following another call that + has the possibility of returning an error to validate if an error has + occurred.
          +
          +
          Returns:
          +
          the last error that was generated.
          +
          +
          • +
        + + + +
          +
        • +

          restoreFactoryDefaults

          +
          public abstract com.revrobotics.REVLibError restoreFactoryDefaults()
          +
          • +
        + + + +
          +
        • +

          getPosition

          +
          public abstract double getPosition()
          +
          • +
        + + + +
          +
        • +

          getVelocity

          +
          public abstract double getVelocity()
          +
          • +
        + + + +
          +
        • +

          setPosition

          +
          public abstract com.revrobotics.REVLibError setPosition​(double position)
          +
          • +
        + + + +
          +
        • +

          setPositionConversionFactor

          +
          public abstract com.revrobotics.REVLibError setPositionConversionFactor​(double factor)
          +
          • +
        + + + +
          +
        • +

          setVelocityConversionFactor

          +
          public abstract com.revrobotics.REVLibError setVelocityConversionFactor​(double factor)
          +
          • +
        + + + +
          +
        • +

          getPositionConversionFactor

          +
          public abstract double getPositionConversionFactor()
          +
          • +
        + + + +
          +
        • +

          getVelocityConversionFactor

          +
          public abstract double getVelocityConversionFactor()
          +
          • +
        + + + +
          +
        • +

          setAverageDepth

          +
          public abstract com.revrobotics.REVLibError setAverageDepth​(int depth)
          +
          • +
        + + + +
          +
        • +

          getAverageDepth

          +
          public abstract int getAverageDepth()
          +
          • +
        + + + +
          +
        • +

          setMeasurementPeriod

          +
          public abstract com.revrobotics.REVLibError setMeasurementPeriod​(int period_us)
          +
          • +
        + + + +
          +
        • +

          getMeasurementPeriod

          +
          public abstract int getMeasurementPeriod()
          +
          • +
        + + + +
          +
        • +

          getCountsPerRevolution

          +
          public abstract int getCountsPerRevolution()
          +
          • +
        + + + +
          +
        • +

          setEncoderInverted

          +
          public abstract com.revrobotics.REVLibError setEncoderInverted​(boolean inverted)
          +
          • +
        + + + +
          +
        • +

          setP

          +
          public abstract com.revrobotics.REVLibError setP​(double gain)
          +
          • +
        + + + +
          +
        • +

          setP

          +
          public abstract com.revrobotics.REVLibError setP​(double gain,
+                                                 int slotID)
          +
          • +
        + + + +
          +
        • +

          setI

          +
          public abstract com.revrobotics.REVLibError setI​(double gain)
          +
          • +
        + + + +
          +
        • +

          setI

          +
          public abstract com.revrobotics.REVLibError setI​(double gain,
+                                                 int slotID)
          +
          • +
        + + + +
          +
        • +

          setD

          +
          public abstract com.revrobotics.REVLibError setD​(double gain)
          +
          • +
        + + + +
          +
        • +

          setD

          +
          public abstract com.revrobotics.REVLibError setD​(double gain,
+                                                 int slotID)
          +
          • +
        + + + +
          +
        • +

          setDFilter

          +
          public abstract com.revrobotics.REVLibError setDFilter​(double gain)
          +
          • +
        + + + +
          +
        • +

          setDFilter

          +
          public abstract com.revrobotics.REVLibError setDFilter​(double gain,
+                                                       int slotID)
          +
          • +
        + + + +
          +
        • +

          setFF

          +
          public abstract com.revrobotics.REVLibError setFF​(double gain)
          +
          • +
        + + + +
          +
        • +

          setFF

          +
          public abstract com.revrobotics.REVLibError setFF​(double gain,
+                                                  int slotID)
          +
          • +
        + + + +
          +
        • +

          setIZone

          +
          public abstract com.revrobotics.REVLibError setIZone​(double iZone)
          +
          • +
        + + + +
          +
        • +

          setIZone

          +
          public abstract com.revrobotics.REVLibError setIZone​(double iZone,
+                                                     int slotID)
          +
          • +
        + + + +
          +
        • +

          setOutputRange

          +
          public abstract com.revrobotics.REVLibError setOutputRange​(double min,
+                                                           double max)
          +
          • +
        + + + +
          +
        • +

          setOutputRange

          +
          public abstract com.revrobotics.REVLibError setOutputRange​(double min,
+                                                           double max,
+                                                           int slotID)
          +
          • +
        + + + +
          +
        • +

          getP

          +
          public abstract double getP()
          +
          • +
        + + + +
          +
        • +

          getP

          +
          public abstract double getP​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getI

          +
          public abstract double getI()
          +
          • +
        + + + +
          +
        • +

          getI

          +
          public abstract double getI​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getD

          +
          public abstract double getD()
          +
          • +
        + + + +
          +
        • +

          getD

          +
          public abstract double getD​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getDFilter

          +
          public abstract double getDFilter​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getFF

          +
          public abstract double getFF()
          +
          • +
        + + + +
          +
        • +

          getFF

          +
          public abstract double getFF​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getIZone

          +
          public abstract double getIZone()
          +
          • +
        + + + +
          +
        • +

          getIZone

          +
          public abstract double getIZone​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getOutputMin

          +
          public abstract double getOutputMin()
          +
          • +
        + + + +
          +
        • +

          getOutputMin

          +
          public abstract double getOutputMin​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getOutputMax

          +
          public abstract double getOutputMax()
          +
          • +
        + + + +
          +
        • +

          getOutputMax

          +
          public abstract double getOutputMax​(int slotID)
          +
          • +
        + + + +
          +
        • +

          setSmartMotionMaxVelocity

          +
          public abstract com.revrobotics.REVLibError setSmartMotionMaxVelocity​(double maxVel,
+                                                                      int slotID)
          +
          • +
        + + + +
          +
        • +

          setSmartMotionMaxAccel

          +
          public abstract com.revrobotics.REVLibError setSmartMotionMaxAccel​(double maxAccel,
+                                                                   int slotID)
          +
          • +
        + + + +
          +
        • +

          setSmartMotionMinOutputVelocity

          +
          public abstract com.revrobotics.REVLibError setSmartMotionMinOutputVelocity​(double minVel,
+                                                                            int slotID)
          +
          • +
        + + + +
          +
        • +

          setSmartMotionAllowedClosedLoopError

          +
          public abstract com.revrobotics.REVLibError setSmartMotionAllowedClosedLoopError​(double allowedErr,
+                                                                                 int slotID)
          +
          • +
        + + + +
          +
        • +

          getSmartMotionMaxVelocity

          +
          public abstract double getSmartMotionMaxVelocity​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getSmartMotionMaxAccel

          +
          public abstract double getSmartMotionMaxAccel​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getSmartMotionMinOutputVelocity

          +
          public abstract double getSmartMotionMinOutputVelocity​(int slotID)
          +
          • +
        + + + +
          +
        • +

          getSmartMotionAllowedClosedLoopError

          +
          public abstract double getSmartMotionAllowedClosedLoopError​(int slotID)
          +
          • +
        + + + +
          +
        • +

          setIMaxAccum

          +
          public abstract com.revrobotics.REVLibError setIMaxAccum​(double iMaxAccum,
+                                                         int slotID)
          +
          • +
        + + + +
          +
        • +

          getIMaxAccum

          +
          public abstract double getIMaxAccum​(int slotID)
          +
          • +
        + + + +
          +
        • +

          setIAccum

          +
          public abstract com.revrobotics.REVLibError setIAccum​(double iAccum)
          +
          • +
        + + + +
          +
        • +

          getIAccum

          +
          public abstract double getIAccum()
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public abstract com.revrobotics.REVLibError setReference​(double value,
+                                                         com.revrobotics.CANSparkMax.ControlType ctrl)
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public abstract com.revrobotics.REVLibError setReference​(double value,
+                                                         com.revrobotics.CANSparkMax.ControlType ctrl,
+                                                         int pidSlot)
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public abstract com.revrobotics.REVLibError setReference​(double value,
+                                                         com.revrobotics.CANSparkMax.ControlType ctrl,
+                                                         int pidSlot,
+                                                         double arbFeedforward)
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public abstract com.revrobotics.REVLibError setReference​(double value,
+                                                         com.revrobotics.CANSparkMax.ControlType ctrl,
+                                                         int pidSlot,
+                                                         double arbFeedforward,
+                                                         com.revrobotics.SparkMaxPIDController.ArbFFUnits arbFFUnits)
          +
          • +
        + + + +
          +
        • +

          getInternalSparkMax

          +
          public abstract com.revrobotics.CANSparkMax getInternalSparkMax()
          +
          • +
        + + + +
          +
        • +

          setForwardLimitSwitch

          +
          public abstract void setForwardLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType,
+                                           boolean enabled)
          +
          • +
        + + + +
          +
        • +

          setReverseLimitSwitch

          +
          public abstract void setReverseLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType,
+                                           boolean enabled)
          +
          • +
        + + + +
          +
        • +

          getForwardLimitSwitchPressed

          +
          public abstract boolean getForwardLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType)
          +
          • +
        + + + +
          +
        • +

          getReverseLimitSwitchPressed

          +
          public abstract boolean getReverseLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XCANSparkMaxPIDProperties.html b/javadoc/xbot/common/controls/actuators/XCANSparkMaxPIDProperties.html new file mode 100644 index 00000000..f5075c53 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XCANSparkMaxPIDProperties.html @@ -0,0 +1,417 @@ + + + + + +XCANSparkMaxPIDProperties (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XCANSparkMaxPIDProperties

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XCANSparkMaxPIDProperties
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class XCANSparkMaxPIDProperties
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        doubled 
        doublefeedForward 
        doublei 
        doubleiZone 
        doublemaxOutput 
        doubleminOutput 
        doublep 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        XCANSparkMaxPIDProperties() 
        XCANSparkMaxPIDProperties​(double p, + double i, + double d, + double iZone, + double feedForward, + double maxOutput, + double minOutput) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          p

          +
          public double p
          +
          • +
        + + + +
          +
        • +

          i

          +
          public double i
          +
          • +
        + + + +
          +
        • +

          d

          +
          public double d
          +
          • +
        + + + +
          +
        • +

          iZone

          +
          public double iZone
          +
          • +
        + + + +
          +
        • +

          feedForward

          +
          public double feedForward
          +
          • +
        + + + +
          +
        • +

          maxOutput

          +
          public double maxOutput
          +
          • +
        + + + +
          +
        • +

          minOutput

          +
          public double minOutput
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XCANSparkMaxPIDProperties

          +
          public XCANSparkMaxPIDProperties​(double p,
+                                 double i,
+                                 double d,
+                                 double iZone,
+                                 double feedForward,
+                                 double maxOutput,
+                                 double minOutput)
          +
          • +
        + + + +
          +
        • +

          XCANSparkMaxPIDProperties

          +
          public XCANSparkMaxPIDProperties()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XCANTalon.XCANTalonFactory.html b/javadoc/xbot/common/controls/actuators/XCANTalon.XCANTalonFactory.html new file mode 100644 index 00000000..430439a8 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XCANTalon.XCANTalonFactory.html @@ -0,0 +1,256 @@ + + + + + +XCANTalon.XCANTalonFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Interface XCANTalon.XCANTalonFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XCANTalon.html b/javadoc/xbot/common/controls/actuators/XCANTalon.html new file mode 100644 index 00000000..9af71709 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XCANTalon.html @@ -0,0 +1,2425 @@ + + + + + +XCANTalon (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XCANTalon

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XCANTalon
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      com.ctre.phoenix.motorcontrol.IFollower, com.ctre.phoenix.motorcontrol.IMotorController, com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced, com.ctre.phoenix.signals.IInvertable, com.ctre.phoenix.signals.IOutputSignal
      +
      +
      +
      Direct Known Subclasses:
      +
      CANTalonWPIAdapter, MockCANTalon, VictorAppearingAsTalonWPIAdapter, XCANVictorSPX
      +
      +
      +
      public abstract class XCANTalon
+extends java.lang.Object
+implements com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static interface XCANTalon.XCANTalonFactory 
        +
        • +
      +
      + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        abstract com.ctre.phoenix.ErrorCodechangeMotionControlFramePeriod​(int periodMs) 
        abstract com.ctre.phoenix.ErrorCodeclearMotionProfileHasUnderrun​(int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeclearMotionProfileTrajectories() 
        abstract com.ctre.phoenix.ErrorCodeclearStickyFaults​(int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfig_IntegralZone​(int slotIdx, + int izone, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfig_kD​(int slotIdx, + double value, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfig_kF​(int slotIdx, + double value, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfig_kI​(int slotIdx, + double value, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfig_kP​(int slotIdx, + double value, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigAllowableClosedloopError​(int slotIdx, + int allowableCloseLoopError, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigClosedloopRamp​(double secondsFromNeutralToFull, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigContinuousCurrentLimit​(int amps, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type, + com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type, + com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose, + int deviceID, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigForwardSoftLimitEnable​(boolean enable, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigForwardSoftLimitThreshold​(int forwardSensorLimit, + int timeoutMs) 
        abstract intconfigGetCustomParam​(int paramIndex, + int timoutMs) 
        abstract doubleconfigGetParameter​(int paramEnum, + int ordinal, + int timeoutMs) 
        abstract doubleconfigGetParameter​(com.ctre.phoenix.ParamEnum paramEnum, + int ordinal, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigMaxIntegralAccumulator​(int slotIdx, + double iaccum, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigMotionAcceleration​(int sensorUnitsPer100msPerSec, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigMotionCruiseVelocity​(int sensorUnitsPer100ms, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigNeutralDeadband​(double percentDeadband, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigNominalOutputForward​(double percentOut, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigNominalOutputReverse​(double percentOut, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigOpenloopRamp​(double secondsFromNeutralToFull, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigPeakCurrentDuration​(int milliseconds, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigPeakCurrentLimit​(int amps, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigPeakOutputForward​(double percentOut, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigPeakOutputReverse​(double percentOut, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigRemoteFeedbackFilter​(int deviceID, + com.ctre.phoenix.motorcontrol.RemoteSensorSource remoteSensorSource, + int remoteOrdinal, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type, + com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type, + com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose, + int deviceID, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigReverseSoftLimitEnable​(boolean enable, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigReverseSoftLimitThreshold​(int reverseSensorLimit, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice, + int pidIdx, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice, + int pidIdx, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm, + com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigSetCustomParam​(int newValue, + int paramIndex, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigSetParameter​(int param, + double value, + int subValue, + int ordinal, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigSetParameter​(com.ctre.phoenix.ParamEnum param, + double value, + int subValue, + int ordinal, + int timeoutMs) 
        voidconfigureAsFollowerMotor​(XCANTalon master, + boolean followerInverted) +
        Convenience function to rapidly configure a XCANTalon to follow another XCANTalon.
        +
        voidconfigureAsMasterMotor​(java.lang.String prefix, + java.lang.String masterName, + boolean masterInverted, + boolean sensorPhase) +
        Convenience function to rapidly configure a CANTalon as a Master motor.
        +
        static voidconfigureMotorTeam​(java.lang.String prefix, + java.lang.String masterName, + XCANTalon master, + XCANTalon follower, + boolean masterInverted, + boolean followerInverted, + boolean sensorPhase) +
        Convenience function to rapidly configure two CANTalons to work in tandem; often used for drive motors.
        +
        static voidconfigureMotorTeam​(java.lang.String prefix, + java.lang.String masterName, + XCANTalon master, + XCANTalon follower1, + XCANTalon follower2, + boolean masterInverted, + boolean follower1Inverted, + boolean follower2Inverted, + boolean sensorPhase) 
        static voidconfigureMotorTeam​(java.lang.String prefix, + java.lang.String masterName, + XCANTalon master, + XCANTalon follower1, + XCANTalon follower2, + XCANTalon follower3, + boolean masterInverted, + boolean follower1Inverted, + boolean follower2Inverted, + boolean follower3Inverted, + boolean sensorPhase) 
        abstract com.ctre.phoenix.ErrorCodeconfigVelocityMeasurementPeriod​(com.ctre.phoenix.sensors.SensorVelocityMeasPeriod period, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigVelocityMeasurementWindow​(int windowSize, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigVoltageCompSaturation​(double voltage, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodeconfigVoltageMeasurementFilter​(int filterWindowSamples, + int timeoutMs) 
        voidcreateTelemetryProperties​(java.lang.String callingSystemPrefix, + java.lang.String deviceName) 
        abstract voidenableCurrentLimit​(boolean enable) 
        abstract voidenableVoltageCompensation​(boolean enable) 
        abstract voidfollow​(com.ctre.phoenix.motorcontrol.IMotorController masterToFollow) 
        abstract doublegetActiveTrajectoryHeading() 
        abstract doublegetActiveTrajectoryPosition() 
        abstract doublegetActiveTrajectoryVelocity() 
        abstract intgetBaseID() 
        abstract doublegetBusVoltage() 
        abstract doublegetClosedLoopError​(int pidIdx) 
        abstract intgetDeviceID() 
        abstract doublegetErrorDerivative​(int pidIdx) 
        abstract com.ctre.phoenix.ErrorCodegetFaults​(com.ctre.phoenix.motorcontrol.Faults toFill) 
        abstract intgetFirmwareVersion() 
        abstract doublegetIntegralAccumulator​(int pidIdx) 
        abstract booleangetInverted() 
        abstract com.ctre.phoenix.ErrorCodegetLastError() 
        abstract com.ctre.phoenix.ErrorCodegetMotionProfileStatus​(com.ctre.phoenix.motion.MotionProfileStatus statusToFill) 
        abstract intgetMotionProfileTopLevelBufferCount() 
        abstract doublegetMotorOutputPercent() 
        abstract doublegetMotorOutputVoltage() 
        abstract doublegetOutputCurrent() 
        abstract intgetPulseWidthRiseToFallUs() 
        abstract doublegetSelectedSensorPosition​(int pidIdx) 
        abstract doublegetSelectedSensorVelocity​(int pidIdx) 
        abstract intgetStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame, + int timeoutMs) 
        abstract intgetStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodegetStickyFaults​(com.ctre.phoenix.motorcontrol.StickyFaults toFill) 
        abstract doublegetTemperature() 
        abstract booleanhasResetOccurred() 
        abstract booleanisFwdLimitSwitchClosed() 
        abstract booleanisMotionProfileTopLevelBufferFull() 
        abstract booleanisRevLimitSwitchClosed() 
        abstract voidneutralOutput() 
        abstract voidoverrideLimitSwitchesEnable​(boolean enable) 
        abstract voidoverrideSoftLimitsEnable​(boolean enable) 
        abstract voidprocessMotionProfileBuffer() 
        abstract com.ctre.phoenix.ErrorCodepushMotionProfileTrajectory​(com.ctre.phoenix.motion.TrajectoryPoint trajPt) 
        abstract voidselectProfileSlot​(int slotIdx, + int pidIdx) 
        abstract voidset​(com.ctre.phoenix.motorcontrol.ControlMode Mode, + double demand) 
        voidset​(com.ctre.phoenix.motorcontrol.ControlMode mode, + double demand1, + double demand2) 
        abstract com.ctre.phoenix.ErrorCodesetControlFramePeriod​(com.ctre.phoenix.motorcontrol.ControlFrame frame, + int periodMs) 
        abstract com.ctre.phoenix.ErrorCodesetIntegralAccumulator​(double iaccum, + int pidIdx, + int timeoutMs) 
        abstract voidsetInverted​(boolean invert) 
        abstract voidsetNeutralMode​(com.ctre.phoenix.motorcontrol.NeutralMode neutralMode) 
        abstract com.ctre.phoenix.ErrorCodesetSelectedSensorPosition​(int sensorPos, + int pidIdx, + int timeoutMs) 
        abstract voidsetSensorPhase​(boolean PhaseSensor) 
        abstract com.ctre.phoenix.ErrorCodesetStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame, + int periodMs, + int timeoutMs) 
        abstract com.ctre.phoenix.ErrorCodesetStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame, + int periodMs, + int timeoutMs) 
        voidsimpleSet​(double percentInput) 
        voidstopMotor() 
        voidupdateTelemetryProperties() 
        abstract voidvalueUpdated() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface com.ctre.phoenix.motorcontrol.IMotorController

          +config_IntegralZone, configAllowableClosedloopError, configAuxPIDPolarity, configClosedLoopPeakOutput, configClosedLoopPeriod, configForwardSoftLimitThreshold, configMotionAcceleration, configMotionCruiseVelocity, configMotionProfileTrajectoryPeriod, configMotionSCurveStrength, configRemoteFeedbackFilter, configRemoteFeedbackFilter, configReverseSoftLimitThreshold, configSelectedFeedbackCoefficient, getClosedLoopTarget, getControlMode, set, setInverted, setSelectedSensorPosition
          • +
        +
          +
        • + + +

          Methods inherited from interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced

          +configSupplyCurrentLimit, configVelocityMeasurementPeriod
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          deviceId

          +
          protected int deviceId
          +
          • +
        + + + + + + + +
          +
        • +

          policeTicket

          +
          protected java.lang.String policeTicket
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTelemetryProperties

          +
          public void createTelemetryProperties​(java.lang.String callingSystemPrefix,
+                                      java.lang.String deviceName)
          +
          • +
        + + + +
          +
        • +

          updateTelemetryProperties

          +
          public void updateTelemetryProperties()
          +
          • +
        + + + +
          +
        • +

          set

          +
          public abstract void set​(com.ctre.phoenix.motorcontrol.ControlMode Mode,
+                         double demand)
          +
          +
          Specified by:
          +
          set in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode mode,
+                double demand1,
+                double demand2)
          +
          • +
        + + + +
          +
        • +

          neutralOutput

          +
          public abstract void neutralOutput()
          +
          +
          Specified by:
          +
          neutralOutput in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          setNeutralMode

          +
          public abstract void setNeutralMode​(com.ctre.phoenix.motorcontrol.NeutralMode neutralMode)
          +
          +
          Specified by:
          +
          setNeutralMode in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          setSensorPhase

          +
          public abstract void setSensorPhase​(boolean PhaseSensor)
          +
          +
          Specified by:
          +
          setSensorPhase in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public abstract void setInverted​(boolean invert)
          +
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public abstract boolean getInverted()
          +
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configOpenloopRamp

          +
          public abstract com.ctre.phoenix.ErrorCode configOpenloopRamp​(double secondsFromNeutralToFull,
+                                                              int timeoutMs)
          +
          +
          Specified by:
          +
          configOpenloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configClosedloopRamp

          +
          public abstract com.ctre.phoenix.ErrorCode configClosedloopRamp​(double secondsFromNeutralToFull,
+                                                                int timeoutMs)
          +
          +
          Specified by:
          +
          configClosedloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputForward

          +
          public abstract com.ctre.phoenix.ErrorCode configPeakOutputForward​(double percentOut,
+                                                                   int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputReverse

          +
          public abstract com.ctre.phoenix.ErrorCode configPeakOutputReverse​(double percentOut,
+                                                                   int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputForward

          +
          public abstract com.ctre.phoenix.ErrorCode configNominalOutputForward​(double percentOut,
+                                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputReverse

          +
          public abstract com.ctre.phoenix.ErrorCode configNominalOutputReverse​(double percentOut,
+                                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configNeutralDeadband

          +
          public abstract com.ctre.phoenix.ErrorCode configNeutralDeadband​(double percentDeadband,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configNeutralDeadband in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageCompSaturation

          +
          public abstract com.ctre.phoenix.ErrorCode configVoltageCompSaturation​(double voltage,
+                                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageCompSaturation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageMeasurementFilter

          +
          public abstract com.ctre.phoenix.ErrorCode configVoltageMeasurementFilter​(int filterWindowSamples,
+                                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageMeasurementFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          enableVoltageCompensation

          +
          public abstract void enableVoltageCompensation​(boolean enable)
          +
          +
          Specified by:
          +
          enableVoltageCompensation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getBusVoltage

          +
          public abstract double getBusVoltage()
          +
          +
          Specified by:
          +
          getBusVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputPercent

          +
          public abstract double getMotorOutputPercent()
          +
          +
          Specified by:
          +
          getMotorOutputPercent in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputVoltage

          +
          public abstract double getMotorOutputVoltage()
          +
          +
          Specified by:
          +
          getMotorOutputVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getOutputCurrent

          +
          public abstract double getOutputCurrent()
          +
          +
          Specified by:
          +
          getOutputCurrent in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        + + + +
          +
        • +

          getTemperature

          +
          public abstract double getTemperature()
          +
          +
          Specified by:
          +
          getTemperature in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public abstract com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice,
+                                                                        int pidIdx,
+                                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public abstract com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(int deviceID,
+                                                                      com.ctre.phoenix.motorcontrol.RemoteSensorSource remoteSensorSource,
+                                                                      int remoteOrdinal,
+                                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          configRemoteFeedbackFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configSensorTerm

          +
          public abstract com.ctre.phoenix.ErrorCode configSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm,
+                                                            com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          configSensorTerm in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public abstract com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                                        int pidIdx,
+                                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorPosition

          +
          public abstract double getSelectedSensorPosition​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorVelocity

          +
          public abstract double getSelectedSensorVelocity​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public abstract com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(int sensorPos,
+                                                                     int pidIdx,
+                                                                     int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setControlFramePeriod

          +
          public abstract com.ctre.phoenix.ErrorCode setControlFramePeriod​(com.ctre.phoenix.motorcontrol.ControlFrame frame,
+                                                                 int periodMs)
          +
          +
          Specified by:
          +
          setControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public abstract com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                                                int periodMs,
+                                                                int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public abstract com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                                                int periodMs,
+                                                                int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public abstract int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                         int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public abstract int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                         int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public abstract com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.sensors.SensorVelocityMeasPeriod period,
+                                                                           int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementWindow

          +
          public abstract com.ctre.phoenix.ErrorCode configVelocityMeasurementWindow​(int windowSize,
+                                                                           int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementWindow in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public abstract com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                          com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                          int deviceID,
+                                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public abstract com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                          com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                          int deviceID,
+                                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          overrideLimitSwitchesEnable

          +
          public abstract void overrideLimitSwitchesEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public abstract com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                          com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public abstract com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                          com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        + + + +
          +
        • +

          isFwdLimitSwitchClosed

          +
          public abstract boolean isFwdLimitSwitchClosed()
          +
          • +
        + + + +
          +
        • +

          isRevLimitSwitchClosed

          +
          public abstract boolean isRevLimitSwitchClosed()
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public abstract com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(int forwardSensorLimit,
+                                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public abstract com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(int reverseSensorLimit,
+                                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitEnable

          +
          public abstract com.ctre.phoenix.ErrorCode configForwardSoftLimitEnable​(boolean enable,
+                                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitEnable

          +
          public abstract com.ctre.phoenix.ErrorCode configReverseSoftLimitEnable​(boolean enable,
+                                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          overrideSoftLimitsEnable

          +
          public abstract void overrideSoftLimitsEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideSoftLimitsEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentLimit

          +
          public abstract com.ctre.phoenix.ErrorCode configPeakCurrentLimit​(int amps,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentDuration

          +
          public abstract com.ctre.phoenix.ErrorCode configPeakCurrentDuration​(int milliseconds,
+                                                                     int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configContinuousCurrentLimit

          +
          public abstract com.ctre.phoenix.ErrorCode configContinuousCurrentLimit​(int amps,
+                                                                        int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          enableCurrentLimit

          +
          public abstract void enableCurrentLimit​(boolean enable)
          +
          • +
        + + + +
          +
        • +

          config_kP

          +
          public abstract com.ctre.phoenix.ErrorCode config_kP​(int slotIdx,
+                                                     double value,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          config_kP in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          config_kI

          +
          public abstract com.ctre.phoenix.ErrorCode config_kI​(int slotIdx,
+                                                     double value,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          config_kI in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          config_kD

          +
          public abstract com.ctre.phoenix.ErrorCode config_kD​(int slotIdx,
+                                                     double value,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          config_kD in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          config_kF

          +
          public abstract com.ctre.phoenix.ErrorCode config_kF​(int slotIdx,
+                                                     double value,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          config_kF in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public abstract com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                               int izone,
+                                                               int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public abstract com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                          int allowableCloseLoopError,
+                                                                          int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMaxIntegralAccumulator

          +
          public abstract com.ctre.phoenix.ErrorCode configMaxIntegralAccumulator​(int slotIdx,
+                                                                        double iaccum,
+                                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configMaxIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          setIntegralAccumulator

          +
          public abstract com.ctre.phoenix.ErrorCode setIntegralAccumulator​(double iaccum,
+                                                                  int pidIdx,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          setIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopError

          +
          public abstract double getClosedLoopError​(int pidIdx)
          +
          +
          Specified by:
          +
          getClosedLoopError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getIntegralAccumulator

          +
          public abstract double getIntegralAccumulator​(int pidIdx)
          +
          +
          Specified by:
          +
          getIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getErrorDerivative

          +
          public abstract double getErrorDerivative​(int pidIdx)
          +
          +
          Specified by:
          +
          getErrorDerivative in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          selectProfileSlot

          +
          public abstract void selectProfileSlot​(int slotIdx,
+                                       int pidIdx)
          +
          +
          Specified by:
          +
          selectProfileSlot in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryPosition

          +
          public abstract double getActiveTrajectoryPosition()
          +
          +
          Specified by:
          +
          getActiveTrajectoryPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryVelocity

          +
          public abstract double getActiveTrajectoryVelocity()
          +
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryHeading

          +
          public abstract double getActiveTrajectoryHeading()
          +
          • +
        + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public abstract com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(int sensorUnitsPer100ms,
+                                                                      int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public abstract com.ctre.phoenix.ErrorCode configMotionAcceleration​(int sensorUnitsPer100msPerSec,
+                                                                    int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileTrajectories

          +
          public abstract com.ctre.phoenix.ErrorCode clearMotionProfileTrajectories()
          +
          +
          Specified by:
          +
          clearMotionProfileTrajectories in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileTopLevelBufferCount

          +
          public abstract int getMotionProfileTopLevelBufferCount()
          +
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          pushMotionProfileTrajectory

          +
          public abstract com.ctre.phoenix.ErrorCode pushMotionProfileTrajectory​(com.ctre.phoenix.motion.TrajectoryPoint trajPt)
          +
          +
          Specified by:
          +
          pushMotionProfileTrajectory in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          isMotionProfileTopLevelBufferFull

          +
          public abstract boolean isMotionProfileTopLevelBufferFull()
          +
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          processMotionProfileBuffer

          +
          public abstract void processMotionProfileBuffer()
          +
          +
          Specified by:
          +
          processMotionProfileBuffer in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileStatus

          +
          public abstract com.ctre.phoenix.ErrorCode getMotionProfileStatus​(com.ctre.phoenix.motion.MotionProfileStatus statusToFill)
          +
          +
          Specified by:
          +
          getMotionProfileStatus in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileHasUnderrun

          +
          public abstract com.ctre.phoenix.ErrorCode clearMotionProfileHasUnderrun​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          changeMotionControlFramePeriod

          +
          public abstract com.ctre.phoenix.ErrorCode changeMotionControlFramePeriod​(int periodMs)
          +
          +
          Specified by:
          +
          changeMotionControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getLastError

          +
          public abstract com.ctre.phoenix.ErrorCode getLastError()
          +
          +
          Specified by:
          +
          getLastError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public abstract com.ctre.phoenix.ErrorCode getFaults​(com.ctre.phoenix.motorcontrol.Faults toFill)
          +
          +
          Specified by:
          +
          getFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public abstract com.ctre.phoenix.ErrorCode getStickyFaults​(com.ctre.phoenix.motorcontrol.StickyFaults toFill)
          +
          +
          Specified by:
          +
          getStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public abstract com.ctre.phoenix.ErrorCode clearStickyFaults​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getFirmwareVersion

          +
          public abstract int getFirmwareVersion()
          +
          +
          Specified by:
          +
          getFirmwareVersion in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          hasResetOccurred

          +
          public abstract boolean hasResetOccurred()
          +
          +
          Specified by:
          +
          hasResetOccurred in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configSetCustomParam

          +
          public abstract com.ctre.phoenix.ErrorCode configSetCustomParam​(int newValue,
+                                                                int paramIndex,
+                                                                int timeoutMs)
          +
          +
          Specified by:
          +
          configSetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configGetCustomParam

          +
          public abstract int configGetCustomParam​(int paramIndex,
+                                         int timoutMs)
          +
          +
          Specified by:
          +
          configGetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public abstract com.ctre.phoenix.ErrorCode configSetParameter​(com.ctre.phoenix.ParamEnum param,
+                                                              double value,
+                                                              int subValue,
+                                                              int ordinal,
+                                                              int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public abstract com.ctre.phoenix.ErrorCode configSetParameter​(int param,
+                                                              double value,
+                                                              int subValue,
+                                                              int ordinal,
+                                                              int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public abstract double configGetParameter​(com.ctre.phoenix.ParamEnum paramEnum,
+                                          int ordinal,
+                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public abstract double configGetParameter​(int paramEnum,
+                                          int ordinal,
+                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getBaseID

          +
          public abstract int getBaseID()
          +
          +
          Specified by:
          +
          getBaseID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceID

          +
          public abstract int getDeviceID()
          +
          +
          Specified by:
          +
          getDeviceID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public abstract void follow​(com.ctre.phoenix.motorcontrol.IMotorController masterToFollow)
          +
          +
          Specified by:
          +
          follow in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          +
          • +
        + + + +
          +
        • +

          valueUpdated

          +
          public abstract void valueUpdated()
          +
          +
          Specified by:
          +
          valueUpdated in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          +
          • +
        + + + +
          +
        • +

          simpleSet

          +
          public void simpleSet​(double percentInput)
          +
          • +
        + + + +
          +
        • +

          stopMotor

          +
          public void stopMotor()
          +
          • +
        + + + +
          +
        • +

          configureMotorTeam

          +
          public static void configureMotorTeam​(java.lang.String prefix,
+                                      java.lang.String masterName,
+                                      XCANTalon master,
+                                      XCANTalon follower,
+                                      boolean masterInverted,
+                                      boolean followerInverted,
+                                      boolean sensorPhase)
          +
          Convenience function to rapidly configure two CANTalons to work in tandem; often used for drive motors.
          +
          +
          Parameters:
          +
          prefix - Prefix for network tables; typically, fill this with getPrefix() if calling this from a Subsystem or Command.
          +
          masterName - Motor name for network tables
          +
          master - Talon that will control overall operations
          +
          follower - Talon that will follow the master
          +
          masterInverted - Should the master be inverted?
          +
          followerInverted - Should the follower be inverted RELATIVE TO THE MASTER?
          +
          sensorPhase - Is the encoder in phase with the master?
          +
          +
          • +
        + + + +
          +
        • +

          configureMotorTeam

          +
          public static void configureMotorTeam​(java.lang.String prefix,
+                                      java.lang.String masterName,
+                                      XCANTalon master,
+                                      XCANTalon follower1,
+                                      XCANTalon follower2,
+                                      boolean masterInverted,
+                                      boolean follower1Inverted,
+                                      boolean follower2Inverted,
+                                      boolean sensorPhase)
          +
          • +
        + + + +
          +
        • +

          configureMotorTeam

          +
          public static void configureMotorTeam​(java.lang.String prefix,
+                                      java.lang.String masterName,
+                                      XCANTalon master,
+                                      XCANTalon follower1,
+                                      XCANTalon follower2,
+                                      XCANTalon follower3,
+                                      boolean masterInverted,
+                                      boolean follower1Inverted,
+                                      boolean follower2Inverted,
+                                      boolean follower3Inverted,
+                                      boolean sensorPhase)
          +
          • +
        + + + +
          +
        • +

          configureAsMasterMotor

          +
          public void configureAsMasterMotor​(java.lang.String prefix,
+                                   java.lang.String masterName,
+                                   boolean masterInverted,
+                                   boolean sensorPhase)
          +
          Convenience function to rapidly configure a CANTalon as a Master motor. Uses some typical configurations that can be + overriden later (for example, it sets typical maximum/minimum output values to 1 and -1)
          +
          +
          Parameters:
          +
          prefix - Prefix for network tables; typically, fill this with getPrefix() if calling this from a Subsystem or Command.
          +
          masterName - Motor name for network tables
          +
          masterInverted - Should the master be inverted?
          +
          sensorPhase - Is the encoder in phase with the master?
          +
          +
          • +
        + + + +
          +
        • +

          configureAsFollowerMotor

          +
          public void configureAsFollowerMotor​(XCANTalon master,
+                                     boolean followerInverted)
          +
          Convenience function to rapidly configure a XCANTalon to follow another XCANTalon. Uses some typical configurations that can be + overriden later (for example, it sets typical maximum/minimum output values to 1 and -1)
          +
          +
          Parameters:
          +
          master - The master XCANTalon that this should follow
          +
          followerInverted - Should the follower be inverted RELATIVE TO THE MASTER?
          +
          +
          • +
        + + + +
          +
        • +

          getPulseWidthRiseToFallUs

          +
          public abstract int getPulseWidthRiseToFallUs()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XCANVictorSPX.XCANVictorSPXFactory.html b/javadoc/xbot/common/controls/actuators/XCANVictorSPX.XCANVictorSPXFactory.html new file mode 100644 index 00000000..ffd6c9c6 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XCANVictorSPX.XCANVictorSPXFactory.html @@ -0,0 +1,256 @@ + + + + + +XCANVictorSPX.XCANVictorSPXFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Interface XCANVictorSPX.XCANVictorSPXFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XCANVictorSPX.html b/javadoc/xbot/common/controls/actuators/XCANVictorSPX.html new file mode 100644 index 00000000..fbf59d63 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XCANVictorSPX.html @@ -0,0 +1,351 @@ + + + + + +XCANVictorSPX (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XCANVictorSPX

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      com.ctre.phoenix.motorcontrol.IFollower, com.ctre.phoenix.motorcontrol.IMotorController, com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced, com.ctre.phoenix.signals.IInvertable, com.ctre.phoenix.signals.IOutputSignal
      +
      +
      +
      Direct Known Subclasses:
      +
      CANVictorSPXWpiAdapter, MockCANVictorSPX
      +
      +
      +
      public abstract class XCANVictorSPX
+extends XCANTalon
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XCompressor.XCompressorFactory.html b/javadoc/xbot/common/controls/actuators/XCompressor.XCompressorFactory.html new file mode 100644 index 00000000..c9095d96 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XCompressor.XCompressorFactory.html @@ -0,0 +1,256 @@ + + + + + +XCompressor.XCompressorFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Interface XCompressor.XCompressorFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XCompressor.html b/javadoc/xbot/common/controls/actuators/XCompressor.html new file mode 100644 index 00000000..cce27373 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XCompressor.html @@ -0,0 +1,359 @@ + + + + + +XCompressor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XCompressor

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XCompressor
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        XCompressor() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract voiddisable() 
        abstract voidenable() 
        abstract booleanisEnabled() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          XCompressor

          +
          public XCompressor()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          disable

          +
          public abstract void disable()
          +
          • +
        + + + +
          +
        • +

          enable

          +
          public abstract void enable()
          +
          • +
        + + + +
          +
        • +

          isEnabled

          +
          public abstract boolean isEnabled()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XDigitalOutput.XDigitalOutputFactory.html b/javadoc/xbot/common/controls/actuators/XDigitalOutput.XDigitalOutputFactory.html new file mode 100644 index 00000000..bbbbad59 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XDigitalOutput.XDigitalOutputFactory.html @@ -0,0 +1,256 @@ + + + + + +XDigitalOutput.XDigitalOutputFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Interface XDigitalOutput.XDigitalOutputFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XDigitalOutput.html b/javadoc/xbot/common/controls/actuators/XDigitalOutput.html new file mode 100644 index 00000000..1ed90c69 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XDigitalOutput.html @@ -0,0 +1,477 @@ + + + + + +XDigitalOutput (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XDigitalOutput

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XDigitalOutput
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected intchannel 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + +
        Constructors 
        ModifierConstructorDescription
        protected XDigitalOutput​(int channel, + DevicePolice police) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        abstract voiddisablePWM() 
        abstract voidenablePWM​(double initialDutyCycle) 
        abstract booleanget() 
        intgetChannel() 
        abstract voidset​(boolean value) 
        abstract voidsetPWMRate​(double frequency) +
        Set the PWM frequency of ALL DIGITAL OUTPUT PWM CHANNELS
        +
        abstract voidupdateDutyCycle​(double dutyCycle) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          channel

          +
          protected int channel
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XDigitalOutput

          +
          protected XDigitalOutput​(int channel,
+                         DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getChannel

          +
          public int getChannel()
          +
          +
          Specified by:
          +
          getChannel in interface XBaseIO
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public abstract void set​(boolean value)
          +
          • +
        + + + +
          +
        • +

          setPWMRate

          +
          public abstract void setPWMRate​(double frequency)
          +
          Set the PWM frequency of ALL DIGITAL OUTPUT PWM CHANNELS
          +
          +
          Parameters:
          +
          frequency - PWM frequency
          +
          +
          • +
        + + + +
          +
        • +

          enablePWM

          +
          public abstract void enablePWM​(double initialDutyCycle)
          +
          • +
        + + + +
          +
        • +

          updateDutyCycle

          +
          public abstract void updateDutyCycle​(double dutyCycle)
          +
          • +
        + + + +
          +
        • +

          disablePWM

          +
          public abstract void disablePWM()
          +
          • +
        + + + +
          +
        • +

          get

          +
          public abstract boolean get()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XDoubleSolenoid.DoubleSolenoidMode.html b/javadoc/xbot/common/controls/actuators/XDoubleSolenoid.DoubleSolenoidMode.html new file mode 100644 index 00000000..7f037c1f --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XDoubleSolenoid.DoubleSolenoidMode.html @@ -0,0 +1,393 @@ + + + + + +XDoubleSolenoid.DoubleSolenoidMode (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Enum XDoubleSolenoid.DoubleSolenoidMode

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        FORWARD 
        OFF 
        REVERSE 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static XDoubleSolenoid.DoubleSolenoidModevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static XDoubleSolenoid.DoubleSolenoidMode[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static XDoubleSolenoid.DoubleSolenoidMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (XDoubleSolenoid.DoubleSolenoidMode c : XDoubleSolenoid.DoubleSolenoidMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static XDoubleSolenoid.DoubleSolenoidMode valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XDoubleSolenoid.XDoubleSolenoidFactory.html b/javadoc/xbot/common/controls/actuators/XDoubleSolenoid.XDoubleSolenoidFactory.html new file mode 100644 index 00000000..5cff87f8 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XDoubleSolenoid.XDoubleSolenoidFactory.html @@ -0,0 +1,313 @@ + + + + + +XDoubleSolenoid.XDoubleSolenoidFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XDoubleSolenoid.XDoubleSolenoidFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XDoubleSolenoid.XDoubleSolenoidFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      XDoubleSolenoid
      +
      +
      +
      @AssistedFactory
+public abstract static class XDoubleSolenoid.XDoubleSolenoidFactory
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XDoubleSolenoidFactory

          +
          public XDoubleSolenoidFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract XDoubleSolenoid create​(@Assisted("forwardSolenoid")
+                                       XSolenoid forwardSolenoid,
+                                       @Assisted("reverseSolenoid")
+                                       XSolenoid reverseSolenoid)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XDoubleSolenoid.html b/javadoc/xbot/common/controls/actuators/XDoubleSolenoid.html new file mode 100644 index 00000000..69cef5a6 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XDoubleSolenoid.html @@ -0,0 +1,519 @@ + + + + + +XDoubleSolenoid (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XDoubleSolenoid

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XDoubleSolenoid
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class XDoubleSolenoid
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          isInverted

          +
          protected boolean isInverted
          +
          • +
        + + + +
          +
        • +

          forwardSolenoid

          +
          public XSolenoid forwardSolenoid
          +
          • +
        + + + +
          +
        • +

          reverseSolenoid

          +
          public XSolenoid reverseSolenoid
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XDoubleSolenoid

          +
          @AssistedInject
+public XDoubleSolenoid​(@Assisted("forwardSolenoid")
+                       XSolenoid forwardSolenoid,
+                       @Assisted("reverseSolenoid")
+                       XSolenoid reverseSolenoid)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean isInverted)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          getIsForward

          +
          public boolean getIsForward()
          +
          • +
        + + + +
          +
        • +

          getIsReverse

          +
          public boolean getIsReverse()
          +
          • +
        + + + +
          +
        • +

          getIsOff

          +
          public boolean getIsOff()
          +
          • +
        + + + +
          +
        • +

          setOff

          +
          public void setOff()
          +
          • +
        + + + +
          +
        • +

          setForward

          +
          public void setForward()
          +
          • +
        + + + +
          +
        • +

          setReverse

          +
          public void setReverse()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XPWM.XPWMFactory.html b/javadoc/xbot/common/controls/actuators/XPWM.XPWMFactory.html new file mode 100644 index 00000000..58fd9b8c --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XPWM.XPWMFactory.html @@ -0,0 +1,256 @@ + + + + + +XPWM.XPWMFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Interface XPWM.XPWMFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          XPWM create​(int channel)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XPWM.html b/javadoc/xbot/common/controls/actuators/XPWM.html new file mode 100644 index 00000000..f00bb9b2 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XPWM.html @@ -0,0 +1,491 @@ + + + + + +XPWM (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XPWM

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XPWM
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XBaseIO
      +
      +
      +
      Direct Known Subclasses:
      +
      MockPWM, PWMWPIAdapter
      +
      +
      +
      public abstract class XPWM
+extends java.lang.Object
+implements XBaseIO
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static interface XPWM.XPWMFactory 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected intchannel 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + +
        Constructors 
        ModifierConstructorDescription
        protected XPWM​(int channel, + DevicePolice police) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        intgetChannel() 
        abstract intgetRaw() 
        abstract doublegetSigned() 
        abstract doublegetUnsigned() 
        abstract voidsetRaw​(int value) +
        Sets the PWM duty cycle
        +
        abstract voidsetSigned​(double value) +
        Sets the PWM duty cycle
        +
        abstract voidsetUnsigned​(double value) +
        Sets the PWM duty cycle
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          channel

          +
          protected int channel
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XPWM

          +
          protected XPWM​(int channel,
+               DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getChannel

          +
          public int getChannel()
          +
          +
          Specified by:
          +
          getChannel in interface XBaseIO
          +
          +
          • +
        + + + +
          +
        • +

          setRaw

          +
          public abstract void setRaw​(int value)
          +
          Sets the PWM duty cycle
          +
          +
          Parameters:
          +
          value - the value to set, in the range [0, 255]
          +
          +
          • +
        + + + +
          +
        • +

          getRaw

          +
          public abstract int getRaw()
          +
          • +
        + + + +
          +
        • +

          setSigned

          +
          public abstract void setSigned​(double value)
          +
          Sets the PWM duty cycle
          +
          +
          Parameters:
          +
          value - the value to set, in the range [-1, 1]
          +
          +
          • +
        + + + +
          +
        • +

          getSigned

          +
          public abstract double getSigned()
          +
          • +
        + + + +
          +
        • +

          setUnsigned

          +
          public abstract void setUnsigned​(double value)
          +
          Sets the PWM duty cycle
          +
          +
          Parameters:
          +
          value - the value to set, in the range [0, 1]
          +
          +
          • +
        + + + +
          +
        • +

          getUnsigned

          +
          public abstract double getUnsigned()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XRelay.XRelayFactory.html b/javadoc/xbot/common/controls/actuators/XRelay.XRelayFactory.html new file mode 100644 index 00000000..b3116557 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XRelay.XRelayFactory.html @@ -0,0 +1,256 @@ + + + + + +XRelay.XRelayFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Interface XRelay.XRelayFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          XRelay create​(int channel)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XRelay.html b/javadoc/xbot/common/controls/actuators/XRelay.html new file mode 100644 index 00000000..05401c70 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XRelay.html @@ -0,0 +1,447 @@ + + + + + +XRelay (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XRelay

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XRelay
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      MockRelay, RelayWPIAdapter
      +
      +
      +
      public abstract class XRelay
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static interface XRelay.XRelayFactory 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected intchannel 
        protected booleaninverted 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + +
        Constructors 
        ModifierConstructorDescription
        protected XRelay​(int channel, + DevicePolice police) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        abstract voidset​(edu.wpi.first.wpilibj.Relay.Value value) 
        voidsetForward() 
        voidsetInverted​(boolean inverted) 
        voidsetReverse() 
        voidstop() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          channel

          +
          protected int channel
          +
          • +
        + + + +
          +
        • +

          inverted

          +
          protected boolean inverted
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XRelay

          +
          protected XRelay​(int channel,
+                 DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setForward

          +
          public void setForward()
          +
          • +
        + + + +
          +
        • +

          setReverse

          +
          public void setReverse()
          +
          • +
        + + + +
          +
        • +

          stop

          +
          public void stop()
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean inverted)
          +
          • +
        + + + +
          +
        • +

          set

          +
          public abstract void set​(edu.wpi.first.wpilibj.Relay.Value value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XServo.XServoFactory.html b/javadoc/xbot/common/controls/actuators/XServo.XServoFactory.html new file mode 100644 index 00000000..e32e41db --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XServo.XServoFactory.html @@ -0,0 +1,256 @@ + + + + + +XServo.XServoFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Interface XServo.XServoFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          XServo create​(int channel)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XServo.html b/javadoc/xbot/common/controls/actuators/XServo.html new file mode 100644 index 00000000..320a14fc --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XServo.html @@ -0,0 +1,400 @@ + + + + + +XServo (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XServo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XServo
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static interface XServo.XServoFactory 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected intchannel 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + +
        Constructors 
        ModifierConstructorDescription
        protected XServo​(int channel, + DevicePolice police) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        intgetChannel() 
        abstract voidset​(double value) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          channel

          +
          protected int channel
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XServo

          +
          protected XServo​(int channel,
+                 DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getChannel

          +
          public int getChannel()
          +
          +
          Specified by:
          +
          getChannel in interface XBaseIO
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public abstract void set​(double value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XSolenoid.XSolenoidFactory.html b/javadoc/xbot/common/controls/actuators/XSolenoid.XSolenoidFactory.html new file mode 100644 index 00000000..4abf22b4 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XSolenoid.XSolenoidFactory.html @@ -0,0 +1,256 @@ + + + + + +XSolenoid.XSolenoidFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Interface XSolenoid.XSolenoidFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XSolenoid.html b/javadoc/xbot/common/controls/actuators/XSolenoid.html new file mode 100644 index 00000000..de6691d0 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XSolenoid.html @@ -0,0 +1,484 @@ + + + + + +XSolenoid (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XSolenoid

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XSolenoid
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static interface XSolenoid.XSolenoidFactory 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected intchannel 
        protected booleanisInverted 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + +
        Constructors 
        ModifierConstructorDescription
        protected XSolenoid​(int channel, + DevicePolice police) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          isInverted

          +
          protected boolean isInverted
          +
          • +
        + + + +
          +
        • +

          channel

          +
          protected final int channel
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XSolenoid

          +
          protected XSolenoid​(int channel,
+                    DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setOn

          +
          public void setOn​(boolean on)
          +
          • +
        + + + +
          +
        • +

          getAdjusted

          +
          public boolean getAdjusted()
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean isInverted)
          +
          • +
        + + + +
          +
        • +

          getChannel

          +
          public int getChannel()
          +
          +
          Specified by:
          +
          getChannel in interface XBaseIO
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          protected abstract void set​(boolean on)
          +
          • +
        + + + +
          +
        • +

          get

          +
          protected abstract boolean get()
          +
          • +
        + + + +
          +
        • +

          getMaxSupportedChannel

          +
          protected abstract int getMaxSupportedChannel()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/XSpeedController.XSpeedControllerFactory.html b/javadoc/xbot/common/controls/actuators/XSpeedController.XSpeedControllerFactory.html new file mode 100644 index 00000000..1d50a96a --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XSpeedController.XSpeedControllerFactory.html @@ -0,0 +1,256 @@ + + + + + +XSpeedController.XSpeedControllerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Interface XSpeedController.XSpeedControllerFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/XSpeedController.html b/javadoc/xbot/common/controls/actuators/XSpeedController.html new file mode 100644 index 00000000..10addda0 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/XSpeedController.html @@ -0,0 +1,482 @@ + + + + + +XSpeedController (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators
    +

    Class XSpeedController

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.XSpeedController
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected intchannel 
        protected booleanisInverted 
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        protected abstract doubleget() 
        intgetChannel() 
        booleangetInverted() 
        doublegetPower() 
        protected abstract voidset​(double value) 
        voidsetInverted​(boolean isInverted) 
        voidsetPower​(double power) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          channel

          +
          protected int channel
          +
          • +
        + + + +
          +
        • +

          isInverted

          +
          protected boolean isInverted
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XSpeedController

          +
          public XSpeedController​(int channel,
+                        DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getChannel

          +
          public int getChannel()
          +
          +
          Specified by:
          +
          getChannel in interface XBaseIO
          +
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean isInverted)
          +
          • +
        + + + +
          +
        • +

          setPower

          +
          public void setPower​(double power)
          +
          • +
        + + + +
          +
        • +

          getPower

          +
          public double getPower()
          +
          • +
        + + + +
          +
        • +

          get

          +
          protected abstract double get()
          +
          • +
        + + + +
          +
        • +

          set

          +
          protected abstract void set​(double value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANSparkMax.MockCANSparkMaxFactory.html b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANSparkMax.MockCANSparkMaxFactory.html new file mode 100644 index 00000000..9f2934fe --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANSparkMax.MockCANSparkMaxFactory.html @@ -0,0 +1,335 @@ + + + + + +MockCANSparkMax.MockCANSparkMaxFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.mock_adapters
    +

    Class MockCANSparkMax.MockCANSparkMaxFactory

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MockCANSparkMaxFactory

          +
          public MockCANSparkMaxFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANSparkMax.html b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANSparkMax.html new file mode 100644 index 00000000..48f494c3 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANSparkMax.html @@ -0,0 +1,2900 @@ + + + + + +MockCANSparkMax (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.mock_adapters
    +

    Class MockCANSparkMax

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        com.revrobotics.REVLibErrorburnFlash() +
        Writes all settings to flash.
        +
        com.revrobotics.REVLibErrorclearFaults() +
        Clears all sticky faults.
        +
        voiddisable() +
        Common interface for disabling a motor.
        +
        com.revrobotics.REVLibErrordisableVoltageCompensation() +
        Disables the voltage compensation setting for all modes on the SPARK MAX.
        +
        com.revrobotics.REVLibErrorenableSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction, + boolean enable) +
        Enable soft limits
        +
        com.revrobotics.REVLibErrorenableVoltageCompensation​(double nominalVoltage) +
        Sets the voltage compensation setting for all modes on the SPARK MAX and + enables voltage compensation.
        +
        com.revrobotics.REVLibErrorfollow​(com.revrobotics.CANSparkMax.ExternalFollower leader, + int deviceID) +
        Causes this controller's output to mirror the provided leader.
        +
        com.revrobotics.REVLibErrorfollow​(com.revrobotics.CANSparkMax.ExternalFollower leader, + int deviceID, + boolean invert) +
        Causes this controller's output to mirror the provided leader.
        +
        com.revrobotics.REVLibErrorfollow​(XCANSparkMax leader) +
        Causes this controller's output to mirror the provided leader.
        +
        com.revrobotics.REVLibErrorfollow​(XCANSparkMax leader, + boolean invert) +
        Causes this controller's output to mirror the provided leader.
        +
        doubleget() +
        Common interface for getting the current set speed of a speed controller.
        +
        doublegetAppliedOutput() 
        intgetAverageDepth() 
        doublegetBusVoltage() 
        doublegetClosedLoopRampRate() +
        Get the configured closed loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
        +
        com.revrobotics.CANSparkMax.ControlTypegetControlType() 
        intgetCountsPerRevolution() 
        doublegetD() 
        doublegetD​(int slotID) 
        doublegetDFilter​(int slotID) 
        booleangetFault​(com.revrobotics.CANSparkMax.FaultID faultID) +
        Get the value of a specific fault
        +
        shortgetFaults() 
        doublegetFF() 
        doublegetFF​(int slotID) 
        booleangetForwardLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType) 
        doublegetI() 
        doublegetI​(int slotID) 
        doublegetIAccum() 
        com.revrobotics.CANSparkMax.IdleModegetIdleMode() +
        Gets the idle mode setting for the SPARK MAX.
        +
        doublegetIMaxAccum​(int slotID) 
        com.revrobotics.CANSparkMaxgetInternalSparkMax() 
        booleangetInverted() +
        Common interface for returning the inversion state of a speed controller.
        +
        doublegetIZone() 
        doublegetIZone​(int slotID) 
        com.revrobotics.REVLibErrorgetLastError() +
        All device errors are tracked on a per thread basis for all devices in that + thread.
        +
        intgetMeasurementPeriod() 
        doublegetMotorTemperature() 
        doublegetOpenLoopRampRate() +
        Get the configured open loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
        +
        doublegetOutputCurrent() 
        doublegetOutputMax() 
        doublegetOutputMax​(int slotID) 
        doublegetOutputMin() 
        doublegetOutputMin​(int slotID) 
        doublegetP() 
        doublegetP​(int slotID) 
        doublegetPosition() 
        doublegetPositionConversionFactor() 
        doublegetReference() 
        booleangetReverseLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType) 
        org.json.JSONObjectgetSimulationData() 
        doublegetSmartMotionAllowedClosedLoopError​(int slotID) 
        doublegetSmartMotionMaxAccel​(int slotID) 
        doublegetSmartMotionMaxVelocity​(int slotID) 
        doublegetSmartMotionMinOutputVelocity​(int slotID) 
        doublegetSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction) +
        Get the soft limit setting in the controller
        +
        booleangetStickyFault​(com.revrobotics.CANSparkMax.FaultID faultID) +
        Get the value of a specific sticky fault
        +
        shortgetStickyFaults() 
        doublegetVelocity() 
        doublegetVelocityConversionFactor() 
        doublegetVoltageCompensationNominalVoltage() +
        Get the configured voltage compensation nominal voltage value
        +
        voidingestSimulationData​(org.json.JSONObject payload) 
        protected doubleinversionFactor() 
        booleanisFollower() +
        Returns whether the controller is following another controller
        +
        booleanisSoftLimitEnabled​(com.revrobotics.CANSparkMax.SoftLimitDirection direction) 
        com.revrobotics.REVLibErrorrestoreFactoryDefaults() 
        voidset​(double speed) +
        Common interface for setting the speed of a speed controller.
        +
        com.revrobotics.REVLibErrorsetAverageDepth​(int depth) 
        com.revrobotics.REVLibErrorsetCANTimeout​(int milliseconds) +
        Sets timeout for sending CAN messages with SetParameter* and GetParameter* + calls.
        +
        com.revrobotics.REVLibErrorsetClosedLoopRampRate​(double rate) +
        Sets the ramp rate for closed loop control modes.
        +
        com.revrobotics.REVLibErrorsetD​(double gain) 
        com.revrobotics.REVLibErrorsetD​(double gain, + int slotID) 
        com.revrobotics.REVLibErrorsetDFilter​(double gain) 
        com.revrobotics.REVLibErrorsetDFilter​(double gain, + int slotID) 
        com.revrobotics.REVLibErrorsetEncoderInverted​(boolean inverted) 
        com.revrobotics.REVLibErrorsetFF​(double gain) 
        com.revrobotics.REVLibErrorsetFF​(double gain, + int slotID) 
        voidsetForwardLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType, + boolean enabled) 
        com.revrobotics.REVLibErrorsetI​(double gain) 
        com.revrobotics.REVLibErrorsetI​(double gain, + int slotID) 
        com.revrobotics.REVLibErrorsetIAccum​(double iAccum) 
        com.revrobotics.REVLibErrorsetIdleMode​(com.revrobotics.CANSparkMax.IdleMode mode) +
        Sets the idle mode setting for the SPARK MAX.
        +
        com.revrobotics.REVLibErrorsetIMaxAccum​(double iMaxAccum, + int slotID) 
        voidsetInverted​(boolean isInverted) +
        Common interface for inverting direction of a speed controller.
        +
        com.revrobotics.REVLibErrorsetIZone​(double IZone) 
        com.revrobotics.REVLibErrorsetIZone​(double IZone, + int slotID) 
        com.revrobotics.REVLibErrorsetMeasurementPeriod​(int period_us) 
        com.revrobotics.REVLibErrorsetOpenLoopRampRate​(double rate) +
        Sets the ramp rate for open loop control modes.
        +
        com.revrobotics.REVLibErrorsetOutputRange​(double min, + double max) 
        com.revrobotics.REVLibErrorsetOutputRange​(double min, + double max, + int slotID) 
        com.revrobotics.REVLibErrorsetP​(double gain) 
        com.revrobotics.REVLibErrorsetP​(double gain, + int slotID) 
        com.revrobotics.REVLibErrorsetPosition​(double position) 
        com.revrobotics.REVLibErrorsetPositionConversionFactor​(double factor) 
        com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl) 
        com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl, + int pidSlot) 
        com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl, + int pidSlot, + double arbFeedforward) 
        com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl, + int pidSlot, + double arbFeedforward, + com.revrobotics.SparkMaxPIDController.ArbFFUnits arbFFUnits) 
        voidsetReverseLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType, + boolean enabled) 
        com.revrobotics.REVLibErrorsetSecondaryCurrentLimit​(double limit) +
        Sets the secondary current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSecondaryCurrentLimit​(double limit, + int chopCycles) +
        Sets the secondary current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSmartCurrentLimit​(int limit) +
        Sets the current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSmartCurrentLimit​(int stallLimit, + int freeLimit) +
        Sets the current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSmartCurrentLimit​(int stallLimit, + int freeLimit, + int limitRPM) +
        Sets the current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSmartMotionAllowedClosedLoopError​(double allowedErr, + int slotID) 
        com.revrobotics.REVLibErrorsetSmartMotionMaxAccel​(double maxAccel, + int slotID) 
        com.revrobotics.REVLibErrorsetSmartMotionMaxVelocity​(double maxVel, + int slotID) 
        com.revrobotics.REVLibErrorsetSmartMotionMinOutputVelocity​(double minVel, + int slotID) 
        com.revrobotics.REVLibErrorsetSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction, + float limit) +
        Set the soft limit based on position.
        +
        voidsetVelocity​(double velocity) 
        com.revrobotics.REVLibErrorsetVelocityConversionFactor​(double factor) 
        voidsetVoltage​(double outputVolts) +
        Sets the voltage output of the SpeedController.
        +
        voidstopMotor() 
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          internalEncoder

          +
          public XEncoder internalEncoder
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MockCANSparkMax

          +
          @AssistedInject
+public MockCANSparkMax​(@Assisted("deviceInfo")
+                       DeviceInfo deviceInfo,
+                       @Assisted("owningSystemPrefix")
+                       java.lang.String owningSystemPrefix,
+                       @Assisted("name")
+                       java.lang.String name,
+                       PropertyFactory propMan,
+                       DevicePolice police,
+                       @Assisted("defaultPIDProperties")
+                       XCANSparkMaxPIDProperties defaultPIDProperties)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          inversionFactor

          +
          protected double inversionFactor()
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(double speed)
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for setting the speed of a speed controller.
          +
          +
          Specified by:
          +
          set in class XCANSparkMax
          +
          Parameters:
          +
          speed - The speed to set. Value should be between -1.0 and 1.0.
          +
          +
          • +
        + + + +
          +
        • +

          setVoltage

          +
          public void setVoltage​(double outputVolts)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the voltage output of the SpeedController. This is equivillant to a call + to SetReference(output, rev::ControlType::kVoltage). The behavior of this + call differs slightly from the WPILib documetation for this call since the + device internally sets the desired voltage (not a compensation value). That + means that this *can* be a 'set-and-forget' call.
          +
          +
          Specified by:
          +
          setVoltage in class XCANSparkMax
          +
          Parameters:
          +
          outputVolts - The voltage to output.
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public double get()
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for getting the current set speed of a speed controller.
          +
          +
          Specified by:
          +
          get in class XCANSparkMax
          +
          Returns:
          +
          The current set speed. Value is between -1.0 and 1.0.
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean isInverted)
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for inverting direction of a speed controller. + + This call has no effect if the controller is a follower.
          +
          +
          Specified by:
          +
          setInverted in class XCANSparkMax
          +
          Parameters:
          +
          isInverted - The state of inversion, true is inverted.
          +
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for returning the inversion state of a speed controller. + + This call has no effect if the controller is a follower.
          +
          +
          Specified by:
          +
          getInverted in class XCANSparkMax
          +
          Returns:
          +
          isInverted The state of inversion, true is inverted.
          +
          +
          • +
        + + + +
          +
        • +

          disable

          +
          public void disable()
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for disabling a motor.
          +
          +
          Specified by:
          +
          disable in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setSmartCurrentLimit

          +
          public com.revrobotics.REVLibError setSmartCurrentLimit​(int limit)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the current limit in Amps. + + The motor controller will reduce the controller voltage output to avoid + surpassing this limit. This limit is enabled by default and used for + brushless only. This limit is highly recommended when using the NEO brushless + motor. + + The NEO Brushless Motor has a low internal resistance, which can mean large + current spikes that could be enough to cause damage to the motor and + controller. This current limit provides a smarter strategy to deal with high + current draws and keep the motor and controller operating in a safe region.
          +
          +
          Specified by:
          +
          setSmartCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          limit - The current limit in Amps.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSmartCurrentLimit

          +
          public com.revrobotics.REVLibError setSmartCurrentLimit​(int stallLimit,
+                                                        int freeLimit)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the current limit in Amps. + + The motor controller will reduce the controller voltage output to avoid + surpassing this limit. This limit is enabled by default and used for + brushless only. This limit is highly recommended when using the NEO brushless + motor. + + The NEO Brushless Motor has a low internal resistance, which can mean large + current spikes that could be enough to cause damage to the motor and + controller. This current limit provides a smarter strategy to deal with high + current draws and keep the motor and controller operating in a safe region. + + The controller can also limit the current based on the RPM of the motor in a + linear fashion to help with controllability in closed loop control. For a + response that is linear the entire RPM range leave limit RPM at 0.
          +
          +
          Specified by:
          +
          setSmartCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          stallLimit - The current limit in Amps at 0 RPM.
          +
          freeLimit - The current limit at free speed (5700RPM for NEO).
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSmartCurrentLimit

          +
          public com.revrobotics.REVLibError setSmartCurrentLimit​(int stallLimit,
+                                                        int freeLimit,
+                                                        int limitRPM)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the current limit in Amps. + + The motor controller will reduce the controller voltage output to avoid + surpassing this limit. This limit is enabled by default and used for + brushless only. This limit is highly recommended when using the NEO brushless + motor. + + The NEO Brushless Motor has a low internal resistance, which can mean large + current spikes that could be enough to cause damage to the motor and + controller. This current limit provides a smarter strategy to deal with high + current draws and keep the motor and controller operating in a safe region. + + The controller can also limit the current based on the RPM of the motor in a + linear fashion to help with controllability in closed loop control. For a + response that is linear the entire RPM range leave limit RPM at 0.
          +
          +
          Specified by:
          +
          setSmartCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          stallLimit - The current limit in Amps at 0 RPM.
          +
          freeLimit - The current limit at free speed (5700RPM for NEO).
          +
          limitRPM - RPM less than this value will be set to the stallLimit, RPM + values greater than limitRPM will scale linearly to + freeLimit
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSecondaryCurrentLimit

          +
          public com.revrobotics.REVLibError setSecondaryCurrentLimit​(double limit)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the secondary current limit in Amps. + + The motor controller will disable the output of the controller briefly if the + current limit is exceeded to reduce the current. This limit is a simplified + 'on/off' controller. This limit is enabled by default but is set higher than + the default Smart Current Limit. + + The time the controller is off after the current limit is reached is + determined by the parameter limitCycles, which is the number of PWM cycles + (20kHz). The recommended value is the default of 0 which is the minimum time + and is part of a PWM cycle from when the over current is detected. This + allows the controller to regulate the current close to the limit value. + + The total time is set by the equation + + + t = (50us - t0) + 50us * limitCycles + t = total off time after over current + t0 = time from the start of the PWM cycle until over current is detected +
          +
          +
          Specified by:
          +
          setSecondaryCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          limit - The current limit in Amps.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSecondaryCurrentLimit

          +
          public com.revrobotics.REVLibError setSecondaryCurrentLimit​(double limit,
+                                                            int chopCycles)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the secondary current limit in Amps. + + The motor controller will disable the output of the controller briefly if the + current limit is exceeded to reduce the current. This limit is a simplified + 'on/off' controller. This limit is enabled by default but is set higher than + the default Smart Current Limit. + + The time the controller is off after the current limit is reached is + determined by the parameter limitCycles, which is the number of PWM cycles + (20kHz). The recommended value is the default of 0 which is the minimum time + and is part of a PWM cycle from when the over current is detected. This + allows the controller to regulate the current close to the limit value. + + The total time is set by the equation + + + t = (50us - t0) + 50us * limitCycles + t = total off time after over current + t0 = time from the start of the PWM cycle until over current is detected +
          +
          +
          Specified by:
          +
          setSecondaryCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          limit - The current limit in Amps.
          +
          chopCycles - The number of additional PWM cycles to turn the driver off + after overcurrent is detected.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setIdleMode

          +
          public com.revrobotics.REVLibError setIdleMode​(com.revrobotics.CANSparkMax.IdleMode mode)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the idle mode setting for the SPARK MAX.
          +
          +
          Specified by:
          +
          setIdleMode in class XCANSparkMax
          +
          Parameters:
          +
          mode - Idle mode (coast or brake).
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getIdleMode

          +
          public com.revrobotics.CANSparkMax.IdleMode getIdleMode()
          +
          Description copied from class: XCANSparkMax
          +
          Gets the idle mode setting for the SPARK MAX. + + This uses the Get Parameter API and should be used infrequently. This + function uses a non-blocking call and will return a cached value if the + parameter is not returned by the timeout. The timeout can be changed by + calling SetCANTimeout(int milliseconds)
          +
          +
          Specified by:
          +
          getIdleMode in class XCANSparkMax
          +
          Returns:
          +
          IdleMode Idle mode setting
          +
          +
          • +
        + + + +
          +
        • +

          enableVoltageCompensation

          +
          public com.revrobotics.REVLibError enableVoltageCompensation​(double nominalVoltage)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the voltage compensation setting for all modes on the SPARK MAX and + enables voltage compensation.
          +
          +
          Specified by:
          +
          enableVoltageCompensation in class XCANSparkMax
          +
          Parameters:
          +
          nominalVoltage - Nominal voltage to compensate output to
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          disableVoltageCompensation

          +
          public com.revrobotics.REVLibError disableVoltageCompensation()
          +
          Description copied from class: XCANSparkMax
          +
          Disables the voltage compensation setting for all modes on the SPARK MAX.
          +
          +
          Specified by:
          +
          disableVoltageCompensation in class XCANSparkMax
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getVoltageCompensationNominalVoltage

          +
          public double getVoltageCompensationNominalVoltage()
          +
          Description copied from class: XCANSparkMax
          +
          Get the configured voltage compensation nominal voltage value
          +
          +
          Specified by:
          +
          getVoltageCompensationNominalVoltage in class XCANSparkMax
          +
          Returns:
          +
          The nominal voltage for voltage compensation mode.
          +
          +
          • +
        + + + +
          +
        • +

          setOpenLoopRampRate

          +
          public com.revrobotics.REVLibError setOpenLoopRampRate​(double rate)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the ramp rate for open loop control modes. + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Specified by:
          +
          setOpenLoopRampRate in class XCANSparkMax
          +
          Parameters:
          +
          rate - Time in seconds to go from 0 to full throttle.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setClosedLoopRampRate

          +
          public com.revrobotics.REVLibError setClosedLoopRampRate​(double rate)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the ramp rate for closed loop control modes. + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Specified by:
          +
          setClosedLoopRampRate in class XCANSparkMax
          +
          Parameters:
          +
          rate - Time in seconds to go from 0 to full throttle.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getOpenLoopRampRate

          +
          public double getOpenLoopRampRate()
          +
          Description copied from class: XCANSparkMax
          +
          Get the configured open loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Specified by:
          +
          getOpenLoopRampRate in class XCANSparkMax
          +
          Returns:
          +
          ramp rate time in seconds to go from 0 to full throttle.
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopRampRate

          +
          public double getClosedLoopRampRate()
          +
          Description copied from class: XCANSparkMax
          +
          Get the configured closed loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Specified by:
          +
          getClosedLoopRampRate in class XCANSparkMax
          +
          Returns:
          +
          ramp rate time in seconds to go from 0 to full throttle.
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(XCANSparkMax leader)
          +
          Description copied from class: XCANSparkMax
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + The motor will spin in the same direction as the leader. This can be changed + by passing a true constant after the leader parameter. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Specified by:
          +
          follow in class XCANSparkMax
          +
          Parameters:
          +
          leader - The motor controller to follow.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(XCANSparkMax leader,
+                                          boolean invert)
          +
          Description copied from class: XCANSparkMax
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Specified by:
          +
          follow in class XCANSparkMax
          +
          Parameters:
          +
          leader - The motor controller to follow.
          +
          invert - Set the follower to output opposite of the leader
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(com.revrobotics.CANSparkMax.ExternalFollower leader,
+                                          int deviceID)
          +
          Description copied from class: XCANSparkMax
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + The motor will spin in the same direction as the leader. This can be changed + by passing a true constant after the deviceID parameter. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Specified by:
          +
          follow in class XCANSparkMax
          +
          Parameters:
          +
          leader - The type of motor controller to follow (Talon SRX, Spark Max, + etc.).
          +
          deviceID - The CAN ID of the device to follow.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(com.revrobotics.CANSparkMax.ExternalFollower leader,
+                                          int deviceID,
+                                          boolean invert)
          +
          Description copied from class: XCANSparkMax
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Specified by:
          +
          follow in class XCANSparkMax
          +
          Parameters:
          +
          leader - The type of motor controller to follow (Talon SRX, Spark Max, + etc.).
          +
          deviceID - The CAN ID of the device to follow.
          +
          invert - Set the follower to output opposite of the leader
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          isFollower

          +
          public boolean isFollower()
          +
          Description copied from class: XCANSparkMax
          +
          Returns whether the controller is following another controller
          +
          +
          Specified by:
          +
          isFollower in class XCANSparkMax
          +
          Returns:
          +
          True if this device is following another controller false otherwise
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public short getFaults()
          +
          +
          Specified by:
          +
          getFaults in class XCANSparkMax
          +
          Returns:
          +
          All fault bits as a short
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public short getStickyFaults()
          +
          +
          Specified by:
          +
          getStickyFaults in class XCANSparkMax
          +
          Returns:
          +
          All sticky fault bits as a short
          +
          +
          • +
        + + + +
          +
        • +

          getFault

          +
          public boolean getFault​(com.revrobotics.CANSparkMax.FaultID faultID)
          +
          Description copied from class: XCANSparkMax
          +
          Get the value of a specific fault
          +
          +
          Specified by:
          +
          getFault in class XCANSparkMax
          +
          Parameters:
          +
          faultID - The ID of the fault to retrive
          +
          Returns:
          +
          True if the fault with the given ID occurred.
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFault

          +
          public boolean getStickyFault​(com.revrobotics.CANSparkMax.FaultID faultID)
          +
          Description copied from class: XCANSparkMax
          +
          Get the value of a specific sticky fault
          +
          +
          Specified by:
          +
          getStickyFault in class XCANSparkMax
          +
          Parameters:
          +
          faultID - The ID of the sticky fault to retrive
          +
          Returns:
          +
          True if the sticky fault with the given ID occurred.
          +
          +
          • +
        + + + +
          +
        • +

          getBusVoltage

          +
          public double getBusVoltage()
          +
          +
          Specified by:
          +
          getBusVoltage in class XCANSparkMax
          +
          Returns:
          +
          The voltage fed into the motor controller.
          +
          +
          • +
        + + + +
          +
        • +

          getAppliedOutput

          +
          public double getAppliedOutput()
          +
          +
          Specified by:
          +
          getAppliedOutput in class XCANSparkMax
          +
          Returns:
          +
          The motor controller's applied output duty cycle.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputCurrent

          +
          public double getOutputCurrent()
          +
          +
          Specified by:
          +
          getOutputCurrent in class XCANSparkMax
          +
          Returns:
          +
          The motor controller's output current in Amps.
          +
          +
          • +
        + + + +
          +
        • +

          getMotorTemperature

          +
          public double getMotorTemperature()
          +
          +
          Specified by:
          +
          getMotorTemperature in class XCANSparkMax
          +
          Returns:
          +
          The motor temperature in Celsius.
          +
          +
          • +
        + + + +
          +
        • +

          clearFaults

          +
          public com.revrobotics.REVLibError clearFaults()
          +
          Description copied from class: XCANSparkMax
          +
          Clears all sticky faults.
          +
          +
          Specified by:
          +
          clearFaults in class XCANSparkMax
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          burnFlash

          +
          public com.revrobotics.REVLibError burnFlash()
          +
          Description copied from class: XCANSparkMax
          +
          Writes all settings to flash.
          +
          +
          Specified by:
          +
          burnFlash in class XCANSparkMax
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setCANTimeout

          +
          public com.revrobotics.REVLibError setCANTimeout​(int milliseconds)
          +
          Description copied from class: XCANSparkMax
          +
          Sets timeout for sending CAN messages with SetParameter* and GetParameter* + calls. These calls will block for up to this amoutn of time before returning + a timeout erro. A timeout of 0 will make the SetParameter* calls + non-blocking, and instead will check the response in a separate thread. With + this configuration, any error messages will appear on the drivestration but + will not be returned by the GetLastError() call.
          +
          +
          Specified by:
          +
          setCANTimeout in class XCANSparkMax
          +
          Parameters:
          +
          milliseconds - The timeout in milliseconds.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          enableSoftLimit

          +
          public com.revrobotics.REVLibError enableSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction,
+                                                   boolean enable)
          +
          Description copied from class: XCANSparkMax
          +
          Enable soft limits
          +
          +
          Specified by:
          +
          enableSoftLimit in class XCANSparkMax
          +
          Parameters:
          +
          direction - the direction of motion to restrict
          +
          enable - set true to enable soft limits
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSoftLimit

          +
          public com.revrobotics.REVLibError setSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction,
+                                                float limit)
          +
          Description copied from class: XCANSparkMax
          +
          Set the soft limit based on position. The default unit is rotations, but will + match the unit scaling set by the user. + + Note that this value is not scaled internally so care must be taken to make + sure these units match the desired conversion
          +
          +
          Specified by:
          +
          setSoftLimit in class XCANSparkMax
          +
          Parameters:
          +
          direction - the direction of motion to restrict
          +
          limit - position soft limit of the controller
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getSoftLimit

          +
          public double getSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction)
          +
          Description copied from class: XCANSparkMax
          +
          Get the soft limit setting in the controller
          +
          +
          Specified by:
          +
          getSoftLimit in class XCANSparkMax
          +
          Parameters:
          +
          direction - the direction of motion to restrict
          +
          Returns:
          +
          position soft limit setting of the controller
          +
          +
          • +
        + + + +
          +
        • +

          isSoftLimitEnabled

          +
          public boolean isSoftLimitEnabled​(com.revrobotics.CANSparkMax.SoftLimitDirection direction)
          +
          +
          Specified by:
          +
          isSoftLimitEnabled in class XCANSparkMax
          +
          Parameters:
          +
          direction - The direction of the motion to restrict
          +
          Returns:
          +
          true if the soft limit is enabled.
          +
          +
          • +
        + + + +
          +
        • +

          getLastError

          +
          public com.revrobotics.REVLibError getLastError()
          +
          Description copied from class: XCANSparkMax
          +
          All device errors are tracked on a per thread basis for all devices in that + thread. This is meant to be called immediately following another call that + has the possibility of returning an error to validate if an error has + occurred.
          +
          +
          Specified by:
          +
          getLastError in class XCANSparkMax
          +
          Returns:
          +
          the last error that was generated.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setPosition

          +
          public com.revrobotics.REVLibError setPosition​(double position)
          +
          +
          Specified by:
          +
          setPosition in class XCANSparkMax
          +
          +
          • +
        + + + + + + + + + + + + + + + + + + + +
          +
        • +

          setAverageDepth

          +
          public com.revrobotics.REVLibError setAverageDepth​(int depth)
          +
          +
          Specified by:
          +
          setAverageDepth in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setMeasurementPeriod

          +
          public com.revrobotics.REVLibError setMeasurementPeriod​(int period_us)
          +
          +
          Specified by:
          +
          setMeasurementPeriod in class XCANSparkMax
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setEncoderInverted

          +
          public com.revrobotics.REVLibError setEncoderInverted​(boolean inverted)
          +
          +
          Specified by:
          +
          setEncoderInverted in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setP

          +
          public com.revrobotics.REVLibError setP​(double gain)
          +
          +
          Specified by:
          +
          setP in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setP

          +
          public com.revrobotics.REVLibError setP​(double gain,
+                                        int slotID)
          +
          +
          Specified by:
          +
          setP in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setI

          +
          public com.revrobotics.REVLibError setI​(double gain)
          +
          +
          Specified by:
          +
          setI in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setI

          +
          public com.revrobotics.REVLibError setI​(double gain,
+                                        int slotID)
          +
          +
          Specified by:
          +
          setI in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setD

          +
          public com.revrobotics.REVLibError setD​(double gain)
          +
          +
          Specified by:
          +
          setD in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setD

          +
          public com.revrobotics.REVLibError setD​(double gain,
+                                        int slotID)
          +
          +
          Specified by:
          +
          setD in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setDFilter

          +
          public com.revrobotics.REVLibError setDFilter​(double gain)
          +
          +
          Specified by:
          +
          setDFilter in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setDFilter

          +
          public com.revrobotics.REVLibError setDFilter​(double gain,
+                                              int slotID)
          +
          +
          Specified by:
          +
          setDFilter in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setFF

          +
          public com.revrobotics.REVLibError setFF​(double gain)
          +
          +
          Specified by:
          +
          setFF in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setFF

          +
          public com.revrobotics.REVLibError setFF​(double gain,
+                                         int slotID)
          +
          +
          Specified by:
          +
          setFF in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setIZone

          +
          public com.revrobotics.REVLibError setIZone​(double IZone)
          +
          +
          Specified by:
          +
          setIZone in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setIZone

          +
          public com.revrobotics.REVLibError setIZone​(double IZone,
+                                            int slotID)
          +
          +
          Specified by:
          +
          setIZone in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setOutputRange

          +
          public com.revrobotics.REVLibError setOutputRange​(double min,
+                                                  double max)
          +
          +
          Specified by:
          +
          setOutputRange in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setOutputRange

          +
          public com.revrobotics.REVLibError setOutputRange​(double min,
+                                                  double max,
+                                                  int slotID)
          +
          +
          Specified by:
          +
          setOutputRange in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getP

          +
          public double getP()
          +
          +
          Specified by:
          +
          getP in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getP

          +
          public double getP​(int slotID)
          +
          +
          Specified by:
          +
          getP in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getI

          +
          public double getI()
          +
          +
          Specified by:
          +
          getI in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getI

          +
          public double getI​(int slotID)
          +
          +
          Specified by:
          +
          getI in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getD

          +
          public double getD()
          +
          +
          Specified by:
          +
          getD in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getD

          +
          public double getD​(int slotID)
          +
          +
          Specified by:
          +
          getD in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getDFilter

          +
          public double getDFilter​(int slotID)
          +
          +
          Specified by:
          +
          getDFilter in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getFF

          +
          public double getFF()
          +
          +
          Specified by:
          +
          getFF in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getFF

          +
          public double getFF​(int slotID)
          +
          +
          Specified by:
          +
          getFF in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getIZone

          +
          public double getIZone​(int slotID)
          +
          +
          Specified by:
          +
          getIZone in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getOutputMin

          +
          public double getOutputMin​(int slotID)
          +
          +
          Specified by:
          +
          getOutputMin in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getOutputMax

          +
          public double getOutputMax​(int slotID)
          +
          +
          Specified by:
          +
          getOutputMax in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setSmartMotionMaxVelocity

          +
          public com.revrobotics.REVLibError setSmartMotionMaxVelocity​(double maxVel,
+                                                             int slotID)
          +
          +
          Specified by:
          +
          setSmartMotionMaxVelocity in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setSmartMotionMaxAccel

          +
          public com.revrobotics.REVLibError setSmartMotionMaxAccel​(double maxAccel,
+                                                          int slotID)
          +
          +
          Specified by:
          +
          setSmartMotionMaxAccel in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setSmartMotionMinOutputVelocity

          +
          public com.revrobotics.REVLibError setSmartMotionMinOutputVelocity​(double minVel,
+                                                                   int slotID)
          +
          +
          Specified by:
          +
          setSmartMotionMinOutputVelocity in class XCANSparkMax
          +
          +
          • +
        + + + + + + + + + + + + + + + + + + + + + + + +
          +
        • +

          setIMaxAccum

          +
          public com.revrobotics.REVLibError setIMaxAccum​(double iMaxAccum,
+                                                int slotID)
          +
          +
          Specified by:
          +
          setIMaxAccum in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getIMaxAccum

          +
          public double getIMaxAccum​(int slotID)
          +
          +
          Specified by:
          +
          getIMaxAccum in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setIAccum

          +
          public com.revrobotics.REVLibError setIAccum​(double iAccum)
          +
          +
          Specified by:
          +
          setIAccum in class XCANSparkMax
          +
          +
          • +
        + + + + + + + + + + + + + + + +
          +
        • +

          setReference

          +
          public com.revrobotics.REVLibError setReference​(double value,
+                                                com.revrobotics.CANSparkMax.ControlType ctrl)
          +
          +
          Specified by:
          +
          setReference in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public com.revrobotics.REVLibError setReference​(double value,
+                                                com.revrobotics.CANSparkMax.ControlType ctrl,
+                                                int pidSlot)
          +
          +
          Specified by:
          +
          setReference in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public com.revrobotics.REVLibError setReference​(double value,
+                                                com.revrobotics.CANSparkMax.ControlType ctrl,
+                                                int pidSlot,
+                                                double arbFeedforward)
          +
          +
          Specified by:
          +
          setReference in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public com.revrobotics.REVLibError setReference​(double value,
+                                                com.revrobotics.CANSparkMax.ControlType ctrl,
+                                                int pidSlot,
+                                                double arbFeedforward,
+                                                com.revrobotics.SparkMaxPIDController.ArbFFUnits arbFFUnits)
          +
          +
          Specified by:
          +
          setReference in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getReference

          +
          public double getReference()
          +
          • +
        + + + +
          +
        • +

          getControlType

          +
          public com.revrobotics.CANSparkMax.ControlType getControlType()
          +
          • +
        + + + +
          +
        • +

          setVelocity

          +
          public void setVelocity​(double velocity)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setForwardLimitSwitch

          +
          public void setForwardLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType,
+                                  boolean enabled)
          +
          +
          Specified by:
          +
          setForwardLimitSwitch in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setReverseLimitSwitch

          +
          public void setReverseLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType,
+                                  boolean enabled)
          +
          +
          Specified by:
          +
          setReverseLimitSwitch in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getForwardLimitSwitchPressed

          +
          public boolean getForwardLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType)
          +
          +
          Specified by:
          +
          getForwardLimitSwitchPressed in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getReverseLimitSwitchPressed

          +
          public boolean getReverseLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType)
          +
          +
          Specified by:
          +
          getReverseLimitSwitchPressed in class XCANSparkMax
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANTalon.MockCANTalonFactory.html b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANTalon.MockCANTalonFactory.html new file mode 100644 index 00000000..bd826895 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANTalon.MockCANTalonFactory.html @@ -0,0 +1,319 @@ + + + + + +MockCANTalon.MockCANTalonFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.mock_adapters
    +

    Class MockCANTalon.MockCANTalonFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.mock_adapters.MockCANTalon.MockCANTalonFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      +
      • +
    +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANTalon.html b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANTalon.html new file mode 100644 index 00000000..2cd582a2 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANTalon.html @@ -0,0 +1,3069 @@ + + + + + +MockCANTalon (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.mock_adapters
    +

    Class MockCANTalon

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      com.ctre.phoenix.motorcontrol.IFollower, com.ctre.phoenix.motorcontrol.IMotorController, com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced, com.ctre.phoenix.signals.IInvertable, com.ctre.phoenix.signals.IOutputSignal, ISimulatableMotor, ISimulatableSensor
      +
      +
      +
      public class MockCANTalon
+extends XCANTalon
+implements ISimulatableSensor, ISimulatableMotor
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          deviceId

          +
          public final int deviceId
          +
          • +
        + + + +
          +
        • +

          internalEncoder

          +
          public XEncoder internalEncoder
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode Mode,
+                double demand)
          +
          +
          Specified by:
          +
          set in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          set in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSetpoint

          +
          public double getSetpoint()
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode Mode,
+                double demand0,
+                double demand1)
          +
          +
          Overrides:
          +
          set in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getThrottlePercent

          +
          public double getThrottlePercent()
          +
          Returns the low-level throttle percentage that would typically be sent to a motor. + For example, if a motor is configured as Inverted, and it was set to a value of 0.75: + getThrottlePercent (this method) would return -0.75 + getMotorOutputPercent would return 0.75 + As such, this is the method you would want to hook into consumers like a simulator, so that + changing inversion would affect them.
          +
          +
          Returns:
          +
          Motor throttle percentage (potentially inverted)
          +
          +
          • +
        + + + +
          +
        • +

          neutralOutput

          +
          public void neutralOutput()
          +
          +
          Specified by:
          +
          neutralOutput in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          neutralOutput in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setNeutralMode

          +
          public void setNeutralMode​(com.ctre.phoenix.motorcontrol.NeutralMode neutralMode)
          +
          +
          Specified by:
          +
          setNeutralMode in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setNeutralMode in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setSensorPhase

          +
          public void setSensorPhase​(boolean PhaseSensor)
          +
          +
          Specified by:
          +
          setSensorPhase in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setSensorPhase in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean invert)
          +
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configOpenloopRamp

          +
          public com.ctre.phoenix.ErrorCode configOpenloopRamp​(double secondsFromNeutralToFull,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configOpenloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configOpenloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getOpenLoopRamp

          +
          public double getOpenLoopRamp()
          +
          • +
        + + + +
          +
        • +

          configClosedloopRamp

          +
          public com.ctre.phoenix.ErrorCode configClosedloopRamp​(double secondsFromNeutralToFull,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configClosedloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configClosedloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputForward

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputForward​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputReverse​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputForward

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputForward​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputReverse​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNeutralDeadband

          +
          public com.ctre.phoenix.ErrorCode configNeutralDeadband​(double percentDeadband,
+                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configNeutralDeadband in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNeutralDeadband in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageCompSaturation

          +
          public com.ctre.phoenix.ErrorCode configVoltageCompSaturation​(double voltage,
+                                                              int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageCompSaturation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageCompSaturation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageMeasurementFilter

          +
          public com.ctre.phoenix.ErrorCode configVoltageMeasurementFilter​(int filterWindowSamples,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageMeasurementFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageMeasurementFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          enableVoltageCompensation

          +
          public void enableVoltageCompensation​(boolean enable)
          +
          +
          Specified by:
          +
          enableVoltageCompensation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          enableVoltageCompensation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getBusVoltage

          +
          public double getBusVoltage()
          +
          +
          Specified by:
          +
          getBusVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBusVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputPercent

          +
          public double getMotorOutputPercent()
          +
          +
          Specified by:
          +
          getMotorOutputPercent in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputPercent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputVoltage

          +
          public double getMotorOutputVoltage()
          +
          +
          Specified by:
          +
          getMotorOutputVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getOutputCurrent

          +
          public double getOutputCurrent()
          +
          +
          Specified by:
          +
          getOutputCurrent in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getOutputCurrent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setOutputCurrent

          +
          public void setOutputCurrent​(double current)
          +
          • +
        + + + +
          +
        • +

          getTemperature

          +
          public double getTemperature()
          +
          +
          Specified by:
          +
          getTemperature in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getTemperature in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(int deviceID,
+                                                             com.ctre.phoenix.motorcontrol.RemoteSensorSource remoteSensorSource,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configRemoteFeedbackFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configRemoteFeedbackFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSensorTerm

          +
          public com.ctre.phoenix.ErrorCode configSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm,
+                                                   com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                   int timeoutMs)
          +
          +
          Specified by:
          +
          configSensorTerm in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSensorTerm in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorPosition

          +
          public double getSelectedSensorPosition​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorVelocity

          +
          public double getSelectedSensorVelocity​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(int sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          setSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setControlFramePeriod​(com.ctre.phoenix.motorcontrol.ControlFrame frame,
+                                                        int periodMs)
          +
          +
          Specified by:
          +
          setControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementWindow

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementWindow​(int windowSize,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementWindow in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementWindow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          overrideLimitSwitchesEnable

          +
          public void overrideLimitSwitchesEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(int forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(int reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          overrideSoftLimitsEnable

          +
          public void overrideSoftLimitsEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideSoftLimitsEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideSoftLimitsEnable in class XCANTalon
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setForwardLimitSwitch

          +
          public void setForwardLimitSwitch​(boolean value)
          +
          • +
        + + + + + + + +
          +
        • +

          setReverseLimitSwitch

          +
          public void setReverseLimitSwitch​(boolean value)
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentLimit​(int amps,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentDuration

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentDuration​(int milliseconds,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentDuration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configContinuousCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configContinuousCurrentLimit​(int amps,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configContinuousCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getContinuousCurrentLimit

          +
          public int getContinuousCurrentLimit()
          +
          • +
        + + + +
          +
        • +

          enableCurrentLimit

          +
          public void enableCurrentLimit​(boolean enable)
          +
          +
          Specified by:
          +
          enableCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kP

          +
          public com.ctre.phoenix.ErrorCode config_kP​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kP in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kP in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kI

          +
          public com.ctre.phoenix.ErrorCode config_kI​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kI in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kI in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kD

          +
          public com.ctre.phoenix.ErrorCode config_kD​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kD in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kD in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kF

          +
          public com.ctre.phoenix.ErrorCode config_kF​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kF in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kF in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      int izone,
+                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          config_IntegralZone in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 int allowableCloseLoopError,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configAllowableClosedloopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMaxIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode configMaxIntegralAccumulator​(int slotIdx,
+                                                               double iaccum,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configMaxIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configMaxIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode setIntegralAccumulator​(double iaccum,
+                                                         int pidIdx,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          setIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopError

          +
          public double getClosedLoopError​(int pidIdx)
          +
          +
          Specified by:
          +
          getClosedLoopError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getClosedLoopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getIntegralAccumulator

          +
          public double getIntegralAccumulator​(int pidIdx)
          +
          +
          Specified by:
          +
          getIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getErrorDerivative

          +
          public double getErrorDerivative​(int pidIdx)
          +
          +
          Specified by:
          +
          getErrorDerivative in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getErrorDerivative in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          selectProfileSlot

          +
          public void selectProfileSlot​(int slotIdx,
+                              int pidIdx)
          +
          +
          Specified by:
          +
          selectProfileSlot in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          selectProfileSlot in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryPosition

          +
          public double getActiveTrajectoryPosition()
          +
          +
          Specified by:
          +
          getActiveTrajectoryPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryVelocity

          +
          public double getActiveTrajectoryVelocity()
          +
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in class XCANTalon
          +
          +
          • +
        + + + + + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(int sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionCruiseVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(int sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionAcceleration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileTrajectories

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileTrajectories()
          +
          +
          Specified by:
          +
          clearMotionProfileTrajectories in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileTrajectories in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileTopLevelBufferCount

          +
          public int getMotionProfileTopLevelBufferCount()
          +
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          pushMotionProfileTrajectory

          +
          public com.ctre.phoenix.ErrorCode pushMotionProfileTrajectory​(com.ctre.phoenix.motion.TrajectoryPoint trajPt)
          +
          +
          Specified by:
          +
          pushMotionProfileTrajectory in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          pushMotionProfileTrajectory in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          isMotionProfileTopLevelBufferFull

          +
          public boolean isMotionProfileTopLevelBufferFull()
          +
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          processMotionProfileBuffer

          +
          public void processMotionProfileBuffer()
          +
          +
          Specified by:
          +
          processMotionProfileBuffer in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          processMotionProfileBuffer in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileStatus

          +
          public com.ctre.phoenix.ErrorCode getMotionProfileStatus​(com.ctre.phoenix.motion.MotionProfileStatus statusToFill)
          +
          +
          Specified by:
          +
          getMotionProfileStatus in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileStatus in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileHasUnderrun

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileHasUnderrun​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          changeMotionControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode changeMotionControlFramePeriod​(int periodMs)
          +
          +
          Specified by:
          +
          changeMotionControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          changeMotionControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getLastError

          +
          public com.ctre.phoenix.ErrorCode getLastError()
          +
          +
          Specified by:
          +
          getLastError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getLastError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public com.ctre.phoenix.ErrorCode getFaults​(com.ctre.phoenix.motorcontrol.Faults toFill)
          +
          +
          Specified by:
          +
          getFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public com.ctre.phoenix.ErrorCode getStickyFaults​(com.ctre.phoenix.motorcontrol.StickyFaults toFill)
          +
          +
          Specified by:
          +
          getStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public com.ctre.phoenix.ErrorCode clearStickyFaults​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getFirmwareVersion

          +
          public int getFirmwareVersion()
          +
          +
          Specified by:
          +
          getFirmwareVersion in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFirmwareVersion in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          hasResetOccurred

          +
          public boolean hasResetOccurred()
          +
          +
          Specified by:
          +
          hasResetOccurred in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          hasResetOccurred in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetCustomParam

          +
          public com.ctre.phoenix.ErrorCode configSetCustomParam​(int newValue,
+                                                       int paramIndex,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configSetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetCustomParam

          +
          public int configGetCustomParam​(int paramIndex,
+                                int timoutMs)
          +
          +
          Specified by:
          +
          configGetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(com.ctre.phoenix.ParamEnum param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(int param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(com.ctre.phoenix.ParamEnum paramEnum,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(int paramEnum,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getBaseID

          +
          public int getBaseID()
          +
          +
          Specified by:
          +
          getBaseID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBaseID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceID

          +
          public int getDeviceID()
          +
          +
          Specified by:
          +
          getDeviceID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getDeviceID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public void follow​(com.ctre.phoenix.motorcontrol.IMotorController masterToFollow)
          +
          +
          Specified by:
          +
          follow in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          follow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          valueUpdated

          +
          public void valueUpdated()
          +
          +
          Specified by:
          +
          valueUpdated in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          valueUpdated in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getPosition

          +
          public double getPosition()
          +
          • +
        + + + +
          +
        • +

          setPosition

          +
          public void setPosition​(double pos)
          +
          • +
        + + + +
          +
        • +

          setRate

          +
          public void setRate​(double rate)
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode Mode,
+                double demand0,
+                com.ctre.phoenix.motorcontrol.DemandType demand1Type,
+                double demand1)
          +
          +
          Specified by:
          +
          set in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackCoefficient

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackCoefficient​(double coefficient,
+                                                                    int pidIdx,
+                                                                    int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackCoefficient in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeakOutput

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeakOutput​(int slotIdx,
+                                                             double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configClosedLoopPeakOutput in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeriod

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeriod​(int slotIdx,
+                                                         int loopTimeMs,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          configClosedLoopPeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configAuxPIDPolarity

          +
          public com.ctre.phoenix.ErrorCode configAuxPIDPolarity​(boolean invert,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configAuxPIDPolarity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopTarget

          +
          public double getClosedLoopTarget​(int pidIdx)
          +
          +
          Specified by:
          +
          getClosedLoopTarget in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configMotionProfileTrajectoryPeriod

          +
          public com.ctre.phoenix.ErrorCode configMotionProfileTrajectoryPeriod​(int baseTrajDurationMs,
+                                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionProfileTrajectoryPeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          getControlMode

          +
          public com.ctre.phoenix.motorcontrol.ControlMode getControlMode()
          +
          +
          Specified by:
          +
          getControlMode in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configMotionSCurveStrength

          +
          public com.ctre.phoenix.ErrorCode configMotionSCurveStrength​(int curveStrength,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionSCurveStrength in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setPulseWidthRiseToFallUs

          +
          public void setPulseWidthRiseToFallUs​(int value)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          configSupplyCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configSupplyCurrentLimit​(com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration currLimitCfg,
+                                                           int timeoutMs)
          +
          +
          Specified by:
          +
          configSupplyCurrentLimit in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(com.ctre.phoenix.motorcontrol.InvertType invertType)
          +
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.sensors.CANCoder canCoderRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configRemoteFeedbackFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.motorcontrol.can.BaseTalon talonRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configRemoteFeedbackFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(double sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          setSelectedSensorPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(double forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitThreshold in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(double reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitThreshold in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      double izone,
+                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          config_IntegralZone in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 double allowableCloseLoopError,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configAllowableClosedloopError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(double sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionCruiseVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(double sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionAcceleration in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.sensors.SensorVelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.motorcontrol.VelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANVictorSPX.MockCANVictorSPXFactory.html b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANVictorSPX.MockCANVictorSPXFactory.html new file mode 100644 index 00000000..d8b71147 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANVictorSPX.MockCANVictorSPXFactory.html @@ -0,0 +1,319 @@ + + + + + +MockCANVictorSPX.MockCANVictorSPXFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.mock_adapters
    +

    Class MockCANVictorSPX.MockCANVictorSPXFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.mock_adapters.MockCANVictorSPX.MockCANVictorSPXFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract MockCANVictorSPXcreate​(int deviceId) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANVictorSPX.html b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANVictorSPX.html new file mode 100644 index 00000000..dab43361 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/MockCANVictorSPX.html @@ -0,0 +1,2717 @@ + + + + + +MockCANVictorSPX (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.mock_adapters
    +

    Class MockCANVictorSPX

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      com.ctre.phoenix.motorcontrol.IFollower, com.ctre.phoenix.motorcontrol.IMotorController, com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced, com.ctre.phoenix.signals.IInvertable, com.ctre.phoenix.signals.IOutputSignal
      +
      +
      +
      public class MockCANVictorSPX
+extends XCANVictorSPX
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MockCANVictorSPX

          +
          @AssistedInject
+public MockCANVictorSPX​(@Assisted("deviceId")
+                        int deviceId,
+                        PropertyFactory propMan,
+                        DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode Mode,
+                double demand0,
+                com.ctre.phoenix.motorcontrol.DemandType demand1Type,
+                double demand1)
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackCoefficient

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackCoefficient​(double coefficient,
+                                                                    int pidIdx,
+                                                                    int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeakOutput

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeakOutput​(int slotIdx,
+                                                             double percentOut,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeriod

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeriod​(int slotIdx,
+                                                         int loopTimeMs,
+                                                         int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configAuxPIDPolarity

          +
          public com.ctre.phoenix.ErrorCode configAuxPIDPolarity​(boolean invert,
+                                                       int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getClosedLoopTarget

          +
          public double getClosedLoopTarget​(int pidIdx)
          +
          • +
        + + + +
          +
        • +

          configMotionSCurveStrength

          +
          public com.ctre.phoenix.ErrorCode configMotionSCurveStrength​(int curveStrength,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionProfileTrajectoryPeriod

          +
          public com.ctre.phoenix.ErrorCode configMotionProfileTrajectoryPeriod​(int baseTrajDurationMs,
+                                                                      int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getControlMode

          +
          public com.ctre.phoenix.motorcontrol.ControlMode getControlMode()
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode Mode,
+                double demand)
          +
          +
          Specified by:
          +
          set in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          set in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          neutralOutput

          +
          public void neutralOutput()
          +
          +
          Specified by:
          +
          neutralOutput in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          neutralOutput in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setNeutralMode

          +
          public void setNeutralMode​(com.ctre.phoenix.motorcontrol.NeutralMode neutralMode)
          +
          +
          Specified by:
          +
          setNeutralMode in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setNeutralMode in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setSensorPhase

          +
          public void setSensorPhase​(boolean PhaseSensor)
          +
          +
          Specified by:
          +
          setSensorPhase in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setSensorPhase in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean invert)
          +
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configOpenloopRamp

          +
          public com.ctre.phoenix.ErrorCode configOpenloopRamp​(double secondsFromNeutralToFull,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configOpenloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configOpenloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configClosedloopRamp

          +
          public com.ctre.phoenix.ErrorCode configClosedloopRamp​(double secondsFromNeutralToFull,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configClosedloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configClosedloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputForward

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputForward​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputReverse​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputForward

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputForward​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputReverse​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNeutralDeadband

          +
          public com.ctre.phoenix.ErrorCode configNeutralDeadband​(double percentDeadband,
+                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configNeutralDeadband in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNeutralDeadband in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageCompSaturation

          +
          public com.ctre.phoenix.ErrorCode configVoltageCompSaturation​(double voltage,
+                                                              int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageCompSaturation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageCompSaturation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageMeasurementFilter

          +
          public com.ctre.phoenix.ErrorCode configVoltageMeasurementFilter​(int filterWindowSamples,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageMeasurementFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageMeasurementFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          enableVoltageCompensation

          +
          public void enableVoltageCompensation​(boolean enable)
          +
          +
          Specified by:
          +
          enableVoltageCompensation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          enableVoltageCompensation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getBusVoltage

          +
          public double getBusVoltage()
          +
          +
          Specified by:
          +
          getBusVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBusVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputPercent

          +
          public double getMotorOutputPercent()
          +
          +
          Specified by:
          +
          getMotorOutputPercent in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputPercent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputVoltage

          +
          public double getMotorOutputVoltage()
          +
          +
          Specified by:
          +
          getMotorOutputVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getOutputCurrent

          +
          public double getOutputCurrent()
          +
          +
          Specified by:
          +
          getOutputCurrent in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getOutputCurrent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getTemperature

          +
          public double getTemperature()
          +
          +
          Specified by:
          +
          getTemperature in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getTemperature in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(int deviceID,
+                                                             com.ctre.phoenix.motorcontrol.RemoteSensorSource remoteSensorSource,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configRemoteFeedbackFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configRemoteFeedbackFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSensorTerm

          +
          public com.ctre.phoenix.ErrorCode configSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm,
+                                                   com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                   int timeoutMs)
          +
          +
          Specified by:
          +
          configSensorTerm in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSensorTerm in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorPosition

          +
          public double getSelectedSensorPosition​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorVelocity

          +
          public double getSelectedSensorVelocity​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(int sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          setSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setControlFramePeriod​(com.ctre.phoenix.motorcontrol.ControlFrame frame,
+                                                        int periodMs)
          +
          +
          Specified by:
          +
          setControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.motorcontrol.VelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementWindow

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementWindow​(int windowSize,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementWindow in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementWindow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          overrideLimitSwitchesEnable

          +
          public void overrideLimitSwitchesEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(int forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(int reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          overrideSoftLimitsEnable

          +
          public void overrideSoftLimitsEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideSoftLimitsEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideSoftLimitsEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentLimit​(int amps,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentDuration

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentDuration​(int milliseconds,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentDuration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configContinuousCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configContinuousCurrentLimit​(int amps,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configContinuousCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          enableCurrentLimit

          +
          public void enableCurrentLimit​(boolean enable)
          +
          +
          Specified by:
          +
          enableCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kP

          +
          public com.ctre.phoenix.ErrorCode config_kP​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kP in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kP in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kI

          +
          public com.ctre.phoenix.ErrorCode config_kI​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kI in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kI in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kD

          +
          public com.ctre.phoenix.ErrorCode config_kD​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kD in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kD in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kF

          +
          public com.ctre.phoenix.ErrorCode config_kF​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kF in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kF in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      int izone,
+                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          config_IntegralZone in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 int allowableCloseLoopError,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configAllowableClosedloopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMaxIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode configMaxIntegralAccumulator​(int slotIdx,
+                                                               double iaccum,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configMaxIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configMaxIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode setIntegralAccumulator​(double iaccum,
+                                                         int pidIdx,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          setIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopError

          +
          public double getClosedLoopError​(int pidIdx)
          +
          +
          Specified by:
          +
          getClosedLoopError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getClosedLoopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getIntegralAccumulator

          +
          public double getIntegralAccumulator​(int pidIdx)
          +
          +
          Specified by:
          +
          getIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getErrorDerivative

          +
          public double getErrorDerivative​(int pidIdx)
          +
          +
          Specified by:
          +
          getErrorDerivative in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getErrorDerivative in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          selectProfileSlot

          +
          public void selectProfileSlot​(int slotIdx,
+                              int pidIdx)
          +
          +
          Specified by:
          +
          selectProfileSlot in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          selectProfileSlot in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryPosition

          +
          public double getActiveTrajectoryPosition()
          +
          +
          Specified by:
          +
          getActiveTrajectoryPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryVelocity

          +
          public double getActiveTrajectoryVelocity()
          +
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in class XCANTalon
          +
          +
          • +
        + + + + + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(int sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionCruiseVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(int sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionAcceleration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileTrajectories

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileTrajectories()
          +
          +
          Specified by:
          +
          clearMotionProfileTrajectories in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileTrajectories in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileTopLevelBufferCount

          +
          public int getMotionProfileTopLevelBufferCount()
          +
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          pushMotionProfileTrajectory

          +
          public com.ctre.phoenix.ErrorCode pushMotionProfileTrajectory​(com.ctre.phoenix.motion.TrajectoryPoint trajPt)
          +
          +
          Specified by:
          +
          pushMotionProfileTrajectory in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          pushMotionProfileTrajectory in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          isMotionProfileTopLevelBufferFull

          +
          public boolean isMotionProfileTopLevelBufferFull()
          +
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          processMotionProfileBuffer

          +
          public void processMotionProfileBuffer()
          +
          +
          Specified by:
          +
          processMotionProfileBuffer in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          processMotionProfileBuffer in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileStatus

          +
          public com.ctre.phoenix.ErrorCode getMotionProfileStatus​(com.ctre.phoenix.motion.MotionProfileStatus statusToFill)
          +
          +
          Specified by:
          +
          getMotionProfileStatus in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileStatus in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileHasUnderrun

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileHasUnderrun​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          changeMotionControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode changeMotionControlFramePeriod​(int periodMs)
          +
          +
          Specified by:
          +
          changeMotionControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          changeMotionControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getLastError

          +
          public com.ctre.phoenix.ErrorCode getLastError()
          +
          +
          Specified by:
          +
          getLastError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getLastError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public com.ctre.phoenix.ErrorCode getFaults​(com.ctre.phoenix.motorcontrol.Faults toFill)
          +
          +
          Specified by:
          +
          getFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public com.ctre.phoenix.ErrorCode getStickyFaults​(com.ctre.phoenix.motorcontrol.StickyFaults toFill)
          +
          +
          Specified by:
          +
          getStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public com.ctre.phoenix.ErrorCode clearStickyFaults​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getFirmwareVersion

          +
          public int getFirmwareVersion()
          +
          +
          Specified by:
          +
          getFirmwareVersion in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFirmwareVersion in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          hasResetOccurred

          +
          public boolean hasResetOccurred()
          +
          +
          Specified by:
          +
          hasResetOccurred in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          hasResetOccurred in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetCustomParam

          +
          public com.ctre.phoenix.ErrorCode configSetCustomParam​(int newValue,
+                                                       int paramIndex,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configSetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetCustomParam

          +
          public int configGetCustomParam​(int paramIndex,
+                                int timoutMs)
          +
          +
          Specified by:
          +
          configGetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(com.ctre.phoenix.ParamEnum param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(int param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(com.ctre.phoenix.ParamEnum paramEnum,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(int paramEnum,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getBaseID

          +
          public int getBaseID()
          +
          +
          Specified by:
          +
          getBaseID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBaseID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceID

          +
          public int getDeviceID()
          +
          +
          Specified by:
          +
          getDeviceID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getDeviceID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public void follow​(com.ctre.phoenix.motorcontrol.IMotorController masterToFollow)
          +
          +
          Specified by:
          +
          follow in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          follow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          valueUpdated

          +
          public void valueUpdated()
          +
          +
          Specified by:
          +
          valueUpdated in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          valueUpdated in class XCANTalon
          +
          +
          • +
        + + + + + + + +
          +
        • +

          configSupplyCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configSupplyCurrentLimit​(com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration currLimitCfg,
+                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(com.ctre.phoenix.motorcontrol.InvertType invertType)
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.sensors.CANCoder canCoderRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.motorcontrol.can.BaseTalon talonRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(double sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(double forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(double reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      double izone,
+                                                      int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 double allowableCloseLoopError,
+                                                                 int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(double sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(double sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.sensors.SensorVelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in class XCANTalon
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/MockRelay.MockRelayFactory.html b/javadoc/xbot/common/controls/actuators/mock_adapters/MockRelay.MockRelayFactory.html new file mode 100644 index 00000000..84d4d190 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/MockRelay.MockRelayFactory.html @@ -0,0 +1,319 @@ + + + + + +MockRelay.MockRelayFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.mock_adapters
    +

    Class MockRelay.MockRelayFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.mock_adapters.MockRelay.MockRelayFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        MockRelayFactory() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract MockRelaycreate​(int channel) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          MockRelayFactory

          +
          public MockRelayFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/MockRelay.html b/javadoc/xbot/common/controls/actuators/mock_adapters/MockRelay.html new file mode 100644 index 00000000..7b190858 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/MockRelay.html @@ -0,0 +1,385 @@ + + + + + +MockRelay (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.mock_adapters
    +

    Class MockRelay

    +
    +
    + +
    +
      +
    • +
      +
      public class MockRelay
+extends XRelay
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        MockRelay​(int channel, + DevicePolice police) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        edu.wpi.first.wpilibj.Relay.Valueget() 
        voidset​(edu.wpi.first.wpilibj.Relay.Value value) 
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          MockRelay

          +
          @AssistedInject
+public MockRelay​(@Assisted("channel")
+                 int channel,
+                 DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          set

          +
          public void set​(edu.wpi.first.wpilibj.Relay.Value value)
          +
          +
          Specified by:
          +
          set in class XRelay
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public edu.wpi.first.wpilibj.Relay.Value get()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/package-summary.html b/javadoc/xbot/common/controls/actuators/mock_adapters/package-summary.html new file mode 100644 index 00000000..a49aaf31 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/package-summary.html @@ -0,0 +1,192 @@ + + + + + +xbot.common.controls.actuators.mock_adapters (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.controls.actuators.mock_adapters

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/mock_adapters/package-tree.html b/javadoc/xbot/common/controls/actuators/mock_adapters/package-tree.html new file mode 100644 index 00000000..1e90561f --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/mock_adapters/package-tree.html @@ -0,0 +1,188 @@ + + + + + +xbot.common.controls.actuators.mock_adapters Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.controls.actuators.mock_adapters

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/controls/actuators/package-summary.html b/javadoc/xbot/common/controls/actuators/package-summary.html new file mode 100644 index 00000000..019d3f17 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/package-summary.html @@ -0,0 +1,278 @@ + + + + + +xbot.common.controls.actuators (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.controls.actuators

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/package-tree.html b/javadoc/xbot/common/controls/actuators/package-tree.html new file mode 100644 index 00000000..c67be165 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/package-tree.html @@ -0,0 +1,205 @@ + + + + + +xbot.common.controls.actuators Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.controls.actuators

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory.html new file mode 100644 index 00000000..ee5c4a01 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory.html @@ -0,0 +1,335 @@ + + + + + +CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class CANSparkMaxWpiAdapter.CANSparkMaxWpiAdapterFactory

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CANSparkMaxWpiAdapterFactory

          +
          public CANSparkMaxWpiAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/CANSparkMaxWpiAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANSparkMaxWpiAdapter.html new file mode 100644 index 00000000..c9744210 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANSparkMaxWpiAdapter.html @@ -0,0 +1,3118 @@ + + + + + +CANSparkMaxWpiAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class CANSparkMaxWpiAdapter

    +
    +
    + +
    +
      +
    • +
      +
      public class CANSparkMaxWpiAdapter
+extends XCANSparkMax
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        com.revrobotics.REVLibErrorburnFlash() +
        Writes all settings to flash.
        +
        com.revrobotics.REVLibErrorclearFaults() +
        Clears all sticky faults.
        +
        voidclose() 
        voiddisable() +
        Common interface for disabling a motor.
        +
        com.revrobotics.REVLibErrordisableVoltageCompensation() +
        Disables the voltage compensation setting for all modes on the SPARK MAX.
        +
        com.revrobotics.REVLibErrorenableSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction, + boolean enable) +
        Enable soft limits
        +
        com.revrobotics.REVLibErrorenableVoltageCompensation​(double nominalVoltage) +
        Sets the voltage compensation setting for all modes on the SPARK MAX and + enables voltage compensation.
        +
        com.revrobotics.REVLibErrorfollow​(com.revrobotics.CANSparkMax leader) 
        com.revrobotics.REVLibErrorfollow​(com.revrobotics.CANSparkMax.ExternalFollower leader, + int deviceID) +
        Causes this controller's output to mirror the provided leader.
        +
        com.revrobotics.REVLibErrorfollow​(com.revrobotics.CANSparkMax.ExternalFollower leader, + int deviceID, + boolean invert) +
        Causes this controller's output to mirror the provided leader.
        +
        com.revrobotics.REVLibErrorfollow​(com.revrobotics.CANSparkMax leader, + boolean invert) 
        com.revrobotics.REVLibErrorfollow​(XCANSparkMax leader) +
        Causes this controller's output to mirror the provided leader.
        +
        com.revrobotics.REVLibErrorfollow​(XCANSparkMax leader, + boolean invert) +
        Causes this controller's output to mirror the provided leader.
        +
        doubleget() +
        Common interface for getting the current set speed of a speed controller.
        +
        com.revrobotics.RelativeEncodergetAlternateEncoder​(int countsPerRev) 
        com.revrobotics.RelativeEncodergetAlternateEncoder​(com.revrobotics.SparkMaxAlternateEncoder.Type encoderType, + int countsPerRev) 
        com.revrobotics.SparkMaxAnalogSensorgetAnalog​(com.revrobotics.SparkMaxAnalogSensor.Mode mode) 
        doublegetAppliedOutput() 
        intgetAverageDepth() 
        doublegetBusVoltage() 
        doublegetClosedLoopRampRate() +
        Get the configured closed loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
        +
        intgetCountsPerRevolution() 
        doublegetD() 
        doublegetD​(int slotID) 
        intgetDeviceId() 
        doublegetDFilter​(int slotID) 
        com.revrobotics.RelativeEncodergetEncoder​(com.revrobotics.SparkMaxRelativeEncoder.Type encoderType, + int countsPerRev) 
        booleangetFault​(com.revrobotics.CANSparkMax.FaultID faultID) +
        Get the value of a specific fault
        +
        shortgetFaults() 
        doublegetFF() 
        doublegetFF​(int slotID) 
        java.lang.StringgetFirmwareString() 
        intgetFirmwareVersion() 
        com.revrobotics.SparkMaxLimitSwitchgetForwardLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType) 
        booleangetForwardLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType) 
        doublegetI() 
        doublegetI​(int slotID) 
        doublegetIAccum() 
        com.revrobotics.CANSparkMax.IdleModegetIdleMode() +
        Gets the idle mode setting for the SPARK MAX.
        +
        doublegetIMaxAccum​(int slotID) 
        com.revrobotics.CANSparkMaxgetInternalSparkMax() 
        booleangetInverted() +
        Common interface for returning the inversion state of a speed controller.
        +
        doublegetIZone() 
        doublegetIZone​(int slotID) 
        com.revrobotics.REVLibErrorgetLastError() +
        All device errors are tracked on a per thread basis for all devices in that + thread.
        +
        intgetMeasurementPeriod() 
        doublegetMotorTemperature() 
        com.revrobotics.CANSparkMaxLowLevel.MotorTypegetMotorType() 
        doublegetOpenLoopRampRate() +
        Get the configured open loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
        +
        doublegetOutputCurrent() 
        doublegetOutputMax() 
        doublegetOutputMax​(int slotID) 
        doublegetOutputMin() 
        doublegetOutputMin​(int slotID) 
        doublegetP() 
        doublegetP​(int slotID) 
        com.revrobotics.SparkMaxPIDControllergetPIDController() 
        doublegetPosition() 
        doublegetPositionConversionFactor() 
        com.revrobotics.SparkMaxLimitSwitchgetReverseLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType) 
        booleangetReverseLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType) 
        floatgetSafeFloat​(float f) 
        byte[]getSerialNumber() 
        com.revrobotics.SparkMaxPIDController.AccelStrategygetSmartMotionAccelStrategy​(int slotID) 
        doublegetSmartMotionAllowedClosedLoopError​(int slotID) 
        doublegetSmartMotionMaxAccel​(int slotID) 
        doublegetSmartMotionMaxVelocity​(int slotID) 
        doublegetSmartMotionMinOutputVelocity​(int slotID) 
        doublegetSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction) +
        Get the soft limit setting in the controller
        +
        booleangetStickyFault​(com.revrobotics.CANSparkMax.FaultID faultID) +
        Get the value of a specific sticky fault
        +
        shortgetStickyFaults() 
        doublegetVelocity() 
        doublegetVelocityConversionFactor() 
        doublegetVoltageCompensationNominalVoltage() +
        Get the configured voltage compensation nominal voltage value
        +
        inthashCode() 
        booleanisFollower() +
        Returns whether the controller is following another controller
        +
        booleanisSoftLimitEnabled​(com.revrobotics.CANSparkMax.SoftLimitDirection direction) 
        com.revrobotics.REVLibErrorrestoreFactoryDefaults() 
        com.revrobotics.REVLibErrorrestoreFactoryDefaults​(boolean persist) 
        voidset​(double speed) +
        Common interface for setting the speed of a speed controller.
        +
        com.revrobotics.REVLibErrorsetAverageDepth​(int depth) 
        com.revrobotics.REVLibErrorsetCANTimeout​(int milliseconds) +
        Sets timeout for sending CAN messages with SetParameter* and GetParameter* + calls.
        +
        com.revrobotics.REVLibErrorsetClosedLoopRampRate​(double rate) +
        Sets the ramp rate for closed loop control modes.
        +
        voidsetControlFramePeriodMs​(int periodMs) 
        com.revrobotics.REVLibErrorsetD​(double gain) 
        com.revrobotics.REVLibErrorsetD​(double gain, + int slotID) 
        com.revrobotics.REVLibErrorsetDFilter​(double gain) 
        com.revrobotics.REVLibErrorsetDFilter​(double gain, + int slotID) 
        com.revrobotics.REVLibErrorsetEncoderInverted​(boolean inverted) 
        com.revrobotics.REVLibErrorsetFeedbackDevice​(com.revrobotics.MotorFeedbackSensor sensor) 
        com.revrobotics.REVLibErrorsetFF​(double gain) 
        com.revrobotics.REVLibErrorsetFF​(double gain, + int slotID) 
        voidsetForwardLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType, + boolean enabled) 
        com.revrobotics.REVLibErrorsetI​(double gain) 
        com.revrobotics.REVLibErrorsetI​(double gain, + int slotID) 
        com.revrobotics.REVLibErrorsetIAccum​(double iAccum) 
        com.revrobotics.REVLibErrorsetIdleMode​(com.revrobotics.CANSparkMax.IdleMode mode) +
        Sets the idle mode setting for the SPARK MAX.
        +
        com.revrobotics.REVLibErrorsetIMaxAccum​(double iMaxAccum, + int slotID) 
        voidsetInverted​(boolean isInverted) +
        Common interface for inverting direction of a speed controller.
        +
        com.revrobotics.REVLibErrorsetIZone​(double iZone) 
        com.revrobotics.REVLibErrorsetIZone​(double iZone, + int slotID) 
        com.revrobotics.REVLibErrorsetMeasurementPeriod​(int period_ms) 
        com.revrobotics.REVLibErrorsetOpenLoopRampRate​(double rate) +
        Sets the ramp rate for open loop control modes.
        +
        com.revrobotics.REVLibErrorsetOutputRange​(double min, + double max) 
        com.revrobotics.REVLibErrorsetOutputRange​(double min, + double max, + int slotID) 
        com.revrobotics.REVLibErrorsetP​(double gain) 
        com.revrobotics.REVLibErrorsetP​(double gain, + int slotID) 
        com.revrobotics.REVLibErrorsetPeriodicFramePeriod​(com.revrobotics.CANSparkMaxLowLevel.PeriodicFrame frame, + int periodMs) 
        com.revrobotics.REVLibErrorsetPosition​(double position) 
        com.revrobotics.REVLibErrorsetPositionConversionFactor​(double factor) 
        com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl) 
        com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl, + int pidSlot) 
        com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl, + int pidSlot, + double arbFeedforward) 
        com.revrobotics.REVLibErrorsetReference​(double value, + com.revrobotics.CANSparkMax.ControlType ctrl, + int pidSlot, + double arbFeedforward, + com.revrobotics.SparkMaxPIDController.ArbFFUnits arbFFUnits) 
        voidsetReverseLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType, + boolean enabled) 
        com.revrobotics.REVLibErrorsetSecondaryCurrentLimit​(double limit) +
        Sets the secondary current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSecondaryCurrentLimit​(double limit, + int chopCycles) +
        Sets the secondary current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSmartCurrentLimit​(int limit) +
        Sets the current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSmartCurrentLimit​(int stallLimit, + int freeLimit) +
        Sets the current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSmartCurrentLimit​(int stallLimit, + int freeLimit, + int limitRPM) +
        Sets the current limit in Amps.
        +
        com.revrobotics.REVLibErrorsetSmartMotionAccelStrategy​(com.revrobotics.SparkMaxPIDController.AccelStrategy accelStrategy, + int slotID) 
        com.revrobotics.REVLibErrorsetSmartMotionAllowedClosedLoopError​(double allowedErr, + int slotID) 
        com.revrobotics.REVLibErrorsetSmartMotionMaxAccel​(double maxAccel, + int slotID) 
        com.revrobotics.REVLibErrorsetSmartMotionMaxVelocity​(double maxVel, + int slotID) 
        com.revrobotics.REVLibErrorsetSmartMotionMinOutputVelocity​(double minVel, + int slotID) 
        com.revrobotics.REVLibErrorsetSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction, + float limit) +
        Set the soft limit based on position.
        +
        com.revrobotics.REVLibErrorsetVelocityConversionFactor​(double factor) 
        voidsetVoltage​(double outputVolts) +
        Sets the voltage output of the SpeedController.
        +
        voidstopMotor() 
        java.lang.StringtoString() 
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CANSparkMaxWpiAdapter

          +
          @AssistedInject
+public CANSparkMaxWpiAdapter​(@Assisted("deviceInfo")
+                             DeviceInfo deviceInfo,
+                             @Assisted("owningSystemPrefix")
+                             java.lang.String owningSystemPrefix,
+                             @Assisted("name")
+                             java.lang.String name,
+                             PropertyFactory propMan,
+                             DevicePolice police,
+                             @Assisted("defaultPIDProperties")
+                             XCANSparkMaxPIDProperties defaultPIDProperties)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          close

          +
          public void close()
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(XCANSparkMax leader)
          +
          Description copied from class: XCANSparkMax
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + The motor will spin in the same direction as the leader. This can be changed + by passing a true constant after the leader parameter. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Specified by:
          +
          follow in class XCANSparkMax
          +
          Parameters:
          +
          leader - The motor controller to follow.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(XCANSparkMax leader,
+                                          boolean invert)
          +
          Description copied from class: XCANSparkMax
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Specified by:
          +
          follow in class XCANSparkMax
          +
          Parameters:
          +
          leader - The motor controller to follow.
          +
          invert - Set the follower to output opposite of the leader
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(com.revrobotics.CANSparkMax leader)
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(com.revrobotics.CANSparkMax leader,
+                                          boolean invert)
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(com.revrobotics.CANSparkMax.ExternalFollower leader,
+                                          int deviceID)
          +
          Description copied from class: XCANSparkMax
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + The motor will spin in the same direction as the leader. This can be changed + by passing a true constant after the deviceID parameter. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Specified by:
          +
          follow in class XCANSparkMax
          +
          Parameters:
          +
          leader - The type of motor controller to follow (Talon SRX, Spark Max, + etc.).
          +
          deviceID - The CAN ID of the device to follow.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public com.revrobotics.REVLibError follow​(com.revrobotics.CANSparkMax.ExternalFollower leader,
+                                          int deviceID,
+                                          boolean invert)
          +
          Description copied from class: XCANSparkMax
          +
          Causes this controller's output to mirror the provided leader. + + Only voltage output is mirrored. Settings changed on the leader do not affect + the follower. + + Following anything other than a CAN SPARK MAX is not officially supported.
          +
          +
          Specified by:
          +
          follow in class XCANSparkMax
          +
          Parameters:
          +
          leader - The type of motor controller to follow (Talon SRX, Spark Max, + etc.).
          +
          deviceID - The CAN ID of the device to follow.
          +
          invert - Set the follower to output opposite of the leader
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getFirmwareVersion

          +
          public int getFirmwareVersion()
          +
          • +
        + + + +
          +
        • +

          setControlFramePeriodMs

          +
          public void setControlFramePeriodMs​(int periodMs)
          +
          • +
        + + + +
          +
        • +

          getFirmwareString

          +
          public java.lang.String getFirmwareString()
          +
          • +
        + + + +
          +
        • +

          getSerialNumber

          +
          public byte[] getSerialNumber()
          +
          • +
        + + + +
          +
        • +

          getDeviceId

          +
          public int getDeviceId()
          +
          • +
        + + + + + + + +
          +
        • +

          getMotorType

          +
          public com.revrobotics.CANSparkMaxLowLevel.MotorType getMotorType()
          +
          • +
        + + + +
          +
        • +

          setPeriodicFramePeriod

          +
          public com.revrobotics.REVLibError setPeriodicFramePeriod​(com.revrobotics.CANSparkMaxLowLevel.PeriodicFrame frame,
+                                                          int periodMs)
          +
          • +
        + + + +
          +
        • +

          getSafeFloat

          +
          public float getSafeFloat​(float f)
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(double speed)
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for setting the speed of a speed controller.
          +
          +
          Specified by:
          +
          set in class XCANSparkMax
          +
          Parameters:
          +
          speed - The speed to set. Value should be between -1.0 and 1.0.
          +
          +
          • +
        + + + +
          +
        • +

          setVoltage

          +
          public void setVoltage​(double outputVolts)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the voltage output of the SpeedController. This is equivillant to a call + to SetReference(output, rev::ControlType::kVoltage). The behavior of this + call differs slightly from the WPILib documetation for this call since the + device internally sets the desired voltage (not a compensation value). That + means that this *can* be a 'set-and-forget' call.
          +
          +
          Specified by:
          +
          setVoltage in class XCANSparkMax
          +
          Parameters:
          +
          outputVolts - The voltage to output.
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public double get()
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for getting the current set speed of a speed controller.
          +
          +
          Specified by:
          +
          get in class XCANSparkMax
          +
          Returns:
          +
          The current set speed. Value is between -1.0 and 1.0.
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean isInverted)
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for inverting direction of a speed controller. + + This call has no effect if the controller is a follower.
          +
          +
          Specified by:
          +
          setInverted in class XCANSparkMax
          +
          Parameters:
          +
          isInverted - The state of inversion, true is inverted.
          +
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for returning the inversion state of a speed controller. + + This call has no effect if the controller is a follower.
          +
          +
          Specified by:
          +
          getInverted in class XCANSparkMax
          +
          Returns:
          +
          isInverted The state of inversion, true is inverted.
          +
          +
          • +
        + + + +
          +
        • +

          disable

          +
          public void disable()
          +
          Description copied from class: XCANSparkMax
          +
          Common interface for disabling a motor.
          +
          +
          Specified by:
          +
          disable in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getEncoder

          +
          public com.revrobotics.RelativeEncoder getEncoder​(com.revrobotics.SparkMaxRelativeEncoder.Type encoderType,
+                                                  int countsPerRev)
          +
          • +
        + + + +
          +
        • +

          getAlternateEncoder

          +
          public com.revrobotics.RelativeEncoder getAlternateEncoder​(int countsPerRev)
          +
          • +
        + + + +
          +
        • +

          getAlternateEncoder

          +
          public com.revrobotics.RelativeEncoder getAlternateEncoder​(com.revrobotics.SparkMaxAlternateEncoder.Type encoderType,
+                                                           int countsPerRev)
          +
          • +
        + + + + + + + +
          +
        • +

          restoreFactoryDefaults

          +
          public com.revrobotics.REVLibError restoreFactoryDefaults​(boolean persist)
          +
          • +
        + + + +
          +
        • +

          getAnalog

          +
          public com.revrobotics.SparkMaxAnalogSensor getAnalog​(com.revrobotics.SparkMaxAnalogSensor.Mode mode)
          +
          • +
        + + + +
          +
        • +

          getPIDController

          +
          public com.revrobotics.SparkMaxPIDController getPIDController()
          +
          • +
        + + + +
          +
        • +

          getForwardLimitSwitch

          +
          public com.revrobotics.SparkMaxLimitSwitch getForwardLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType)
          +
          • +
        + + + +
          +
        • +

          getReverseLimitSwitch

          +
          public com.revrobotics.SparkMaxLimitSwitch getReverseLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType)
          +
          • +
        + + + +
          +
        • +

          setSmartCurrentLimit

          +
          public com.revrobotics.REVLibError setSmartCurrentLimit​(int limit)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the current limit in Amps. + + The motor controller will reduce the controller voltage output to avoid + surpassing this limit. This limit is enabled by default and used for + brushless only. This limit is highly recommended when using the NEO brushless + motor. + + The NEO Brushless Motor has a low internal resistance, which can mean large + current spikes that could be enough to cause damage to the motor and + controller. This current limit provides a smarter strategy to deal with high + current draws and keep the motor and controller operating in a safe region.
          +
          +
          Specified by:
          +
          setSmartCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          limit - The current limit in Amps.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSmartCurrentLimit

          +
          public com.revrobotics.REVLibError setSmartCurrentLimit​(int stallLimit,
+                                                        int freeLimit)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the current limit in Amps. + + The motor controller will reduce the controller voltage output to avoid + surpassing this limit. This limit is enabled by default and used for + brushless only. This limit is highly recommended when using the NEO brushless + motor. + + The NEO Brushless Motor has a low internal resistance, which can mean large + current spikes that could be enough to cause damage to the motor and + controller. This current limit provides a smarter strategy to deal with high + current draws and keep the motor and controller operating in a safe region. + + The controller can also limit the current based on the RPM of the motor in a + linear fashion to help with controllability in closed loop control. For a + response that is linear the entire RPM range leave limit RPM at 0.
          +
          +
          Specified by:
          +
          setSmartCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          stallLimit - The current limit in Amps at 0 RPM.
          +
          freeLimit - The current limit at free speed (5700RPM for NEO).
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSmartCurrentLimit

          +
          public com.revrobotics.REVLibError setSmartCurrentLimit​(int stallLimit,
+                                                        int freeLimit,
+                                                        int limitRPM)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the current limit in Amps. + + The motor controller will reduce the controller voltage output to avoid + surpassing this limit. This limit is enabled by default and used for + brushless only. This limit is highly recommended when using the NEO brushless + motor. + + The NEO Brushless Motor has a low internal resistance, which can mean large + current spikes that could be enough to cause damage to the motor and + controller. This current limit provides a smarter strategy to deal with high + current draws and keep the motor and controller operating in a safe region. + + The controller can also limit the current based on the RPM of the motor in a + linear fashion to help with controllability in closed loop control. For a + response that is linear the entire RPM range leave limit RPM at 0.
          +
          +
          Specified by:
          +
          setSmartCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          stallLimit - The current limit in Amps at 0 RPM.
          +
          freeLimit - The current limit at free speed (5700RPM for NEO).
          +
          limitRPM - RPM less than this value will be set to the stallLimit, RPM + values greater than limitRPM will scale linearly to + freeLimit
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSecondaryCurrentLimit

          +
          public com.revrobotics.REVLibError setSecondaryCurrentLimit​(double limit)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the secondary current limit in Amps. + + The motor controller will disable the output of the controller briefly if the + current limit is exceeded to reduce the current. This limit is a simplified + 'on/off' controller. This limit is enabled by default but is set higher than + the default Smart Current Limit. + + The time the controller is off after the current limit is reached is + determined by the parameter limitCycles, which is the number of PWM cycles + (20kHz). The recommended value is the default of 0 which is the minimum time + and is part of a PWM cycle from when the over current is detected. This + allows the controller to regulate the current close to the limit value. + + The total time is set by the equation + + + t = (50us - t0) + 50us * limitCycles + t = total off time after over current + t0 = time from the start of the PWM cycle until over current is detected +
          +
          +
          Specified by:
          +
          setSecondaryCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          limit - The current limit in Amps.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSecondaryCurrentLimit

          +
          public com.revrobotics.REVLibError setSecondaryCurrentLimit​(double limit,
+                                                            int chopCycles)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the secondary current limit in Amps. + + The motor controller will disable the output of the controller briefly if the + current limit is exceeded to reduce the current. This limit is a simplified + 'on/off' controller. This limit is enabled by default but is set higher than + the default Smart Current Limit. + + The time the controller is off after the current limit is reached is + determined by the parameter limitCycles, which is the number of PWM cycles + (20kHz). The recommended value is the default of 0 which is the minimum time + and is part of a PWM cycle from when the over current is detected. This + allows the controller to regulate the current close to the limit value. + + The total time is set by the equation + + + t = (50us - t0) + 50us * limitCycles + t = total off time after over current + t0 = time from the start of the PWM cycle until over current is detected +
          +
          +
          Specified by:
          +
          setSecondaryCurrentLimit in class XCANSparkMax
          +
          Parameters:
          +
          limit - The current limit in Amps.
          +
          chopCycles - The number of additional PWM cycles to turn the driver off + after overcurrent is detected.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setIdleMode

          +
          public com.revrobotics.REVLibError setIdleMode​(com.revrobotics.CANSparkMax.IdleMode mode)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the idle mode setting for the SPARK MAX.
          +
          +
          Specified by:
          +
          setIdleMode in class XCANSparkMax
          +
          Parameters:
          +
          mode - Idle mode (coast or brake).
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getIdleMode

          +
          public com.revrobotics.CANSparkMax.IdleMode getIdleMode()
          +
          Description copied from class: XCANSparkMax
          +
          Gets the idle mode setting for the SPARK MAX. + + This uses the Get Parameter API and should be used infrequently. This + function uses a non-blocking call and will return a cached value if the + parameter is not returned by the timeout. The timeout can be changed by + calling SetCANTimeout(int milliseconds)
          +
          +
          Specified by:
          +
          getIdleMode in class XCANSparkMax
          +
          Returns:
          +
          IdleMode Idle mode setting
          +
          +
          • +
        + + + +
          +
        • +

          enableVoltageCompensation

          +
          public com.revrobotics.REVLibError enableVoltageCompensation​(double nominalVoltage)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the voltage compensation setting for all modes on the SPARK MAX and + enables voltage compensation.
          +
          +
          Specified by:
          +
          enableVoltageCompensation in class XCANSparkMax
          +
          Parameters:
          +
          nominalVoltage - Nominal voltage to compensate output to
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          disableVoltageCompensation

          +
          public com.revrobotics.REVLibError disableVoltageCompensation()
          +
          Description copied from class: XCANSparkMax
          +
          Disables the voltage compensation setting for all modes on the SPARK MAX.
          +
          +
          Specified by:
          +
          disableVoltageCompensation in class XCANSparkMax
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getVoltageCompensationNominalVoltage

          +
          public double getVoltageCompensationNominalVoltage()
          +
          Description copied from class: XCANSparkMax
          +
          Get the configured voltage compensation nominal voltage value
          +
          +
          Specified by:
          +
          getVoltageCompensationNominalVoltage in class XCANSparkMax
          +
          Returns:
          +
          The nominal voltage for voltage compensation mode.
          +
          +
          • +
        + + + +
          +
        • +

          setOpenLoopRampRate

          +
          public com.revrobotics.REVLibError setOpenLoopRampRate​(double rate)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the ramp rate for open loop control modes. + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Specified by:
          +
          setOpenLoopRampRate in class XCANSparkMax
          +
          Parameters:
          +
          rate - Time in seconds to go from 0 to full throttle.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setClosedLoopRampRate

          +
          public com.revrobotics.REVLibError setClosedLoopRampRate​(double rate)
          +
          Description copied from class: XCANSparkMax
          +
          Sets the ramp rate for closed loop control modes. + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Specified by:
          +
          setClosedLoopRampRate in class XCANSparkMax
          +
          Parameters:
          +
          rate - Time in seconds to go from 0 to full throttle.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getOpenLoopRampRate

          +
          public double getOpenLoopRampRate()
          +
          Description copied from class: XCANSparkMax
          +
          Get the configured open loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Specified by:
          +
          getOpenLoopRampRate in class XCANSparkMax
          +
          Returns:
          +
          ramp rate time in seconds to go from 0 to full throttle.
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopRampRate

          +
          public double getClosedLoopRampRate()
          +
          Description copied from class: XCANSparkMax
          +
          Get the configured closed loop ramp rate + + This is the maximum rate at which the motor controller's output is allowed to + change.
          +
          +
          Specified by:
          +
          getClosedLoopRampRate in class XCANSparkMax
          +
          Returns:
          +
          ramp rate time in seconds to go from 0 to full throttle.
          +
          +
          • +
        + + + +
          +
        • +

          isFollower

          +
          public boolean isFollower()
          +
          Description copied from class: XCANSparkMax
          +
          Returns whether the controller is following another controller
          +
          +
          Specified by:
          +
          isFollower in class XCANSparkMax
          +
          Returns:
          +
          True if this device is following another controller false otherwise
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public short getFaults()
          +
          +
          Specified by:
          +
          getFaults in class XCANSparkMax
          +
          Returns:
          +
          All fault bits as a short
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public short getStickyFaults()
          +
          +
          Specified by:
          +
          getStickyFaults in class XCANSparkMax
          +
          Returns:
          +
          All sticky fault bits as a short
          +
          +
          • +
        + + + +
          +
        • +

          getFault

          +
          public boolean getFault​(com.revrobotics.CANSparkMax.FaultID faultID)
          +
          Description copied from class: XCANSparkMax
          +
          Get the value of a specific fault
          +
          +
          Specified by:
          +
          getFault in class XCANSparkMax
          +
          Parameters:
          +
          faultID - The ID of the fault to retrive
          +
          Returns:
          +
          True if the fault with the given ID occurred.
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFault

          +
          public boolean getStickyFault​(com.revrobotics.CANSparkMax.FaultID faultID)
          +
          Description copied from class: XCANSparkMax
          +
          Get the value of a specific sticky fault
          +
          +
          Specified by:
          +
          getStickyFault in class XCANSparkMax
          +
          Parameters:
          +
          faultID - The ID of the sticky fault to retrive
          +
          Returns:
          +
          True if the sticky fault with the given ID occurred.
          +
          +
          • +
        + + + +
          +
        • +

          getBusVoltage

          +
          public double getBusVoltage()
          +
          +
          Specified by:
          +
          getBusVoltage in class XCANSparkMax
          +
          Returns:
          +
          The voltage fed into the motor controller.
          +
          +
          • +
        + + + +
          +
        • +

          getAppliedOutput

          +
          public double getAppliedOutput()
          +
          +
          Specified by:
          +
          getAppliedOutput in class XCANSparkMax
          +
          Returns:
          +
          The motor controller's applied output duty cycle.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputCurrent

          +
          public double getOutputCurrent()
          +
          +
          Specified by:
          +
          getOutputCurrent in class XCANSparkMax
          +
          Returns:
          +
          The motor controller's output current in Amps.
          +
          +
          • +
        + + + +
          +
        • +

          getMotorTemperature

          +
          public double getMotorTemperature()
          +
          +
          Specified by:
          +
          getMotorTemperature in class XCANSparkMax
          +
          Returns:
          +
          The motor temperature in Celsius.
          +
          +
          • +
        + + + +
          +
        • +

          clearFaults

          +
          public com.revrobotics.REVLibError clearFaults()
          +
          Description copied from class: XCANSparkMax
          +
          Clears all sticky faults.
          +
          +
          Specified by:
          +
          clearFaults in class XCANSparkMax
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          burnFlash

          +
          public com.revrobotics.REVLibError burnFlash()
          +
          Description copied from class: XCANSparkMax
          +
          Writes all settings to flash.
          +
          +
          Specified by:
          +
          burnFlash in class XCANSparkMax
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setCANTimeout

          +
          public com.revrobotics.REVLibError setCANTimeout​(int milliseconds)
          +
          Description copied from class: XCANSparkMax
          +
          Sets timeout for sending CAN messages with SetParameter* and GetParameter* + calls. These calls will block for up to this amoutn of time before returning + a timeout erro. A timeout of 0 will make the SetParameter* calls + non-blocking, and instead will check the response in a separate thread. With + this configuration, any error messages will appear on the drivestration but + will not be returned by the GetLastError() call.
          +
          +
          Specified by:
          +
          setCANTimeout in class XCANSparkMax
          +
          Parameters:
          +
          milliseconds - The timeout in milliseconds.
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          enableSoftLimit

          +
          public com.revrobotics.REVLibError enableSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction,
+                                                   boolean enable)
          +
          Description copied from class: XCANSparkMax
          +
          Enable soft limits
          +
          +
          Specified by:
          +
          enableSoftLimit in class XCANSparkMax
          +
          Parameters:
          +
          direction - the direction of motion to restrict
          +
          enable - set true to enable soft limits
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          setSoftLimit

          +
          public com.revrobotics.REVLibError setSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction,
+                                                float limit)
          +
          Description copied from class: XCANSparkMax
          +
          Set the soft limit based on position. The default unit is rotations, but will + match the unit scaling set by the user. + + Note that this value is not scaled internally so care must be taken to make + sure these units match the desired conversion
          +
          +
          Specified by:
          +
          setSoftLimit in class XCANSparkMax
          +
          Parameters:
          +
          direction - the direction of motion to restrict
          +
          limit - position soft limit of the controller
          +
          Returns:
          +
          REVLibError Set to REVLibError.kOK if successful
          +
          +
          • +
        + + + +
          +
        • +

          getSoftLimit

          +
          public double getSoftLimit​(com.revrobotics.CANSparkMax.SoftLimitDirection direction)
          +
          Description copied from class: XCANSparkMax
          +
          Get the soft limit setting in the controller
          +
          +
          Specified by:
          +
          getSoftLimit in class XCANSparkMax
          +
          Parameters:
          +
          direction - the direction of motion to restrict
          +
          Returns:
          +
          position soft limit setting of the controller
          +
          +
          • +
        + + + +
          +
        • +

          isSoftLimitEnabled

          +
          public boolean isSoftLimitEnabled​(com.revrobotics.CANSparkMax.SoftLimitDirection direction)
          +
          +
          Specified by:
          +
          isSoftLimitEnabled in class XCANSparkMax
          +
          Parameters:
          +
          direction - The direction of the motion to restrict
          +
          Returns:
          +
          true if the soft limit is enabled.
          +
          +
          • +
        + + + +
          +
        • +

          getLastError

          +
          public com.revrobotics.REVLibError getLastError()
          +
          Description copied from class: XCANSparkMax
          +
          All device errors are tracked on a per thread basis for all devices in that + thread. This is meant to be called immediately following another call that + has the possibility of returning an error to validate if an error has + occurred.
          +
          +
          Specified by:
          +
          getLastError in class XCANSparkMax
          +
          Returns:
          +
          the last error that was generated.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setPosition

          +
          public com.revrobotics.REVLibError setPosition​(double position)
          +
          +
          Specified by:
          +
          setPosition in class XCANSparkMax
          +
          +
          • +
        + + + + + + + + + + + + + + + + + + + +
          +
        • +

          setAverageDepth

          +
          public com.revrobotics.REVLibError setAverageDepth​(int depth)
          +
          +
          Specified by:
          +
          setAverageDepth in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setMeasurementPeriod

          +
          public com.revrobotics.REVLibError setMeasurementPeriod​(int period_ms)
          +
          +
          Specified by:
          +
          setMeasurementPeriod in class XCANSparkMax
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setEncoderInverted

          +
          public com.revrobotics.REVLibError setEncoderInverted​(boolean inverted)
          +
          +
          Specified by:
          +
          setEncoderInverted in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setP

          +
          public com.revrobotics.REVLibError setP​(double gain)
          +
          +
          Specified by:
          +
          setP in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setP

          +
          public com.revrobotics.REVLibError setP​(double gain,
+                                        int slotID)
          +
          +
          Specified by:
          +
          setP in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setI

          +
          public com.revrobotics.REVLibError setI​(double gain)
          +
          +
          Specified by:
          +
          setI in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setI

          +
          public com.revrobotics.REVLibError setI​(double gain,
+                                        int slotID)
          +
          +
          Specified by:
          +
          setI in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setD

          +
          public com.revrobotics.REVLibError setD​(double gain)
          +
          +
          Specified by:
          +
          setD in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setD

          +
          public com.revrobotics.REVLibError setD​(double gain,
+                                        int slotID)
          +
          +
          Specified by:
          +
          setD in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setDFilter

          +
          public com.revrobotics.REVLibError setDFilter​(double gain)
          +
          +
          Specified by:
          +
          setDFilter in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setDFilter

          +
          public com.revrobotics.REVLibError setDFilter​(double gain,
+                                              int slotID)
          +
          +
          Specified by:
          +
          setDFilter in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setFF

          +
          public com.revrobotics.REVLibError setFF​(double gain)
          +
          +
          Specified by:
          +
          setFF in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setFF

          +
          public com.revrobotics.REVLibError setFF​(double gain,
+                                         int slotID)
          +
          +
          Specified by:
          +
          setFF in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setIZone

          +
          public com.revrobotics.REVLibError setIZone​(double iZone)
          +
          +
          Specified by:
          +
          setIZone in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setIZone

          +
          public com.revrobotics.REVLibError setIZone​(double iZone,
+                                            int slotID)
          +
          +
          Specified by:
          +
          setIZone in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setOutputRange

          +
          public com.revrobotics.REVLibError setOutputRange​(double min,
+                                                  double max)
          +
          +
          Specified by:
          +
          setOutputRange in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setOutputRange

          +
          public com.revrobotics.REVLibError setOutputRange​(double min,
+                                                  double max,
+                                                  int slotID)
          +
          +
          Specified by:
          +
          setOutputRange in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getP

          +
          public double getP()
          +
          +
          Specified by:
          +
          getP in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getP

          +
          public double getP​(int slotID)
          +
          +
          Specified by:
          +
          getP in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getI

          +
          public double getI()
          +
          +
          Specified by:
          +
          getI in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getI

          +
          public double getI​(int slotID)
          +
          +
          Specified by:
          +
          getI in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getD

          +
          public double getD()
          +
          +
          Specified by:
          +
          getD in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getD

          +
          public double getD​(int slotID)
          +
          +
          Specified by:
          +
          getD in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getDFilter

          +
          public double getDFilter​(int slotID)
          +
          +
          Specified by:
          +
          getDFilter in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getFF

          +
          public double getFF()
          +
          +
          Specified by:
          +
          getFF in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getFF

          +
          public double getFF​(int slotID)
          +
          +
          Specified by:
          +
          getFF in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getIZone

          +
          public double getIZone​(int slotID)
          +
          +
          Specified by:
          +
          getIZone in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getOutputMin

          +
          public double getOutputMin​(int slotID)
          +
          +
          Specified by:
          +
          getOutputMin in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getOutputMax

          +
          public double getOutputMax​(int slotID)
          +
          +
          Specified by:
          +
          getOutputMax in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setSmartMotionMaxVelocity

          +
          public com.revrobotics.REVLibError setSmartMotionMaxVelocity​(double maxVel,
+                                                             int slotID)
          +
          +
          Specified by:
          +
          setSmartMotionMaxVelocity in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setSmartMotionMaxAccel

          +
          public com.revrobotics.REVLibError setSmartMotionMaxAccel​(double maxAccel,
+                                                          int slotID)
          +
          +
          Specified by:
          +
          setSmartMotionMaxAccel in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setSmartMotionMinOutputVelocity

          +
          public com.revrobotics.REVLibError setSmartMotionMinOutputVelocity​(double minVel,
+                                                                   int slotID)
          +
          +
          Specified by:
          +
          setSmartMotionMinOutputVelocity in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setSmartMotionAccelStrategy

          +
          public com.revrobotics.REVLibError setSmartMotionAccelStrategy​(com.revrobotics.SparkMaxPIDController.AccelStrategy accelStrategy,
+                                                               int slotID)
          +
          • +
        + + + + + + + + + + + + + + + + + + + +
          +
        • +

          getSmartMotionAccelStrategy

          +
          public com.revrobotics.SparkMaxPIDController.AccelStrategy getSmartMotionAccelStrategy​(int slotID)
          +
          • +
        + + + +
          +
        • +

          setIMaxAccum

          +
          public com.revrobotics.REVLibError setIMaxAccum​(double iMaxAccum,
+                                                int slotID)
          +
          +
          Specified by:
          +
          setIMaxAccum in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getIMaxAccum

          +
          public double getIMaxAccum​(int slotID)
          +
          +
          Specified by:
          +
          getIMaxAccum in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setIAccum

          +
          public com.revrobotics.REVLibError setIAccum​(double iAccum)
          +
          +
          Specified by:
          +
          setIAccum in class XCANSparkMax
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setFeedbackDevice

          +
          public com.revrobotics.REVLibError setFeedbackDevice​(com.revrobotics.MotorFeedbackSensor sensor)
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public com.revrobotics.REVLibError setReference​(double value,
+                                                com.revrobotics.CANSparkMax.ControlType ctrl)
          +
          +
          Specified by:
          +
          setReference in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public com.revrobotics.REVLibError setReference​(double value,
+                                                com.revrobotics.CANSparkMax.ControlType ctrl,
+                                                int pidSlot)
          +
          +
          Specified by:
          +
          setReference in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public com.revrobotics.REVLibError setReference​(double value,
+                                                com.revrobotics.CANSparkMax.ControlType ctrl,
+                                                int pidSlot,
+                                                double arbFeedforward)
          +
          +
          Specified by:
          +
          setReference in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setReference

          +
          public com.revrobotics.REVLibError setReference​(double value,
+                                                com.revrobotics.CANSparkMax.ControlType ctrl,
+                                                int pidSlot,
+                                                double arbFeedforward,
+                                                com.revrobotics.SparkMaxPIDController.ArbFFUnits arbFFUnits)
          +
          +
          Specified by:
          +
          setReference in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          setForwardLimitSwitch

          +
          public void setForwardLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType,
+                                  boolean enabled)
          +
          +
          Specified by:
          +
          setForwardLimitSwitch in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          setReverseLimitSwitch

          +
          public void setReverseLimitSwitch​(com.revrobotics.SparkMaxLimitSwitch.Type switchType,
+                                  boolean enabled)
          +
          +
          Specified by:
          +
          setReverseLimitSwitch in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getForwardLimitSwitchPressed

          +
          public boolean getForwardLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType)
          +
          +
          Specified by:
          +
          getForwardLimitSwitchPressed in class XCANSparkMax
          +
          +
          • +
        + + + +
          +
        • +

          getReverseLimitSwitchPressed

          +
          public boolean getReverseLimitSwitchPressed​(com.revrobotics.SparkMaxLimitSwitch.Type switchType)
          +
          +
          Specified by:
          +
          getReverseLimitSwitchPressed in class XCANSparkMax
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/CANTalonWPIAdapter.CANTalonWPIAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANTalonWPIAdapter.CANTalonWPIAdapterFactory.html new file mode 100644 index 00000000..33752db5 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANTalonWPIAdapter.CANTalonWPIAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +CANTalonWPIAdapter.CANTalonWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class CANTalonWPIAdapter.CANTalonWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.wpi_adapters.CANTalonWPIAdapter.CANTalonWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/CANTalonWPIAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANTalonWPIAdapter.html new file mode 100644 index 00000000..057b4e4c --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANTalonWPIAdapter.html @@ -0,0 +1,2801 @@ + + + + + +CANTalonWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class CANTalonWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      com.ctre.phoenix.motorcontrol.IFollower, com.ctre.phoenix.motorcontrol.IMotorController, com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced, com.ctre.phoenix.signals.IInvertable, com.ctre.phoenix.signals.IOutputSignal
      +
      +
      +
      public class CANTalonWPIAdapter
+extends XCANTalon
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.motorcontrol.VelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementWindow

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementWindow​(int windowSize,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementWindow in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementWindow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentLimit​(int amps,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getHandle

          +
          public long getHandle()
          +
          • +
        + + + +
          +
        • +

          getDeviceID

          +
          public int getDeviceID()
          +
          +
          Specified by:
          +
          getDeviceID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getDeviceID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode mode,
+                double outputValue)
          +
          +
          Specified by:
          +
          set in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          set in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentDuration

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentDuration​(int milliseconds,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentDuration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configContinuousCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configContinuousCurrentLimit​(int amps,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configContinuousCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          enableCurrentLimit

          +
          public void enableCurrentLimit​(boolean enable)
          +
          +
          Specified by:
          +
          enableCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          neutralOutput

          +
          public void neutralOutput()
          +
          +
          Specified by:
          +
          neutralOutput in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          neutralOutput in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setNeutralMode

          +
          public void setNeutralMode​(com.ctre.phoenix.motorcontrol.NeutralMode neutralMode)
          +
          +
          Specified by:
          +
          setNeutralMode in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setNeutralMode in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setSensorPhase

          +
          public void setSensorPhase​(boolean PhaseSensor)
          +
          +
          Specified by:
          +
          setSensorPhase in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setSensorPhase in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean invert)
          +
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configOpenloopRamp

          +
          public com.ctre.phoenix.ErrorCode configOpenloopRamp​(double secondsFromNeutralToFull,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configOpenloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configOpenloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configClosedloopRamp

          +
          public com.ctre.phoenix.ErrorCode configClosedloopRamp​(double secondsFromNeutralToFull,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configClosedloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configClosedloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputForward

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputForward​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputReverse​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputForward

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputForward​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputReverse​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          configNeutralDeadband

          +
          public com.ctre.phoenix.ErrorCode configNeutralDeadband​(double percentDeadband,
+                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configNeutralDeadband in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNeutralDeadband in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageCompSaturation

          +
          public com.ctre.phoenix.ErrorCode configVoltageCompSaturation​(double voltage,
+                                                              int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageCompSaturation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageCompSaturation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageMeasurementFilter

          +
          public com.ctre.phoenix.ErrorCode configVoltageMeasurementFilter​(int filterWindowSamples,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageMeasurementFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageMeasurementFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          enableVoltageCompensation

          +
          public void enableVoltageCompensation​(boolean enable)
          +
          +
          Specified by:
          +
          enableVoltageCompensation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          enableVoltageCompensation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getBusVoltage

          +
          public double getBusVoltage()
          +
          +
          Specified by:
          +
          getBusVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBusVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputPercent

          +
          public double getMotorOutputPercent()
          +
          +
          Specified by:
          +
          getMotorOutputPercent in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputPercent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputVoltage

          +
          public double getMotorOutputVoltage()
          +
          +
          Specified by:
          +
          getMotorOutputVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getOutputCurrent

          +
          public double getOutputCurrent()
          +
          +
          Specified by:
          +
          getOutputCurrent in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getOutputCurrent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getTemperature

          +
          public double getTemperature()
          +
          +
          Specified by:
          +
          getTemperature in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getTemperature in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(int deviceID,
+                                                             com.ctre.phoenix.motorcontrol.RemoteSensorSource remoteSensorSource,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configRemoteFeedbackFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configRemoteFeedbackFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSensorTerm

          +
          public com.ctre.phoenix.ErrorCode configSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm,
+                                                   com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                   int timeoutMs)
          +
          +
          Specified by:
          +
          configSensorTerm in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSensorTerm in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorPosition

          +
          public double getSelectedSensorPosition​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorVelocity

          +
          public double getSelectedSensorVelocity​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(int sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          setSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setControlFramePeriod​(com.ctre.phoenix.motorcontrol.ControlFrame frame,
+                                                        int periodMs)
          +
          +
          Specified by:
          +
          setControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setControlFramePeriod​(int frame,
+                                                        int periodMs)
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(int frameValue,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(int frame,
+                                int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          overrideLimitSwitchesEnable

          +
          public void overrideLimitSwitchesEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(int forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(int reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          overrideSoftLimitsEnable

          +
          public void overrideSoftLimitsEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideSoftLimitsEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideSoftLimitsEnable in class XCANTalon
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          config_kP

          +
          public com.ctre.phoenix.ErrorCode config_kP​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kP in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kP in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kI

          +
          public com.ctre.phoenix.ErrorCode config_kI​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kI in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kI in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kD

          +
          public com.ctre.phoenix.ErrorCode config_kD​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kD in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kD in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kF

          +
          public com.ctre.phoenix.ErrorCode config_kF​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kF in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kF in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      int izone,
+                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          config_IntegralZone in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 int allowableClosedLoopError,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configAllowableClosedloopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMaxIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode configMaxIntegralAccumulator​(int slotIdx,
+                                                               double iaccum,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configMaxIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configMaxIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode setIntegralAccumulator​(double iaccum,
+                                                         int pidIdx,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          setIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopError

          +
          public double getClosedLoopError​(int pidIdx)
          +
          +
          Specified by:
          +
          getClosedLoopError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getClosedLoopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getIntegralAccumulator

          +
          public double getIntegralAccumulator​(int pidIdx)
          +
          +
          Specified by:
          +
          getIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getErrorDerivative

          +
          public double getErrorDerivative​(int pidIdx)
          +
          +
          Specified by:
          +
          getErrorDerivative in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getErrorDerivative in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          selectProfileSlot

          +
          public void selectProfileSlot​(int slotIdx,
+                              int pidIdx)
          +
          +
          Specified by:
          +
          selectProfileSlot in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          selectProfileSlot in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryPosition

          +
          public double getActiveTrajectoryPosition()
          +
          +
          Specified by:
          +
          getActiveTrajectoryPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryVelocity

          +
          public double getActiveTrajectoryVelocity()
          +
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(int sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionCruiseVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(int sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionAcceleration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileTrajectories

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileTrajectories()
          +
          +
          Specified by:
          +
          clearMotionProfileTrajectories in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileTrajectories in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileTopLevelBufferCount

          +
          public int getMotionProfileTopLevelBufferCount()
          +
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          pushMotionProfileTrajectory

          +
          public com.ctre.phoenix.ErrorCode pushMotionProfileTrajectory​(com.ctre.phoenix.motion.TrajectoryPoint trajPt)
          +
          +
          Specified by:
          +
          pushMotionProfileTrajectory in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          pushMotionProfileTrajectory in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          isMotionProfileTopLevelBufferFull

          +
          public boolean isMotionProfileTopLevelBufferFull()
          +
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          processMotionProfileBuffer

          +
          public void processMotionProfileBuffer()
          +
          +
          Specified by:
          +
          processMotionProfileBuffer in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          processMotionProfileBuffer in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileStatus

          +
          public com.ctre.phoenix.ErrorCode getMotionProfileStatus​(com.ctre.phoenix.motion.MotionProfileStatus statusToFill)
          +
          +
          Specified by:
          +
          getMotionProfileStatus in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileStatus in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileHasUnderrun

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileHasUnderrun​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          changeMotionControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode changeMotionControlFramePeriod​(int periodMs)
          +
          +
          Specified by:
          +
          changeMotionControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          changeMotionControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getLastError

          +
          public com.ctre.phoenix.ErrorCode getLastError()
          +
          +
          Specified by:
          +
          getLastError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getLastError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public com.ctre.phoenix.ErrorCode getFaults​(com.ctre.phoenix.motorcontrol.Faults toFill)
          +
          +
          Specified by:
          +
          getFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public com.ctre.phoenix.ErrorCode getStickyFaults​(com.ctre.phoenix.motorcontrol.StickyFaults toFill)
          +
          +
          Specified by:
          +
          getStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public com.ctre.phoenix.ErrorCode clearStickyFaults​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getFirmwareVersion

          +
          public int getFirmwareVersion()
          +
          +
          Specified by:
          +
          getFirmwareVersion in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFirmwareVersion in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          hasResetOccurred

          +
          public boolean hasResetOccurred()
          +
          +
          Specified by:
          +
          hasResetOccurred in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          hasResetOccurred in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetCustomParam

          +
          public com.ctre.phoenix.ErrorCode configSetCustomParam​(int newValue,
+                                                       int paramIndex,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configSetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetCustomParam

          +
          public int configGetCustomParam​(int paramIndex,
+                                int timoutMs)
          +
          +
          Specified by:
          +
          configGetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(com.ctre.phoenix.ParamEnum param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(int param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(com.ctre.phoenix.ParamEnum param,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(int param,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getBaseID

          +
          public int getBaseID()
          +
          +
          Specified by:
          +
          getBaseID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBaseID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public void follow​(com.ctre.phoenix.motorcontrol.IMotorController masterToFollow)
          +
          +
          Specified by:
          +
          follow in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          follow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          valueUpdated

          +
          public void valueUpdated()
          +
          +
          Specified by:
          +
          valueUpdated in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          valueUpdated in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSensorCollection

          +
          public com.ctre.phoenix.motorcontrol.SensorCollection getSensorCollection()
          +
          • +
        + + + +
          +
        • +

          getControlMode

          +
          public com.ctre.phoenix.motorcontrol.ControlMode getControlMode()
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode Mode,
+                double demand0,
+                com.ctre.phoenix.motorcontrol.DemandType demand1Type,
+                double demand1)
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackCoefficient

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackCoefficient​(double coefficient,
+                                                                    int pidIdx,
+                                                                    int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeakOutput

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeakOutput​(int slotIdx,
+                                                             double percentOut,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeriod

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeriod​(int slotIdx,
+                                                         int loopTimeMs,
+                                                         int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configAuxPIDPolarity

          +
          public com.ctre.phoenix.ErrorCode configAuxPIDPolarity​(boolean invert,
+                                                       int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getClosedLoopTarget

          +
          public double getClosedLoopTarget​(int pidIdx)
          +
          • +
        + + + +
          +
        • +

          configMotionProfileTrajectoryPeriod

          +
          public com.ctre.phoenix.ErrorCode configMotionProfileTrajectoryPeriod​(int baseTrajDurationMs,
+                                                                      int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionSCurveStrength

          +
          public com.ctre.phoenix.ErrorCode configMotionSCurveStrength​(int curveStrength,
+                                                             int timeoutMs)
          +
          • +
        + + + + + + + +
          +
        • +

          configSupplyCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configSupplyCurrentLimit​(com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration currLimitCfg,
+                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(com.ctre.phoenix.motorcontrol.InvertType invertType)
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.sensors.CANCoder canCoderRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.motorcontrol.can.BaseTalon talonRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(double sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(double forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(double reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      double izone,
+                                                      int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 double allowableCloseLoopError,
+                                                                 int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(double sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(double sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.sensors.SensorVelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in class XCANTalon
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory.html new file mode 100644 index 00000000..5b56c215 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.wpi_adapters.CANVictorSPXWpiAdapter.CANVictorSPXWpiAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/CANVictorSPXWpiAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANVictorSPXWpiAdapter.html new file mode 100644 index 00000000..4bea5f26 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/CANVictorSPXWpiAdapter.html @@ -0,0 +1,4317 @@ + + + + + +CANVictorSPXWpiAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class CANVictorSPXWpiAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      com.ctre.phoenix.motorcontrol.IFollower, com.ctre.phoenix.motorcontrol.IMotorController, com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced, com.ctre.phoenix.signals.IInvertable, com.ctre.phoenix.signals.IOutputSignal
      +
      +
      +
      public class CANVictorSPXWpiAdapter
+extends XCANVictorSPX
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CANVictorSPXWpiAdapter

          +
          @AssistedInject
+public CANVictorSPXWpiAdapter​(@Assisted("deviceId")
+                              int deviceId,
+                              PropertyFactory propMan,
+                              DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          DestroyObject

          +
          public com.ctre.phoenix.ErrorCode DestroyObject()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          getHandle

          +
          public long getHandle()
          +
          • +
        + + + +
          +
        • +

          getDeviceID

          +
          public int getDeviceID()
          +
          +
          Specified by:
          +
          getDeviceID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getDeviceID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getPIDConfigs

          +
          public void getPIDConfigs​(com.ctre.phoenix.motorcontrol.can.VictorSPXPIDSetConfiguration pid,
+                          int pidIdx,
+                          int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode mode,
+                double outputValue)
          +
          +
          Specified by:
          +
          set in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          set in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getPIDConfigs

          +
          public void getPIDConfigs​(com.ctre.phoenix.motorcontrol.can.VictorSPXPIDSetConfiguration pid)
          +
          • +
        + + + +
          +
        • +

          configAllSettings

          +
          public com.ctre.phoenix.ErrorCode configAllSettings​(com.ctre.phoenix.motorcontrol.can.VictorSPXConfiguration allConfigs,
+                                                    int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode mode,
+                double demand0,
+                com.ctre.phoenix.motorcontrol.DemandType demand1Type,
+                double demand1)
          +
          • +
        + + + +
          +
        • +

          configAllSettings

          +
          public com.ctre.phoenix.ErrorCode configAllSettings​(com.ctre.phoenix.motorcontrol.can.VictorSPXConfiguration allConfigs)
          +
          • +
        + + + +
          +
        • +

          getAllConfigs

          +
          public void getAllConfigs​(com.ctre.phoenix.motorcontrol.can.VictorSPXConfiguration allConfigs,
+                          int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          neutralOutput

          +
          public void neutralOutput()
          +
          +
          Specified by:
          +
          neutralOutput in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          neutralOutput in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setNeutralMode

          +
          public void setNeutralMode​(com.ctre.phoenix.motorcontrol.NeutralMode neutralMode)
          +
          +
          Specified by:
          +
          setNeutralMode in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setNeutralMode in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getAllConfigs

          +
          public void getAllConfigs​(com.ctre.phoenix.motorcontrol.can.VictorSPXConfiguration allConfigs)
          +
          • +
        + + + +
          +
        • +

          setSensorPhase

          +
          public void setSensorPhase​(boolean PhaseSensor)
          +
          +
          Specified by:
          +
          setSensorPhase in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setSensorPhase in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean invert)
          +
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(com.ctre.phoenix.motorcontrol.InvertType invertType)
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configFactoryDefault

          +
          public com.ctre.phoenix.ErrorCode configFactoryDefault​(int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configFactoryDefault

          +
          public com.ctre.phoenix.ErrorCode configFactoryDefault()
          +
          • +
        + + + +
          +
        • +

          configOpenloopRamp

          +
          public com.ctre.phoenix.ErrorCode configOpenloopRamp​(double secondsFromNeutralToFull,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configOpenloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configOpenloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configOpenloopRamp

          +
          public com.ctre.phoenix.ErrorCode configOpenloopRamp​(double secondsFromNeutralToFull)
          +
          • +
        + + + +
          +
        • +

          configClosedloopRamp

          +
          public com.ctre.phoenix.ErrorCode configClosedloopRamp​(double secondsFromNeutralToFull,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configClosedloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configClosedloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configClosedloopRamp

          +
          public com.ctre.phoenix.ErrorCode configClosedloopRamp​(double secondsFromNeutralToFull)
          +
          • +
        + + + +
          +
        • +

          configPeakOutputForward

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputForward​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputForward

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputForward​(double percentOut)
          +
          • +
        + + + +
          +
        • +

          configPeakOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputReverse​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputReverse​(double percentOut)
          +
          • +
        + + + +
          +
        • +

          configNominalOutputForward

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputForward​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputForward

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputForward​(double percentOut)
          +
          • +
        + + + +
          +
        • +

          configNominalOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputReverse​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputReverse​(double percentOut)
          +
          • +
        + + + +
          +
        • +

          configNeutralDeadband

          +
          public com.ctre.phoenix.ErrorCode configNeutralDeadband​(double percentDeadband,
+                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configNeutralDeadband in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNeutralDeadband in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNeutralDeadband

          +
          public com.ctre.phoenix.ErrorCode configNeutralDeadband​(double percentDeadband)
          +
          • +
        + + + +
          +
        • +

          configVoltageCompSaturation

          +
          public com.ctre.phoenix.ErrorCode configVoltageCompSaturation​(double voltage,
+                                                              int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageCompSaturation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageCompSaturation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageCompSaturation

          +
          public com.ctre.phoenix.ErrorCode configVoltageCompSaturation​(double voltage)
          +
          • +
        + + + +
          +
        • +

          configVoltageMeasurementFilter

          +
          public com.ctre.phoenix.ErrorCode configVoltageMeasurementFilter​(int filterWindowSamples,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageMeasurementFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageMeasurementFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageMeasurementFilter

          +
          public com.ctre.phoenix.ErrorCode configVoltageMeasurementFilter​(int filterWindowSamples)
          +
          • +
        + + + +
          +
        • +

          enableVoltageCompensation

          +
          public void enableVoltageCompensation​(boolean enable)
          +
          +
          Specified by:
          +
          enableVoltageCompensation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          enableVoltageCompensation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getBusVoltage

          +
          public double getBusVoltage()
          +
          +
          Specified by:
          +
          getBusVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBusVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputPercent

          +
          public double getMotorOutputPercent()
          +
          +
          Specified by:
          +
          getMotorOutputPercent in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputPercent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputVoltage

          +
          public double getMotorOutputVoltage()
          +
          +
          Specified by:
          +
          getMotorOutputVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getTemperature

          +
          public double getTemperature()
          +
          +
          Specified by:
          +
          getTemperature in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getTemperature in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice)
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice)
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackCoefficient

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackCoefficient​(double coefficient,
+                                                                    int pidIdx,
+                                                                    int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackCoefficient

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackCoefficient​(double coefficient)
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(int deviceID,
+                                                             com.ctre.phoenix.motorcontrol.RemoteSensorSource remoteSensorSource,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configRemoteFeedbackFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configRemoteFeedbackFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(int deviceID,
+                                                             com.ctre.phoenix.motorcontrol.RemoteSensorSource remoteSensorSource,
+                                                             int remoteOrdinal)
          +
          • +
        + + + +
          +
        • +

          configSensorTerm

          +
          public com.ctre.phoenix.ErrorCode configSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm,
+                                                   com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                   int timeoutMs)
          +
          +
          Specified by:
          +
          configSensorTerm in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSensorTerm in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSensorTerm

          +
          public com.ctre.phoenix.ErrorCode configSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm,
+                                                   com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice)
          +
          • +
        + + + +
          +
        • +

          configSensorTerm

          +
          public com.ctre.phoenix.ErrorCode configSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm,
+                                                   com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice,
+                                                   int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configSensorTerm

          +
          public com.ctre.phoenix.ErrorCode configSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm,
+                                                   com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice)
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorPosition

          +
          public double getSelectedSensorPosition​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorPosition

          +
          public double getSelectedSensorPosition()
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorVelocity

          +
          public double getSelectedSensorVelocity​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorVelocity

          +
          public double getSelectedSensorVelocity()
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(int sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          setSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(int sensorPos)
          +
          • +
        + + + +
          +
        • +

          setControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setControlFramePeriod​(com.ctre.phoenix.motorcontrol.ControlFrame frame,
+                                                        int periodMs)
          +
          +
          Specified by:
          +
          setControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setControlFramePeriod​(int frame,
+                                                        int periodMs)
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(int frameValue,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(int frameValue,
+                                                       int periodMs)
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                                       int periodMs)
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(int frame,
+                                int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(int frame)
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame)
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame)
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.motorcontrol.VelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.motorcontrol.VelocityMeasPeriod period)
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementWindow

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementWindow​(int windowSize,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementWindow in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementWindow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementWindow

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementWindow​(int windowSize)
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID)
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID)
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose)
          +
          • +
        + + + +
          +
        • +

          overrideLimitSwitchesEnable

          +
          public void overrideLimitSwitchesEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(int forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(int forwardSensorLimit)
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(int reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(int reverseSensorLimit)
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitEnable​(boolean enable)
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitEnable​(boolean enable)
          +
          • +
        + + + +
          +
        • +

          overrideSoftLimitsEnable

          +
          public void overrideSoftLimitsEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideSoftLimitsEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideSoftLimitsEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kP

          +
          public com.ctre.phoenix.ErrorCode config_kP​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kP in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kP in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kP

          +
          public com.ctre.phoenix.ErrorCode config_kP​(int slotIdx,
+                                            double value)
          +
          • +
        + + + +
          +
        • +

          config_kI

          +
          public com.ctre.phoenix.ErrorCode config_kI​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kI in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kI in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kI

          +
          public com.ctre.phoenix.ErrorCode config_kI​(int slotIdx,
+                                            double value)
          +
          • +
        + + + +
          +
        • +

          config_kD

          +
          public com.ctre.phoenix.ErrorCode config_kD​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kD in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kD in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kD

          +
          public com.ctre.phoenix.ErrorCode config_kD​(int slotIdx,
+                                            double value)
          +
          • +
        + + + +
          +
        • +

          config_kF

          +
          public com.ctre.phoenix.ErrorCode config_kF​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kF in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kF in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kF

          +
          public com.ctre.phoenix.ErrorCode config_kF​(int slotIdx,
+                                            double value)
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      int izone,
+                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          config_IntegralZone in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      int izone)
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 int allowableClosedLoopError,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configAllowableClosedloopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 int allowableClosedLoopError)
          +
          • +
        + + + +
          +
        • +

          configMaxIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode configMaxIntegralAccumulator​(int slotIdx,
+                                                               double iaccum,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configMaxIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configMaxIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMaxIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode configMaxIntegralAccumulator​(int slotIdx,
+                                                               double iaccum)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeakOutput

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeakOutput​(int slotIdx,
+                                                             double percentOut,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeakOutput

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeakOutput​(int slotIdx,
+                                                             double percentOut)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeriod

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeriod​(int slotIdx,
+                                                         int loopTimeMs,
+                                                         int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeriod

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeriod​(int slotIdx,
+                                                         int loopTimeMs)
          +
          • +
        + + + +
          +
        • +

          configAuxPIDPolarity

          +
          public com.ctre.phoenix.ErrorCode configAuxPIDPolarity​(boolean invert,
+                                                       int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configAuxPIDPolarity

          +
          public com.ctre.phoenix.ErrorCode configAuxPIDPolarity​(boolean invert)
          +
          • +
        + + + +
          +
        • +

          setIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode setIntegralAccumulator​(double iaccum,
+                                                         int pidIdx,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          setIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode setIntegralAccumulator​(double iaccum)
          +
          • +
        + + + +
          +
        • +

          getClosedLoopError

          +
          public double getClosedLoopError​(int pidIdx)
          +
          +
          Specified by:
          +
          getClosedLoopError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getClosedLoopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopError

          +
          public double getClosedLoopError()
          +
          • +
        + + + +
          +
        • +

          getIntegralAccumulator

          +
          public double getIntegralAccumulator​(int pidIdx)
          +
          +
          Specified by:
          +
          getIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getIntegralAccumulator

          +
          public double getIntegralAccumulator()
          +
          • +
        + + + +
          +
        • +

          getErrorDerivative

          +
          public double getErrorDerivative​(int pidIdx)
          +
          +
          Specified by:
          +
          getErrorDerivative in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getErrorDerivative in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getErrorDerivative

          +
          public double getErrorDerivative()
          +
          • +
        + + + +
          +
        • +

          selectProfileSlot

          +
          public void selectProfileSlot​(int slotIdx,
+                              int pidIdx)
          +
          +
          Specified by:
          +
          selectProfileSlot in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          selectProfileSlot in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopTarget

          +
          public double getClosedLoopTarget​(int pidIdx)
          +
          • +
        + + + +
          +
        • +

          getClosedLoopTarget

          +
          public double getClosedLoopTarget()
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryPosition

          +
          public double getActiveTrajectoryPosition()
          +
          +
          Specified by:
          +
          getActiveTrajectoryPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryPosition

          +
          public double getActiveTrajectoryPosition​(int pidIdx)
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryVelocity

          +
          public double getActiveTrajectoryVelocity()
          +
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryVelocity

          +
          public double getActiveTrajectoryVelocity​(int pidIdx)
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryArbFeedFwd

          +
          public double getActiveTrajectoryArbFeedFwd()
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryArbFeedFwd

          +
          public double getActiveTrajectoryArbFeedFwd​(int pidIdx)
          +
          • +
        + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(int sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionCruiseVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(int sensorUnitsPer100ms)
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(int sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionAcceleration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(int sensorUnitsPer100msPerSec)
          +
          • +
        + + + +
          +
        • +

          configMotionSCurveStrength

          +
          public com.ctre.phoenix.ErrorCode configMotionSCurveStrength​(int curveStrength,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionSCurveStrength

          +
          public com.ctre.phoenix.ErrorCode configMotionSCurveStrength​(int curveStrength)
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileTrajectories

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileTrajectories()
          +
          +
          Specified by:
          +
          clearMotionProfileTrajectories in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileTrajectories in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileTopLevelBufferCount

          +
          public int getMotionProfileTopLevelBufferCount()
          +
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          pushMotionProfileTrajectory

          +
          public com.ctre.phoenix.ErrorCode pushMotionProfileTrajectory​(com.ctre.phoenix.motion.TrajectoryPoint trajPt)
          +
          +
          Specified by:
          +
          pushMotionProfileTrajectory in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          pushMotionProfileTrajectory in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          startMotionProfile

          +
          public com.ctre.phoenix.ErrorCode startMotionProfile​(com.ctre.phoenix.motion.BufferedTrajectoryPointStream stream,
+                                                     int minBufferedPts,
+                                                     com.ctre.phoenix.motorcontrol.ControlMode motionProfControlMode)
          +
          • +
        + + + +
          +
        • +

          isMotionProfileFinished

          +
          public boolean isMotionProfileFinished()
          +
          • +
        + + + +
          +
        • +

          isMotionProfileTopLevelBufferFull

          +
          public boolean isMotionProfileTopLevelBufferFull()
          +
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          processMotionProfileBuffer

          +
          public void processMotionProfileBuffer()
          +
          +
          Specified by:
          +
          processMotionProfileBuffer in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          processMotionProfileBuffer in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileStatus

          +
          public com.ctre.phoenix.ErrorCode getMotionProfileStatus​(com.ctre.phoenix.motion.MotionProfileStatus statusToFill)
          +
          +
          Specified by:
          +
          getMotionProfileStatus in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileStatus in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileHasUnderrun

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileHasUnderrun​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileHasUnderrun

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileHasUnderrun()
          +
          • +
        + + + +
          +
        • +

          changeMotionControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode changeMotionControlFramePeriod​(int periodMs)
          +
          +
          Specified by:
          +
          changeMotionControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          changeMotionControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMotionProfileTrajectoryPeriod

          +
          public com.ctre.phoenix.ErrorCode configMotionProfileTrajectoryPeriod​(int baseTrajDurationMs,
+                                                                      int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionProfileTrajectoryPeriod

          +
          public com.ctre.phoenix.ErrorCode configMotionProfileTrajectoryPeriod​(int baseTrajDurationMs)
          +
          • +
        + + + +
          +
        • +

          configMotionProfileTrajectoryInterpolationEnable

          +
          public com.ctre.phoenix.ErrorCode configMotionProfileTrajectoryInterpolationEnable​(boolean enable,
+                                                                                   int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionProfileTrajectoryInterpolationEnable

          +
          public com.ctre.phoenix.ErrorCode configMotionProfileTrajectoryInterpolationEnable​(boolean enable)
          +
          • +
        + + + +
          +
        • +

          configFeedbackNotContinuous

          +
          public com.ctre.phoenix.ErrorCode configFeedbackNotContinuous​(boolean feedbackNotContinuous,
+                                                              int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configRemoteSensorClosedLoopDisableNeutralOnLOS

          +
          public com.ctre.phoenix.ErrorCode configRemoteSensorClosedLoopDisableNeutralOnLOS​(boolean remoteSensorClosedLoopDisableNeutralOnLOS,
+                                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClearPositionOnLimitF

          +
          public com.ctre.phoenix.ErrorCode configClearPositionOnLimitF​(boolean clearPositionOnLimitF,
+                                                              int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClearPositionOnLimitR

          +
          public com.ctre.phoenix.ErrorCode configClearPositionOnLimitR​(boolean clearPositionOnLimitR,
+                                                              int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClearPositionOnQuadIdx

          +
          public com.ctre.phoenix.ErrorCode configClearPositionOnQuadIdx​(boolean clearPositionOnQuadIdx,
+                                                               int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configLimitSwitchDisableNeutralOnLOS

          +
          public com.ctre.phoenix.ErrorCode configLimitSwitchDisableNeutralOnLOS​(boolean limitSwitchDisableNeutralOnLOS,
+                                                                       int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configSoftLimitDisableNeutralOnLOS

          +
          public com.ctre.phoenix.ErrorCode configSoftLimitDisableNeutralOnLOS​(boolean softLimitDisableNeutralOnLOS,
+                                                                     int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configPulseWidthPeriod_EdgesPerRot

          +
          public com.ctre.phoenix.ErrorCode configPulseWidthPeriod_EdgesPerRot​(int pulseWidthPeriod_EdgesPerRot,
+                                                                     int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configPulseWidthPeriod_FilterWindowSz

          +
          public com.ctre.phoenix.ErrorCode configPulseWidthPeriod_FilterWindowSz​(int pulseWidthPeriod_FilterWindowSz,
+                                                                        int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getLastError

          +
          public com.ctre.phoenix.ErrorCode getLastError()
          +
          +
          Specified by:
          +
          getLastError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getLastError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public com.ctre.phoenix.ErrorCode getFaults​(com.ctre.phoenix.motorcontrol.Faults toFill)
          +
          +
          Specified by:
          +
          getFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public com.ctre.phoenix.ErrorCode getStickyFaults​(com.ctre.phoenix.motorcontrol.StickyFaults toFill)
          +
          +
          Specified by:
          +
          getStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public com.ctre.phoenix.ErrorCode clearStickyFaults​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public com.ctre.phoenix.ErrorCode clearStickyFaults()
          +
          • +
        + + + +
          +
        • +

          getFirmwareVersion

          +
          public int getFirmwareVersion()
          +
          +
          Specified by:
          +
          getFirmwareVersion in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFirmwareVersion in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          hasResetOccurred

          +
          public boolean hasResetOccurred()
          +
          +
          Specified by:
          +
          hasResetOccurred in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          hasResetOccurred in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetCustomParam

          +
          public com.ctre.phoenix.ErrorCode configSetCustomParam​(int newValue,
+                                                       int paramIndex,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configSetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetCustomParam

          +
          public com.ctre.phoenix.ErrorCode configSetCustomParam​(int newValue,
+                                                       int paramIndex)
          +
          • +
        + + + +
          +
        • +

          configGetCustomParam

          +
          public int configGetCustomParam​(int paramIndex,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          configGetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetCustomParam

          +
          public int configGetCustomParam​(int paramIndex)
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(com.ctre.phoenix.ParamEnum param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(com.ctre.phoenix.ParamEnum param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal)
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(int param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(int param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal)
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(com.ctre.phoenix.ParamEnum param,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(com.ctre.phoenix.ParamEnum param,
+                                 int ordinal)
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(int param,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(int param,
+                                 int ordinal)
          +
          • +
        + + + +
          +
        • +

          getBaseID

          +
          public int getBaseID()
          +
          +
          Specified by:
          +
          getBaseID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBaseID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getControlMode

          +
          public com.ctre.phoenix.motorcontrol.ControlMode getControlMode()
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public void follow​(com.ctre.phoenix.motorcontrol.IMotorController masterToFollow,
+                   com.ctre.phoenix.motorcontrol.FollowerType followerType)
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public void follow​(com.ctre.phoenix.motorcontrol.IMotorController masterToFollow)
          +
          +
          Specified by:
          +
          follow in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          follow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          valueUpdated

          +
          public void valueUpdated()
          +
          +
          Specified by:
          +
          valueUpdated in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          valueUpdated in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configureSlot

          +
          @Deprecated
+public com.ctre.phoenix.ErrorCode configureSlot​(com.ctre.phoenix.motorcontrol.can.SlotConfiguration slot)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          configureSlot

          +
          @Deprecated
+public com.ctre.phoenix.ErrorCode configureSlot​(com.ctre.phoenix.motorcontrol.can.SlotConfiguration slot,
+                                                int slotIdx,
+                                                int timeoutMs)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          getSlotConfigs

          +
          public void getSlotConfigs​(com.ctre.phoenix.motorcontrol.can.SlotConfiguration slot,
+                           int slotIdx,
+                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getSlotConfigs

          +
          public void getSlotConfigs​(com.ctre.phoenix.motorcontrol.can.SlotConfiguration slot)
          +
          • +
        + + + +
          +
        • +

          configureFilter

          +
          @Deprecated
+public com.ctre.phoenix.ErrorCode configureFilter​(com.ctre.phoenix.motorcontrol.can.FilterConfiguration filter,
+                                                  int ordinal,
+                                                  int timeoutMs,
+                                                  boolean enableOptimizations)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          configureFilter

          +
          @Deprecated
+public com.ctre.phoenix.ErrorCode configureFilter​(com.ctre.phoenix.motorcontrol.can.FilterConfiguration filter,
+                                                  int ordinal,
+                                                  int timeoutMs)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          configureFilter

          +
          @Deprecated
+public com.ctre.phoenix.ErrorCode configureFilter​(com.ctre.phoenix.motorcontrol.can.FilterConfiguration filter)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          getFilterConfigs

          +
          public void getFilterConfigs​(com.ctre.phoenix.motorcontrol.can.FilterConfiguration filter,
+                             int ordinal,
+                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getFilterConfigs

          +
          public void getFilterConfigs​(com.ctre.phoenix.motorcontrol.can.FilterConfiguration filter)
          +
          • +
        + + + +
          +
        • +

          getOutputCurrent

          +
          public double getOutputCurrent()
          +
          +
          Specified by:
          +
          getOutputCurrent in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getOutputCurrent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          configPeakCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentLimit​(int amps,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentDuration

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentDuration​(int milliseconds,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentDuration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configContinuousCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configContinuousCurrentLimit​(int amps,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configContinuousCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          enableCurrentLimit

          +
          public void enableCurrentLimit​(boolean enable)
          +
          +
          Specified by:
          +
          enableCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + + + + + +
          +
        • +

          configSupplyCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configSupplyCurrentLimit​(com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration currLimitCfg,
+                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.sensors.CANCoder canCoderRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.motorcontrol.can.BaseTalon talonRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(double sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(double forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(double reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      double izone,
+                                                      int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 double allowableCloseLoopError,
+                                                                 int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(double sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(double sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.sensors.SensorVelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in class XCANTalon
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/CompressorWPIAdapter.CompressorWPIAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/CompressorWPIAdapter.CompressorWPIAdapterFactory.html new file mode 100644 index 00000000..59f95331 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/CompressorWPIAdapter.CompressorWPIAdapterFactory.html @@ -0,0 +1,318 @@ + + + + + +CompressorWPIAdapter.CompressorWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class CompressorWPIAdapter.CompressorWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.wpi_adapters.CompressorWPIAdapter.CompressorWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/CompressorWPIAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/CompressorWPIAdapter.html new file mode 100644 index 00000000..8dc3e653 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/CompressorWPIAdapter.html @@ -0,0 +1,380 @@ + + + + + +CompressorWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class CompressorWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      public class CompressorWPIAdapter
+extends XCompressor
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CompressorWPIAdapter

          +
          @AssistedInject
+public CompressorWPIAdapter()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory.html new file mode 100644 index 00000000..ef95423a --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.wpi_adapters.DigitalOutputWPIAdapter.DigitalOutputWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/DigitalOutputWPIAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/DigitalOutputWPIAdapter.html new file mode 100644 index 00000000..054977d3 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/DigitalOutputWPIAdapter.html @@ -0,0 +1,485 @@ + + + + + +DigitalOutputWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class DigitalOutputWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XBaseIO
      +
      +
      +
      public class DigitalOutputWPIAdapter
+extends XDigitalOutput
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DigitalOutputWPIAdapter

          +
          @AssistedInject
+public DigitalOutputWPIAdapter​(@Assisted("channel")
+                               int channel,
+                               DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          set

          +
          public void set​(boolean value)
          +
          +
          Specified by:
          +
          set in class XDigitalOutput
          +
          +
          • +
        + + + +
          +
        • +

          getWPIDigitalOutput

          +
          public edu.wpi.first.wpilibj.DigitalOutput getWPIDigitalOutput()
          +
          • +
        + + + +
          +
        • +

          setPWMRate

          +
          public void setPWMRate​(double frequency)
          +
          Description copied from class: XDigitalOutput
          +
          Set the PWM frequency of ALL DIGITAL OUTPUT PWM CHANNELS
          +
          +
          Specified by:
          +
          setPWMRate in class XDigitalOutput
          +
          Parameters:
          +
          frequency - PWM frequency
          +
          +
          • +
        + + + +
          +
        • +

          enablePWM

          +
          public void enablePWM​(double initialDutyCycle)
          +
          +
          Specified by:
          +
          enablePWM in class XDigitalOutput
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          get

          +
          public boolean get()
          +
          +
          Specified by:
          +
          get in class XDigitalOutput
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/PWMWPIAdapter.PWMWPIAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/PWMWPIAdapter.PWMWPIAdapterFactory.html new file mode 100644 index 00000000..e2f2d7e3 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/PWMWPIAdapter.PWMWPIAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +PWMWPIAdapter.PWMWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class PWMWPIAdapter.PWMWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.wpi_adapters.PWMWPIAdapter.PWMWPIAdapterFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XPWM.XPWMFactory
      +
      +
      +
      Enclosing class:
      +
      PWMWPIAdapter
      +
      +
      +
      @AssistedFactory
+public abstract static class PWMWPIAdapter.PWMWPIAdapterFactory
+extends java.lang.Object
+implements XPWM.XPWMFactory
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract PWMWPIAdaptercreate​(int channel) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          PWMWPIAdapterFactory

          +
          public PWMWPIAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/PWMWPIAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/PWMWPIAdapter.html new file mode 100644 index 00000000..43510adf --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/PWMWPIAdapter.html @@ -0,0 +1,483 @@ + + + + + +PWMWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class PWMWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XBaseIO
      +
      +
      +
      public class PWMWPIAdapter
+extends XPWM
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class xbot.common.controls.actuators.XPWM

          +channel
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        PWMWPIAdapter​(int channel, + DevicePolice police) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        intgetRaw() 
        doublegetSigned() 
        doublegetUnsigned() 
        voidsetRaw​(int value) +
        Sets the PWM duty cycle
        +
        voidsetSigned​(double value) +
        Sets the PWM duty cycle
        +
        voidsetUnsigned​(double value) +
        Sets the PWM duty cycle
        +
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          PWMWPIAdapter

          +
          @AssistedInject
+public PWMWPIAdapter​(@Assisted("channel")
+                     int channel,
+                     DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setRaw

          +
          public void setRaw​(int value)
          +
          Description copied from class: XPWM
          +
          Sets the PWM duty cycle
          +
          +
          Specified by:
          +
          setRaw in class XPWM
          +
          Parameters:
          +
          value - the value to set, in the range [0, 255]
          +
          +
          • +
        + + + +
          +
        • +

          getRaw

          +
          public int getRaw()
          +
          +
          Specified by:
          +
          getRaw in class XPWM
          +
          +
          • +
        + + + +
          +
        • +

          setSigned

          +
          public void setSigned​(double value)
          +
          Description copied from class: XPWM
          +
          Sets the PWM duty cycle
          +
          +
          Specified by:
          +
          setSigned in class XPWM
          +
          Parameters:
          +
          value - the value to set, in the range [-1, 1]
          +
          +
          • +
        + + + +
          +
        • +

          getSigned

          +
          public double getSigned()
          +
          +
          Specified by:
          +
          getSigned in class XPWM
          +
          +
          • +
        + + + +
          +
        • +

          setUnsigned

          +
          public void setUnsigned​(double value)
          +
          Description copied from class: XPWM
          +
          Sets the PWM duty cycle
          +
          +
          Specified by:
          +
          setUnsigned in class XPWM
          +
          Parameters:
          +
          value - the value to set, in the range [0, 1]
          +
          +
          • +
        + + + +
          +
        • +

          getUnsigned

          +
          public double getUnsigned()
          +
          +
          Specified by:
          +
          getUnsigned in class XPWM
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/RelayWPIAdapter.RelayWPIAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/RelayWPIAdapter.RelayWPIAdapterFactory.html new file mode 100644 index 00000000..c0cdf01b --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/RelayWPIAdapter.RelayWPIAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +RelayWPIAdapter.RelayWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class RelayWPIAdapter.RelayWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.wpi_adapters.RelayWPIAdapter.RelayWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract RelayWPIAdaptercreate​(int channel) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          RelayWPIAdapterFactory

          +
          public RelayWPIAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/RelayWPIAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/RelayWPIAdapter.html new file mode 100644 index 00000000..a79b76c5 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/RelayWPIAdapter.html @@ -0,0 +1,371 @@ + + + + + +RelayWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class RelayWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      public class RelayWPIAdapter
+extends XRelay
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RelayWPIAdapter

          +
          @AssistedInject
+public RelayWPIAdapter​(@Assisted("channel")
+                       int channel,
+                       DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          set

          +
          public void set​(edu.wpi.first.wpilibj.Relay.Value value)
          +
          +
          Specified by:
          +
          set in class XRelay
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/ServoWPIAdapter.ServoWPIAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/ServoWPIAdapter.ServoWPIAdapterFactory.html new file mode 100644 index 00000000..f6cb7ad9 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/ServoWPIAdapter.ServoWPIAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +ServoWPIAdapter.ServoWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class ServoWPIAdapter.ServoWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.wpi_adapters.ServoWPIAdapter.ServoWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract ServoWPIAdaptercreate​(int channel) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ServoWPIAdapterFactory

          +
          public ServoWPIAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/ServoWPIAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/ServoWPIAdapter.html new file mode 100644 index 00000000..92308f8b --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/ServoWPIAdapter.html @@ -0,0 +1,375 @@ + + + + + +ServoWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class ServoWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XBaseIO
      +
      +
      +
      public class ServoWPIAdapter
+extends XServo
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class xbot.common.controls.actuators.XServo

          +channel
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidset​(double value) 
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ServoWPIAdapter

          +
          @AssistedInject
+public ServoWPIAdapter​(@Assisted("channel")
+                       int channel,
+                       DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          set

          +
          public void set​(double value)
          +
          +
          Specified by:
          +
          set in class XServo
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/SolenoidWPIAdapter.SolenoidWPIAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/SolenoidWPIAdapter.SolenoidWPIAdapterFactory.html new file mode 100644 index 00000000..2ae75202 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/SolenoidWPIAdapter.SolenoidWPIAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +SolenoidWPIAdapter.SolenoidWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class SolenoidWPIAdapter.SolenoidWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.wpi_adapters.SolenoidWPIAdapter.SolenoidWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract SolenoidWPIAdaptercreate​(int channel) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          SolenoidWPIAdapterFactory

          +
          public SolenoidWPIAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/SolenoidWPIAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/SolenoidWPIAdapter.html new file mode 100644 index 00000000..90454ae2 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/SolenoidWPIAdapter.html @@ -0,0 +1,411 @@ + + + + + +SolenoidWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class SolenoidWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XBaseIO
      +
      +
      +
      public class SolenoidWPIAdapter
+extends XSolenoid
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SolenoidWPIAdapter

          +
          @AssistedInject
+public SolenoidWPIAdapter​(@Assisted("channel")
+                          int channel,
+                          DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory.html new file mode 100644 index 00000000..ce8ef503 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.actuators.wpi_adapters.SpeedControllerWPIAdapter.SpeedControllerWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/SpeedControllerWPIAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/SpeedControllerWPIAdapter.html new file mode 100644 index 00000000..6bc65c58 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/SpeedControllerWPIAdapter.html @@ -0,0 +1,393 @@ + + + + + +SpeedControllerWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class SpeedControllerWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XBaseIO
      +
      +
      +
      public class SpeedControllerWPIAdapter
+extends XSpeedController
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SpeedControllerWPIAdapter

          +
          @AssistedInject
+public SpeedControllerWPIAdapter​(@Assisted("channel")
+                                 int channel,
+                                 DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/VictorAppearingAsTalonWPIAdapter.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/VictorAppearingAsTalonWPIAdapter.html new file mode 100644 index 00000000..fb2d772b --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/VictorAppearingAsTalonWPIAdapter.html @@ -0,0 +1,2716 @@ + + + + + +VictorAppearingAsTalonWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.actuators.wpi_adapters
    +

    Class VictorAppearingAsTalonWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      com.ctre.phoenix.motorcontrol.IFollower, com.ctre.phoenix.motorcontrol.IMotorController, com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced, com.ctre.phoenix.signals.IInvertable, com.ctre.phoenix.signals.IOutputSignal
      +
      +
      +
      public class VictorAppearingAsTalonWPIAdapter
+extends XCANTalon
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode mode,
+                double demand)
          +
          +
          Specified by:
          +
          set in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          set in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode Mode,
+                double demand0,
+                com.ctre.phoenix.motorcontrol.DemandType demand1Type,
+                double demand1)
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(com.ctre.phoenix.motorcontrol.ControlMode mode,
+                double demand0,
+                double demand1)
          +
          +
          Overrides:
          +
          set in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          neutralOutput

          +
          public void neutralOutput()
          +
          +
          Specified by:
          +
          neutralOutput in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          neutralOutput in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setNeutralMode

          +
          public void setNeutralMode​(com.ctre.phoenix.motorcontrol.NeutralMode neutralMode)
          +
          +
          Specified by:
          +
          setNeutralMode in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setNeutralMode in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setSensorPhase

          +
          public void setSensorPhase​(boolean phaseSensor)
          +
          +
          Specified by:
          +
          setSensorPhase in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setSensorPhase in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean invert)
          +
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          setInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.signals.IInvertable
          +
          Specified by:
          +
          getInverted in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getInverted in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configOpenloopRamp

          +
          public com.ctre.phoenix.ErrorCode configOpenloopRamp​(double secondsFromNeutralToFull,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configOpenloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configOpenloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configClosedloopRamp

          +
          public com.ctre.phoenix.ErrorCode configClosedloopRamp​(double secondsFromNeutralToFull,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configClosedloopRamp in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configClosedloopRamp in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputForward

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputForward​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configPeakOutputReverse​(double percentOut,
+                                                          int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configPeakOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputForward

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputForward​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputForward in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputForward in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNominalOutputReverse

          +
          public com.ctre.phoenix.ErrorCode configNominalOutputReverse​(double percentOut,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configNominalOutputReverse in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNominalOutputReverse in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configNeutralDeadband

          +
          public com.ctre.phoenix.ErrorCode configNeutralDeadband​(double percentDeadband,
+                                                        int timeoutMs)
          +
          +
          Specified by:
          +
          configNeutralDeadband in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configNeutralDeadband in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageCompSaturation

          +
          public com.ctre.phoenix.ErrorCode configVoltageCompSaturation​(double voltage,
+                                                              int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageCompSaturation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageCompSaturation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVoltageMeasurementFilter

          +
          public com.ctre.phoenix.ErrorCode configVoltageMeasurementFilter​(int filterWindowSamples,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configVoltageMeasurementFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configVoltageMeasurementFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          enableVoltageCompensation

          +
          public void enableVoltageCompensation​(boolean enable)
          +
          +
          Specified by:
          +
          enableVoltageCompensation in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          enableVoltageCompensation in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getBusVoltage

          +
          public double getBusVoltage()
          +
          +
          Specified by:
          +
          getBusVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBusVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputPercent

          +
          public double getMotorOutputPercent()
          +
          +
          Specified by:
          +
          getMotorOutputPercent in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputPercent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotorOutputVoltage

          +
          public double getMotorOutputVoltage()
          +
          +
          Specified by:
          +
          getMotorOutputVoltage in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotorOutputVoltage in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getOutputCurrent

          +
          public double getOutputCurrent()
          +
          +
          Specified by:
          +
          getOutputCurrent in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getOutputCurrent in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getTemperature

          +
          public double getTemperature()
          +
          +
          Specified by:
          +
          getTemperature in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getTemperature in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.RemoteFeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSelectedFeedbackSensor

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackSensor​(com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                               int pidIdx,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configSelectedFeedbackSensor in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configSelectedFeedbackSensor in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(int deviceID,
+                                                             com.ctre.phoenix.motorcontrol.RemoteSensorSource remoteSensorSource,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configRemoteFeedbackFilter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configRemoteFeedbackFilter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSensorTerm

          +
          public com.ctre.phoenix.ErrorCode configSensorTerm​(com.ctre.phoenix.motorcontrol.SensorTerm sensorTerm,
+                                                   com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                                                   int timeoutMs)
          +
          +
          Specified by:
          +
          configSensorTerm in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSensorTerm in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorPosition

          +
          public double getSelectedSensorPosition​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getSelectedSensorVelocity

          +
          public double getSelectedSensorVelocity​(int pidIdx)
          +
          +
          Specified by:
          +
          getSelectedSensorVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getSelectedSensorVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(int sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          setSelectedSensorPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setControlFramePeriod​(com.ctre.phoenix.motorcontrol.ControlFrame frame,
+                                                        int periodMs)
          +
          +
          Specified by:
          +
          setControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                                       int periodMs,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrame frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.motorcontrol.StatusFrameEnhanced frame,
+                                int timeoutMs)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementWindow

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementWindow​(int windowSize,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementWindow in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementWindow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configForwardLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configForwardLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.RemoteLimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int deviceID,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseLimitSwitchSource

          +
          public com.ctre.phoenix.ErrorCode configReverseLimitSwitchSource​(com.ctre.phoenix.motorcontrol.LimitSwitchSource type,
+                                                                 com.ctre.phoenix.motorcontrol.LimitSwitchNormal normalOpenOrClose,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseLimitSwitchSource in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configReverseLimitSwitchSource in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          overrideLimitSwitchesEnable

          +
          public void overrideLimitSwitchesEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideLimitSwitchesEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(int forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(int reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitThreshold in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configForwardSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configForwardSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitEnable

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitEnable​(boolean enable,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configReverseSoftLimitEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configReverseSoftLimitEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          overrideSoftLimitsEnable

          +
          public void overrideSoftLimitsEnable​(boolean enable)
          +
          +
          Specified by:
          +
          overrideSoftLimitsEnable in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          overrideSoftLimitsEnable in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentLimit​(int amps,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configPeakCurrentDuration

          +
          public com.ctre.phoenix.ErrorCode configPeakCurrentDuration​(int milliseconds,
+                                                            int timeoutMs)
          +
          +
          Specified by:
          +
          configPeakCurrentDuration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configContinuousCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configContinuousCurrentLimit​(int amps,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configContinuousCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          enableCurrentLimit

          +
          public void enableCurrentLimit​(boolean enable)
          +
          +
          Specified by:
          +
          enableCurrentLimit in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kP

          +
          public com.ctre.phoenix.ErrorCode config_kP​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kP in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kP in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kI

          +
          public com.ctre.phoenix.ErrorCode config_kI​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kI in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kI in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kD

          +
          public com.ctre.phoenix.ErrorCode config_kD​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kD in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kD in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_kF

          +
          public com.ctre.phoenix.ErrorCode config_kF​(int slotIdx,
+                                            double value,
+                                            int timeoutMs)
          +
          +
          Specified by:
          +
          config_kF in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          config_kF in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      int izone,
+                                                      int timeoutMs)
          +
          +
          Specified by:
          +
          config_IntegralZone in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 int allowableCloseLoopError,
+                                                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configAllowableClosedloopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMaxIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode configMaxIntegralAccumulator​(int slotIdx,
+                                                               double iaccum,
+                                                               int timeoutMs)
          +
          +
          Specified by:
          +
          configMaxIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configMaxIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          setIntegralAccumulator

          +
          public com.ctre.phoenix.ErrorCode setIntegralAccumulator​(double iaccum,
+                                                         int pidIdx,
+                                                         int timeoutMs)
          +
          +
          Specified by:
          +
          setIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          setIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getClosedLoopError

          +
          public double getClosedLoopError​(int pidIdx)
          +
          +
          Specified by:
          +
          getClosedLoopError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getClosedLoopError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getIntegralAccumulator

          +
          public double getIntegralAccumulator​(int pidIdx)
          +
          +
          Specified by:
          +
          getIntegralAccumulator in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getIntegralAccumulator in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getErrorDerivative

          +
          public double getErrorDerivative​(int pidIdx)
          +
          +
          Specified by:
          +
          getErrorDerivative in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getErrorDerivative in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          selectProfileSlot

          +
          public void selectProfileSlot​(int slotIdx,
+                              int pidIdx)
          +
          +
          Specified by:
          +
          selectProfileSlot in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          selectProfileSlot in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryPosition

          +
          public double getActiveTrajectoryPosition()
          +
          +
          Specified by:
          +
          getActiveTrajectoryPosition in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryPosition in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getActiveTrajectoryVelocity

          +
          public double getActiveTrajectoryVelocity()
          +
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getActiveTrajectoryVelocity in class XCANTalon
          +
          +
          • +
        + + + + + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(int sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionCruiseVelocity in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(int sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          +
          Specified by:
          +
          configMotionAcceleration in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileTrajectories

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileTrajectories()
          +
          +
          Specified by:
          +
          clearMotionProfileTrajectories in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileTrajectories in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileTopLevelBufferCount

          +
          public int getMotionProfileTopLevelBufferCount()
          +
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileTopLevelBufferCount in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          pushMotionProfileTrajectory

          +
          public com.ctre.phoenix.ErrorCode pushMotionProfileTrajectory​(com.ctre.phoenix.motion.TrajectoryPoint trajPt)
          +
          +
          Specified by:
          +
          pushMotionProfileTrajectory in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          pushMotionProfileTrajectory in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          isMotionProfileTopLevelBufferFull

          +
          public boolean isMotionProfileTopLevelBufferFull()
          +
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          isMotionProfileTopLevelBufferFull in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          processMotionProfileBuffer

          +
          public void processMotionProfileBuffer()
          +
          +
          Specified by:
          +
          processMotionProfileBuffer in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          processMotionProfileBuffer in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getMotionProfileStatus

          +
          public com.ctre.phoenix.ErrorCode getMotionProfileStatus​(com.ctre.phoenix.motion.MotionProfileStatus statusToFill)
          +
          +
          Specified by:
          +
          getMotionProfileStatus in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getMotionProfileStatus in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearMotionProfileHasUnderrun

          +
          public com.ctre.phoenix.ErrorCode clearMotionProfileHasUnderrun​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearMotionProfileHasUnderrun in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          changeMotionControlFramePeriod

          +
          public com.ctre.phoenix.ErrorCode changeMotionControlFramePeriod​(int periodMs)
          +
          +
          Specified by:
          +
          changeMotionControlFramePeriod in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          changeMotionControlFramePeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getLastError

          +
          public com.ctre.phoenix.ErrorCode getLastError()
          +
          +
          Specified by:
          +
          getLastError in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getLastError in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public com.ctre.phoenix.ErrorCode getFaults​(com.ctre.phoenix.motorcontrol.Faults toFill)
          +
          +
          Specified by:
          +
          getFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public com.ctre.phoenix.ErrorCode getStickyFaults​(com.ctre.phoenix.motorcontrol.StickyFaults toFill)
          +
          +
          Specified by:
          +
          getStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public com.ctre.phoenix.ErrorCode clearStickyFaults​(int timeoutMs)
          +
          +
          Specified by:
          +
          clearStickyFaults in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          clearStickyFaults in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getFirmwareVersion

          +
          public int getFirmwareVersion()
          +
          +
          Specified by:
          +
          getFirmwareVersion in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getFirmwareVersion in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          hasResetOccurred

          +
          public boolean hasResetOccurred()
          +
          +
          Specified by:
          +
          hasResetOccurred in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          hasResetOccurred in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetCustomParam

          +
          public com.ctre.phoenix.ErrorCode configSetCustomParam​(int newValue,
+                                                       int paramIndex,
+                                                       int timeoutMs)
          +
          +
          Specified by:
          +
          configSetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetCustomParam

          +
          public int configGetCustomParam​(int paramIndex,
+                                int timoutMs)
          +
          +
          Specified by:
          +
          configGetCustomParam in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetCustomParam in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(com.ctre.phoenix.ParamEnum param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configSetParameter

          +
          public com.ctre.phoenix.ErrorCode configSetParameter​(int param,
+                                                     double value,
+                                                     int subValue,
+                                                     int ordinal,
+                                                     int timeoutMs)
          +
          +
          Specified by:
          +
          configSetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configSetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(com.ctre.phoenix.ParamEnum paramEnum,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configGetParameter

          +
          public double configGetParameter​(int paramEnum,
+                                 int ordinal,
+                                 int timeoutMs)
          +
          +
          Specified by:
          +
          configGetParameter in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          configGetParameter in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getBaseID

          +
          public int getBaseID()
          +
          +
          Specified by:
          +
          getBaseID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getBaseID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceID

          +
          public int getDeviceID()
          +
          +
          Specified by:
          +
          getDeviceID in interface com.ctre.phoenix.motorcontrol.IMotorController
          +
          Specified by:
          +
          getDeviceID in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          follow

          +
          public void follow​(com.ctre.phoenix.motorcontrol.IMotorController masterToFollow)
          +
          +
          Specified by:
          +
          follow in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          follow in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          valueUpdated

          +
          public void valueUpdated()
          +
          +
          Specified by:
          +
          valueUpdated in interface com.ctre.phoenix.motorcontrol.IFollower
          +
          Specified by:
          +
          valueUpdated in class XCANTalon
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          configSelectedFeedbackCoefficient

          +
          public com.ctre.phoenix.ErrorCode configSelectedFeedbackCoefficient​(double coefficient,
+                                                                    int pidIdx,
+                                                                    int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeakOutput

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeakOutput​(int slotIdx,
+                                                             double percentOut,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configClosedLoopPeriod

          +
          public com.ctre.phoenix.ErrorCode configClosedLoopPeriod​(int slotIdx,
+                                                         int loopTimeMs,
+                                                         int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configAuxPIDPolarity

          +
          public com.ctre.phoenix.ErrorCode configAuxPIDPolarity​(boolean invert,
+                                                       int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getClosedLoopTarget

          +
          public double getClosedLoopTarget​(int pidIdx)
          +
          • +
        + + + +
          +
        • +

          configMotionProfileTrajectoryPeriod

          +
          public com.ctre.phoenix.ErrorCode configMotionProfileTrajectoryPeriod​(int baseTrajDurationMs,
+                                                                      int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          getControlMode

          +
          public com.ctre.phoenix.motorcontrol.ControlMode getControlMode()
          +
          • +
        + + + +
          +
        • +

          configMotionSCurveStrength

          +
          public com.ctre.phoenix.ErrorCode configMotionSCurveStrength​(int curveStrength,
+                                                             int timeoutMs)
          +
          • +
        + + + + + + + +
          +
        • +

          configSupplyCurrentLimit

          +
          public com.ctre.phoenix.ErrorCode configSupplyCurrentLimit​(com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration currLimitCfg,
+                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(com.ctre.phoenix.motorcontrol.InvertType invertType)
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.sensors.CANCoder canCoderRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configRemoteFeedbackFilter

          +
          public com.ctre.phoenix.ErrorCode configRemoteFeedbackFilter​(com.ctre.phoenix.motorcontrol.can.BaseTalon talonRef,
+                                                             int remoteOrdinal,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          setSelectedSensorPosition

          +
          public com.ctre.phoenix.ErrorCode setSelectedSensorPosition​(double sensorPos,
+                                                            int pidIdx,
+                                                            int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configForwardSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configForwardSoftLimitThreshold​(double forwardSensorLimit,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configReverseSoftLimitThreshold

          +
          public com.ctre.phoenix.ErrorCode configReverseSoftLimitThreshold​(double reverseSensorLimit,
+                                                                  int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          config_IntegralZone

          +
          public com.ctre.phoenix.ErrorCode config_IntegralZone​(int slotIdx,
+                                                      double izone,
+                                                      int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configAllowableClosedloopError

          +
          public com.ctre.phoenix.ErrorCode configAllowableClosedloopError​(int slotIdx,
+                                                                 double allowableCloseLoopError,
+                                                                 int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionCruiseVelocity

          +
          public com.ctre.phoenix.ErrorCode configMotionCruiseVelocity​(double sensorUnitsPer100ms,
+                                                             int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configMotionAcceleration

          +
          public com.ctre.phoenix.ErrorCode configMotionAcceleration​(double sensorUnitsPer100msPerSec,
+                                                           int timeoutMs)
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.sensors.SensorVelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in interface com.ctre.phoenix.motorcontrol.IMotorControllerEnhanced
          +
          Specified by:
          +
          configVelocityMeasurementPeriod in class XCANTalon
          +
          +
          • +
        + + + +
          +
        • +

          configVelocityMeasurementPeriod

          +
          public com.ctre.phoenix.ErrorCode configVelocityMeasurementPeriod​(com.ctre.phoenix.motorcontrol.VelocityMeasPeriod period,
+                                                                  int timeoutMs)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/package-summary.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/package-summary.html new file mode 100644 index 00000000..38ab675f --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/package-summary.html @@ -0,0 +1,244 @@ + + + + + +xbot.common.controls.actuators.wpi_adapters (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.controls.actuators.wpi_adapters

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/controls/actuators/wpi_adapters/package-tree.html b/javadoc/xbot/common/controls/actuators/wpi_adapters/package-tree.html new file mode 100644 index 00000000..8591de82 --- /dev/null +++ b/javadoc/xbot/common/controls/actuators/wpi_adapters/package-tree.html @@ -0,0 +1,225 @@ + + + + + +xbot.common.controls.actuators.wpi_adapters Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.controls.actuators.wpi_adapters

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/controls/package-summary.html b/javadoc/xbot/common/controls/package-summary.html new file mode 100644 index 00000000..c1e27248 --- /dev/null +++ b/javadoc/xbot/common/controls/package-summary.html @@ -0,0 +1,164 @@ + + + + + +xbot.common.controls (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.controls

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      XBaseIO 
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/controls/package-tree.html b/javadoc/xbot/common/controls/package-tree.html new file mode 100644 index 00000000..77a25740 --- /dev/null +++ b/javadoc/xbot/common/controls/package-tree.html @@ -0,0 +1,157 @@ + + + + + +xbot.common.controls Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.controls

    +Package Hierarchies: + +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/controls/sensors/AnalogDistanceSensor.AnalogDistanceSensorFactory.html b/javadoc/xbot/common/controls/sensors/AnalogDistanceSensor.AnalogDistanceSensorFactory.html new file mode 100644 index 00000000..fabd9170 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/AnalogDistanceSensor.AnalogDistanceSensorFactory.html @@ -0,0 +1,325 @@ + + + + + +AnalogDistanceSensor.AnalogDistanceSensorFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class AnalogDistanceSensor.AnalogDistanceSensorFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.AnalogDistanceSensor.AnalogDistanceSensorFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract AnalogDistanceSensorcreate​(int channel, + java.util.function.DoubleFunction<java.lang.Double> voltageMap, + java.lang.String prefix) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          AnalogDistanceSensorFactory

          +
          public AnalogDistanceSensorFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/AnalogDistanceSensor.html b/javadoc/xbot/common/controls/sensors/AnalogDistanceSensor.html new file mode 100644 index 00000000..ad12c0c8 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/AnalogDistanceSensor.html @@ -0,0 +1,459 @@ + + + + + +AnalogDistanceSensor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class AnalogDistanceSensor

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/DistanceSensor.html b/javadoc/xbot/common/controls/sensors/DistanceSensor.html new file mode 100644 index 00000000..362ada5b --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/DistanceSensor.html @@ -0,0 +1,266 @@ + + + + + +DistanceSensor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface DistanceSensor

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDistance

          +
          double getDistance()
          +
          • +
        + + + +
          +
        • +

          setAveraging

          +
          void setAveraging​(boolean shouldAverage)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/DistanceSensorPair.html b/javadoc/xbot/common/controls/sensors/DistanceSensorPair.html new file mode 100644 index 00000000..69923d64 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/DistanceSensorPair.html @@ -0,0 +1,280 @@ + + + + + +DistanceSensorPair (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface DistanceSensorPair

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/IGamepad.html b/javadoc/xbot/common/controls/sensors/IGamepad.html new file mode 100644 index 00000000..45332482 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/IGamepad.html @@ -0,0 +1,326 @@ + + + + + +IGamepad (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface IGamepad

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getLeftVector

          +
          XYPair getLeftVector()
          +
          • +
        + + + +
          +
        • +

          getRightVector

          +
          XYPair getRightVector()
          +
          • +
        + + + +
          +
        • +

          getLeftTrigger

          +
          double getLeftTrigger()
          +
          • +
        + + + +
          +
        • +

          getRightTrigger

          +
          double getRightTrigger()
          +
          • +
        + + + +
          +
        • +

          setLeftInversion

          +
          void setLeftInversion​(boolean xInverted,
+                      boolean yInverted)
          +
          • +
        + + + +
          +
        • +

          setRightInversion

          +
          void setRightInversion​(boolean xInverted,
+                       boolean yInverted)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/MultiplexedLidarPair.html b/javadoc/xbot/common/controls/sensors/MultiplexedLidarPair.html new file mode 100644 index 00000000..526e5469 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/MultiplexedLidarPair.html @@ -0,0 +1,355 @@ + + + + + +MultiplexedLidarPair (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class MultiplexedLidarPair

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.MultiplexedLidarPair
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory.html b/javadoc/xbot/common/controls/sensors/SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory.html new file mode 100644 index 00000000..5f8e09c0 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory.html @@ -0,0 +1,325 @@ + + + + + +SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.SimulatedAnalogDistanceSensor.SimulatedAnalogDistanceSensorFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract SimulatedAnalogDistanceSensorcreate​(int channel, + java.util.function.DoubleFunction<java.lang.Double> voltageMap, + java.lang.String prefix) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          SimulatedAnalogDistanceSensorFactory

          +
          public SimulatedAnalogDistanceSensorFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/SimulatedAnalogDistanceSensor.html b/javadoc/xbot/common/controls/sensors/SimulatedAnalogDistanceSensor.html new file mode 100644 index 00000000..018b76ef --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/SimulatedAnalogDistanceSensor.html @@ -0,0 +1,450 @@ + + + + + +SimulatedAnalogDistanceSensor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class SimulatedAnalogDistanceSensor

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/TalonCurrentMonitor.html b/javadoc/xbot/common/controls/sensors/TalonCurrentMonitor.html new file mode 100644 index 00000000..b84f718f --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/TalonCurrentMonitor.html @@ -0,0 +1,332 @@ + + + + + +TalonCurrentMonitor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class TalonCurrentMonitor

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.TalonCurrentMonitor
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class TalonCurrentMonitor
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TalonCurrentMonitor

          +
          public TalonCurrentMonitor​(XCANTalon talon)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          updateCurrent

          +
          public void updateCurrent()
          +
          • +
        + + + +
          +
        • +

          calculateAverageCurrent

          +
          public double calculateAverageCurrent()
          +
          • +
        + + + +
          +
        • +

          calculatePeakCurrent

          +
          public double calculatePeakCurrent()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XAS5600.XAS5600Factory.html b/javadoc/xbot/common/controls/sensors/XAS5600.XAS5600Factory.html new file mode 100644 index 00000000..9ecb0d91 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XAS5600.XAS5600Factory.html @@ -0,0 +1,310 @@ + + + + + +XAS5600.XAS5600Factory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XAS5600.XAS5600Factory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XAS5600.XAS5600Factory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      XAS5600
      +
      +
      +
      @AssistedFactory
+public abstract static class XAS5600.XAS5600Factory
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        XAS5600Factory() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract XAS5600create​(XCANTalon talon) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          XAS5600Factory

          +
          public XAS5600Factory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract XAS5600 create​(@Assisted("talon")
+                               XCANTalon talon)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XAS5600.html b/javadoc/xbot/common/controls/sensors/XAS5600.html new file mode 100644 index 00000000..7ca9bd0d --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XAS5600.html @@ -0,0 +1,371 @@ + + + + + +XAS5600 (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XAS5600

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XAS5600
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class XAS5600
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class XAS5600.XAS5600Factory 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected org.apache.log4j.Loggerlog 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        XAS5600​(XCANTalon talon) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        intgetPosition() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          log

          +
          protected org.apache.log4j.Logger log
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XAS5600

          +
          @AssistedInject
+public XAS5600​(@Assisted("talon")
+               XCANTalon talon)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPosition

          +
          public int getPosition()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XAbsoluteEncoder.XAbsoluteEncoderFactory.html b/javadoc/xbot/common/controls/sensors/XAbsoluteEncoder.XAbsoluteEncoderFactory.html new file mode 100644 index 00000000..e9c55959 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XAbsoluteEncoder.XAbsoluteEncoderFactory.html @@ -0,0 +1,262 @@ + + + + + +XAbsoluteEncoder.XAbsoluteEncoderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XAbsoluteEncoder.XAbsoluteEncoderFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XAbsoluteEncoder.html b/javadoc/xbot/common/controls/sensors/XAbsoluteEncoder.html new file mode 100644 index 00000000..8cbcfeba --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XAbsoluteEncoder.html @@ -0,0 +1,401 @@ + + + + + +XAbsoluteEncoder (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XAbsoluteEncoder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XAbsoluteEncoder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XAbsoluteEncoder

          +
          public XAbsoluteEncoder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDeviceId

          +
          public abstract int getDeviceId()
          +
          • +
        + + + +
          +
        • +

          getPosition

          +
          public abstract double getPosition()
          +
          • +
        + + + +
          +
        • +

          getAbsolutePosition

          +
          public abstract double getAbsolutePosition()
          +
          • +
        + + + +
          +
        • +

          getVelocity

          +
          public abstract double getVelocity()
          +
          • +
        + + + +
          +
        • +

          setPosition

          +
          public abstract void setPosition​(double newPostition)
          +
          • +
        + + + +
          +
        • +

          getHealth

          +
          public abstract DeviceHealth getHealth()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XAnalogDistanceSensor.VoltageMaps.html b/javadoc/xbot/common/controls/sensors/XAnalogDistanceSensor.VoltageMaps.html new file mode 100644 index 00000000..b0f68178 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XAnalogDistanceSensor.VoltageMaps.html @@ -0,0 +1,308 @@ + + + + + +XAnalogDistanceSensor.VoltageMaps (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XAnalogDistanceSensor.VoltageMaps

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XAnalogDistanceSensor.VoltageMaps
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      XAnalogDistanceSensor
      +
      +
      +
      public static class XAnalogDistanceSensor.VoltageMaps
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        VoltageMaps() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static doublesharp0A51SK​(double voltage) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          VoltageMaps

          +
          public VoltageMaps()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          sharp0A51SK

          +
          public static final double sharp0A51SK​(double voltage)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XAnalogDistanceSensor.XAnalogDistanceSensorFactory.html b/javadoc/xbot/common/controls/sensors/XAnalogDistanceSensor.XAnalogDistanceSensorFactory.html new file mode 100644 index 00000000..9b8e8d43 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XAnalogDistanceSensor.XAnalogDistanceSensorFactory.html @@ -0,0 +1,260 @@ + + + + + +XAnalogDistanceSensor.XAnalogDistanceSensorFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XAnalogDistanceSensor.XAnalogDistanceSensorFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          XAnalogDistanceSensor create​(int channel,
+                             java.util.function.DoubleFunction<java.lang.Double> voltageMap,
+                             java.lang.String prefix)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XAnalogDistanceSensor.html b/javadoc/xbot/common/controls/sensors/XAnalogDistanceSensor.html new file mode 100644 index 00000000..722d4cd7 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XAnalogDistanceSensor.html @@ -0,0 +1,395 @@ + + + + + +XAnalogDistanceSensor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XAnalogDistanceSensor

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XAnalogDistanceSensor
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XAnalogDistanceSensor

          +
          protected XAnalogDistanceSensor​(int channel,
+                                java.util.function.DoubleFunction<java.lang.Double> voltageMap)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          setAveraging

          +
          public abstract void setAveraging​(boolean shouldAverage)
          +
          +
          Specified by:
          +
          setAveraging in interface DistanceSensor
          +
          +
          • +
        + + + +
          +
        • +

          setVoltageOffset

          +
          public abstract void setVoltageOffset​(double offset)
          +
          • +
        + + + +
          +
        • +

          setDistanceOffset

          +
          public abstract void setDistanceOffset​(double offset)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XAnalogInput.XAnalogInputFactory.html b/javadoc/xbot/common/controls/sensors/XAnalogInput.XAnalogInputFactory.html new file mode 100644 index 00000000..262ef1e6 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XAnalogInput.XAnalogInputFactory.html @@ -0,0 +1,256 @@ + + + + + +XAnalogInput.XAnalogInputFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XAnalogInput.XAnalogInputFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XAnalogInput.html b/javadoc/xbot/common/controls/sensors/XAnalogInput.html new file mode 100644 index 00000000..6b8c01a3 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XAnalogInput.html @@ -0,0 +1,429 @@ + + + + + +XAnalogInput (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XAnalogInput

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XAnalogInput
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected intchannel 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        XAnalogInput​(int channel, + DevicePolice police) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          channel

          +
          protected int channel
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XAnalogInput

          +
          public XAnalogInput​(int channel,
+                    DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getVoltage

          +
          public abstract double getVoltage()
          +
          • +
        + + + +
          +
        • +

          getAverageVoltage

          +
          public abstract double getAverageVoltage()
          +
          • +
        + + + +
          +
        • +

          setAverageBits

          +
          public abstract void setAverageBits​(int bits)
          +
          • +
        + + + +
          +
        • +

          getAsDigital

          +
          public abstract boolean getAsDigital​(double threshold)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XCANCoder.XCANCoderFactory.html b/javadoc/xbot/common/controls/sensors/XCANCoder.XCANCoderFactory.html new file mode 100644 index 00000000..3a47787a --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XCANCoder.XCANCoderFactory.html @@ -0,0 +1,267 @@ + + + + + +XCANCoder.XCANCoderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XCANCoder.XCANCoderFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XCANCoder.html b/javadoc/xbot/common/controls/sensors/XCANCoder.html new file mode 100644 index 00000000..be91da95 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XCANCoder.html @@ -0,0 +1,422 @@ + + + + + +XCANCoder (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XCANCoder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XCANCoder

          +
          public XCANCoder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public abstract com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.sensors.CANCoderStatusFrame frame,
+                                                                int periodMs)
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public abstract int getStatusFramePeriod​(com.ctre.phoenix.sensors.CANCoderStatusFrame frame)
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public abstract com.ctre.phoenix.ErrorCode getFaults​(com.ctre.phoenix.sensors.CANCoderFaults toFill)
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public abstract com.ctre.phoenix.ErrorCode getStickyFaults​(com.ctre.phoenix.sensors.CANCoderStickyFaults toFill)
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public abstract com.ctre.phoenix.ErrorCode clearStickyFaults()
          +
          • +
        + + + +
          +
        • +

          hasResetOccurred

          +
          public abstract boolean hasResetOccurred()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XDigitalInput.XDigitalInputFactory.html b/javadoc/xbot/common/controls/sensors/XDigitalInput.XDigitalInputFactory.html new file mode 100644 index 00000000..dffd92ab --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XDigitalInput.XDigitalInputFactory.html @@ -0,0 +1,256 @@ + + + + + +XDigitalInput.XDigitalInputFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XDigitalInput.XDigitalInputFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XDigitalInput.html b/javadoc/xbot/common/controls/sensors/XDigitalInput.html new file mode 100644 index 00000000..5a0347d5 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XDigitalInput.html @@ -0,0 +1,387 @@ + + + + + +XDigitalInput (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XDigitalInput

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XDigitalInput
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XDigitalInput

          +
          public XDigitalInput​(DevicePolice police,
+                     int channel)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          get

          +
          public boolean get()
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean inverted)
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          • +
        + + + +
          +
        • +

          getRaw

          +
          protected abstract boolean getRaw()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XDutyCycleEncoder.XDutyCycleEncoderFactory.html b/javadoc/xbot/common/controls/sensors/XDutyCycleEncoder.XDutyCycleEncoderFactory.html new file mode 100644 index 00000000..92854472 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XDutyCycleEncoder.XDutyCycleEncoderFactory.html @@ -0,0 +1,256 @@ + + + + + +XDutyCycleEncoder.XDutyCycleEncoderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XDutyCycleEncoder.XDutyCycleEncoderFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XDutyCycleEncoder.html b/javadoc/xbot/common/controls/sensors/XDutyCycleEncoder.html new file mode 100644 index 00000000..e033a23a --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XDutyCycleEncoder.html @@ -0,0 +1,493 @@ + + + + + +XDutyCycleEncoder (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XDutyCycleEncoder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XDutyCycleEncoder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          channel

          +
          protected int channel
          +
          • +
        + + + +
          +
        • +

          inverted

          +
          protected boolean inverted
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAbsoluteRawPosition

          +
          protected abstract double getAbsoluteRawPosition()
          +
          • +
        + + + +
          +
        • +

          getAbsolutePosition

          +
          public edu.wpi.first.math.geometry.Rotation2d getAbsolutePosition()
          +
          Typically not recommended - use getWrappedPosition() instead.
          +
          +
          Returns:
          +
          the absolute position of the encoder in degrees from (0, 360)
          +
          +
          • +
        + + + +
          +
        • +

          getAbsoluteDegrees

          +
          public double getAbsoluteDegrees()
          +
          • +
        + + + +
          +
        • +

          getWrappedPosition

          +
          public WrappedRotation2d getWrappedPosition()
          +
          +
          Returns:
          +
          the absolute position of the encoder in degrees from (-180, 180)
          +
          +
          • +
        + + + +
          +
        • +

          getChannel

          +
          public int getChannel()
          +
          +
          Specified by:
          +
          getChannel in interface XBaseIO
          +
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean inverted)
          +
          • +
        + + + +
          +
        • +

          inversionFactor

          +
          protected double inversionFactor()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XEncoder.XEncoderFactory.html b/javadoc/xbot/common/controls/sensors/XEncoder.XEncoderFactory.html new file mode 100644 index 00000000..f99edb48 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XEncoder.XEncoderFactory.html @@ -0,0 +1,262 @@ + + + + + +XEncoder.XEncoderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XEncoder.XEncoderFactory

    +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          XEncoder create​(java.lang.String name,
+                int aChannel,
+                int bChannel,
+                double defaultDistancePerPulse)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XEncoder.html b/javadoc/xbot/common/controls/sensors/XEncoder.html new file mode 100644 index 00000000..c3962855 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XEncoder.html @@ -0,0 +1,523 @@ + + + + + +XEncoder (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XEncoder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XEncoder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          isInverted

          +
          protected boolean isInverted
          +
          • +
        + + + + + + + +
          +
        • +

          distancePerPulseSupplier

          +
          protected java.util.function.Supplier<java.lang.Double> distancePerPulseSupplier
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XEncoder

          +
          public XEncoder​(java.lang.String name,
+                int aChannel,
+                int bChannel,
+                double defaultDistancePerPulse,
+                PropertyFactory propMan,
+                DevicePolice police)
          +
          • +
        + + + +
          +
        • +

          XEncoder

          +
          public XEncoder​(java.lang.String prefix,
+                PropertyFactory propMan)
          +
          • +
        + + + +
          +
        • +

          XEncoder

          +
          public XEncoder​(java.util.function.Supplier<java.lang.Double> distancePerPulse)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setDistancePerPulseSupplier

          +
          public void setDistancePerPulseSupplier​(java.util.function.Supplier<java.lang.Double> supplier)
          +
          • +
        + + + +
          +
        • +

          getAdjustedDistance

          +
          public double getAdjustedDistance()
          +
          • +
        + + + +
          +
        • +

          getAdjustedRate

          +
          public double getAdjustedRate()
          +
          • +
        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean inverted)
          +
          • +
        + + + +
          +
        • +

          getRate

          +
          protected abstract double getRate()
          +
          • +
        + + + +
          +
        • +

          getDistance

          +
          protected abstract double getDistance()
          +
          • +
        + + + +
          +
        • +

          setSamplesToAverage

          +
          public abstract void setSamplesToAverage​(int samples)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XFTCGamepad.XFTCGamepadFactory.html b/javadoc/xbot/common/controls/sensors/XFTCGamepad.XFTCGamepadFactory.html new file mode 100644 index 00000000..806cfd86 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XFTCGamepad.XFTCGamepadFactory.html @@ -0,0 +1,258 @@ + + + + + +XFTCGamepad.XFTCGamepadFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XFTCGamepad.XFTCGamepadFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          XFTCGamepad create​(int port,
+                   int numButtons)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XFTCGamepad.html b/javadoc/xbot/common/controls/sensors/XFTCGamepad.html new file mode 100644 index 00000000..67116cef --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XFTCGamepad.html @@ -0,0 +1,566 @@ + + + + + +XFTCGamepad (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XFTCGamepad

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XGyro.ImuType.html b/javadoc/xbot/common/controls/sensors/XGyro.ImuType.html new file mode 100644 index 00000000..52241e0c --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XGyro.ImuType.html @@ -0,0 +1,393 @@ + + + + + +XGyro.ImuType (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Enum XGyro.ImuType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<XGyro.ImuType>
        • +
      • +
          +
        • xbot.common.controls.sensors.XGyro.ImuType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<XGyro.ImuType>
      +
      +
      +
      Enclosing class:
      +
      XGyro
      +
      +
      +
      public static enum XGyro.ImuType
+extends java.lang.Enum<XGyro.ImuType>
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        mock 
        nav6 
        navX 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static XGyro.ImuTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static XGyro.ImuType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static XGyro.ImuType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (XGyro.ImuType c : XGyro.ImuType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static XGyro.ImuType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XGyro.XGyroFactory.html b/javadoc/xbot/common/controls/sensors/XGyro.XGyroFactory.html new file mode 100644 index 00000000..cfa6623e --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XGyro.XGyroFactory.html @@ -0,0 +1,372 @@ + + + + + +XGyro.XGyroFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XGyro.XGyroFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XGyro.XGyroFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        XGyroFactory() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        XGyrocreate() 
        XGyrocreate​(edu.wpi.first.wpilibj.I2C.Port i2cPort) 
        XGyrocreate​(edu.wpi.first.wpilibj.SerialPort.Port serialPort) 
        XGyrocreate​(edu.wpi.first.wpilibj.SPI.Port spiPort) 
        protected abstract XGyrocreate​(edu.wpi.first.wpilibj.SPI.Port spiPort, + edu.wpi.first.wpilibj.SerialPort.Port serialPort, + edu.wpi.first.wpilibj.I2C.Port i2cPort) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          XGyroFactory

          +
          public XGyroFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          protected abstract XGyro create​(edu.wpi.first.wpilibj.SPI.Port spiPort,
+                                edu.wpi.first.wpilibj.SerialPort.Port serialPort,
+                                edu.wpi.first.wpilibj.I2C.Port i2cPort)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public XGyro create()
          +
          • +
        + + + +
          +
        • +

          create

          +
          public XGyro create​(edu.wpi.first.wpilibj.SPI.Port spiPort)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public XGyro create​(edu.wpi.first.wpilibj.SerialPort.Port serialPort)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public XGyro create​(edu.wpi.first.wpilibj.I2C.Port i2cPort)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XGyro.html b/javadoc/xbot/common/controls/sensors/XGyro.html new file mode 100644 index 00000000..f3126a9a --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XGyro.html @@ -0,0 +1,619 @@ + + + + + +XGyro (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XGyro

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XGyro
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isBroken

          +
          public abstract boolean isBroken()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          getRoll

          +
          public double getRoll()
          +
          • +
        + + + +
          +
        • +

          getPitch

          +
          public double getPitch()
          +
          • +
        + + + +
          +
        • +

          getYawAngularVelocity

          +
          public double getYawAngularVelocity()
          +
          • +
        + + + +
          +
        • +

          isConnected

          +
          public abstract boolean isConnected()
          +
          • +
        + + + +
          +
        • +

          getDeviceRoll

          +
          protected abstract double getDeviceRoll()
          +
          In degrees
          +
          • +
        + + + +
          +
        • +

          getDevicePitch

          +
          protected abstract double getDevicePitch()
          +
          In degrees
          +
          • +
        + + + +
          +
        • +

          getDeviceYaw

          +
          protected abstract double getDeviceYaw()
          +
          In degrees
          +
          • +
        + + + +
          +
        • +

          getDeviceYawAngularVelocity

          +
          protected abstract double getDeviceYawAngularVelocity()
          +
          In degrees per second
          +
          • +
        + + + +
          +
        • +

          getDeviceVelocityX

          +
          public abstract double getDeviceVelocityX()
          +
          • +
        + + + +
          +
        • +

          getDeviceVelocityY

          +
          public abstract double getDeviceVelocityY()
          +
          • +
        + + + +
          +
        • +

          getDeviceVelocityZ

          +
          public abstract double getDeviceVelocityZ()
          +
          • +
        + + + +
          +
        • +

          getDeviceRawAccelX

          +
          public abstract double getDeviceRawAccelX()
          +
          • +
        + + + +
          +
        • +

          getDeviceRawAccelY

          +
          public abstract double getDeviceRawAccelY()
          +
          • +
        + + + +
          +
        • +

          getDeviceRawAccelZ

          +
          public abstract double getDeviceRawAccelZ()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XJoystick.ButtonSource.html b/javadoc/xbot/common/controls/sensors/XJoystick.ButtonSource.html new file mode 100644 index 00000000..95ba6a32 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XJoystick.ButtonSource.html @@ -0,0 +1,380 @@ + + + + + +XJoystick.ButtonSource (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Enum XJoystick.ButtonSource

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        POV 
        Standard 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static XJoystick.ButtonSourcevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static XJoystick.ButtonSource[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static XJoystick.ButtonSource[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (XJoystick.ButtonSource c : XJoystick.ButtonSource.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static XJoystick.ButtonSource valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XJoystick.XJoystickFactory.html b/javadoc/xbot/common/controls/sensors/XJoystick.XJoystickFactory.html new file mode 100644 index 00000000..5067fca1 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XJoystick.XJoystickFactory.html @@ -0,0 +1,258 @@ + + + + + +XJoystick.XJoystickFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XJoystick.XJoystickFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          XJoystick create​(int port,
+                 int numButtons)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XJoystick.html b/javadoc/xbot/common/controls/sensors/XJoystick.html new file mode 100644 index 00000000..318722cb --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XJoystick.html @@ -0,0 +1,575 @@ + + + + + +XJoystick (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XJoystick

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XJoystick
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XLidarLite.XLidarLiteFactory.html b/javadoc/xbot/common/controls/sensors/XLidarLite.XLidarLiteFactory.html new file mode 100644 index 00000000..d5b56a9e --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XLidarLite.XLidarLiteFactory.html @@ -0,0 +1,258 @@ + + + + + +XLidarLite.XLidarLiteFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XLidarLite.XLidarLiteFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          XLidarLite create​(edu.wpi.first.wpilibj.I2C.Port port,
+                  java.lang.String prefix)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XLidarLite.html b/javadoc/xbot/common/controls/sensors/XLidarLite.html new file mode 100644 index 00000000..aad20f2b --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XLidarLite.html @@ -0,0 +1,516 @@ + + + + + +XLidarLite (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XLidarLite

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XLidarLite
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          distance

          +
          protected byte[] distance
          +
          • +
        + + + + + + + +
          +
        • +

          lidar_config_register

          +
          protected final int lidar_config_register
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          lidar_distance_register

          +
          protected final int lidar_distance_register
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XLidarLite

          +
          public XLidarLite​(edu.wpi.first.wpilibj.I2C.Port port,
+                  PropertyFactory propMan,
+                  DevicePolice police,
+                  java.lang.String prefix)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          update

          +
          protected abstract void update()
          +
          • +
        + + + + + + + +
          +
        • +

          pidGet

          +
          public double pidGet()
          +
          • +
        + + + +
          +
        • +

          start

          +
          public void start()
          +
          • +
        + + + +
          +
        • +

          stop

          +
          public void stop()
          +
          • +
        + + + +
          +
        • +

          setAveraging

          +
          public void setAveraging​(boolean shouldAverage)
          +
          +
          Specified by:
          +
          setAveraging in interface DistanceSensor
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XPowerDistributionPanel.XPowerDistributionPanelFactory.html b/javadoc/xbot/common/controls/sensors/XPowerDistributionPanel.XPowerDistributionPanelFactory.html new file mode 100644 index 00000000..69979a71 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XPowerDistributionPanel.XPowerDistributionPanelFactory.html @@ -0,0 +1,256 @@ + + + + + +XPowerDistributionPanel.XPowerDistributionPanelFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XPowerDistributionPanel.XPowerDistributionPanelFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XPowerDistributionPanel.html b/javadoc/xbot/common/controls/sensors/XPowerDistributionPanel.html new file mode 100644 index 00000000..b80f7693 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XPowerDistributionPanel.html @@ -0,0 +1,331 @@ + + + + + +XPowerDistributionPanel (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XPowerDistributionPanel

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XPowerDistributionPanel
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XPowerDistributionPanel

          +
          public XPowerDistributionPanel()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCurrent

          +
          public abstract double getCurrent​(int channel)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XSettableTimerImpl.html b/javadoc/xbot/common/controls/sensors/XSettableTimerImpl.html new file mode 100644 index 00000000..dfff7b1d --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XSettableTimerImpl.html @@ -0,0 +1,292 @@ + + + + + +XSettableTimerImpl (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XSettableTimerImpl

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setTimeInSeconds

          +
          void setTimeInSeconds​(double time)
          +
          Set the current time
          +
          +
          Parameters:
          +
          time - The current time in seconds
          +
          +
          • +
        + + + +
          +
        • +

          advanceTimeInSecondsBy

          +
          void advanceTimeInSecondsBy​(double time)
          +
          Advance the timer
          +
          +
          Parameters:
          +
          time - Duration in seconds to advance by
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XTimer.html b/javadoc/xbot/common/controls/sensors/XTimer.html new file mode 100644 index 00000000..2c36ebff --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XTimer.html @@ -0,0 +1,353 @@ + + + + + +XTimer (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XTimer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.XTimer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class XTimer
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        XTimer() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static voiddelay​(double seconds) 
        static doublegetFPGATimestamp() +
        Returns the current time in seconds since the FPGA was powered on.
        +
        static doublegetMatchTime() 
        static voidsetImplementation​(XTimerImpl implementation) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          XTimer

          +
          public XTimer()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setImplementation

          +
          public static void setImplementation​(XTimerImpl implementation)
          +
          • +
        + + + +
          +
        • +

          getFPGATimestamp

          +
          public static double getFPGATimestamp()
          +
          Returns the current time in seconds since the FPGA was powered on.
          +
          +
          Returns:
          +
          Time in seconds
          +
          +
          • +
        + + + +
          +
        • +

          getMatchTime

          +
          public static double getMatchTime()
          +
          • +
        + + + +
          +
        • +

          delay

          +
          public static void delay​(double seconds)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XTimerImpl.html b/javadoc/xbot/common/controls/sensors/XTimerImpl.html new file mode 100644 index 00000000..4aafe445 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XTimerImpl.html @@ -0,0 +1,284 @@ + + + + + +XTimerImpl (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XTimerImpl

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getFPGATimestamp

          +
          double getFPGATimestamp()
          +
          • +
        + + + +
          +
        • +

          getMatchTime

          +
          double getMatchTime()
          +
          • +
        + + + +
          +
        • +

          delay

          +
          void delay​(double seconds)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XXboxController.XXboxControllerFactory.html b/javadoc/xbot/common/controls/sensors/XXboxController.XXboxControllerFactory.html new file mode 100644 index 00000000..de065587 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XXboxController.XXboxControllerFactory.html @@ -0,0 +1,256 @@ + + + + + +XXboxController.XXboxControllerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Interface XXboxController.XXboxControllerFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/XXboxController.XboxButton.html b/javadoc/xbot/common/controls/sensors/XXboxController.XboxButton.html new file mode 100644 index 00000000..84414fc9 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XXboxController.XboxButton.html @@ -0,0 +1,550 @@ + + + + + +XXboxController.XboxButton (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Enum XXboxController.XboxButton

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/XXboxController.html b/javadoc/xbot/common/controls/sensors/XXboxController.html new file mode 100644 index 00000000..ed8205f8 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/XXboxController.html @@ -0,0 +1,798 @@ + + + + + +XXboxController (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors
    +

    Class XXboxController

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory.html b/javadoc/xbot/common/controls/sensors/buttons/AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory.html new file mode 100644 index 00000000..73f15e25 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory.html @@ -0,0 +1,313 @@ + + + + + +AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.buttons.AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      AdvancedJoystickButtonTrigger
      +
      +
      +
      @AssistedFactory
+public abstract static class AdvancedJoystickButtonTrigger.AdvancedJoystickButtonTriggerFactory
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AdvancedJoystickButtonTriggerFactory

          +
          public AdvancedJoystickButtonTriggerFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AdvancedJoystickButtonTrigger.html b/javadoc/xbot/common/controls/sensors/buttons/AdvancedJoystickButtonTrigger.html new file mode 100644 index 00000000..3c16c701 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AdvancedJoystickButtonTrigger.html @@ -0,0 +1,339 @@ + + + + + +AdvancedJoystickButtonTrigger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AdvancedJoystickButtonTrigger

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.BooleanSupplier
      +
      +
      +
      public class AdvancedJoystickButtonTrigger
+extends AdvancedTrigger
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.button.Trigger

          +and, cancelWhenActive, debounce, debounce, getAsBoolean, negate, onFalse, onTrue, or, toggleOnFalse, toggleOnTrue, toggleWhenActive, whenActive, whenActive, whenInactive, whenInactive, whileActiveContinuous, whileActiveContinuous, whileActiveOnce, whileFalse, whileTrue
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          AdvancedJoystickButtonTrigger

          +
          @AssistedInject
+public AdvancedJoystickButtonTrigger​(@Assisted("joystick")
+                                     XJoystick joystick,
+                                     @Assisted("buttonNumber")
+                                     int buttonNumber)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory.html b/javadoc/xbot/common/controls/sensors/buttons/AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory.html new file mode 100644 index 00000000..2e36997b --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory.html @@ -0,0 +1,313 @@ + + + + + +AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.buttons.AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      AdvancedPovButtonTrigger
      +
      +
      +
      @AssistedFactory
+public abstract static class AdvancedPovButtonTrigger.AdvancedPovButtonTriggerFactory
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AdvancedPovButtonTriggerFactory

          +
          public AdvancedPovButtonTriggerFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AdvancedPovButtonTrigger.html b/javadoc/xbot/common/controls/sensors/buttons/AdvancedPovButtonTrigger.html new file mode 100644 index 00000000..1f0d83ca --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AdvancedPovButtonTrigger.html @@ -0,0 +1,339 @@ + + + + + +AdvancedPovButtonTrigger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AdvancedPovButtonTrigger

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.BooleanSupplier
      +
      +
      +
      public class AdvancedPovButtonTrigger
+extends AdvancedTrigger
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.button.Trigger

          +and, cancelWhenActive, debounce, debounce, getAsBoolean, negate, onFalse, onTrue, or, toggleOnFalse, toggleOnTrue, toggleWhenActive, whenActive, whenActive, whenInactive, whenInactive, whileActiveContinuous, whileActiveContinuous, whileActiveOnce, whileFalse, whileTrue
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          AdvancedPovButtonTrigger

          +
          @AssistedInject
+public AdvancedPovButtonTrigger​(@Assisted("joystick")
+                                XJoystick joystick,
+                                @Assisted("povNumber")
+                                int povNumber)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AdvancedTrigger.html b/javadoc/xbot/common/controls/sensors/buttons/AdvancedTrigger.html new file mode 100644 index 00000000..e693de9f --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AdvancedTrigger.html @@ -0,0 +1,380 @@ + + + + + +AdvancedTrigger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AdvancedTrigger

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • edu.wpi.first.wpilibj2.command.button.Trigger
        • +
      • +
          +
        • xbot.common.controls.sensors.buttons.AdvancedTrigger
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        AdvancedTrigger​(java.util.function.BooleanSupplier supplier) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleangetInverted() 
        voidsetInverted​(boolean inverted) 
        +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.button.Trigger

          +and, cancelWhenActive, debounce, debounce, getAsBoolean, negate, onFalse, onTrue, or, toggleOnFalse, toggleOnTrue, toggleWhenActive, whenActive, whenActive, whenInactive, whenInactive, whileActiveContinuous, whileActiveContinuous, whileActiveOnce, whileFalse, whileTrue
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          AdvancedTrigger

          +
          public AdvancedTrigger​(java.util.function.BooleanSupplier supplier)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean inverted)
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AdvancedXboxAxisTrigger.html b/javadoc/xbot/common/controls/sensors/buttons/AdvancedXboxAxisTrigger.html new file mode 100644 index 00000000..7eff3e83 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AdvancedXboxAxisTrigger.html @@ -0,0 +1,351 @@ + + + + + +AdvancedXboxAxisTrigger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AdvancedXboxAxisTrigger

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.BooleanSupplier
      +
      +
      +
      public class AdvancedXboxAxisTrigger
+extends AdvancedXboxButtonTrigger
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AdvancedXboxButtonTrigger.ButtonTriggerType.html b/javadoc/xbot/common/controls/sensors/buttons/AdvancedXboxButtonTrigger.ButtonTriggerType.html new file mode 100644 index 00000000..38bbb563 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AdvancedXboxButtonTrigger.ButtonTriggerType.html @@ -0,0 +1,407 @@ + + + + + +AdvancedXboxButtonTrigger.ButtonTriggerType (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Enum AdvancedXboxButtonTrigger.ButtonTriggerType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static AdvancedXboxButtonTrigger.ButtonTriggerType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (AdvancedXboxButtonTrigger.ButtonTriggerType c : AdvancedXboxButtonTrigger.ButtonTriggerType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static AdvancedXboxButtonTrigger.ButtonTriggerType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AdvancedXboxButtonTrigger.html b/javadoc/xbot/common/controls/sensors/buttons/AdvancedXboxButtonTrigger.html new file mode 100644 index 00000000..020a33ad --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AdvancedXboxButtonTrigger.html @@ -0,0 +1,484 @@ + + + + + +AdvancedXboxButtonTrigger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AdvancedXboxButtonTrigger

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.BooleanSupplier
      +
      +
      +
      Direct Known Subclasses:
      +
      AdvancedXboxAxisTrigger
      +
      +
      +
      public class AdvancedXboxButtonTrigger
+extends AdvancedTrigger
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onTrue

          +
          public edu.wpi.first.wpilibj2.command.button.Trigger onTrue​(edu.wpi.first.wpilibj2.command.Command command)
          +
          +
          Overrides:
          +
          onTrue in class edu.wpi.first.wpilibj2.command.button.Trigger
          +
          +
          • +
        + + + +
          +
        • +

          onFalse

          +
          public edu.wpi.first.wpilibj2.command.button.Trigger onFalse​(edu.wpi.first.wpilibj2.command.Command command)
          +
          +
          Overrides:
          +
          onFalse in class edu.wpi.first.wpilibj2.command.button.Trigger
          +
          +
          • +
        + + + +
          +
        • +

          whileTrue

          +
          public edu.wpi.first.wpilibj2.command.button.Trigger whileTrue​(edu.wpi.first.wpilibj2.command.Command command)
          +
          +
          Overrides:
          +
          whileTrue in class edu.wpi.first.wpilibj2.command.button.Trigger
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonConfiguration.html b/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonConfiguration.html new file mode 100644 index 00000000..e78e3a8a --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonConfiguration.html @@ -0,0 +1,317 @@ + + + + + +AnalogHIDButtonConfiguration (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AnalogHIDButtonConfiguration

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.buttons.AnalogHIDButtonConfiguration
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class AnalogHIDButtonConfiguration
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        AnalogHIDButtonConfiguration​(XJoystick joystick, + int axisNumber, + double analogMinThreshold, + double analogMaxThreshold) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.function.BooleanSuppliergetSupplier() +
        Supplier indicates whether the analog value is in the button's range
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          AnalogHIDButtonConfiguration

          +
          public AnalogHIDButtonConfiguration​(XJoystick joystick,
+                                    int axisNumber,
+                                    double analogMinThreshold,
+                                    double analogMaxThreshold)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSupplier

          +
          public java.util.function.BooleanSupplier getSupplier()
          +
          Supplier indicates whether the analog value is in the button's range
          +
          +
          Returns:
          +
          A supplier for the value of the joystick button
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory.html b/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory.html new file mode 100644 index 00000000..18103f9e --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory.html @@ -0,0 +1,335 @@ + + + + + +AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      AnalogHIDButtonTrigger
      +
      +
      +
      @AssistedFactory
+public abstract static class AnalogHIDButtonTrigger.AnalogHIDButtonTriggerFactory
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonTrigger.AnalogHIDDescription.html b/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonTrigger.AnalogHIDDescription.html new file mode 100644 index 00000000..fc9732d7 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonTrigger.AnalogHIDDescription.html @@ -0,0 +1,422 @@ + + + + + +AnalogHIDButtonTrigger.AnalogHIDDescription (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AnalogHIDButtonTrigger.AnalogHIDDescription

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.buttons.AnalogHIDButtonTrigger.AnalogHIDDescription
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      AnalogHIDButtonTrigger
      +
      +
      +
      public static class AnalogHIDButtonTrigger.AnalogHIDDescription
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        AnalogHIDDescription​(int axisNumber, + double analogMinThreshold, + double analogMaxThreshold) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object obj) 
        inthashCode() 
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          axisNumber

          +
          public int axisNumber
          +
          • +
        + + + +
          +
        • +

          analogMinThreshold

          +
          public double analogMinThreshold
          +
          • +
        + + + +
          +
        • +

          analogMaxThreshold

          +
          public double analogMaxThreshold
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AnalogHIDDescription

          +
          public AnalogHIDDescription​(int axisNumber,
+                            double analogMinThreshold,
+                            double analogMaxThreshold)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonTrigger.html b/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonTrigger.html new file mode 100644 index 00000000..2b3bca85 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/AnalogHIDButtonTrigger.html @@ -0,0 +1,398 @@ + + + + + +AnalogHIDButtonTrigger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class AnalogHIDButtonTrigger

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.BooleanSupplier
      +
      +
      +
      public class AnalogHIDButtonTrigger
+extends AdvancedTrigger
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AnalogHIDButtonTrigger

          +
          @AssistedInject
+public AnalogHIDButtonTrigger​(@Assisted("joystick")
+                              XJoystick joystick,
+                              @Assisted("axisNumber")
+                              int axisNumber,
+                              @Assisted("analogMinThreshold")
+                              double analogMinThreshold,
+                              @Assisted("analogMaxThreshold")
+                              double analogMaxThreshold)
          +
          Create a joystick button for triggering commands based off of an analog axis
          +
          +
          Parameters:
          +
          joystick - The GenericHID object that has the analog axis to use
          +
          axisNumber - The axis number (appears to usually be [X=0,Y=1,Z=2])
          +
          analogMinThreshold - Analog threshold to trigger binary button state
          +
          analogMaxThreshold - Analog threshold to trigger binary button state
          +
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/ChordTrigger.ChordTriggerFactory.html b/javadoc/xbot/common/controls/sensors/buttons/ChordTrigger.ChordTriggerFactory.html new file mode 100644 index 00000000..e4d52496 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/ChordTrigger.ChordTriggerFactory.html @@ -0,0 +1,313 @@ + + + + + +ChordTrigger.ChordTriggerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class ChordTrigger.ChordTriggerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.buttons.ChordTrigger.ChordTriggerFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ChordTrigger
      +
      +
      +
      @AssistedFactory
+public abstract static class ChordTrigger.ChordTriggerFactory
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract ChordTriggercreate​(edu.wpi.first.wpilibj2.command.button.Trigger a, + edu.wpi.first.wpilibj2.command.button.Trigger b) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ChordTriggerFactory

          +
          public ChordTriggerFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract ChordTrigger create​(@Assisted("a")
+                                    edu.wpi.first.wpilibj2.command.button.Trigger a,
+                                    @Assisted("b")
+                                    edu.wpi.first.wpilibj2.command.button.Trigger b)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/ChordTrigger.html b/javadoc/xbot/common/controls/sensors/buttons/ChordTrigger.html new file mode 100644 index 00000000..99aa7460 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/ChordTrigger.html @@ -0,0 +1,339 @@ + + + + + +ChordTrigger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class ChordTrigger

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.BooleanSupplier
      +
      +
      +
      public class ChordTrigger
+extends AdvancedTrigger
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ChordTrigger​(edu.wpi.first.wpilibj2.command.button.Trigger a, + edu.wpi.first.wpilibj2.command.button.Trigger b) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.button.Trigger

          +and, cancelWhenActive, debounce, debounce, getAsBoolean, negate, onFalse, onTrue, or, toggleOnFalse, toggleOnTrue, toggleWhenActive, whenActive, whenActive, whenInactive, whenInactive, whileActiveContinuous, whileActiveContinuous, whileActiveOnce, whileFalse, whileTrue
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ChordTrigger

          +
          @AssistedInject
+public ChordTrigger​(@Assisted("a")
+                    edu.wpi.first.wpilibj2.command.button.Trigger a,
+                    @Assisted("b")
+                    edu.wpi.first.wpilibj2.command.button.Trigger b)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/InvertingBooleanSupplier.html b/javadoc/xbot/common/controls/sensors/buttons/InvertingBooleanSupplier.html new file mode 100644 index 00000000..22b7b720 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/InvertingBooleanSupplier.html @@ -0,0 +1,341 @@ + + + + + +InvertingBooleanSupplier (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class InvertingBooleanSupplier

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.buttons.InvertingBooleanSupplier
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.BooleanSupplier
      +
      +
      +
      public class InvertingBooleanSupplier
+extends java.lang.Object
+implements java.util.function.BooleanSupplier
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        InvertingBooleanSupplier​(java.util.function.BooleanSupplier supplier) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleangetAsBoolean() 
        booleangetInverted() 
        voidsetInverted​(boolean isInverted) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          InvertingBooleanSupplier

          +
          public InvertingBooleanSupplier​(java.util.function.BooleanSupplier supplier)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setInverted

          +
          public void setInverted​(boolean isInverted)
          +
          • +
        + + + +
          +
        • +

          getInverted

          +
          public boolean getInverted()
          +
          • +
        + + + +
          +
        • +

          getAsBoolean

          +
          public boolean getAsBoolean()
          +
          +
          Specified by:
          +
          getAsBoolean in interface java.util.function.BooleanSupplier
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/SettableBooleanSuppler.html b/javadoc/xbot/common/controls/sensors/buttons/SettableBooleanSuppler.html new file mode 100644 index 00000000..80410b7a --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/SettableBooleanSuppler.html @@ -0,0 +1,341 @@ + + + + + +SettableBooleanSuppler (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class SettableBooleanSuppler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.buttons.SettableBooleanSuppler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.BooleanSupplier
      +
      +
      +
      public class SettableBooleanSuppler
+extends java.lang.Object
+implements java.util.function.BooleanSupplier
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        SettableBooleanSuppler​(boolean defaultValue) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleangetAsBoolean() 
        voidset​(boolean value) 
        voidtoggle() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          SettableBooleanSuppler

          +
          public SettableBooleanSuppler​(boolean defaultValue)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAsBoolean

          +
          public boolean getAsBoolean()
          +
          +
          Specified by:
          +
          getAsBoolean in interface java.util.function.BooleanSupplier
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(boolean value)
          +
          • +
        + + + +
          +
        • +

          toggle

          +
          public void toggle()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/VirtualTrigger.VirtualTriggerFactory.html b/javadoc/xbot/common/controls/sensors/buttons/VirtualTrigger.VirtualTriggerFactory.html new file mode 100644 index 00000000..f50a2117 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/VirtualTrigger.VirtualTriggerFactory.html @@ -0,0 +1,324 @@ + + + + + +VirtualTrigger.VirtualTriggerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class VirtualTrigger.VirtualTriggerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.buttons.VirtualTrigger.VirtualTriggerFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      VirtualTrigger
      +
      +
      +
      @AssistedFactory
+public abstract static class VirtualTrigger.VirtualTriggerFactory
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          VirtualTriggerFactory

          +
          public VirtualTriggerFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/VirtualTrigger.html b/javadoc/xbot/common/controls/sensors/buttons/VirtualTrigger.html new file mode 100644 index 00000000..489bf785 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/VirtualTrigger.html @@ -0,0 +1,386 @@ + + + + + +VirtualTrigger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.buttons
    +

    Class VirtualTrigger

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.BooleanSupplier
      +
      +
      +
      public class VirtualTrigger
+extends AdvancedTrigger
      +
      A virtual button under program control that can be used for creating chords. + This is useful to repurpose buttons in multiple "modes".
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidset​(boolean value) 
        voidtoggle() 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.button.Trigger

          +and, cancelWhenActive, debounce, debounce, getAsBoolean, negate, onFalse, onTrue, or, toggleOnFalse, toggleOnTrue, toggleWhenActive, whenActive, whenActive, whenInactive, whenInactive, whileActiveContinuous, whileActiveContinuous, whileActiveOnce, whileFalse, whileTrue
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          VirtualTrigger

          +
          @AssistedInject
+public VirtualTrigger​(@Assisted
+                      boolean defaultPressed)
          +
          • +
        + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          set

          +
          public void set​(boolean value)
          +
          • +
        + + + +
          +
        • +

          toggle

          +
          public void toggle()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/package-summary.html b/javadoc/xbot/common/controls/sensors/buttons/package-summary.html new file mode 100644 index 00000000..6ae0b73b --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/package-summary.html @@ -0,0 +1,245 @@ + + + + + +xbot.common.controls.sensors.buttons (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.controls.sensors.buttons

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/buttons/package-tree.html b/javadoc/xbot/common/controls/sensors/buttons/package-tree.html new file mode 100644 index 00000000..77f608cf --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/buttons/package-tree.html @@ -0,0 +1,201 @@ + + + + + +xbot.common.controls.sensors.buttons Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.controls.sensors.buttons

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockAbsoluteEncoder.MockAbsoluteEncoderFactory.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockAbsoluteEncoder.MockAbsoluteEncoderFactory.html new file mode 100644 index 00000000..fbb40d60 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockAbsoluteEncoder.MockAbsoluteEncoderFactory.html @@ -0,0 +1,322 @@ + + + + + +MockAbsoluteEncoder.MockAbsoluteEncoderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockAbsoluteEncoder.MockAbsoluteEncoderFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.mock_adapters.MockAbsoluteEncoder.MockAbsoluteEncoderFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract MockAbsoluteEncodercreate​(DeviceInfo deviceInfo, + java.lang.String owningSystemPrefix) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockAbsoluteEncoder.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockAbsoluteEncoder.html new file mode 100644 index 00000000..63e5e6fc --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockAbsoluteEncoder.html @@ -0,0 +1,493 @@ + + + + + +MockAbsoluteEncoder (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockAbsoluteEncoder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockCANCoder.MockCANCoderFactory.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockCANCoder.MockCANCoderFactory.html new file mode 100644 index 00000000..8cd04a0a --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockCANCoder.MockCANCoderFactory.html @@ -0,0 +1,324 @@ + + + + + +MockCANCoder.MockCANCoderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockCANCoder.MockCANCoderFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.mock_adapters.MockCANCoder.MockCANCoderFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract MockCANCodercreate​(DeviceInfo deviceInfo, + java.lang.String owningSystemPrefix) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockCANCoder.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockCANCoder.html new file mode 100644 index 00000000..e55be377 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockCANCoder.html @@ -0,0 +1,615 @@ + + + + + +MockCANCoder (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockCANCoder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MockCANCoder

          +
          @AssistedInject
+public MockCANCoder​(@Assisted("deviceInfo")
+                    DeviceInfo deviceInfo,
+                    @Assisted("owningSystemPrefix")
+                    java.lang.String owningSystemPrefix,
+                    DevicePolice police,
+                    PropertyFactory pf)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + + + + + + + + + +
          +
        • +

          getPositionOffset

          +
          public double getPositionOffset()
          +
          • +
        + + + +
          +
        • +

          setAbsolutePosition

          +
          public void setAbsolutePosition​(double position)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.sensors.CANCoderStatusFrame frame,
+                                                       int periodMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANCoder
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.sensors.CANCoderStatusFrame frame)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANCoder
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public com.ctre.phoenix.ErrorCode getFaults​(com.ctre.phoenix.sensors.CANCoderFaults toFill)
          +
          +
          Specified by:
          +
          getFaults in class XCANCoder
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public com.ctre.phoenix.ErrorCode getStickyFaults​(com.ctre.phoenix.sensors.CANCoderStickyFaults toFill)
          +
          +
          Specified by:
          +
          getStickyFaults in class XCANCoder
          +
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public com.ctre.phoenix.ErrorCode clearStickyFaults()
          +
          +
          Specified by:
          +
          clearStickyFaults in class XCANCoder
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockDutyCycleEncoder.MockDutyCycleEncoderFactory.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockDutyCycleEncoder.MockDutyCycleEncoderFactory.html new file mode 100644 index 00000000..3a1af09d --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockDutyCycleEncoder.MockDutyCycleEncoderFactory.html @@ -0,0 +1,319 @@ + + + + + +MockDutyCycleEncoder.MockDutyCycleEncoderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockDutyCycleEncoder.MockDutyCycleEncoderFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.mock_adapters.MockDutyCycleEncoder.MockDutyCycleEncoderFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockDutyCycleEncoder.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockDutyCycleEncoder.html new file mode 100644 index 00000000..09f2d2c0 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockDutyCycleEncoder.html @@ -0,0 +1,409 @@ + + + + + +MockDutyCycleEncoder (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockDutyCycleEncoder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockEncoder.MockEncoderFactory.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockEncoder.MockEncoderFactory.html new file mode 100644 index 00000000..9b6a365c --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockEncoder.MockEncoderFactory.html @@ -0,0 +1,328 @@ + + + + + +MockEncoder.MockEncoderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockEncoder.MockEncoderFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.mock_adapters.MockEncoder.MockEncoderFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        MockEncoderFactory() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract MockEncodercreate​(java.lang.String name, + int aChannel, + int bChannel, + double defaultDistancePerPulse) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          MockEncoderFactory

          +
          public MockEncoderFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract MockEncoder create​(@Assisted("name")
+                                   java.lang.String name,
+                                   @Assisted("aChannel")
+                                   int aChannel,
+                                   @Assisted("bChannel")
+                                   int bChannel,
+                                   @Assisted("defaultDistancePerPulse")
+                                   double defaultDistancePerPulse)
          +
          +
          Specified by:
          +
          create in interface XEncoder.XEncoderFactory
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockEncoder.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockEncoder.html new file mode 100644 index 00000000..0e934ee7 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockEncoder.html @@ -0,0 +1,484 @@ + + + + + +MockEncoder (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockEncoder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MockEncoder

          +
          @AssistedInject
+public MockEncoder​(@Assisted("name")
+                   java.lang.String name,
+                   @Assisted("aChannel")
+                   int aChannel,
+                   @Assisted("bChannel")
+                   int bChannel,
+                   @Assisted("defaultDistancePerPulse")
+                   double defaultDistancePerPulse,
+                   PropertyFactory propMan,
+                   DevicePolice police)
          +
          • +
        + + + +
          +
        • +

          MockEncoder

          +
          public MockEncoder​(java.lang.String prefix,
+                   PropertyFactory propMan)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setDistance

          +
          public void setDistance​(double distance)
          +
          • +
        + + + +
          +
        • +

          getRate

          +
          protected double getRate()
          +
          +
          Specified by:
          +
          getRate in class XEncoder
          +
          +
          • +
        + + + +
          +
        • +

          setRate

          +
          public void setRate​(double newRate)
          +
          • +
        + + + +
          +
        • +

          getDistance

          +
          protected double getDistance()
          +
          +
          Specified by:
          +
          getDistance in class XEncoder
          +
          +
          • +
        + + + +
          +
        • +

          setSamplesToAverage

          +
          public void setSamplesToAverage​(int samples)
          +
          +
          Specified by:
          +
          setSamplesToAverage in class XEncoder
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockFTCGamepad.MockFTCGamepadFactory.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockFTCGamepad.MockFTCGamepadFactory.html new file mode 100644 index 00000000..e07fa525 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockFTCGamepad.MockFTCGamepadFactory.html @@ -0,0 +1,322 @@ + + + + + +MockFTCGamepad.MockFTCGamepadFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockFTCGamepad.MockFTCGamepadFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.mock_adapters.MockFTCGamepad.MockFTCGamepadFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract MockFTCGamepadcreate​(int port, + int numButtons) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          MockFTCGamepadFactory

          +
          public MockFTCGamepadFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockFTCGamepad.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockFTCGamepad.html new file mode 100644 index 00000000..9b05bee7 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockFTCGamepad.html @@ -0,0 +1,559 @@ + + + + + +MockFTCGamepad (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockFTCGamepad

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      IGamepad
      +
      +
      +
      public class MockFTCGamepad
+extends XFTCGamepad
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockGyro.MockGyroFactory.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockGyro.MockGyroFactory.html new file mode 100644 index 00000000..ed8ad696 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockGyro.MockGyroFactory.html @@ -0,0 +1,332 @@ + + + + + +MockGyro.MockGyroFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockGyro.MockGyroFactory

    +
    +
    + +
    +
      +
    • +
      +
      Enclosing class:
      +
      MockGyro
      +
      +
      +
      @AssistedFactory
+public abstract static class MockGyro.MockGyroFactory
+extends XGyro.XGyroFactory
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        MockGyroFactory() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract MockGyrocreate​(edu.wpi.first.wpilibj.SPI.Port spiPort, + edu.wpi.first.wpilibj.SerialPort.Port serialPort, + edu.wpi.first.wpilibj.I2C.Port i2cPort) 
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          MockGyroFactory

          +
          public MockGyroFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract MockGyro create​(@Assisted
+                                edu.wpi.first.wpilibj.SPI.Port spiPort,
+                                @Assisted
+                                edu.wpi.first.wpilibj.SerialPort.Port serialPort,
+                                @Assisted
+                                edu.wpi.first.wpilibj.I2C.Port i2cPort)
          +
          +
          Specified by:
          +
          create in class XGyro.XGyroFactory
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockGyro.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockGyro.html new file mode 100644 index 00000000..bb8f1d6c --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockGyro.html @@ -0,0 +1,768 @@ + + + + + +MockGyro (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockGyro

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MockGyro

          +
          @AssistedInject
+public MockGyro​(DevicePolice police,
+                @Assisted
+                edu.wpi.first.wpilibj.SPI.Port spiPort,
+                @Assisted
+                edu.wpi.first.wpilibj.SerialPort.Port serialPort,
+                @Assisted
+                edu.wpi.first.wpilibj.I2C.Port i2cPort)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isConnected

          +
          public boolean isConnected()
          +
          +
          Specified by:
          +
          isConnected in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setYaw

          +
          public void setYaw​(double yaw)
          +
          • +
        + + + +
          +
        • +

          getDeviceYaw

          +
          public double getDeviceYaw()
          +
          Description copied from class: XGyro
          +
          In degrees
          +
          +
          Specified by:
          +
          getDeviceYaw in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setIsBroken

          +
          public void setIsBroken​(boolean broken)
          +
          • +
        + + + +
          +
        • +

          isBroken

          +
          public boolean isBroken()
          +
          +
          Specified by:
          +
          isBroken in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setRoll

          +
          public void setRoll​(double roll)
          +
          • +
        + + + +
          +
        • +

          getDeviceRoll

          +
          public double getDeviceRoll()
          +
          Description copied from class: XGyro
          +
          In degrees
          +
          +
          Specified by:
          +
          getDeviceRoll in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setPitch

          +
          public void setPitch​(double pitch)
          +
          • +
        + + + +
          +
        • +

          getDevicePitch

          +
          public double getDevicePitch()
          +
          Description copied from class: XGyro
          +
          In degrees
          +
          +
          Specified by:
          +
          getDevicePitch in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setYawAngularVelocity

          +
          public void setYawAngularVelocity​(double yawAngularVelocity)
          +
          • +
        + + + +
          +
        • +

          getDeviceYawAngularVelocity

          +
          public double getDeviceYawAngularVelocity()
          +
          Description copied from class: XGyro
          +
          In degrees per second
          +
          +
          Specified by:
          +
          getDeviceYawAngularVelocity in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceVelocityX

          +
          public double getDeviceVelocityX()
          +
          +
          Specified by:
          +
          getDeviceVelocityX in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setDeviceVelocityX

          +
          public void setDeviceVelocityX​(double velocity)
          +
          • +
        + + + +
          +
        • +

          getDeviceVelocityY

          +
          public double getDeviceVelocityY()
          +
          +
          Specified by:
          +
          getDeviceVelocityY in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setDeviceVelocityY

          +
          public void setDeviceVelocityY​(double velocity)
          +
          • +
        + + + +
          +
        • +

          getDeviceVelocityZ

          +
          public double getDeviceVelocityZ()
          +
          +
          Specified by:
          +
          getDeviceVelocityZ in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setDeviceVelocityZ

          +
          public void setDeviceVelocityZ​(double velocity)
          +
          • +
        + + + +
          +
        • +

          getDeviceRawAccelX

          +
          public double getDeviceRawAccelX()
          +
          +
          Specified by:
          +
          getDeviceRawAccelX in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setDeviceRawAccelX

          +
          public void setDeviceRawAccelX​(double accel)
          +
          • +
        + + + +
          +
        • +

          getDeviceRawAccelY

          +
          public double getDeviceRawAccelY()
          +
          +
          Specified by:
          +
          getDeviceRawAccelY in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setDeviceRawAccelY

          +
          public void setDeviceRawAccelY​(double accel)
          +
          • +
        + + + +
          +
        • +

          getDeviceRawAccelZ

          +
          public double getDeviceRawAccelZ()
          +
          +
          Specified by:
          +
          getDeviceRawAccelZ in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          setDeviceRawAccelZ

          +
          public void setDeviceRawAccelZ​(double accel)
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockJoystick.MockJoystickFactory.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockJoystick.MockJoystickFactory.html new file mode 100644 index 00000000..95034013 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockJoystick.MockJoystickFactory.html @@ -0,0 +1,322 @@ + + + + + +MockJoystick.MockJoystickFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockJoystick.MockJoystickFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.mock_adapters.MockJoystick.MockJoystickFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract MockJoystickcreate​(int port, + int numButtons) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          MockJoystickFactory

          +
          public MockJoystickFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/MockJoystick.html b/javadoc/xbot/common/controls/sensors/mock_adapters/MockJoystick.html new file mode 100644 index 00000000..ef37baeb --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/MockJoystick.html @@ -0,0 +1,508 @@ + + + + + +MockJoystick (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.mock_adapters
    +

    Class MockJoystick

    +
    +
    + +
    +
      +
    • +
      +
      public class MockJoystick
+extends XJoystick
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/package-summary.html b/javadoc/xbot/common/controls/sensors/mock_adapters/package-summary.html new file mode 100644 index 00000000..824074c3 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/package-summary.html @@ -0,0 +1,216 @@ + + + + + +xbot.common.controls.sensors.mock_adapters (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.controls.sensors.mock_adapters

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/mock_adapters/package-tree.html b/javadoc/xbot/common/controls/sensors/mock_adapters/package-tree.html new file mode 100644 index 00000000..02b24d59 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/mock_adapters/package-tree.html @@ -0,0 +1,206 @@ + + + + + +xbot.common.controls.sensors.mock_adapters Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.controls.sensors.mock_adapters

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/controls/sensors/package-summary.html b/javadoc/xbot/common/controls/sensors/package-summary.html new file mode 100644 index 00000000..1da9e7e1 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/package-summary.html @@ -0,0 +1,358 @@ + + + + + +xbot.common.controls.sensors (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.controls.sensors

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/package-tree.html b/javadoc/xbot/common/controls/sensors/package-tree.html new file mode 100644 index 00000000..e3c256c3 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/package-tree.html @@ -0,0 +1,237 @@ + + + + + +xbot.common.controls.sensors Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.controls.sensors

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory.html new file mode 100644 index 00000000..552713fd --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory.html @@ -0,0 +1,319 @@ + + + + + +AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.AnalogInputWPIAdapater.AnalogInputWPIAdapaterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/AnalogInputWPIAdapater.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/AnalogInputWPIAdapater.html new file mode 100644 index 00000000..80b6f64d --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/AnalogInputWPIAdapater.html @@ -0,0 +1,464 @@ + + + + + +AnalogInputWPIAdapater (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class AnalogInputWPIAdapater

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XBaseIO
      +
      +
      +
      public class AnalogInputWPIAdapater
+extends XAnalogInput
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AnalogInputWPIAdapater

          +
          @AssistedInject
+public AnalogInputWPIAdapater​(@Assisted("channel")
+                              int channel,
+                              DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          • +
        + + + + + + + + + + + + + + + +
          +
        • +

          getInternalDevice

          +
          public edu.wpi.first.wpilibj.AnalogInput getInternalDevice()
          +
          • +
        + + + +
          +
        • +

          getChannel

          +
          public int getChannel()
          +
          • +
        + + + +
          +
        • +

          getAsDigital

          +
          public boolean getAsDigital​(double threshold)
          +
          +
          Specified by:
          +
          getAsDigital in class XAnalogInput
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/CANCoderAdapter.CANCoderAdapterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/CANCoderAdapter.CANCoderAdapterFactory.html new file mode 100644 index 00000000..983a71d3 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/CANCoderAdapter.CANCoderAdapterFactory.html @@ -0,0 +1,324 @@ + + + + + +CANCoderAdapter.CANCoderAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class CANCoderAdapter.CANCoderAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.CANCoderAdapter.CANCoderAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract CANCoderAdaptercreate​(DeviceInfo deviceInfo, + java.lang.String owningSystemPrefix) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/CANCoderAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/CANCoderAdapter.html new file mode 100644 index 00000000..a4d061e1 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/CANCoderAdapter.html @@ -0,0 +1,608 @@ + + + + + +CANCoderAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class CANCoderAdapter

    +
    +
    + +
    +
      +
    • +
      +
      public class CANCoderAdapter
+extends XCANCoder
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CANCoderAdapter

          +
          @AssistedInject
+public CANCoderAdapter​(@Assisted("deviceInfo")
+                       DeviceInfo deviceInfo,
+                       @Assisted("owningSystemPrefix")
+                       java.lang.String owningSystemPrefix,
+                       DevicePolice police,
+                       PropertyFactory pf)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +
        • +

          getMagnetOffset

          +
          public double getMagnetOffset()
          +
          Gets the magnet offset configured on the encoder device.
          +
          +
          Returns:
          +
          The magnet offset in degrees
          +
          +
          • +
        + + + +
          +
        • +

          setMagnetOffset

          +
          public boolean setMagnetOffset​(double offsetInDegrees)
          +
          Sets the magnet offset configured on the encoder device.
          +
          +
          Parameters:
          +
          offsetInDegrees - The magnet offset in degrees
          +
          Returns:
          +
          True on success.
          +
          +
          • +
        + + + +
          +
        • +

          setStatusFramePeriod

          +
          public com.ctre.phoenix.ErrorCode setStatusFramePeriod​(com.ctre.phoenix.sensors.CANCoderStatusFrame frame,
+                                                       int periodMs)
          +
          +
          Specified by:
          +
          setStatusFramePeriod in class XCANCoder
          +
          +
          • +
        + + + +
          +
        • +

          getStatusFramePeriod

          +
          public int getStatusFramePeriod​(com.ctre.phoenix.sensors.CANCoderStatusFrame frame)
          +
          +
          Specified by:
          +
          getStatusFramePeriod in class XCANCoder
          +
          +
          • +
        + + + +
          +
        • +

          getFaults

          +
          public com.ctre.phoenix.ErrorCode getFaults​(com.ctre.phoenix.sensors.CANCoderFaults toFill)
          +
          +
          Specified by:
          +
          getFaults in class XCANCoder
          +
          +
          • +
        + + + +
          +
        • +

          getStickyFaults

          +
          public com.ctre.phoenix.ErrorCode getStickyFaults​(com.ctre.phoenix.sensors.CANCoderStickyFaults toFill)
          +
          +
          Specified by:
          +
          getStickyFaults in class XCANCoder
          +
          +
          • +
        + + + +
          +
        • +

          clearStickyFaults

          +
          public com.ctre.phoenix.ErrorCode clearStickyFaults()
          +
          +
          Specified by:
          +
          clearStickyFaults in class XCANCoder
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory.html new file mode 100644 index 00000000..7735f5cc --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.DigitalInputWPIAdapter.DigitalInputWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/DigitalInputWPIAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/DigitalInputWPIAdapter.html new file mode 100644 index 00000000..511903cd --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/DigitalInputWPIAdapter.html @@ -0,0 +1,433 @@ + + + + + +DigitalInputWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class DigitalInputWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XBaseIO
      +
      +
      +
      public class DigitalInputWPIAdapter
+extends XDigitalInput
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          adapter

          +
          protected edu.wpi.first.wpilibj.DigitalInput adapter
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DigitalInputWPIAdapter

          +
          @AssistedInject
+public DigitalInputWPIAdapter​(@Assisted("channel")
+                              int channel,
+                              DevicePolice police)
          +
          Create an instance of a Digital Input class. Creates a digital input given a channel.
          +
          +
          Parameters:
          +
          channel - the DIO channel for the digital input 0-9 are on-board, 10-25 are on the MXP
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getRaw

          +
          protected boolean getRaw()
          +
          Get the value from a digital input channel. Retrieve the value of a single digital input channel from the FPGA.
          +
          +
          Specified by:
          +
          getRaw in class XDigitalInput
          +
          Returns:
          +
          the status of the digital input
          +
          +
          • +
        + + + +
          +
        • +

          getChannel

          +
          public int getChannel()
          +
          Get the channel of the digital input
          +
          +
          Returns:
          +
          The GPIO channel number that this object represents.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory.html new file mode 100644 index 00000000..8c05db1f --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.DutyCycleEncoderWpiAdapter.DutyCycleEncoderWpiAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/DutyCycleEncoderWpiAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/DutyCycleEncoderWpiAdapter.html new file mode 100644 index 00000000..8560944c --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/DutyCycleEncoderWpiAdapter.html @@ -0,0 +1,375 @@ + + + + + +DutyCycleEncoderWpiAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class DutyCycleEncoderWpiAdapter

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DutyCycleEncoderWpiAdapter

          +
          @AssistedInject
+public DutyCycleEncoderWpiAdapter​(@Assisted("info")
+                                  DeviceInfo info,
+                                  DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/EncoderWPIAdapter.EncoderWPIAdapterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/EncoderWPIAdapter.EncoderWPIAdapterFactory.html new file mode 100644 index 00000000..a4238c29 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/EncoderWPIAdapter.EncoderWPIAdapterFactory.html @@ -0,0 +1,328 @@ + + + + + +EncoderWPIAdapter.EncoderWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class EncoderWPIAdapter.EncoderWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.EncoderWPIAdapter.EncoderWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract EncoderWPIAdaptercreate​(java.lang.String name, + int aChannel, + int bChannel, + double defaultDistancePerPulse) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          EncoderWPIAdapterFactory

          +
          public EncoderWPIAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract EncoderWPIAdapter create​(@Assisted("name")
+                                         java.lang.String name,
+                                         @Assisted("aChannel")
+                                         int aChannel,
+                                         @Assisted("bChannel")
+                                         int bChannel,
+                                         @Assisted("defaultDistancePerPulse")
+                                         double defaultDistancePerPulse)
          +
          +
          Specified by:
          +
          create in interface XEncoder.XEncoderFactory
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/EncoderWPIAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/EncoderWPIAdapter.html new file mode 100644 index 00000000..28fd0f78 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/EncoderWPIAdapter.html @@ -0,0 +1,418 @@ + + + + + +EncoderWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class EncoderWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      public class EncoderWPIAdapter
+extends XEncoder
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EncoderWPIAdapter

          +
          @AssistedInject
+public EncoderWPIAdapter​(@Assisted("name")
+                         java.lang.String name,
+                         @Assisted("aChannel")
+                         int aChannel,
+                         @Assisted("bChannel")
+                         int bChannel,
+                         @Assisted("defaultDistancePerPulse")
+                         double defaultDistancePerPulse,
+                         PropertyFactory propMan,
+                         DevicePolice police)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getRate

          +
          protected double getRate()
          +
          +
          Specified by:
          +
          getRate in class XEncoder
          +
          +
          • +
        + + + +
          +
        • +

          getDistance

          +
          protected double getDistance()
          +
          +
          Specified by:
          +
          getDistance in class XEncoder
          +
          +
          • +
        + + + +
          +
        • +

          setSamplesToAverage

          +
          public void setSamplesToAverage​(int samples)
          +
          +
          Specified by:
          +
          setSamplesToAverage in class XEncoder
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory.html new file mode 100644 index 00000000..c308292f --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory.html @@ -0,0 +1,322 @@ + + + + + +FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.FTCGamepadWpiAdapter.FTCGamepadWpiAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract FTCGamepadWpiAdaptercreate​(int port, + int numButtons) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          FTCGamepadWpiAdapterFactory

          +
          public FTCGamepadWpiAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/FTCGamepadWpiAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/FTCGamepadWpiAdapter.html new file mode 100644 index 00000000..12fb49e5 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/FTCGamepadWpiAdapter.html @@ -0,0 +1,487 @@ + + + + + +FTCGamepadWpiAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class FTCGamepadWpiAdapter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      IGamepad
      +
      +
      +
      public class FTCGamepadWpiAdapter
+extends XFTCGamepad
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory.html new file mode 100644 index 00000000..bee62f3a --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory.html @@ -0,0 +1,332 @@ + + + + + +InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class InertialMeasurementUnitAdapter.InertialMeasurementUnitAdapterFactory

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InertialMeasurementUnitAdapterFactory

          +
          public InertialMeasurementUnitAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract InertialMeasurementUnitAdapter create​(@Assisted
+                                                      edu.wpi.first.wpilibj.SPI.Port spiPort,
+                                                      @Assisted
+                                                      edu.wpi.first.wpilibj.SerialPort.Port serialPort,
+                                                      @Assisted
+                                                      edu.wpi.first.wpilibj.I2C.Port i2cPort)
          +
          +
          Specified by:
          +
          create in class XGyro.XGyroFactory
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/InertialMeasurementUnitAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/InertialMeasurementUnitAdapter.html new file mode 100644 index 00000000..1850c028 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/InertialMeasurementUnitAdapter.html @@ -0,0 +1,590 @@ + + + + + +InertialMeasurementUnitAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class InertialMeasurementUnitAdapter

    +
    +
    + +
    +
      +
    • +
      +
      public class InertialMeasurementUnitAdapter
+extends XGyro
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InertialMeasurementUnitAdapter

          +
          @AssistedInject
+public InertialMeasurementUnitAdapter​(DevicePolice police,
+                                      @Assisted
+                                      edu.wpi.first.wpilibj.SPI.Port spiPort,
+                                      @Assisted
+                                      edu.wpi.first.wpilibj.SerialPort.Port serialPort,
+                                      @Assisted
+                                      edu.wpi.first.wpilibj.I2C.Port i2cPort)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isConnected

          +
          public boolean isConnected()
          +
          +
          Specified by:
          +
          isConnected in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceYaw

          +
          protected double getDeviceYaw()
          +
          Description copied from class: XGyro
          +
          In degrees
          +
          +
          Specified by:
          +
          getDeviceYaw in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceRoll

          +
          public double getDeviceRoll()
          +
          Description copied from class: XGyro
          +
          In degrees
          +
          +
          Specified by:
          +
          getDeviceRoll in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDevicePitch

          +
          public double getDevicePitch()
          +
          Description copied from class: XGyro
          +
          In degrees
          +
          +
          Specified by:
          +
          getDevicePitch in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          isBroken

          +
          public boolean isBroken()
          +
          +
          Specified by:
          +
          isBroken in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceYawAngularVelocity

          +
          public double getDeviceYawAngularVelocity()
          +
          Note: this is in degrees per second.
          +
          +
          Specified by:
          +
          getDeviceYawAngularVelocity in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceVelocityX

          +
          public double getDeviceVelocityX()
          +
          +
          Specified by:
          +
          getDeviceVelocityX in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceVelocityY

          +
          public double getDeviceVelocityY()
          +
          +
          Specified by:
          +
          getDeviceVelocityY in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceVelocityZ

          +
          public double getDeviceVelocityZ()
          +
          +
          Specified by:
          +
          getDeviceVelocityZ in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceRawAccelX

          +
          public double getDeviceRawAccelX()
          +
          +
          Specified by:
          +
          getDeviceRawAccelX in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceRawAccelY

          +
          public double getDeviceRawAccelY()
          +
          +
          Specified by:
          +
          getDeviceRawAccelY in class XGyro
          +
          +
          • +
        + + + +
          +
        • +

          getDeviceRawAccelZ

          +
          public double getDeviceRawAccelZ()
          +
          +
          Specified by:
          +
          getDeviceRawAccelZ in class XGyro
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/JoystickWPIAdapter.JoystickWPIAdapterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/JoystickWPIAdapter.JoystickWPIAdapterFactory.html new file mode 100644 index 00000000..5f7dd565 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/JoystickWPIAdapter.JoystickWPIAdapterFactory.html @@ -0,0 +1,322 @@ + + + + + +JoystickWPIAdapter.JoystickWPIAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class JoystickWPIAdapter.JoystickWPIAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.JoystickWPIAdapter.JoystickWPIAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract JoystickWPIAdaptercreate​(int port, + int numButtons) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          JoystickWPIAdapterFactory

          +
          public JoystickWPIAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/JoystickWPIAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/JoystickWPIAdapter.html new file mode 100644 index 00000000..0ceda3ac --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/JoystickWPIAdapter.html @@ -0,0 +1,464 @@ + + + + + +JoystickWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class JoystickWPIAdapter

    +
    +
    + +
    +
      +
    • +
      +
      public class JoystickWPIAdapter
+extends XJoystick
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory.html new file mode 100644 index 00000000..5254a202 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory.html @@ -0,0 +1,322 @@ + + + + + +LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.LidarLiteWpiAdapter.LidarLiteWpiAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract LidarLiteWpiAdaptercreate​(edu.wpi.first.wpilibj.I2C.Port port, + java.lang.String prefix) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          LidarLiteWpiAdapterFactory

          +
          public LidarLiteWpiAdapterFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/LidarLiteWpiAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/LidarLiteWpiAdapter.html new file mode 100644 index 00000000..4d67822b --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/LidarLiteWpiAdapter.html @@ -0,0 +1,380 @@ + + + + + +LidarLiteWpiAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class LidarLiteWpiAdapter

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          LidarLiteWpiAdapter

          +
          @AssistedInject
+public LidarLiteWpiAdapter​(@Assisted("port")
+                           edu.wpi.first.wpilibj.I2C.Port port,
+                           PropertyFactory propMan,
+                           DevicePolice police,
+                           @Assisted("prefix")
+                           java.lang.String prefix)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          update

          +
          public void update()
          +
          +
          Specified by:
          +
          update in class XLidarLite
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory.html new file mode 100644 index 00000000..9519e08b --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory.html @@ -0,0 +1,318 @@ + + + + + +PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.PowerDistributionPanelWPIAdapter.PowerDistributionPanelWPIAdapaterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/PowerDistributionPanelWPIAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/PowerDistributionPanelWPIAdapter.html new file mode 100644 index 00000000..d9915b44 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/PowerDistributionPanelWPIAdapter.html @@ -0,0 +1,344 @@ + + + + + +PowerDistributionPanelWPIAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class PowerDistributionPanelWPIAdapter

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PowerDistributionPanelWPIAdapter

          +
          @AssistedInject
+public PowerDistributionPanelWPIAdapter()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/TimerWpiAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/TimerWpiAdapter.html new file mode 100644 index 00000000..350e435f --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/TimerWpiAdapter.html @@ -0,0 +1,399 @@ + + + + + +TimerWpiAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class TimerWpiAdapter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.TimerWpiAdapter
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        TimerWpiAdapter() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TimerWpiAdapter

          +
          @Inject
+public TimerWpiAdapter()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory.html new file mode 100644 index 00000000..4baa90b6 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory.html @@ -0,0 +1,319 @@ + + + + + +XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.controls.sensors.wpi_adapters.XboxControllerWpiAdapter.XboxControllerWpiAdapterFactory
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/XboxControllerWpiAdapter.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/XboxControllerWpiAdapter.html new file mode 100644 index 00000000..6ecc415f --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/XboxControllerWpiAdapter.html @@ -0,0 +1,598 @@ + + + + + +XboxControllerWpiAdapter (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.controls.sensors.wpi_adapters
    +

    Class XboxControllerWpiAdapter

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/package-summary.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/package-summary.html new file mode 100644 index 00000000..8307ab51 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/package-summary.html @@ -0,0 +1,252 @@ + + + + + +xbot.common.controls.sensors.wpi_adapters (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.controls.sensors.wpi_adapters

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/controls/sensors/wpi_adapters/package-tree.html b/javadoc/xbot/common/controls/sensors/wpi_adapters/package-tree.html new file mode 100644 index 00000000..af5668b4 --- /dev/null +++ b/javadoc/xbot/common/controls/sensors/wpi_adapters/package-tree.html @@ -0,0 +1,235 @@ + + + + + +xbot.common.controls.sensors.wpi_adapters Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.controls.sensors.wpi_adapters

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/injection/BaseWPITest.html b/javadoc/xbot/common/injection/BaseWPITest.html new file mode 100644 index 00000000..b67a0b28 --- /dev/null +++ b/javadoc/xbot/common/injection/BaseWPITest.html @@ -0,0 +1,409 @@ + + + + + +BaseWPITest (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection
    +

    Class BaseWPITest

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.BaseWPITest
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      PurePursuitTest
      +
      +
      +
      public abstract class BaseWPITest
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/DevicePolice.DeviceType.html b/javadoc/xbot/common/injection/DevicePolice.DeviceType.html new file mode 100644 index 00000000..c41a245b --- /dev/null +++ b/javadoc/xbot/common/injection/DevicePolice.DeviceType.html @@ -0,0 +1,472 @@ + + + + + +DevicePolice.DeviceType (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection
    +

    Enum DevicePolice.DeviceType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static DevicePolice.DeviceTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static DevicePolice.DeviceType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static DevicePolice.DeviceType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (DevicePolice.DeviceType c : DevicePolice.DeviceType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static DevicePolice.DeviceType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/DevicePolice.html b/javadoc/xbot/common/injection/DevicePolice.html new file mode 100644 index 00000000..28a0006f --- /dev/null +++ b/javadoc/xbot/common/injection/DevicePolice.html @@ -0,0 +1,497 @@ + + + + + +DevicePolice (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection
    +

    Class DevicePolice

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.DevicePolice
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Singleton
+public class DevicePolice
+extends java.lang.Object
      +
      Tracks how many devices are registered and prevents incorrectly re-using devices
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class DevicePolice.DeviceType +
        Types of devices
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        java.util.Map<java.lang.String,​java.lang.Object>registeredChannels +
        A list of all the channels in use, and what device is using them.
        +
        java.util.List<java.lang.Object>registeredDevices +
        A list of all the devices in use
        +
        +
        • +
      +
      + +
      + +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          registeredChannels

          +
          public java.util.Map<java.lang.String,​java.lang.Object> registeredChannels
          +
          A list of all the channels in use, and what device is using them.
          +
          • +
        + + + +
          +
        • +

          registeredDevices

          +
          public java.util.List<java.lang.Object> registeredDevices
          +
          A list of all the devices in use
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DevicePolice

          +
          @Inject
+public DevicePolice​(RobotAssertionManager assertionManager)
          +
          Creates a new DevicePolice instance
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          registerDevice

          +
          public java.lang.String registerDevice​(DevicePolice.DeviceType type,
+                                       int id,
+                                       java.lang.Object device)
          +
          Register a device
          +
          +
          Parameters:
          +
          type - Device type
          +
          id - Device id
          +
          +
          • +
        + + + +
          +
        • +

          registerDevice

          +
          public void registerDevice​(DevicePolice.DeviceType type,
+                           int id,
+                           int minId,
+                           int maxId)
          +
          Register a device with an id falling into an allowable range
          +
          +
          Parameters:
          +
          type - Device type
          +
          id - Device id
          +
          minId - Minimum allowable id
          +
          maxId - Maximum allowable id
          +
          +
          • +
        + + + +
          +
        • +

          registerDevice

          +
          public void registerDevice​(DevicePolice.DeviceType type,
+                           int id,
+                           int minId,
+                           int maxId,
+                           java.lang.Object device)
          +
          Register a device with an id falling into an allowable range
          +
          +
          Parameters:
          +
          type - Device type
          +
          id - Device id
          +
          minId - Minimum allowable id
          +
          maxId - Maximum allowable id
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/MockPermanentStorage.html b/javadoc/xbot/common/injection/MockPermanentStorage.html new file mode 100644 index 00000000..0e7e9a73 --- /dev/null +++ b/javadoc/xbot/common/injection/MockPermanentStorage.html @@ -0,0 +1,453 @@ + + + + + +MockPermanentStorage (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection
    +

    Class MockPermanentStorage

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ITableProxy
      +
      +
      +
      @Singleton
+public class MockPermanentStorage
+extends TableProxy
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          propertyDelimiter

          +
          protected java.lang.String propertyDelimiter
          +
          Permanent storage property storage delimiter
          +
          • +
        + + + +
          +
        • +

          lineSeperator

          +
          protected java.lang.String lineSeperator
          +
          Permanent storage line seperator
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MockPermanentStorage

          +
          @Inject
+public MockPermanentStorage()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          addTestDouble

          +
          public void addTestDouble​(java.lang.String key,
+                          double value)
          +
          • +
        + + + +
          +
        • +

          addTestBoolean

          +
          public void addTestBoolean​(java.lang.String key,
+                           boolean value)
          +
          • +
        + + + +
          +
        • +

          addTestString

          +
          public void addTestString​(java.lang.String key,
+                          java.lang.String value)
          +
          • +
        + + + +
          +
        • +

          readFromFile

          +
          protected java.lang.String readFromFile()
          +
          • +
        + + + +
          +
        • +

          writeToFile

          +
          protected void writeToFile​(java.lang.String data)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/components/BaseComponent.html b/javadoc/xbot/common/injection/components/BaseComponent.html new file mode 100644 index 00000000..32cf1ec0 --- /dev/null +++ b/javadoc/xbot/common/injection/components/BaseComponent.html @@ -0,0 +1,1110 @@ + + + + + +BaseComponent (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.components
    +

    Class BaseComponent

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.components.BaseComponent
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      PurePursuitTestComponent, SimulationComponent
      +
      +
      +
      public abstract class BaseComponent
+extends java.lang.Object
      +
      Base class for all Components that provides methods to get implementations from DI. + Implementations of this abstract class map Modules to the Component. Dagger will automatically + generate a class with the prefix "Dagger" in the same package.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/components/PurePursuitTestComponent.html b/javadoc/xbot/common/injection/components/PurePursuitTestComponent.html new file mode 100644 index 00000000..8e89aad2 --- /dev/null +++ b/javadoc/xbot/common/injection/components/PurePursuitTestComponent.html @@ -0,0 +1,319 @@ + + + + + +PurePursuitTestComponent (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.components
    +

    Class PurePursuitTestComponent

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PurePursuitTestComponent

          +
          public PurePursuitTestComponent()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/components/SimulationComponent.html b/javadoc/xbot/common/injection/components/SimulationComponent.html new file mode 100644 index 00000000..add58a6a --- /dev/null +++ b/javadoc/xbot/common/injection/components/SimulationComponent.html @@ -0,0 +1,281 @@ + + + + + +SimulationComponent (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.components
    +

    Class SimulationComponent

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SimulationComponent

          +
          public SimulationComponent()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/injection/components/package-summary.html b/javadoc/xbot/common/injection/components/package-summary.html new file mode 100644 index 00000000..2c0f232a --- /dev/null +++ b/javadoc/xbot/common/injection/components/package-summary.html @@ -0,0 +1,178 @@ + + + + + +xbot.common.injection.components (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.injection.components

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      BaseComponent +
      Base class for all Components that provides methods to get implementations from DI.
      +
      PurePursuitTestComponent +
      Do not use this directly.
      +
      SimulationComponent +
      Do not use this directly.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/injection/components/package-tree.html b/javadoc/xbot/common/injection/components/package-tree.html new file mode 100644 index 00000000..9e19f5d7 --- /dev/null +++ b/javadoc/xbot/common/injection/components/package-tree.html @@ -0,0 +1,166 @@ + + + + + +xbot.common.injection.components Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.injection.components

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/injection/electrical_contract/CANTalonInfo.html b/javadoc/xbot/common/injection/electrical_contract/CANTalonInfo.html new file mode 100644 index 00000000..84162dac --- /dev/null +++ b/javadoc/xbot/common/injection/electrical_contract/CANTalonInfo.html @@ -0,0 +1,419 @@ + + + + + +CANTalonInfo (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.electrical_contract
    +

    Class CANTalonInfo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.electrical_contract.CANTalonInfo
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class CANTalonInfo
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CANTalonInfo​(int channel) 
        CANTalonInfo​(int channel, + boolean inverted) 
        CANTalonInfo​(int channel, + boolean inverted, + com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice, + boolean feedbackDeviceInverted) 
        CANTalonInfo​(int channel, + boolean inverted, + com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice, + boolean feedbackDeviceInverted, + double simulationScalingValue) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          channel

          +
          public int channel
          +
          • +
        + + + +
          +
        • +

          inverted

          +
          public boolean inverted
          +
          • +
        + + + +
          +
        • +

          feedbackDevice

          +
          public com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice
          +
          • +
        + + + +
          +
        • +

          feedbackDeviceInverted

          +
          public boolean feedbackDeviceInverted
          +
          • +
        + + + +
          +
        • +

          simulationScalingValue

          +
          public double simulationScalingValue
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CANTalonInfo

          +
          public CANTalonInfo​(int channel)
          +
          • +
        + + + +
          +
        • +

          CANTalonInfo

          +
          public CANTalonInfo​(int channel,
+                    boolean inverted)
          +
          • +
        + + + +
          +
        • +

          CANTalonInfo

          +
          public CANTalonInfo​(int channel,
+                    boolean inverted,
+                    com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                    boolean feedbackDeviceInverted)
          +
          • +
        + + + +
          +
        • +

          CANTalonInfo

          +
          public CANTalonInfo​(int channel,
+                    boolean inverted,
+                    com.ctre.phoenix.motorcontrol.FeedbackDevice feedbackDevice,
+                    boolean feedbackDeviceInverted,
+                    double simulationScalingValue)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/electrical_contract/DeviceInfo.html b/javadoc/xbot/common/injection/electrical_contract/DeviceInfo.html new file mode 100644 index 00000000..c3ce7592 --- /dev/null +++ b/javadoc/xbot/common/injection/electrical_contract/DeviceInfo.html @@ -0,0 +1,368 @@ + + + + + +DeviceInfo (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.electrical_contract
    +

    Class DeviceInfo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.electrical_contract.DeviceInfo
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class DeviceInfo
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        DeviceInfo​(int channel) 
        DeviceInfo​(int channel, + boolean inverted) 
        DeviceInfo​(int channel, + boolean inverted, + double simulationScalingValue) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          channel

          +
          public int channel
          +
          • +
        + + + +
          +
        • +

          inverted

          +
          public boolean inverted
          +
          • +
        + + + +
          +
        • +

          simulationScalingValue

          +
          public double simulationScalingValue
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DeviceInfo

          +
          public DeviceInfo​(int channel)
          +
          • +
        + + + +
          +
        • +

          DeviceInfo

          +
          public DeviceInfo​(int channel,
+                  boolean inverted)
          +
          • +
        + + + +
          +
        • +

          DeviceInfo

          +
          public DeviceInfo​(int channel,
+                  boolean inverted,
+                  double simulationScalingValue)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/electrical_contract/package-summary.html b/javadoc/xbot/common/injection/electrical_contract/package-summary.html new file mode 100644 index 00000000..47482bb9 --- /dev/null +++ b/javadoc/xbot/common/injection/electrical_contract/package-summary.html @@ -0,0 +1,168 @@ + + + + + +xbot.common.injection.electrical_contract (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.injection.electrical_contract

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/injection/electrical_contract/package-tree.html b/javadoc/xbot/common/injection/electrical_contract/package-tree.html new file mode 100644 index 00000000..5fc0e41f --- /dev/null +++ b/javadoc/xbot/common/injection/electrical_contract/package-tree.html @@ -0,0 +1,162 @@ + + + + + +xbot.common.injection.electrical_contract Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.injection.electrical_contract

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • xbot.common.injection.electrical_contract.CANTalonInfo
        • +
      • xbot.common.injection.electrical_contract.DeviceInfo
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/injection/modules/MockControlsModule.html b/javadoc/xbot/common/injection/modules/MockControlsModule.html new file mode 100644 index 00000000..c18407eb --- /dev/null +++ b/javadoc/xbot/common/injection/modules/MockControlsModule.html @@ -0,0 +1,355 @@ + + + + + +MockControlsModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.modules
    +

    Class MockControlsModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.modules.MockControlsModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Module
+public abstract class MockControlsModule
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/modules/MockDevicesModule.html b/javadoc/xbot/common/injection/modules/MockDevicesModule.html new file mode 100644 index 00000000..aadb63a7 --- /dev/null +++ b/javadoc/xbot/common/injection/modules/MockDevicesModule.html @@ -0,0 +1,627 @@ + + + + + +MockDevicesModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.modules
    +

    Class MockDevicesModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.modules.MockDevicesModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Module
+public abstract class MockDevicesModule
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/modules/RealControlsModule.html b/javadoc/xbot/common/injection/modules/RealControlsModule.html new file mode 100644 index 00000000..6136c6bc --- /dev/null +++ b/javadoc/xbot/common/injection/modules/RealControlsModule.html @@ -0,0 +1,355 @@ + + + + + +RealControlsModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.modules
    +

    Class RealControlsModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.modules.RealControlsModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Module
+public abstract class RealControlsModule
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/modules/RealDevicesModule.html b/javadoc/xbot/common/injection/modules/RealDevicesModule.html new file mode 100644 index 00000000..4fbd6239 --- /dev/null +++ b/javadoc/xbot/common/injection/modules/RealDevicesModule.html @@ -0,0 +1,627 @@ + + + + + +RealDevicesModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.modules
    +

    Class RealDevicesModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.modules.RealDevicesModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Module
+public abstract class RealDevicesModule
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/injection/modules/RobotModule.html b/javadoc/xbot/common/injection/modules/RobotModule.html new file mode 100644 index 00000000..20fe5781 --- /dev/null +++ b/javadoc/xbot/common/injection/modules/RobotModule.html @@ -0,0 +1,268 @@ + + + + + +RobotModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.modules
    +

    Class RobotModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.modules.RobotModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Module
+public abstract class RobotModule
+extends java.lang.Object
      +
      Module mapping interfaces to implementations for a real robot.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        RobotModule() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          RobotModule

          +
          public RobotModule()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/injection/modules/SimulationModule.html b/javadoc/xbot/common/injection/modules/SimulationModule.html new file mode 100644 index 00000000..328a4a3e --- /dev/null +++ b/javadoc/xbot/common/injection/modules/SimulationModule.html @@ -0,0 +1,268 @@ + + + + + +SimulationModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.modules
    +

    Class SimulationModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.modules.SimulationModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Module
+public abstract class SimulationModule
+extends java.lang.Object
      +
      Module mapping interfaces to implementations for a simulated robot.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        SimulationModule() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          SimulationModule

          +
          public SimulationModule()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/injection/modules/UnitTestModule.html b/javadoc/xbot/common/injection/modules/UnitTestModule.html new file mode 100644 index 00000000..1e15b9ea --- /dev/null +++ b/javadoc/xbot/common/injection/modules/UnitTestModule.html @@ -0,0 +1,268 @@ + + + + + +UnitTestModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.modules
    +

    Class UnitTestModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.modules.UnitTestModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Module
+public abstract class UnitTestModule
+extends java.lang.Object
      +
      Module mapping interfaces to implementations for unit tests.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        UnitTestModule() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          UnitTestModule

          +
          public UnitTestModule()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/injection/modules/UnitTestRobotModule.html b/javadoc/xbot/common/injection/modules/UnitTestRobotModule.html new file mode 100644 index 00000000..6c419774 --- /dev/null +++ b/javadoc/xbot/common/injection/modules/UnitTestRobotModule.html @@ -0,0 +1,267 @@ + + + + + +UnitTestRobotModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.injection.modules
    +

    Class UnitTestRobotModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.injection.modules.UnitTestRobotModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Module
+public abstract class UnitTestRobotModule
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          UnitTestRobotModule

          +
          public UnitTestRobotModule()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/injection/modules/package-summary.html b/javadoc/xbot/common/injection/modules/package-summary.html new file mode 100644 index 00000000..6b45378b --- /dev/null +++ b/javadoc/xbot/common/injection/modules/package-summary.html @@ -0,0 +1,198 @@ + + + + + +xbot.common.injection.modules (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.injection.modules

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/injection/modules/package-tree.html b/javadoc/xbot/common/injection/modules/package-tree.html new file mode 100644 index 00000000..1c387e6e --- /dev/null +++ b/javadoc/xbot/common/injection/modules/package-tree.html @@ -0,0 +1,168 @@ + + + + + +xbot.common.injection.modules Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.injection.modules

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/injection/package-summary.html b/javadoc/xbot/common/injection/package-summary.html new file mode 100644 index 00000000..eb2ff5c8 --- /dev/null +++ b/javadoc/xbot/common/injection/package-summary.html @@ -0,0 +1,191 @@ + + + + + +xbot.common.injection (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.injection

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/injection/package-tree.html b/javadoc/xbot/common/injection/package-tree.html new file mode 100644 index 00000000..2827b2ce --- /dev/null +++ b/javadoc/xbot/common/injection/package-tree.html @@ -0,0 +1,181 @@ + + + + + +xbot.common.injection Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.injection

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/logging/DriverStationAppender.html b/javadoc/xbot/common/logging/DriverStationAppender.html new file mode 100644 index 00000000..4c946ba0 --- /dev/null +++ b/javadoc/xbot/common/logging/DriverStationAppender.html @@ -0,0 +1,369 @@ + + + + + +DriverStationAppender (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class DriverStationAppender

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • org.apache.log4j.AppenderSkeleton
        • +
      • +
          +
        • xbot.common.logging.DriverStationAppender
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler
      +
      +
      +
      public class DriverStationAppender
+extends org.apache.log4j.AppenderSkeleton
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class org.apache.log4j.AppenderSkeleton

          +closed, errorHandler, headFilter, layout, name, tailFilter, threshold
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        protected voidappend​(org.apache.log4j.spi.LoggingEvent arg0) 
        voidclose() 
        booleanrequiresLayout() 
        +
          +
        • + + +

          Methods inherited from class org.apache.log4j.AppenderSkeleton

          +activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          DriverStationAppender

          +
          public DriverStationAppender()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          close

          +
          public void close()
          +
          • +
        + + + +
          +
        • +

          requiresLayout

          +
          public boolean requiresLayout()
          +
          • +
        + + + +
          +
        • +

          append

          +
          protected void append​(org.apache.log4j.spi.LoggingEvent arg0)
          +
          +
          Specified by:
          +
          append in class org.apache.log4j.AppenderSkeleton
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/IntermittentConsoleLogger.html b/javadoc/xbot/common/logging/IntermittentConsoleLogger.html new file mode 100644 index 00000000..60e7c1a5 --- /dev/null +++ b/javadoc/xbot/common/logging/IntermittentConsoleLogger.html @@ -0,0 +1,318 @@ + + + + + +IntermittentConsoleLogger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class IntermittentConsoleLogger

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logging.IntermittentConsoleLogger
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class IntermittentConsoleLogger
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidlogSometimes​(java.lang.String message) 
        voidsetModulus​(int modulus) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          IntermittentConsoleLogger

          +
          public IntermittentConsoleLogger()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          logSometimes

          +
          public void logSometimes​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          setModulus

          +
          public void setModulus​(int modulus)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/LoggingLatch.html b/javadoc/xbot/common/logging/LoggingLatch.html new file mode 100644 index 00000000..f369d2b5 --- /dev/null +++ b/javadoc/xbot/common/logging/LoggingLatch.html @@ -0,0 +1,308 @@ + + + + + +LoggingLatch (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class LoggingLatch

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logging.LoggingLatch
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class LoggingLatch
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        LoggingLatch​(java.lang.String callerName, + java.lang.String message, + Latch.EdgeType edgeType) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidcheckValue​(boolean value) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          LoggingLatch

          +
          public LoggingLatch​(java.lang.String callerName,
+                    java.lang.String message,
+                    Latch.EdgeType edgeType)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          checkValue

          +
          public void checkValue​(boolean value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/LoudRobotAssertionManager.html b/javadoc/xbot/common/logging/LoudRobotAssertionManager.html new file mode 100644 index 00000000..aa89a016 --- /dev/null +++ b/javadoc/xbot/common/logging/LoudRobotAssertionManager.html @@ -0,0 +1,342 @@ + + + + + +LoudRobotAssertionManager (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class LoudRobotAssertionManager

    +
    +
    + +
    +
      +
    • +
      +
      public class LoudRobotAssertionManager
+extends RobotAssertionManager
      +
      Version of RobotAssertionManager that allows exceptions to be thrown. Should + only be used off-robot or during controlled testing sessions; should never + be used in competition.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/OneLogFilePerRunRollingFileAppender.html b/javadoc/xbot/common/logging/OneLogFilePerRunRollingFileAppender.html new file mode 100644 index 00000000..8e5fd926 --- /dev/null +++ b/javadoc/xbot/common/logging/OneLogFilePerRunRollingFileAppender.html @@ -0,0 +1,456 @@ + + + + + +OneLogFilePerRunRollingFileAppender (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class OneLogFilePerRunRollingFileAppender

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • org.apache.log4j.AppenderSkeleton
        • +
      • +
          +
        • org.apache.log4j.WriterAppender
          • +
        • +
            +
          • org.apache.log4j.FileAppender
            • +
          • +
              +
            • org.apache.log4j.RollingFileAppender
              • +
            • +
                +
              • xbot.common.logging.OneLogFilePerRunRollingFileAppender
                • +
              +
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler
      +
      +
      +
      public class OneLogFilePerRunRollingFileAppender
+extends org.apache.log4j.RollingFileAppender
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class org.apache.log4j.RollingFileAppender

          +maxBackupIndex, maxFileSize
          • +
        +
          +
        • + + +

          Fields inherited from class org.apache.log4j.FileAppender

          +bufferedIO, bufferSize, fileAppend, fileName
          • +
        +
          +
        • + + +

          Fields inherited from class org.apache.log4j.WriterAppender

          +encoding, immediateFlush, qw
          • +
        +
          +
        • + + +

          Fields inherited from class org.apache.log4j.AppenderSkeleton

          +closed, errorHandler, headFilter, layout, name, tailFilter, threshold
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidactivateOptions() 
        voidrollOverManually() 
        +
          +
        • + + +

          Methods inherited from class org.apache.log4j.RollingFileAppender

          +getMaxBackupIndex, getMaximumFileSize, rollOver, setFile, setMaxBackupIndex, setMaxFileSize, setMaximumFileSize, setQWForFiles, subAppend
          • +
        +
          +
        • + + +

          Methods inherited from class org.apache.log4j.FileAppender

          +closeFile, getAppend, getBufferedIO, getBufferSize, getFile, reset, setAppend, setBufferedIO, setBufferSize, setFile
          • +
        +
          +
        • + + +

          Methods inherited from class org.apache.log4j.WriterAppender

          +append, checkEntryConditions, close, closeWriter, createWriter, getEncoding, getImmediateFlush, requiresLayout, setEncoding, setErrorHandler, setImmediateFlush, setWriter, shouldFlush, writeFooter, writeHeader
          • +
        +
          +
        • + + +

          Methods inherited from class org.apache.log4j.AppenderSkeleton

          +addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setLayout, setName, setThreshold
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          OneLogFilePerRunRollingFileAppender

          +
          public OneLogFilePerRunRollingFileAppender()
          +
          • +
        + + + +
          +
        • +

          OneLogFilePerRunRollingFileAppender

          +
          public OneLogFilePerRunRollingFileAppender​(org.apache.log4j.Layout layout,
+                                           java.lang.String filename,
+                                           boolean append)
+                                    throws java.io.IOException
          +
          +
          Throws:
          +
          java.io.IOException
          +
          +
          • +
        + + + +
          +
        • +

          OneLogFilePerRunRollingFileAppender

          +
          public OneLogFilePerRunRollingFileAppender​(org.apache.log4j.Layout layout,
+                                           java.lang.String filename)
+                                    throws java.io.IOException
          +
          +
          Throws:
          +
          java.io.IOException
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          activateOptions

          +
          public void activateOptions()
          +
          +
          Specified by:
          +
          activateOptions in interface org.apache.log4j.spi.OptionHandler
          +
          Overrides:
          +
          activateOptions in class org.apache.log4j.FileAppender
          +
          +
          • +
        + + + +
          +
        • +

          rollOverManually

          +
          public void rollOverManually()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/RobotAssertionException.html b/javadoc/xbot/common/logging/RobotAssertionException.html new file mode 100644 index 00000000..17487fd4 --- /dev/null +++ b/javadoc/xbot/common/logging/RobotAssertionException.html @@ -0,0 +1,296 @@ + + + + + +RobotAssertionException (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class RobotAssertionException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • xbot.common.logging.RobotAssertionException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class RobotAssertionException
+extends java.lang.RuntimeException
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        RobotAssertionException​(java.lang.String failureCauseCause) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          RobotAssertionException

          +
          public RobotAssertionException​(java.lang.String failureCauseCause)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/logging/RobotAssertionManager.html b/javadoc/xbot/common/logging/RobotAssertionManager.html new file mode 100644 index 00000000..66321d8f --- /dev/null +++ b/javadoc/xbot/common/logging/RobotAssertionManager.html @@ -0,0 +1,384 @@ + + + + + +RobotAssertionManager (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class RobotAssertionManager

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logging.RobotAssertionManager
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      LoudRobotAssertionManager, SilentRobotAssertionManager
      +
      +
      +
      public abstract class RobotAssertionManager
+extends java.lang.Object
      +
      Base class for safe assertion manager. Allows context-based management of + exceptions and assertion conditions.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidassertTrue​(boolean value, + java.lang.String assertionFaliureCause) 
        voidfail​(java.lang.String message) 
        protected abstract voidhandlePlatformException​(java.lang.RuntimeException e) 
        abstract booleanisExceptionsEnabled() 
        voidthrowException​(java.lang.RuntimeException e) 
        voidthrowException​(java.lang.String message, + java.lang.Throwable cause) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          RobotAssertionManager

          +
          public RobotAssertionManager()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          throwException

          +
          public final void throwException​(java.lang.RuntimeException e)
          +
          • +
        + + + +
          +
        • +

          throwException

          +
          public final void throwException​(java.lang.String message,
+                                 java.lang.Throwable cause)
          +
          • +
        + + + +
          +
        • +

          handlePlatformException

          +
          protected abstract void handlePlatformException​(java.lang.RuntimeException e)
          +
          • +
        + + + +
          +
        • +

          isExceptionsEnabled

          +
          public abstract boolean isExceptionsEnabled()
          +
          • +
        + + + +
          +
        • +

          fail

          +
          public final void fail​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          assertTrue

          +
          public final void assertTrue​(boolean value,
+                             java.lang.String assertionFaliureCause)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/RobotSession.html b/javadoc/xbot/common/logging/RobotSession.html new file mode 100644 index 00000000..55ee021e --- /dev/null +++ b/javadoc/xbot/common/logging/RobotSession.html @@ -0,0 +1,350 @@ + + + + + +RobotSession (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class RobotSession

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logging.RobotSession
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Singleton
+public class RobotSession
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          autoInit

          +
          public void autoInit()
          +
          • +
        + + + +
          +
        • +

          teleopInit

          +
          public void teleopInit()
          +
          • +
        + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          • +
        + + + +
          +
        • +

          getSessionId

          +
          public java.lang.String getSessionId()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/SilentRobotAssertionManager.html b/javadoc/xbot/common/logging/SilentRobotAssertionManager.html new file mode 100644 index 00000000..09248d6f --- /dev/null +++ b/javadoc/xbot/common/logging/SilentRobotAssertionManager.html @@ -0,0 +1,341 @@ + + + + + +SilentRobotAssertionManager (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class SilentRobotAssertionManager

    +
    +
    + +
    +
      +
    • +
      +
      public class SilentRobotAssertionManager
+extends RobotAssertionManager
      +
      Version of RobotAssertionManager that prevents throwing of exceptions. Should + be used on-robot in competitions.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/TimeLogger.html b/javadoc/xbot/common/logging/TimeLogger.html new file mode 100644 index 00000000..370fe0c1 --- /dev/null +++ b/javadoc/xbot/common/logging/TimeLogger.html @@ -0,0 +1,320 @@ + + + + + +TimeLogger (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class TimeLogger

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logging.TimeLogger
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class TimeLogger
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        TimeLogger​(java.lang.String name, + int reportingIntervalInSeconds) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidstart() 
        voidstop() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          TimeLogger

          +
          public TimeLogger​(java.lang.String name,
+                  int reportingIntervalInSeconds)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          start

          +
          public void start()
          +
          • +
        + + + +
          +
        • +

          stop

          +
          public void stop()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/WordGenerator.html b/javadoc/xbot/common/logging/WordGenerator.html new file mode 100644 index 00000000..1ca77a0f --- /dev/null +++ b/javadoc/xbot/common/logging/WordGenerator.html @@ -0,0 +1,321 @@ + + + + + +WordGenerator (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logging
    +

    Class WordGenerator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logging.WordGenerator
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class WordGenerator
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        WordGenerator() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringgetRandomWordChain​(int length, + java.lang.String separator) 
        java.lang.StringgetResourceFileAsString​(java.lang.String fileName) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          WordGenerator

          +
          @Inject
+public WordGenerator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getResourceFileAsString

          +
          public java.lang.String getResourceFileAsString​(java.lang.String fileName)
          +
          • +
        + + + +
          +
        • +

          getRandomWordChain

          +
          public java.lang.String getRandomWordChain​(int length,
+                                           java.lang.String separator)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logging/package-summary.html b/javadoc/xbot/common/logging/package-summary.html new file mode 100644 index 00000000..e9fda2a0 --- /dev/null +++ b/javadoc/xbot/common/logging/package-summary.html @@ -0,0 +1,221 @@ + + + + + +xbot.common.logging (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.logging

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/logging/package-tree.html b/javadoc/xbot/common/logging/package-tree.html new file mode 100644 index 00000000..3a73950c --- /dev/null +++ b/javadoc/xbot/common/logging/package-tree.html @@ -0,0 +1,202 @@ + + + + + +xbot.common.logging Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.logging

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/logic/CalibrationDecider.CalibrationDeciderFactory.html b/javadoc/xbot/common/logic/CalibrationDecider.CalibrationDeciderFactory.html new file mode 100644 index 00000000..8d2b63fe --- /dev/null +++ b/javadoc/xbot/common/logic/CalibrationDecider.CalibrationDeciderFactory.html @@ -0,0 +1,310 @@ + + + + + +CalibrationDecider.CalibrationDeciderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class CalibrationDecider.CalibrationDeciderFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.CalibrationDecider.CalibrationDeciderFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      CalibrationDecider
      +
      +
      +
      @AssistedFactory
+public abstract static class CalibrationDecider.CalibrationDeciderFactory
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract CalibrationDecidercreate​(java.lang.String name) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CalibrationDeciderFactory

          +
          public CalibrationDeciderFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract CalibrationDecider create​(@Assisted("name")
+                                          java.lang.String name)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/CalibrationDecider.CalibrationMode.html b/javadoc/xbot/common/logic/CalibrationDecider.CalibrationMode.html new file mode 100644 index 00000000..346658b8 --- /dev/null +++ b/javadoc/xbot/common/logic/CalibrationDecider.CalibrationMode.html @@ -0,0 +1,393 @@ + + + + + +CalibrationDecider.CalibrationMode (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Enum CalibrationDecider.CalibrationMode

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static CalibrationDecider.CalibrationModevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static CalibrationDecider.CalibrationMode[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static CalibrationDecider.CalibrationMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (CalibrationDecider.CalibrationMode c : CalibrationDecider.CalibrationMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static CalibrationDecider.CalibrationMode valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/CalibrationDecider.html b/javadoc/xbot/common/logic/CalibrationDecider.html new file mode 100644 index 00000000..2616f314 --- /dev/null +++ b/javadoc/xbot/common/logic/CalibrationDecider.html @@ -0,0 +1,350 @@ + + + + + +CalibrationDecider (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class CalibrationDecider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.CalibrationDecider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class CalibrationDecider
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CalibrationDecider

          +
          @AssistedInject
+public CalibrationDecider​(@Assisted("name")
+                          java.lang.String name,
+                          PropertyFactory propMan)
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/HumanVsMachineDecider.HumanVsMachineDeciderFactory.html b/javadoc/xbot/common/logic/HumanVsMachineDecider.HumanVsMachineDeciderFactory.html new file mode 100644 index 00000000..bc39b8f5 --- /dev/null +++ b/javadoc/xbot/common/logic/HumanVsMachineDecider.HumanVsMachineDeciderFactory.html @@ -0,0 +1,310 @@ + + + + + +HumanVsMachineDecider.HumanVsMachineDeciderFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class HumanVsMachineDecider.HumanVsMachineDeciderFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.HumanVsMachineDecider.HumanVsMachineDeciderFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      HumanVsMachineDecider
      +
      +
      +
      @AssistedFactory
+public abstract static class HumanVsMachineDecider.HumanVsMachineDeciderFactory
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract HumanVsMachineDecidercreate​(java.lang.String prefix) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          HumanVsMachineDeciderFactory

          +
          public HumanVsMachineDeciderFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract HumanVsMachineDecider create​(@Assisted("prefix")
+                                             java.lang.String prefix)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/HumanVsMachineDecider.HumanVsMachineMode.html b/javadoc/xbot/common/logic/HumanVsMachineDecider.HumanVsMachineMode.html new file mode 100644 index 00000000..f94f35ae --- /dev/null +++ b/javadoc/xbot/common/logic/HumanVsMachineDecider.HumanVsMachineMode.html @@ -0,0 +1,406 @@ + + + + + +HumanVsMachineDecider.HumanVsMachineMode (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Enum HumanVsMachineDecider.HumanVsMachineMode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HumanVsMachineDecider.HumanVsMachineMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HumanVsMachineDecider.HumanVsMachineMode c : HumanVsMachineDecider.HumanVsMachineMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HumanVsMachineDecider.HumanVsMachineMode valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/HumanVsMachineDecider.html b/javadoc/xbot/common/logic/HumanVsMachineDecider.html new file mode 100644 index 00000000..a8d99b71 --- /dev/null +++ b/javadoc/xbot/common/logic/HumanVsMachineDecider.html @@ -0,0 +1,378 @@ + + + + + +HumanVsMachineDecider (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class HumanVsMachineDecider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.HumanVsMachineDecider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class HumanVsMachineDecider
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HumanVsMachineDecider

          +
          @AssistedInject
+public HumanVsMachineDecider​(@Assisted("prefix")
+                             java.lang.String prefix,
+                             PropertyFactory propMan)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          • +
        + + + +
          +
        • +

          reset

          +
          public void reset​(boolean startInAutomaticMode)
          +
          • +
        + + + + + + + +
          +
        • +

          getDeadband

          +
          public double getDeadband()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/Latch.EdgeType.html b/javadoc/xbot/common/logic/Latch.EdgeType.html new file mode 100644 index 00000000..5cbeea2e --- /dev/null +++ b/javadoc/xbot/common/logic/Latch.EdgeType.html @@ -0,0 +1,393 @@ + + + + + +Latch.EdgeType (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Enum Latch.EdgeType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<Latch.EdgeType>
        • +
      • +
          +
        • xbot.common.logic.Latch.EdgeType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<Latch.EdgeType>
      +
      +
      +
      Enclosing class:
      +
      Latch
      +
      +
      +
      public static enum Latch.EdgeType
+extends java.lang.Enum<Latch.EdgeType>
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static Latch.EdgeTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static Latch.EdgeType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Latch.EdgeType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Latch.EdgeType c : Latch.EdgeType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Latch.EdgeType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/Latch.html b/javadoc/xbot/common/logic/Latch.html new file mode 100644 index 00000000..77149e4b --- /dev/null +++ b/javadoc/xbot/common/logic/Latch.html @@ -0,0 +1,362 @@ + + + + + +Latch (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class Latch

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.Latch
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class Latch
+extends java.lang.Object
      +
      Logical switch which consumes booleans and signals when the given value + changes.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class Latch.EdgeType 
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidaddObserver​(java.util.function.Consumer<Latch.EdgeType> callback) 
        voidsetValue​(boolean newValue) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          addObserver

          +
          public void addObserver​(java.util.function.Consumer<Latch.EdgeType> callback)
          +
          • +
        + + + +
          +
        • +

          setValue

          +
          public void setValue​(boolean newValue)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/StallDetector.StallDetectorFactory.html b/javadoc/xbot/common/logic/StallDetector.StallDetectorFactory.html new file mode 100644 index 00000000..a679e0d6 --- /dev/null +++ b/javadoc/xbot/common/logic/StallDetector.StallDetectorFactory.html @@ -0,0 +1,310 @@ + + + + + +StallDetector.StallDetectorFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class StallDetector.StallDetectorFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.StallDetector.StallDetectorFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      StallDetector
      +
      +
      +
      @AssistedFactory
+public abstract static class StallDetector.StallDetectorFactory
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract StallDetectorcreate​(java.lang.String owningSystemPrefix) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          StallDetectorFactory

          +
          public StallDetectorFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract StallDetector create​(@Assisted("owningSystemPrefix")
+                                     java.lang.String owningSystemPrefix)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/StallDetector.StallState.html b/javadoc/xbot/common/logic/StallDetector.StallState.html new file mode 100644 index 00000000..799e383b --- /dev/null +++ b/javadoc/xbot/common/logic/StallDetector.StallState.html @@ -0,0 +1,393 @@ + + + + + +StallDetector.StallState (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Enum StallDetector.StallState

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static StallDetector.StallStatevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static StallDetector.StallState[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static StallDetector.StallState[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (StallDetector.StallState c : StallDetector.StallState.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static StallDetector.StallState valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/StallDetector.html b/javadoc/xbot/common/logic/StallDetector.html new file mode 100644 index 00000000..bce01f2c --- /dev/null +++ b/javadoc/xbot/common/logic/StallDetector.html @@ -0,0 +1,378 @@ + + + + + +StallDetector (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class StallDetector

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.StallDetector
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class StallDetector
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        StallDetector​(PropertyFactory pf, + java.lang.String owningSystemPrefix) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        StallDetector.StallStategetIsStalled​(double current, + double voltagePercent, + double velocity) 
        voidsetAllParameters​(double currentTimeWindow, + double currentLimit, + double noMotionTimeWindow, + double tryingHardVoltagePercentThreshold, + double littleMotionThreshold, + double stallCoolDown) 
        booleanwasStalledRecently() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          StallDetector

          +
          @AssistedInject
+public StallDetector​(PropertyFactory pf,
+                     @Assisted("owningSystemPrefix")
+                     java.lang.String owningSystemPrefix)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setAllParameters

          +
          public void setAllParameters​(double currentTimeWindow,
+                             double currentLimit,
+                             double noMotionTimeWindow,
+                             double tryingHardVoltagePercentThreshold,
+                             double littleMotionThreshold,
+                             double stallCoolDown)
          +
          • +
        + + + +
          +
        • +

          getIsStalled

          +
          public StallDetector.StallState getIsStalled​(double current,
+                                             double voltagePercent,
+                                             double velocity)
          +
          • +
        + + + +
          +
        • +

          wasStalledRecently

          +
          public boolean wasStalledRecently()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/TimeStableValidator.html b/javadoc/xbot/common/logic/TimeStableValidator.html new file mode 100644 index 00000000..6a0341d8 --- /dev/null +++ b/javadoc/xbot/common/logic/TimeStableValidator.html @@ -0,0 +1,362 @@ + + + + + +TimeStableValidator (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class TimeStableValidator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.TimeStableValidator
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class TimeStableValidator
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        TimeStableValidator​(double stableWindow) 
        TimeStableValidator​(java.util.function.Supplier<java.lang.Double> stableWindowProvider) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleancheckStable​(boolean value) 
        voidsetStable() +
        Used if you want the validator to start in a stable state
        +
        voidsetStableWindow​(double stableWindow) 
        voidsetStableWindowProvider​(java.util.function.Supplier<java.lang.Double> stableWindowProvider) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          TimeStableValidator

          +
          public TimeStableValidator​(double stableWindow)
          +
          • +
        + + + +
          +
        • +

          TimeStableValidator

          +
          public TimeStableValidator​(java.util.function.Supplier<java.lang.Double> stableWindowProvider)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setStableWindowProvider

          +
          public void setStableWindowProvider​(java.util.function.Supplier<java.lang.Double> stableWindowProvider)
          +
          • +
        + + + +
          +
        • +

          setStableWindow

          +
          public void setStableWindow​(double stableWindow)
          +
          • +
        + + + +
          +
        • +

          checkStable

          +
          public boolean checkStable​(boolean value)
          +
          • +
        + + + +
          +
        • +

          setStable

          +
          public void setStable()
          +
          Used if you want the validator to start in a stable state
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/VelocityThrottleModule.VelocityThrottleModuleFactory.html b/javadoc/xbot/common/logic/VelocityThrottleModule.VelocityThrottleModuleFactory.html new file mode 100644 index 00000000..a9e0e9cc --- /dev/null +++ b/javadoc/xbot/common/logic/VelocityThrottleModule.VelocityThrottleModuleFactory.html @@ -0,0 +1,313 @@ + + + + + +VelocityThrottleModule.VelocityThrottleModuleFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class VelocityThrottleModule.VelocityThrottleModuleFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.VelocityThrottleModule.VelocityThrottleModuleFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      VelocityThrottleModule
      +
      +
      +
      @AssistedFactory
+public abstract static class VelocityThrottleModule.VelocityThrottleModuleFactory
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          VelocityThrottleModuleFactory

          +
          public VelocityThrottleModuleFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/VelocityThrottleModule.html b/javadoc/xbot/common/logic/VelocityThrottleModule.html new file mode 100644 index 00000000..bac69bbf --- /dev/null +++ b/javadoc/xbot/common/logic/VelocityThrottleModule.html @@ -0,0 +1,366 @@ + + + + + +VelocityThrottleModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class VelocityThrottleModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.VelocityThrottleModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class VelocityThrottleModule
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          VelocityThrottleModule

          +
          @AssistedInject
+public VelocityThrottleModule​(@Assisted("name")
+                              java.lang.String name,
+                              @Assisted("velocityPid")
+                              PIDManager velocityPid,
+                              PropertyFactory propMan)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setThrottleLimits

          +
          public void setThrottleLimits​(double lowerLimit,
+                              double upperLimit)
          +
          • +
        + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          • +
        + + + +
          +
        • +

          calculateThrottle

          +
          public double calculateThrottle​(double goalSpeed,
+                                double currentSpeed)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/WatchdogTimer.html b/javadoc/xbot/common/logic/WatchdogTimer.html new file mode 100644 index 00000000..67ddccc9 --- /dev/null +++ b/javadoc/xbot/common/logic/WatchdogTimer.html @@ -0,0 +1,360 @@ + + + + + +WatchdogTimer (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.logic
    +

    Class WatchdogTimer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.logic.WatchdogTimer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class WatchdogTimer
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        WatchdogTimer​(double timeout, + java.lang.Runnable onUp, + java.lang.Runnable onDown) 
        WatchdogTimer​(double timeout, + java.lang.Runnable onUp, + java.lang.Runnable onDown, + java.lang.String name, + PropertyFactory propMan) 
        WatchdogTimer​(double timeout, + java.lang.String name, + PropertyFactory propMan) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidcheck() 
        voidkick() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          WatchdogTimer

          +
          public WatchdogTimer​(double timeout,
+                     java.lang.String name,
+                     PropertyFactory propMan)
          +
          • +
        + + + +
          +
        • +

          WatchdogTimer

          +
          public WatchdogTimer​(double timeout,
+                     java.lang.Runnable onUp,
+                     java.lang.Runnable onDown)
          +
          • +
        + + + +
          +
        • +

          WatchdogTimer

          +
          public WatchdogTimer​(double timeout,
+                     java.lang.Runnable onUp,
+                     java.lang.Runnable onDown,
+                     java.lang.String name,
+                     PropertyFactory propMan)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          kick

          +
          public void kick()
          +
          • +
        + + + +
          +
        • +

          check

          +
          public void check()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/logic/package-summary.html b/javadoc/xbot/common/logic/package-summary.html new file mode 100644 index 00000000..2297c6c3 --- /dev/null +++ b/javadoc/xbot/common/logic/package-summary.html @@ -0,0 +1,234 @@ + + + + + +xbot.common.logic (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.logic

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/logic/package-tree.html b/javadoc/xbot/common/logic/package-tree.html new file mode 100644 index 00000000..acae26ea --- /dev/null +++ b/javadoc/xbot/common/logic/package-tree.html @@ -0,0 +1,188 @@ + + + + + +xbot.common.logic Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.logic

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/math/ContiguousDouble.html b/javadoc/xbot/common/math/ContiguousDouble.html new file mode 100644 index 00000000..f825a807 --- /dev/null +++ b/javadoc/xbot/common/math/ContiguousDouble.html @@ -0,0 +1,634 @@ + + + + + +ContiguousDouble (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class ContiguousDouble

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.ContiguousDouble
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class ContiguousDouble
+extends java.lang.Object
      +
      Wraps a double to allow easy comparison and manipulation of sensor readings + that wrap (e.g. -180 to 180). + + For bounds 0 - 10, logically: + - 10 + 1 == 1 + - 0 - 1 == 9 + - 0 == 10
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ContiguousDouble() 
        ContiguousDouble​(double lowerBound, + double upperBound) 
        ContiguousDouble​(double value, + double lowerBound, + double upperBound) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ContiguousDoubleclone() 
        doubledifference​(double otherValue) +
        Computes the difference between two values (other - this), accounting for + wrapping.
        +
        doubledifference​(ContiguousDouble otherValue) +
        Computes the difference between two values (other - this), accounting for + wrapping
        +
        doublegetLowerBound() 
        doublegetUpperBound() 
        doublegetValue() 
        doublereboundValue() +
        Shifts the value so that it still represents the same position but is + within the current bounds.
        +
        static doublereboundValue​(double value, + double lowerBound, + double upperBound) 
        voidsetLowerBound​(double newValue) 
        voidsetUpperBound​(double newValue) 
        voidsetValue​(double newValue) 
        ContiguousDoubleshiftBounds​(double shiftMagnitude) +
        Shifts both bounds by the specified amount
        +
        ContiguousDoubleshiftValue​(double shiftMagnitude) +
        Shifts value by the specified amount (addition)
        +
        java.lang.StringtoString() 
        doubleunwrapAbove() +
        Calculates a number representing the current value that is higher than + (or equal to) the upper bound.
        +
        doubleunwrapBelow() +
        Calculates a number representing the current value that is lower than (or + equal to) the lower bound.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ContiguousDouble

          +
          public ContiguousDouble​(double value,
+                        double lowerBound,
+                        double upperBound)
          +
          • +
        + + + +
          +
        • +

          ContiguousDouble

          +
          public ContiguousDouble​(double lowerBound,
+                        double upperBound)
          +
          • +
        + + + +
          +
        • +

          ContiguousDouble

          +
          public ContiguousDouble()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          reboundValue

          +
          public double reboundValue()
          +
          Shifts the value so that it still represents the same position but is + within the current bounds.
          +
          +
          Returns:
          +
          the new value for chaining functions
          +
          +
          • +
        + + + +
          +
        • +

          reboundValue

          +
          public static double reboundValue​(double value,
+                                  double lowerBound,
+                                  double upperBound)
          +
          • +
        + + + +
          +
        • +

          unwrapBelow

          +
          public double unwrapBelow()
          +
          Calculates a number representing the current value that is lower than (or + equal to) the lower bound. Used to make normal numerical comparisons + without needing to handle wrap cases.
          +
          +
          Returns:
          +
          the computed value
          +
          +
          • +
        + + + +
          +
        • +

          unwrapAbove

          +
          public double unwrapAbove()
          +
          Calculates a number representing the current value that is higher than + (or equal to) the upper bound. Used to make normal numerical comparisons + without needing to handle wrap cases.
          +
          +
          Returns:
          +
          the computed value
          +
          +
          • +
        + + + +
          +
        • +

          difference

          +
          public double difference​(double otherValue)
          +
          Computes the difference between two values (other - this), accounting for + wrapping. Treats the given 'other' value as a number within the same bounds + as the current instance.
          +
          +
          Parameters:
          +
          otherValue - the other value to compare against
          +
          Returns:
          +
          the computed difference
          +
          +
          • +
        + + + +
          +
        • +

          difference

          +
          public double difference​(ContiguousDouble otherValue)
          +
          Computes the difference between two values (other - this), accounting for + wrapping
          +
          +
          Parameters:
          +
          otherValue - the other value to compare against (must have the same bounds + as the current instance)
          +
          Returns:
          +
          the computed difference
          +
          +
          • +
        + + + +
          +
        • +

          shiftBounds

          +
          public ContiguousDouble shiftBounds​(double shiftMagnitude)
          +
          Shifts both bounds by the specified amount
          +
          +
          Parameters:
          +
          shiftMagnitude - the amount to add to each bound
          +
          +
          • +
        + + + +
          +
        • +

          shiftValue

          +
          public ContiguousDouble shiftValue​(double shiftMagnitude)
          +
          Shifts value by the specified amount (addition)
          +
          +
          Parameters:
          +
          shiftMagnitude - the amount to add to the current value
          +
          Returns:
          +
          A reference to the current ContiguousDouble, for daisy chaining.
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public double getValue()
          +
          • +
        + + + +
          +
        • +

          setValue

          +
          public void setValue​(double newValue)
          +
          • +
        + + + +
          +
        • +

          getUpperBound

          +
          public double getUpperBound()
          +
          • +
        + + + +
          +
        • +

          setUpperBound

          +
          public void setUpperBound​(double newValue)
          +
          • +
        + + + +
          +
        • +

          getLowerBound

          +
          public double getLowerBound()
          +
          • +
        + + + +
          +
        • +

          setLowerBound

          +
          public void setLowerBound​(double newValue)
          +
          • +
        + + + +
          +
        • +

          clone

          +
          public ContiguousDouble clone()
          +
          +
          Overrides:
          +
          clone in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/FieldPose.html b/javadoc/xbot/common/math/FieldPose.html new file mode 100644 index 00000000..47459c15 --- /dev/null +++ b/javadoc/xbot/common/math/FieldPose.html @@ -0,0 +1,572 @@ + + + + + +FieldPose (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class FieldPose

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.FieldPose
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class FieldPose
+extends java.lang.Object
      +
      The FieldPose class represents a point on the field as well as a heading. + + It also keeps track of some linear equation parameters such as slope and y-intercept. + These are used to calculate intersection points between multiple FieldPose instances, + which can then be used as part of path-following logic.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FieldPose

          +
          public FieldPose()
          +
          • +
        + + + +
          +
        • +

          FieldPose

          +
          public FieldPose​(XYPair point,
+                 edu.wpi.first.math.geometry.Rotation2d heading)
          +
          • +
        + + + +
          +
        • +

          FieldPose

          +
          public FieldPose​(double x,
+                 double y,
+                 double heading)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          clone

          +
          public FieldPose clone()
          +
          +
          Overrides:
          +
          clone in class java.lang.Object
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getPoint

          +
          public XYPair getPoint()
          +
          • +
        + + + + + + + +
          +
        • +

          getPointAlongPoseClosestToPoint

          +
          public XYPair getPointAlongPoseClosestToPoint​(XYPair other)
          +
          • +
        + + + +
          +
        • +

          getDistanceAlongPoseLine

          +
          public double getDistanceAlongPoseLine​(XYPair other)
          +
          • +
        + + + +
          +
        • +

          getRabbitPose

          +
          public FieldPose getRabbitPose​(XYPair other,
+                               double lookaheadDistance)
          +
          • +
        + + + +
          +
        • +

          getDeltaAngleToRabbit

          +
          public double getDeltaAngleToRabbit​(FieldPose other,
+                                    double lookaheadDistance)
          +
          • +
        + + + +
          +
        • +

          getVectorToRabbit

          +
          public XYPair getVectorToRabbit​(FieldPose other,
+                                double lookaheadDistance)
          +
          • +
        + + + +
          +
        • +

          getAngleToPoint

          +
          public double getAngleToPoint​(XYPair point)
          +
          • +
        + + + +
          +
        • +

          getDistanceToLineFromPoint

          +
          public double getDistanceToLineFromPoint​(XYPair currentPoint)
          +
          • +
        + + + +
          +
        • +

          getPoseRelativeDisplacement

          +
          public XYPair getPoseRelativeDisplacement​(FieldPose other)
          +
          • +
        + + + +
          +
        • +

          getPointAlongPoseLine

          +
          public FieldPose getPointAlongPoseLine​(double distance)
          +
          Projects along the line created by the X,Y pair and the Heading. + Positive distances are in front, negative are behind. Keeps the + original heading.
          +
          +
          Parameters:
          +
          distance - Positive distances are in front, negative are behind.
          +
          Returns:
          +
          FieldPose projected along the line
          +
          +
          • +
        + + + +
          +
        • +

          getFieldPoseOffsetBy

          +
          public FieldPose getFieldPoseOffsetBy​(FieldPose offset)
          +
          Returns a FieldPose that's "subtracted" by the offset FieldPose. Useful for setting your current position + as 0,0 and measuring relative to that as you move around the field.
          +
          +
          Parameters:
          +
          offset - The offset location
          +
          Returns:
          +
          The FieldPose shifted by the given offset
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/FieldPosePropertyManager.FieldPosePropertyManagerFactory.html b/javadoc/xbot/common/math/FieldPosePropertyManager.FieldPosePropertyManagerFactory.html new file mode 100644 index 00000000..132cb696 --- /dev/null +++ b/javadoc/xbot/common/math/FieldPosePropertyManager.FieldPosePropertyManagerFactory.html @@ -0,0 +1,335 @@ + + + + + +FieldPosePropertyManager.FieldPosePropertyManagerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class FieldPosePropertyManager.FieldPosePropertyManagerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.FieldPosePropertyManager.FieldPosePropertyManagerFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      FieldPosePropertyManager
      +
      +
      +
      @AssistedFactory
+public abstract static class FieldPosePropertyManager.FieldPosePropertyManagerFactory
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FieldPosePropertyManagerFactory

          +
          public FieldPosePropertyManagerFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract FieldPosePropertyManager create​(@Assisted("poseName")
+                                                java.lang.String poseName,
+                                                @Assisted("x")
+                                                double x,
+                                                @Assisted("y")
+                                                double y,
+                                                @Assisted("heading")
+                                                double heading)
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/FieldPosePropertyManager.html b/javadoc/xbot/common/math/FieldPosePropertyManager.html new file mode 100644 index 00000000..1e6ac8f6 --- /dev/null +++ b/javadoc/xbot/common/math/FieldPosePropertyManager.html @@ -0,0 +1,340 @@ + + + + + +FieldPosePropertyManager (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class FieldPosePropertyManager

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.FieldPosePropertyManager
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class FieldPosePropertyManager
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FieldPosePropertyManager

          +
          @AssistedInject
+public FieldPosePropertyManager​(@Assisted("poseName")
+                                java.lang.String poseName,
+                                @Assisted("x")
+                                double x,
+                                @Assisted("y")
+                                double y,
+                                @Assisted("heading")
+                                double heading,
+                                PropertyFactory propMan)
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/InterpolatingFieldPoseBuffer.html b/javadoc/xbot/common/math/InterpolatingFieldPoseBuffer.html new file mode 100644 index 00000000..64f6e0d4 --- /dev/null +++ b/javadoc/xbot/common/math/InterpolatingFieldPoseBuffer.html @@ -0,0 +1,318 @@ + + + + + +InterpolatingFieldPoseBuffer (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class InterpolatingFieldPoseBuffer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.InterpolatingFieldPoseBuffer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class InterpolatingFieldPoseBuffer
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InterpolatingFieldPoseBuffer

          +
          public InterpolatingFieldPoseBuffer​(FieldPose pose)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          insert

          +
          public void insert​(FieldPose pose)
          +
          • +
        + + + +
          +
        • +

          getPoseAtTime

          +
          public FieldPose getPoseAtTime​(double timeInSeconds)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/InterpolatingHistoryBuffer.html b/javadoc/xbot/common/math/InterpolatingHistoryBuffer.html new file mode 100644 index 00000000..7bfa2f66 --- /dev/null +++ b/javadoc/xbot/common/math/InterpolatingHistoryBuffer.html @@ -0,0 +1,356 @@ + + + + + +InterpolatingHistoryBuffer (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class InterpolatingHistoryBuffer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.InterpolatingHistoryBuffer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class InterpolatingHistoryBuffer
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        InterpolatingHistoryBuffer​(int length, + double init_val) +
        This class implements a set of circular buffers that can be used to store + values of signals in the past, and retrieve values at arbitrary previous time + indexes.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        doublegetValAtTime​(double time) +
        Returns the value at a given time, linearlly interpolated.
        +
        booleaninsert​(double time, + double value) +
        Insert a new value into the buffer.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          InterpolatingHistoryBuffer

          +
          public InterpolatingHistoryBuffer​(int length,
+                                  double init_val)
          +
          This class implements a set of circular buffers that can be used to store + values of signals in the past, and retrieve values at arbitrary previous time + indexes. + + The value is assumed to saturate at the end of the maintained history.
          +
          +
          Parameters:
          +
          length - Number of samples to keep
          +
          init_val - Value to fill the inital samples with (probably zero is fine)
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          insert

          +
          public boolean insert​(double time,
+                      double value)
          +
          Insert a new value into the buffer. Discards the oldest value.
          +
          +
          Parameters:
          +
          time - Time at which the value was sampled. elements must be inserted + in a monotomically increasing fashion
          +
          value - Value of the signal right now
          +
          Returns:
          +
          true if the value was inserted, false otherwise
          +
          +
          • +
        + + + +
          +
        • +

          getValAtTime

          +
          public double getValAtTime​(double time)
          +
          Returns the value at a given time, linearlly interpolated.
          +
          +
          Parameters:
          +
          time - time at which to retrieve value
          +
          Returns:
          +
          value at inputted time.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/MathUtils.html b/javadoc/xbot/common/math/MathUtils.html new file mode 100644 index 00000000..bd3d7eb8 --- /dev/null +++ b/javadoc/xbot/common/math/MathUtils.html @@ -0,0 +1,468 @@ + + + + + +MathUtils (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class MathUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.MathUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class MathUtils
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static doubleTau 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        MathUtils() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static doubleconstrainDouble​(double value, + double lowerBound, + double upperBound) 
        static doubleconstrainDoubleToRobotScale​(double value) 
        static intconstrainInt​(int value, + int lowerBound, + int upperBound) 
        static doubledeadband​(double input, + double deadband) 
        static doubledeadband​(double input, + double deadband, + java.util.function.Function<java.lang.Double,​java.lang.Double> function) 
        static doubleexponentAndRetainSign​(double value, + int exponent) 
        static doublescaleDouble​(double value, + double oldMin, + double oldMax, + double newMin, + double newMax) 
        static doublesquareAndRetainSign​(double value) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          Tau

          +
          public static double Tau
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MathUtils

          +
          public MathUtils()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          constrainDouble

          +
          public static double constrainDouble​(double value,
+                                     double lowerBound,
+                                     double upperBound)
          +
          • +
        + + + +
          +
        • +

          constrainInt

          +
          public static int constrainInt​(int value,
+                               int lowerBound,
+                               int upperBound)
          +
          • +
        + + + +
          +
        • +

          scaleDouble

          +
          public static double scaleDouble​(double value,
+                                 double oldMin,
+                                 double oldMax,
+                                 double newMin,
+                                 double newMax)
          +
          • +
        + + + +
          +
        • +

          constrainDoubleToRobotScale

          +
          public static double constrainDoubleToRobotScale​(double value)
          +
          • +
        + + + +
          +
        • +

          squareAndRetainSign

          +
          public static double squareAndRetainSign​(double value)
          +
          • +
        + + + +
          +
        • +

          exponentAndRetainSign

          +
          public static double exponentAndRetainSign​(double value,
+                                           int exponent)
          +
          • +
        + + + +
          +
        • +

          deadband

          +
          public static double deadband​(double input,
+                              double deadband)
          +
          • +
        + + + +
          +
        • +

          deadband

          +
          public static double deadband​(double input,
+                              double deadband,
+                              java.util.function.Function<java.lang.Double,​java.lang.Double> function)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PID.OffTargetReason.html b/javadoc/xbot/common/math/PID.OffTargetReason.html new file mode 100644 index 00000000..619049bc --- /dev/null +++ b/javadoc/xbot/common/math/PID.OffTargetReason.html @@ -0,0 +1,432 @@ + + + + + +PID.OffTargetReason (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Enum PID.OffTargetReason

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<PID.OffTargetReason>
      +
      +
      +
      Enclosing class:
      +
      PID
      +
      +
      +
      public static enum PID.OffTargetReason
+extends java.lang.Enum<PID.OffTargetReason>
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static PID.OffTargetReasonvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static PID.OffTargetReason[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static PID.OffTargetReason[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (PID.OffTargetReason c : PID.OffTargetReason.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static PID.OffTargetReason valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PID.html b/javadoc/xbot/common/math/PID.html new file mode 100644 index 00000000..e6bec6b1 --- /dev/null +++ b/javadoc/xbot/common/math/PID.html @@ -0,0 +1,545 @@ + + + + + +PID (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PID

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.PID
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class PID
+extends java.lang.Object
      +
      This PID was extracted from WPILib. It has all the same functionality, but + does not run on its own separate thread.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class PID.OffTargetReason 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        PID() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        doublecalculate​(double goal, + double current, + double p, + double i, + double d) +
        Calculates the output value given P,I,D, a process variable and a goal
        +
        doublecalculate​(double goal, + double current, + double p, + double i, + double d, + double f) +
        Calculates the output value given P,I,D, a process variable and a goal
        +
        doublecalculate​(double goal, + double current, + double p, + double i, + double d, + double f, + double iZone) +
        Calculates the output value given P,I,D, a process variable and a goal
        +
        PID.OffTargetReasongetOffTargetReason() +
        Returns an enum explaining the reason the PID is not on target.
        +
        booleanisOnTarget() 
        voidreset() +
        Resets the PID controller.
        +
        voidsetShouldCheckTolerances​(boolean checkError, + boolean checkDerivative, + boolean checkTime) +
        Controls whether or not the tolerances are checked as part of isOnTarget().
        +
        voidsetTolerances​(double errorTolerance, + double derivativeTolerance, + double timeToleranceInSeconds) +
        Set tolerances for the PID system.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          PID

          +
          public PID()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          Resets the PID controller.
          +
          • +
        + + + +
          +
        • +

          setTolerances

          +
          public void setTolerances​(double errorTolerance,
+                          double derivativeTolerance,
+                          double timeToleranceInSeconds)
          +
          Set tolerances for the PID system.
          +
          +
          Parameters:
          +
          errorTolerance - How close the error can be before it is considered + "on-target." + + Negative values will cause that constraint to skipped when checking + isOnTarget(). + + This is in the same units as your current and goal values.
          +
          derivativeTolerance - Set how small the derivative of the error can be before it is considered + "on-target." + + This is roughly in the same units as your current and goal values, + but per 1/20th of a second. + + e.g. if you wanted a minimum rotation speed of 5 degrees per second, + this tolerance would need to be 0.25.
          +
          +
          • +
        + + + +
          +
        • +

          setShouldCheckTolerances

          +
          public void setShouldCheckTolerances​(boolean checkError,
+                                     boolean checkDerivative,
+                                     boolean checkTime)
          +
          Controls whether or not the tolerances are checked as part of isOnTarget().
          +
          • +
        + + + +
          +
        • +

          calculate

          +
          public double calculate​(double goal,
+                        double current,
+                        double p,
+                        double i,
+                        double d,
+                        double f,
+                        double iZone)
          +
          Calculates the output value given P,I,D, a process variable and a goal
          +
          +
          Parameters:
          +
          goal - What value you are trying to achieve
          +
          current - What the value under observation currently is
          +
          p - Proportionate response
          +
          i - Integral response.
          +
          d - Derivative response.
          +
          f - Feed-forward response
          +
          Returns:
          +
          The output value to achieve goal
          +
          +
          • +
        + + + +
          +
        • +

          calculate

          +
          public double calculate​(double goal,
+                        double current,
+                        double p,
+                        double i,
+                        double d,
+                        double f)
          +
          Calculates the output value given P,I,D, a process variable and a goal
          +
          +
          Parameters:
          +
          goal - What value you are trying to achieve
          +
          current - What the value under observation currently is
          +
          p - Proportionate response
          +
          i - Integral response.
          +
          d - Derivative response.
          +
          f - Feed-forward response.
          +
          Returns:
          +
          The output value to achieve goal
          +
          +
          • +
        + + + +
          +
        • +

          calculate

          +
          public double calculate​(double goal,
+                        double current,
+                        double p,
+                        double i,
+                        double d)
          +
          Calculates the output value given P,I,D, a process variable and a goal
          +
          +
          Parameters:
          +
          goal - What value you are trying to achieve
          +
          current - What the value under observation currently is
          +
          p - Proportionate response
          +
          i - Integral response.
          +
          d - Derivative response.
          +
          Returns:
          +
          The output value to achieve goal
          +
          +
          • +
        + + + +
          +
        • +

          isOnTarget

          +
          public boolean isOnTarget()
          +
          • +
        + + + +
          +
        • +

          getOffTargetReason

          +
          public PID.OffTargetReason getOffTargetReason()
          +
          Returns an enum explaining the reason the PID is not on target. + It has the following priority list if there are multiple reasons (higher ones overrule lower ones): + - Too much error + - Too much derivative + - Waiting for time stability + - On Target
          +
          +
          Returns:
          +
          The reason the PID is not on target.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PIDManager.PIDManagerFactory.html b/javadoc/xbot/common/math/PIDManager.PIDManagerFactory.html new file mode 100644 index 00000000..b4f467a3 --- /dev/null +++ b/javadoc/xbot/common/math/PIDManager.PIDManagerFactory.html @@ -0,0 +1,455 @@ + + + + + +PIDManager.PIDManagerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PIDManager.PIDManagerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.PIDManager.PIDManagerFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      PIDManager
      +
      +
      +
      @AssistedFactory
+public abstract static class PIDManager.PIDManagerFactory
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        PIDManagerFactory() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        PIDManagercreate​(java.lang.String functionName) 
        PIDManagercreate​(java.lang.String functionName, + double defaultP, + double defaultI, + double defaultD) 
        PIDManagercreate​(java.lang.String functionName, + double defaultP, + double defaultI, + double defaultD, + double defaultMaxOutput, + double defaultMinOutput) 
        PIDManagercreate​(java.lang.String functionName, + double defaultP, + double defaultI, + double defaultD, + double defaultF, + double defaultMaxOutput, + double defaultMinOutput) 
        PIDManagercreate​(java.lang.String functionName, + double defaultP, + double defaultI, + double defaultD, + double defaultF, + double defaultMaxOutput, + double defaultMinOutput, + double errorThreshold, + double derivativeThreshold, + double timeThreshold) 
        abstract PIDManagercreate​(java.lang.String functionName, + double defaultP, + double defaultI, + double defaultD, + double defaultF, + double defaultMaxOutput, + double defaultMinOutput, + double errorThreshold, + double derivativeThreshold, + double timeThreshold, + double iZone) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          PIDManagerFactory

          +
          public PIDManagerFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract PIDManager create​(java.lang.String functionName,
+                                  @Assisted("defaultP")
+                                  double defaultP,
+                                  @Assisted("defaultI")
+                                  double defaultI,
+                                  @Assisted("defaultD")
+                                  double defaultD,
+                                  @Assisted("defaultF")
+                                  double defaultF,
+                                  @Assisted("defaultMaxOutput")
+                                  double defaultMaxOutput,
+                                  @Assisted("defaultMinOutput")
+                                  double defaultMinOutput,
+                                  @Assisted("errorThreshold")
+                                  double errorThreshold,
+                                  @Assisted("derivativeThreshold")
+                                  double derivativeThreshold,
+                                  @Assisted("timeThreshold")
+                                  double timeThreshold,
+                                  @Assisted("iZone")
+                                  double iZone)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public PIDManager create​(java.lang.String functionName,
+                         double defaultP,
+                         double defaultI,
+                         double defaultD,
+                         double defaultF,
+                         double defaultMaxOutput,
+                         double defaultMinOutput,
+                         double errorThreshold,
+                         double derivativeThreshold,
+                         double timeThreshold)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public PIDManager create​(java.lang.String functionName,
+                         double defaultP,
+                         double defaultI,
+                         double defaultD,
+                         double defaultF,
+                         double defaultMaxOutput,
+                         double defaultMinOutput)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public PIDManager create​(java.lang.String functionName,
+                         double defaultP,
+                         double defaultI,
+                         double defaultD,
+                         double defaultMaxOutput,
+                         double defaultMinOutput)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public PIDManager create​(java.lang.String functionName,
+                         double defaultP,
+                         double defaultI,
+                         double defaultD)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public PIDManager create​(java.lang.String functionName)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PIDManager.html b/javadoc/xbot/common/math/PIDManager.html new file mode 100644 index 00000000..9c8f847f --- /dev/null +++ b/javadoc/xbot/common/math/PIDManager.html @@ -0,0 +1,538 @@ + + + + + +PIDManager (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PIDManager

    +
    +
    + +
    +
      +
    • +
      +
      public class PIDManager
+extends PIDPropertyManager
      +
      Wrapper for PID class which automatically puts the P, I and D values on + the SmartDashboard.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PIDManager

          +
          @AssistedInject
+public PIDManager​(@Assisted
+                  java.lang.String functionName,
+                  PropertyFactory propMan,
+                  RobotAssertionManager assertionManager,
+                  @Assisted("defaultP")
+                  double defaultP,
+                  @Assisted("defaultI")
+                  double defaultI,
+                  @Assisted("defaultD")
+                  double defaultD,
+                  @Assisted("defaultF")
+                  double defaultF,
+                  @Assisted("defaultMaxOutput")
+                  double defaultMaxOutput,
+                  @Assisted("defaultMinOutput")
+                  double defaultMinOutput,
+                  @Assisted("errorThreshold")
+                  double errorThreshold,
+                  @Assisted("derivativeThreshold")
+                  double derivativeThreshold,
+                  @Assisted("timeThreshold")
+                  double timeThreshold,
+                  @Assisted("iZone")
+                  double iZone)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          calculate

          +
          public double calculate​(double goal,
+                        double current)
          +
          • +
        + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          • +
        + + + +
          +
        • +

          isOnTarget

          +
          @Deprecated
+public boolean isOnTarget​(double errorTolerance)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          isOnTarget

          +
          public boolean isOnTarget()
          +
          Determines if you are on target. + Only works if: you have called setErrorThreshold() and/or + setDerivativeThreshold(), as well as + setEnableErrorThreshold() and/or setDerivativeErrorThreshold(), or if you + have set + these values in the SmartDashboard at runtime.
          +
          • +
        + + + + + + + +
          +
        • +

          setIMask

          +
          public void setIMask​(boolean isMasked)
          +
          • +
        + + + +
          +
        • +

          getIMask

          +
          public boolean getIMask()
          +
          • +
        + + + +
          +
        • +

          setMinOutput

          +
          public void setMinOutput​(double value)
          +
          • +
        + + + +
          +
        • +

          getMinOutput

          +
          public double getMinOutput()
          +
          • +
        + + + +
          +
        • +

          setMaxOutput

          +
          public void setMaxOutput​(double value)
          +
          • +
        + + + +
          +
        • +

          getMaxOutput

          +
          public double getMaxOutput()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PIDPropertyManager.PIDPropertyManagerFactory.html b/javadoc/xbot/common/math/PIDPropertyManager.PIDPropertyManagerFactory.html new file mode 100644 index 00000000..6bb2d779 --- /dev/null +++ b/javadoc/xbot/common/math/PIDPropertyManager.PIDPropertyManagerFactory.html @@ -0,0 +1,383 @@ + + + + + +PIDPropertyManager.PIDPropertyManagerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PIDPropertyManager.PIDPropertyManagerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.PIDPropertyManager.PIDPropertyManagerFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      PIDPropertyManager
      +
      +
      +
      @AssistedFactory
+public abstract static class PIDPropertyManager.PIDPropertyManagerFactory
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        PIDPropertyManagercreate​(java.lang.String functionName, + double defaultP, + double defaultI, + double defaultD, + double defaultF) 
        PIDPropertyManagercreate​(java.lang.String functionName, + double defaultP, + double defaultI, + double defaultD, + double defaultF, + double errorThreshold, + double derivativeThreshold, + double timeThreshold) 
        abstract PIDPropertyManagercreate​(java.lang.String functionName, + double defaultP, + double defaultI, + double defaultD, + double defaultF, + double errorThreshold, + double derivativeThreshold, + double timeThreshold, + double defaultIZone) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          PIDPropertyManagerFactory

          +
          public PIDPropertyManagerFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract PIDPropertyManager create​(java.lang.String functionName,
+                                          @Assisted("defaultP")
+                                          double defaultP,
+                                          @Assisted("defaultI")
+                                          double defaultI,
+                                          @Assisted("defaultD")
+                                          double defaultD,
+                                          @Assisted("defaultF")
+                                          double defaultF,
+                                          @Assisted("errorThreshold")
+                                          double errorThreshold,
+                                          @Assisted("derivativeThreshold")
+                                          double derivativeThreshold,
+                                          @Assisted("timeThreshold")
+                                          double timeThreshold,
+                                          @Assisted("iZone")
+                                          double defaultIZone)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public PIDPropertyManager create​(java.lang.String functionName,
+                                 double defaultP,
+                                 double defaultI,
+                                 double defaultD,
+                                 double defaultF,
+                                 double errorThreshold,
+                                 double derivativeThreshold,
+                                 double timeThreshold)
          +
          • +
        + + + +
          +
        • +

          create

          +
          public PIDPropertyManager create​(java.lang.String functionName,
+                                 double defaultP,
+                                 double defaultI,
+                                 double defaultD,
+                                 double defaultF)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PIDPropertyManager.html b/javadoc/xbot/common/math/PIDPropertyManager.html new file mode 100644 index 00000000..f474be74 --- /dev/null +++ b/javadoc/xbot/common/math/PIDPropertyManager.html @@ -0,0 +1,655 @@ + + + + + +PIDPropertyManager (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PIDPropertyManager

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.PIDPropertyManager
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      PIDManager
      +
      +
      +
      public class PIDPropertyManager
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PIDPropertyManager

          +
          @AssistedInject
+public PIDPropertyManager​(@Assisted
+                          java.lang.String functionName,
+                          PropertyFactory propMan,
+                          RobotAssertionManager assertionManager,
+                          @Assisted("defaultP")
+                          double defaultP,
+                          @Assisted("defaultI")
+                          double defaultI,
+                          @Assisted("defaultD")
+                          double defaultD,
+                          @Assisted("defaultF")
+                          double defaultF,
+                          @Assisted("errorThreshold")
+                          double errorThreshold,
+                          @Assisted("derivativeThreshold")
+                          double derivativeThreshold,
+                          @Assisted("timeThreshold")
+                          double timeThreshold,
+                          @Assisted("iZone")
+                          double defaultIZone)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getP

          +
          public double getP()
          +
          • +
        + + + +
          +
        • +

          setP

          +
          public void setP​(double p)
          +
          • +
        + + + +
          +
        • +

          getI

          +
          public double getI()
          +
          • +
        + + + +
          +
        • +

          setI

          +
          public void setI​(double i)
          +
          • +
        + + + +
          +
        • +

          getD

          +
          public double getD()
          +
          • +
        + + + +
          +
        • +

          setD

          +
          public void setD​(double d)
          +
          • +
        + + + +
          +
        • +

          getF

          +
          public double getF()
          +
          • +
        + + + +
          +
        • +

          setF

          +
          public void setF​(double f)
          +
          • +
        + + + +
          +
        • +

          getIZone

          +
          public double getIZone()
          +
          • +
        + + + +
          +
        • +

          setIZone

          +
          public void setIZone​(double iZone)
          +
          • +
        + + + +
          +
        • +

          getErrorThreshold

          +
          public double getErrorThreshold()
          +
          • +
        + + + +
          +
        • +

          setErrorThreshold

          +
          public void setErrorThreshold​(double errorThreshold)
          +
          • +
        + + + +
          +
        • +

          getDerivativeThreshold

          +
          public double getDerivativeThreshold()
          +
          • +
        + + + +
          +
        • +

          setDerivativeThreshold

          +
          public void setDerivativeThreshold​(double derivativeThreshold)
          +
          • +
        + + + +
          +
        • +

          getTimeThreshold

          +
          public double getTimeThreshold()
          +
          • +
        + + + +
          +
        • +

          setTimeThreshold

          +
          public void setTimeThreshold​(double timeThreshold)
          +
          • +
        + + + +
          +
        • +

          getEnableErrorThreshold

          +
          public boolean getEnableErrorThreshold()
          +
          • +
        + + + +
          +
        • +

          setEnableErrorThreshold

          +
          public void setEnableErrorThreshold​(boolean isEnabled)
          +
          • +
        + + + +
          +
        • +

          getEnableDerivativeThreshold

          +
          public boolean getEnableDerivativeThreshold()
          +
          • +
        + + + +
          +
        • +

          setEnableDerivativeThreshold

          +
          public void setEnableDerivativeThreshold​(boolean isEnabled)
          +
          • +
        + + + +
          +
        • +

          getEnableTimeThreshold

          +
          public boolean getEnableTimeThreshold()
          +
          • +
        + + + +
          +
        • +

          setEnableTimeThreshold

          +
          public void setEnableTimeThreshold​(boolean isEnabled)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PlanarEngine.html b/javadoc/xbot/common/math/PlanarEngine.html new file mode 100644 index 00000000..b76aff90 --- /dev/null +++ b/javadoc/xbot/common/math/PlanarEngine.html @@ -0,0 +1,362 @@ + + + + + +PlanarEngine (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PlanarEngine

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.PlanarEngine
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class PlanarEngine
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PlanarEngine

          +
          public PlanarEngine()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getGoalPoint

          +
          public XYPair getGoalPoint()
          +
          • +
        + + + +
          +
        • +

          step

          +
          public XYPair step​(double forwardPower,
+                   double rotatePower)
          +
          • +
        + + + +
          +
        • +

          getVelocity

          +
          public double getVelocity()
          +
          • +
        + + + +
          +
        • +

          getRobotPose

          +
          public FieldPose getRobotPose()
          +
          • +
        + + + +
          +
        • +

          getLoops

          +
          public int getLoops()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PlanarTestVisualizer.html b/javadoc/xbot/common/math/PlanarTestVisualizer.html new file mode 100644 index 00000000..47d63814 --- /dev/null +++ b/javadoc/xbot/common/math/PlanarTestVisualizer.html @@ -0,0 +1,388 @@ + + + + + +PlanarTestVisualizer (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PlanarTestVisualizer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.PlanarTestVisualizer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class PlanarTestVisualizer
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          frmLinearTestVisualizer

          +
          public javax.swing.JFrame frmLinearTestVisualizer
          +
          • +
        + + + + + + + +
          +
        • +

          controlPanel

          +
          public javax.swing.JPanel controlPanel
          +
          • +
        + + + +
          +
        • +

          speedSlider

          +
          public javax.swing.JSlider speedSlider
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PlanarTestVisualizer

          +
          public PlanarTestVisualizer​(java.util.List<RabbitPoint> points)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          main

          +
          public static void main​(java.lang.String[] args)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PlanarVisualizationPanel.html b/javadoc/xbot/common/math/PlanarVisualizationPanel.html new file mode 100644 index 00000000..2018553c --- /dev/null +++ b/javadoc/xbot/common/math/PlanarVisualizationPanel.html @@ -0,0 +1,498 @@ + + + + + +PlanarVisualizationPanel (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PlanarVisualizationPanel

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.awt.Component
        • +
      • +
          +
        • java.awt.Container
          • +
        • +
            +
          • javax.swing.JComponent
            • +
          • +
              +
            • javax.swing.JPanel
              • +
            • +
                +
              • xbot.common.math.PlanarVisualizationPanel
                • +
              +
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
      +
      +
      +
      public class PlanarVisualizationPanel
+extends javax.swing.JPanel
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from class javax.swing.JPanel

          +javax.swing.JPanel.AccessibleJPanel
          • +
        +
          +
        • + + +

          Nested classes/interfaces inherited from class javax.swing.JComponent

          +javax.swing.JComponent.AccessibleJComponent
          • +
        +
          +
        • + + +

          Nested classes/interfaces inherited from class java.awt.Container

          +java.awt.Container.AccessibleAWTContainer
          • +
        +
          +
        • + + +

          Nested classes/interfaces inherited from class java.awt.Component

          +java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class javax.swing.JComponent

          +listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
          • +
        +
          +
        • + + +

          Fields inherited from class java.awt.Component

          +accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
          • +
        +
          +
        • + + +

          Fields inherited from interface java.awt.image.ImageObserver

          +ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.awt.DimensiongetMinimumSize() 
        java.awt.DimensiongetPreferredSize() 
        protected voidpaintComponent​(java.awt.Graphics g) 
        voidupdateViz​(PurePursuitTest.PursuitEnvironmentState state) 
        +
          +
        • + + +

          Methods inherited from class javax.swing.JPanel

          +getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
          • +
        +
          +
        • + + +

          Methods inherited from class javax.swing.JComponent

          +addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
          • +
        +
          +
        • + + +

          Methods inherited from class java.awt.Container

          +add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
          • +
        +
          +
        • + + +

          Methods inherited from class java.awt.Component

          +action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          PlanarVisualizationPanel

          +
          public PlanarVisualizationPanel()
          +
          • +
        + + + +
          +
        • +

          PlanarVisualizationPanel

          +
          public PlanarVisualizationPanel​(int preferredWidth,
+                                int minimumWidth)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          paintComponent

          +
          protected void paintComponent​(java.awt.Graphics g)
          +
          +
          Overrides:
          +
          paintComponent in class javax.swing.JComponent
          +
          +
          • +
        + + + +
          +
        • +

          getPreferredSize

          +
          public java.awt.Dimension getPreferredSize()
          +
          +
          Overrides:
          +
          getPreferredSize in class javax.swing.JComponent
          +
          +
          • +
        + + + +
          +
        • +

          getMinimumSize

          +
          public java.awt.Dimension getMinimumSize()
          +
          +
          Overrides:
          +
          getMinimumSize in class javax.swing.JComponent
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PurePursuitTest.AsyncLinearIntervalJob.html b/javadoc/xbot/common/math/PurePursuitTest.AsyncLinearIntervalJob.html new file mode 100644 index 00000000..62b52cf7 --- /dev/null +++ b/javadoc/xbot/common/math/PurePursuitTest.AsyncLinearIntervalJob.html @@ -0,0 +1,252 @@ + + + + + +PurePursuitTest.AsyncLinearIntervalJob (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Interface PurePursuitTest.AsyncLinearIntervalJob

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      PurePursuitTest
      +
      +
      +
      public static interface PurePursuitTest.AsyncLinearIntervalJob
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/math/PurePursuitTest.PursuitEnvironmentState.html b/javadoc/xbot/common/math/PurePursuitTest.PursuitEnvironmentState.html new file mode 100644 index 00000000..cbf6b0e0 --- /dev/null +++ b/javadoc/xbot/common/math/PurePursuitTest.PursuitEnvironmentState.html @@ -0,0 +1,408 @@ + + + + + +PurePursuitTest.PursuitEnvironmentState (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PurePursuitTest.PursuitEnvironmentState

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.PurePursuitTest.PursuitEnvironmentState
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      PurePursuitTest
      +
      +
      +
      public static class PurePursuitTest.PursuitEnvironmentState
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + + + + + + + + + + + + + +
          +
        • +

          loops

          +
          public int loops
          +
          • +
        + + + +
          +
        • +

          rabbitAngle

          +
          public double rabbitAngle
          +
          • +
        + + + +
          +
        • +

          turnPower

          +
          public double turnPower
          +
          • +
        + + + +
          +
        • +

          translatePower

          +
          public double translatePower
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PursuitEnvironmentState

          +
          public PursuitEnvironmentState​(FieldPose robot,
+                               FieldPose goal,
+                               FieldPose rabbit,
+                               int loops,
+                               double rabbitAngle,
+                               double turnPower,
+                               double translatePower)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/PurePursuitTest.html b/javadoc/xbot/common/math/PurePursuitTest.html new file mode 100644 index 00000000..1be892ce --- /dev/null +++ b/javadoc/xbot/common/math/PurePursuitTest.html @@ -0,0 +1,545 @@ + + + + + +PurePursuitTest (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class PurePursuitTest

    +
    +
    + +
    +
      +
    • +
      +
      public class PurePursuitTest
+extends BaseWPITest
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/WrappedRotation2d.html b/javadoc/xbot/common/math/WrappedRotation2d.html new file mode 100644 index 00000000..90d2ea05 --- /dev/null +++ b/javadoc/xbot/common/math/WrappedRotation2d.html @@ -0,0 +1,384 @@ + + + + + +WrappedRotation2d (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class WrappedRotation2d

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • edu.wpi.first.math.geometry.Rotation2d
        • +
      • +
          +
        • xbot.common.math.WrappedRotation2d
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.math.interpolation.Interpolatable<edu.wpi.first.math.geometry.Rotation2d>
      +
      +
      +
      public class WrappedRotation2d
+extends edu.wpi.first.math.geometry.Rotation2d
      +
      A rotation in a 2d coordinate frame, with its rotation wrapped from -pi to pi radians (-180 to 180 degrees). + Prefer this class over Rotation2d when representing robot pose.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        WrappedRotation2d​(double value) +
        Constructs a WrappedRotation2d with the given radian value.
        +
        WrappedRotation2d​(double x, + double y) +
        Constructs a WrappedRotation2d with the given x and y (cosine and sine) components.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static WrappedRotation2dfromDegrees​(double degrees) +
        Constructs and returns a Rotation2d with the given degree value.
        +
        static WrappedRotation2dfromRotation2d​(edu.wpi.first.math.geometry.Rotation2d rotation) +
        Converts a Rotation2d to the wrapped equivalent.
        +
        +
          +
        • + + +

          Methods inherited from class edu.wpi.first.math.geometry.Rotation2d

          +div, equals, fromRadians, fromRotations, getCos, getDegrees, getRadians, getRotations, getSin, getTan, hashCode, interpolate, minus, plus, rotateBy, times, toString, unaryMinus
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          WrappedRotation2d

          +
          public WrappedRotation2d​(double value)
          +
          Constructs a WrappedRotation2d with the given radian value.
          +
          +
          Parameters:
          +
          value - The value of the angle in radians.
          +
          +
          • +
        + + + +
          +
        • +

          WrappedRotation2d

          +
          public WrappedRotation2d​(double x,
+                         double y)
          +
          Constructs a WrappedRotation2d with the given x and y (cosine and sine) components. The x and y don't have to be normalized.
          +
          +
          Parameters:
          +
          x - The x component or cosine of the rotation.
          +
          y - The y component or sine of the rotation.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromRotation2d

          +
          public static WrappedRotation2d fromRotation2d​(edu.wpi.first.math.geometry.Rotation2d rotation)
          +
          Converts a Rotation2d to the wrapped equivalent.
          +
          +
          Parameters:
          +
          rotation - The rotation.
          +
          Returns:
          +
          The rotation with its angle wrapped from -pi to pi radians.
          +
          +
          • +
        + + + +
          +
        • +

          fromDegrees

          +
          public static WrappedRotation2d fromDegrees​(double degrees)
          +
          Constructs and returns a Rotation2d with the given degree value.
          +
          +
          Parameters:
          +
          degrees - The value of the angle in degrees.
          +
          Returns:
          +
          The rotation object with the desired angle value.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/XYPair.html b/javadoc/xbot/common/math/XYPair.html new file mode 100644 index 00000000..7dedfa2b --- /dev/null +++ b/javadoc/xbot/common/math/XYPair.html @@ -0,0 +1,716 @@ + + + + + +XYPair (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.math
    +

    Class XYPair

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.math.XYPair
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class XYPair
+extends java.lang.Object
      +
      Pair of X and Y coordinates. Can be used for points, vectors, or anything + else that requires a coordinate pair.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        doublex 
        doubley 
        static XYPairZERO 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        XYPair() +
        Create a coordinate at the origin.
        +
        XYPair​(double x, + double y) +
        Create a coordinate with the specified x and y value.
        +
        XYPair​(edu.wpi.first.math.geometry.Rotation2d rotation) +
        Creates a coordinate representing the unit vector for a rotation.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        XYPairadd​(XYPair pair) +
        Adds the value of a second coordinate to the current coordinate.
        +
        XYPairaddMagnitude​(double magnitudeToAdd) +
        Add the magnitude to the vector represented by the coordinate.
        +
        XYPairclone() +
        Clone the object
        +
        doubledotProduct​(XYPair otherPoint) +
        Calculate the dot-product between this and another point.
        +
        static XYPairfromPolar​(double angle, + double magnitude) +
        Create a coordinate from an angle and magnitude
        +
        static XYPairfromUnitPolar​(double angle) +
        Create a coordinate of magnitude 1 with an angle
        +
        doublegetAngle() +
        Get the angle of the vector in degrees
        +
        doublegetDistanceToPoint​(XYPair otherPoint) +
        Get the distance between the current point and a second point.
        +
        doublegetMagnitude() +
        Get the magnitude of the vector (i.e.
        +
        XYPairrotate​(double angle) +
        Rotates the vector by a given angle.
        +
        XYPairscale​(double scalarMagnitude) +
        Scales the current coordinate by a magnitude equally in both dimensions.
        +
        XYPairscale​(double xMagnitude, + double yMagnitude) +
        Scales the coordinate by an x- and y- magnitude.
        +
        java.lang.StringtoString() 
        edu.wpi.first.math.geometry.Translation2dtoTranslation2d() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          ZERO

          +
          public static final XYPair ZERO
          +
          • +
        + + + +
          +
        • +

          x

          +
          public double x
          +
          • +
        + + + +
          +
        • +

          y

          +
          public double y
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XYPair

          +
          public XYPair​(double x,
+              double y)
          +
          Create a coordinate with the specified x and y value.
          +
          +
          Parameters:
          +
          x - the x value to use
          +
          y - the y value to use
          +
          +
          • +
        + + + +
          +
        • +

          XYPair

          +
          public XYPair​(edu.wpi.first.math.geometry.Rotation2d rotation)
          +
          Creates a coordinate representing the unit vector for a rotation.
          +
          +
          Parameters:
          +
          rotation - The rotation value.
          +
          +
          • +
        + + + +
          +
        • +

          XYPair

          +
          public XYPair()
          +
          Create a coordinate at the origin.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          clone

          +
          public XYPair clone()
          +
          Clone the object
          +
          +
          Overrides:
          +
          clone in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          fromPolar

          +
          public static XYPair fromPolar​(double angle,
+                               double magnitude)
          +
          Create a coordinate from an angle and magnitude
          +
          +
          Parameters:
          +
          angle - angle in degrees
          +
          magnitude - magnitude
          +
          Returns:
          +
          coordinate
          +
          +
          • +
        + + + +
          +
        • +

          fromUnitPolar

          +
          public static XYPair fromUnitPolar​(double angle)
          +
          Create a coordinate of magnitude 1 with an angle
          +
          +
          Parameters:
          +
          angle - angle in degrees
          +
          Returns:
          +
          coordinate
          +
          +
          • +
        + + + +
          +
        • +

          scale

          +
          public XYPair scale​(double scalarMagnitude)
          +
          Scales the current coordinate by a magnitude equally in both dimensions.
          +
          +
          Parameters:
          +
          scalarMagnitude - the magnitude to scale the coordinate by
          +
          Returns:
          +
          the scaled object
          +
          +
          • +
        + + + +
          +
        • +

          scale

          +
          public XYPair scale​(double xMagnitude,
+                    double yMagnitude)
          +
          Scales the coordinate by an x- and y- magnitude.
          +
          +
          Parameters:
          +
          xMagnitude - the magnitude to scale the x-coordinate by
          +
          yMagnitude - the magnitude to scale the y-coordinate by
          +
          Returns:
          +
          the scaled object
          +
          +
          • +
        + + + +
          +
        • +

          addMagnitude

          +
          public XYPair addMagnitude​(double magnitudeToAdd)
          +
          Add the magnitude to the vector represented by the coordinate.
          +
          +
          Parameters:
          +
          magnitudeToAdd - magnitude to add
          +
          Returns:
          +
          the modified coordinate
          +
          +
          • +
        + + + +
          +
        • +

          rotate

          +
          public XYPair rotate​(double angle)
          +
          Rotates the vector by a given angle.
          +
          +
          Parameters:
          +
          angle - the angle in degrees to rotate the pair by
          +
          Returns:
          +
          the rotated object
          +
          +
          • +
        + + + +
          +
        • +

          getAngle

          +
          public double getAngle()
          +
          Get the angle of the vector in degrees
          +
          +
          Returns:
          +
          angle in degrees
          +
          +
          • +
        + + + +
          +
        • +

          getMagnitude

          +
          public double getMagnitude()
          +
          Get the magnitude of the vector (i.e. distance from origin to the coordinate).
          +
          +
          Returns:
          +
          magnitude
          +
          +
          • +
        + + + +
          +
        • +

          add

          +
          public XYPair add​(XYPair pair)
          +
          Adds the value of a second coordinate to the current coordinate.
          +
          +
          Parameters:
          +
          pair - coordinate to add
          +
          Returns:
          +
          the combined object
          +
          +
          • +
        + + + +
          +
        • +

          getDistanceToPoint

          +
          public double getDistanceToPoint​(XYPair otherPoint)
          +
          Get the distance between the current point and a second point.
          +
          +
          Parameters:
          +
          otherPoint - the point to calculate the distance from
          +
          Returns:
          +
          the distance
          +
          +
          • +
        + + + +
          +
        • +

          dotProduct

          +
          public double dotProduct​(XYPair otherPoint)
          +
          Calculate the dot-product between this and another point.
          +
          +
          Parameters:
          +
          otherPoint - the second point to use for calculating dot product
          +
          Returns:
          +
          the dot product value
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toTranslation2d

          +
          public edu.wpi.first.math.geometry.Translation2d toTranslation2d()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/math/package-summary.html b/javadoc/xbot/common/math/package-summary.html new file mode 100644 index 00000000..73b537db --- /dev/null +++ b/javadoc/xbot/common/math/package-summary.html @@ -0,0 +1,280 @@ + + + + + +xbot.common.math (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.math

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/math/package-tree.html b/javadoc/xbot/common/math/package-tree.html new file mode 100644 index 00000000..056c4a5d --- /dev/null +++ b/javadoc/xbot/common/math/package-tree.html @@ -0,0 +1,226 @@ + + + + + +xbot.common.math Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.math

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/networking/MockZeromqListener.MockZeromqListenerFactory.html b/javadoc/xbot/common/networking/MockZeromqListener.MockZeromqListenerFactory.html new file mode 100644 index 00000000..dd7ac61d --- /dev/null +++ b/javadoc/xbot/common/networking/MockZeromqListener.MockZeromqListenerFactory.html @@ -0,0 +1,322 @@ + + + + + +MockZeromqListener.MockZeromqListenerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.networking
    +

    Class MockZeromqListener.MockZeromqListenerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.networking.MockZeromqListener.MockZeromqListenerFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract MockZeromqListenercreate​(java.lang.String connectionString, + java.lang.String topic) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          MockZeromqListenerFactory

          +
          public MockZeromqListenerFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/networking/MockZeromqListener.html b/javadoc/xbot/common/networking/MockZeromqListener.html new file mode 100644 index 00000000..52626e7a --- /dev/null +++ b/javadoc/xbot/common/networking/MockZeromqListener.html @@ -0,0 +1,380 @@ + + + + + +MockZeromqListener (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.networking
    +

    Class MockZeromqListener

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.networking.MockZeromqListener
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MockZeromqListener

          +
          @AssistedInject
+public MockZeromqListener​(@Assisted("connectionString")
+                          java.lang.String connectionString,
+                          @Assisted("topic")
+                          java.lang.String topic)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          setNewPacketHandler

          +
          public void setNewPacketHandler​(java.util.function.Consumer<java.lang.String> handler)
          +
          +
          Specified by:
          +
          setNewPacketHandler in interface XZeromqListener
          +
          +
          • +
        + + + +
          +
        • +

          sendPacket

          +
          public void sendPacket​(java.lang.String packet)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/networking/XZeromqListener.XZeromqListenerFactory.html b/javadoc/xbot/common/networking/XZeromqListener.XZeromqListenerFactory.html new file mode 100644 index 00000000..4ba7ccf9 --- /dev/null +++ b/javadoc/xbot/common/networking/XZeromqListener.XZeromqListenerFactory.html @@ -0,0 +1,258 @@ + + + + + +XZeromqListener.XZeromqListenerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.networking
    +

    Interface XZeromqListener.XZeromqListenerFactory

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          XZeromqListener create​(java.lang.String connectionString,
+                       java.lang.String topic)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/networking/XZeromqListener.html b/javadoc/xbot/common/networking/XZeromqListener.html new file mode 100644 index 00000000..52b2791b --- /dev/null +++ b/javadoc/xbot/common/networking/XZeromqListener.html @@ -0,0 +1,289 @@ + + + + + +XZeromqListener (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.networking
    +

    Interface XZeromqListener

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          start

          +
          void start()
          +
          • +
        + + + +
          +
        • +

          setNewPacketHandler

          +
          void setNewPacketHandler​(java.util.function.Consumer<java.lang.String> handler)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/networking/ZeromqListener.ZeromqListenerFactory.html b/javadoc/xbot/common/networking/ZeromqListener.ZeromqListenerFactory.html new file mode 100644 index 00000000..1f0a6bbb --- /dev/null +++ b/javadoc/xbot/common/networking/ZeromqListener.ZeromqListenerFactory.html @@ -0,0 +1,322 @@ + + + + + +ZeromqListener.ZeromqListenerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.networking
    +

    Class ZeromqListener.ZeromqListenerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.networking.ZeromqListener.ZeromqListenerFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract ZeromqListenercreate​(java.lang.String connectionString, + java.lang.String topic) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ZeromqListenerFactory

          +
          public ZeromqListenerFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/networking/ZeromqListener.html b/javadoc/xbot/common/networking/ZeromqListener.html new file mode 100644 index 00000000..ed69885e --- /dev/null +++ b/javadoc/xbot/common/networking/ZeromqListener.html @@ -0,0 +1,395 @@ + + + + + +ZeromqListener (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.networking
    +

    Class ZeromqListener

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.networking.ZeromqListener
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ZeromqListener​(java.lang.String connectionString, + java.lang.String topic) +
        This is the wrapper class for the actual ZeroMQ subscriber, based on + http://zguide.zeromq.org/java:wuclient and our 2017 ethernet implementation.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidsetNewPacketHandler​(java.util.function.Consumer<java.lang.String> handler) 
        voidstart() 
        voidstop() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ZeromqListener

          +
          @AssistedInject
+public ZeromqListener​(@Assisted("connectionString")
+                      java.lang.String connectionString,
+                      @Assisted("topic")
+                      java.lang.String topic)
          +
          This is the wrapper class for the actual ZeroMQ subscriber, based on + http://zguide.zeromq.org/java:wuclient and our 2017 ethernet implementation. + It represents the Subscriber half of the Publisher/Subscriber 0MQ model, + reading packets as strings.
          +
          +
          Parameters:
          +
          connectionString - Typically something like "tcp://localhost:5556"; read + the ZeroMQ documentation.
          +
          topic - Will filter to messages beginning with this topic. + Empty string will read all messages posted ot the + given connectionString.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          stop

          +
          public void stop()
          +
          • +
        + + + +
          +
        • +

          setNewPacketHandler

          +
          public void setNewPacketHandler​(java.util.function.Consumer<java.lang.String> handler)
          +
          +
          Specified by:
          +
          setNewPacketHandler in interface XZeromqListener
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/networking/package-summary.html b/javadoc/xbot/common/networking/package-summary.html new file mode 100644 index 00000000..eacc4257 --- /dev/null +++ b/javadoc/xbot/common/networking/package-summary.html @@ -0,0 +1,195 @@ + + + + + +xbot.common.networking (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.networking

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/networking/package-tree.html b/javadoc/xbot/common/networking/package-tree.html new file mode 100644 index 00000000..8eda1efc --- /dev/null +++ b/javadoc/xbot/common/networking/package-tree.html @@ -0,0 +1,171 @@ + + + + + +xbot.common.networking Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.networking

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/properties/BooleanProperty.html b/javadoc/xbot/common/properties/BooleanProperty.html new file mode 100644 index 00000000..8b92d731 --- /dev/null +++ b/javadoc/xbot/common/properties/BooleanProperty.html @@ -0,0 +1,481 @@ + + + + + +BooleanProperty (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class BooleanProperty

    +
    +
    + +
    +
      +
    • +
      +
      public class BooleanProperty
+extends Property
      +
      A property holding a boolean value.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          get

          +
          public boolean get()
          +
          +
          Returns:
          +
          the current boolean value
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(boolean value)
          +
          +
          Parameters:
          +
          value - the value to set
          +
          +
          • +
        + + + +
          +
        • +

          save

          +
          public void save()
          +
          Saves the value permanently (presumably to the Robot).
          +
          +
          Specified by:
          +
          save in class Property
          +
          +
          • +
        + + + +
          +
        • +

          load

          +
          public void load()
          +
          Load the boolean value from the permanent store.
          +
          +
          Specified by:
          +
          load in class Property
          +
          +
          • +
        + + + +
          +
        • +

          isSetToDefault

          +
          public boolean isSetToDefault()
          +
          Description copied from class: Property
          +
          Checks if the property's current value matches the default.
          +
          +
          Specified by:
          +
          isSetToDefault in class Property
          +
          Returns:
          +
          True if the current value is the default.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/ConfigurePropertiesCommand.html b/javadoc/xbot/common/properties/ConfigurePropertiesCommand.html new file mode 100644 index 00000000..e65d04bf --- /dev/null +++ b/javadoc/xbot/common/properties/ConfigurePropertiesCommand.html @@ -0,0 +1,455 @@ + + + + + +ConfigurePropertiesCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class ConfigurePropertiesCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public class ConfigurePropertiesCommand
+extends BaseCommand
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute() 
        voidinitialize() 
        booleanisFinished() 
        booleanrunsWhenDisabled() 
        voidsetFastMode​(boolean on) 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ConfigurePropertiesCommand

          +
          @Inject
+public ConfigurePropertiesCommand​(ITableProxy table)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          runsWhenDisabled

          +
          public boolean runsWhenDisabled()
          +
          +
          Specified by:
          +
          runsWhenDisabled in interface edu.wpi.first.wpilibj2.command.Command
          +
          Overrides:
          +
          runsWhenDisabled in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          setFastMode

          +
          public void setFastMode​(boolean on)
          +
          • +
        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          initialize in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/DatabaseStorageBase.html b/javadoc/xbot/common/properties/DatabaseStorageBase.html new file mode 100644 index 00000000..a6ac72d4 --- /dev/null +++ b/javadoc/xbot/common/properties/DatabaseStorageBase.html @@ -0,0 +1,448 @@ + + + + + +DatabaseStorageBase (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class DatabaseStorageBase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.properties.DatabaseStorageBase
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        DatabaseStorageBase​(java.lang.String databaseDirectory) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidclear() 
        java.lang.BooleangetBoolean​(java.lang.String key) 
        java.lang.DoublegetDouble​(java.lang.String key) 
        java.lang.StringgetString​(java.lang.String key) 
        booleanobliterateStorage() 
        voidsetBoolean​(java.lang.String key, + boolean value) 
        voidsetDouble​(java.lang.String key, + double value) 
        voidsetString​(java.lang.String key, + java.lang.String value) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          DatabaseStorageBase

          +
          public DatabaseStorageBase​(java.lang.String databaseDirectory)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setDouble

          +
          public void setDouble​(java.lang.String key,
+                      double value)
          +
          +
          Specified by:
          +
          setDouble in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setBoolean

          +
          public void setBoolean​(java.lang.String key,
+                       boolean value)
          +
          +
          Specified by:
          +
          setBoolean in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setString

          +
          public void setString​(java.lang.String key,
+                      java.lang.String value)
          +
          +
          Specified by:
          +
          setString in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getDouble

          +
          public java.lang.Double getDouble​(java.lang.String key)
          +
          +
          Specified by:
          +
          getDouble in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getBoolean

          +
          public java.lang.Boolean getBoolean​(java.lang.String key)
          +
          +
          Specified by:
          +
          getBoolean in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getString

          +
          public java.lang.String getString​(java.lang.String key)
          +
          +
          Specified by:
          +
          getString in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          clear

          +
          public void clear()
          +
          +
          Specified by:
          +
          clear in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          obliterateStorage

          +
          public boolean obliterateStorage()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/DebugFlag.html b/javadoc/xbot/common/properties/DebugFlag.html new file mode 100644 index 00000000..694e1958 --- /dev/null +++ b/javadoc/xbot/common/properties/DebugFlag.html @@ -0,0 +1,319 @@ + + + + + +DebugFlag (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class DebugFlag

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.properties.DebugFlag
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Singleton
+public class DebugFlag
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        DebugFlag() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanisDebug() 
        voidsetDebug​(boolean debug) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          DebugFlag

          +
          public DebugFlag()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setDebug

          +
          public void setDebug​(boolean debug)
          +
          • +
        + + + +
          +
        • +

          isDebug

          +
          public boolean isDebug()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/DoubleProperty.html b/javadoc/xbot/common/properties/DoubleProperty.html new file mode 100644 index 00000000..989ab004 --- /dev/null +++ b/javadoc/xbot/common/properties/DoubleProperty.html @@ -0,0 +1,484 @@ + + + + + +DoubleProperty (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class DoubleProperty

    +
    +
    + +
    +
      +
    • +
      +
      public class DoubleProperty
+extends Property
      +
      This manages a double in the property system.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          get

          +
          public double get()
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(double value)
          +
          • +
        + + + +
          +
        • +

          save

          +
          public void save()
          +
          We only save the property if it's from a persistent type
          +
          +
          Specified by:
          +
          save in class Property
          +
          +
          • +
        + + + +
          +
        • +

          load

          +
          public void load()
          +
          Description copied from class: Property
          +
          Load the property from storage. This shouldn't happen very often (I/O is + expensive).
          +
          +
          Specified by:
          +
          load in class Property
          +
          +
          • +
        + + + +
          +
        • +

          hasChangedSinceLastCheck

          +
          public void hasChangedSinceLastCheck​(java.util.function.Consumer<java.lang.Double> callback)
          +
          • +
        + + + +
          +
        • +

          isSetToDefault

          +
          public boolean isSetToDefault()
          +
          Description copied from class: Property
          +
          Checks if the property's current value matches the default.
          +
          +
          Specified by:
          +
          isSetToDefault in class Property
          +
          Returns:
          +
          True if the current value is the default.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/IPropertySupport.html b/javadoc/xbot/common/properties/IPropertySupport.html new file mode 100644 index 00000000..8b5610f3 --- /dev/null +++ b/javadoc/xbot/common/properties/IPropertySupport.html @@ -0,0 +1,252 @@ + + + + + +IPropertySupport (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Interface IPropertySupport

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPrefix

          +
          java.lang.String getPrefix()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/properties/ITableProxy.html b/javadoc/xbot/common/properties/ITableProxy.html new file mode 100644 index 00000000..0363c112 --- /dev/null +++ b/javadoc/xbot/common/properties/ITableProxy.html @@ -0,0 +1,376 @@ + + + + + +ITableProxy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Interface ITableProxy

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        voidclear() 
        java.lang.BooleangetBoolean​(java.lang.String key) 
        java.lang.DoublegetDouble​(java.lang.String key) 
        java.lang.StringgetString​(java.lang.String key) 
        voidremove​(java.lang.String key) 
        voidsetBoolean​(java.lang.String key, + boolean value) 
        voidsetDouble​(java.lang.String key, + double value) 
        voidsetFastMode​(boolean on) 
        voidsetString​(java.lang.String key, + java.lang.String value) 
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setDouble

          +
          void setDouble​(java.lang.String key,
+               double value)
          +
          • +
        + + + +
          +
        • +

          setBoolean

          +
          void setBoolean​(java.lang.String key,
+                boolean value)
          +
          • +
        + + + +
          +
        • +

          setString

          +
          void setString​(java.lang.String key,
+               java.lang.String value)
          +
          • +
        + + + +
          +
        • +

          getDouble

          +
          java.lang.Double getDouble​(java.lang.String key)
          +
          • +
        + + + +
          +
        • +

          getBoolean

          +
          java.lang.Boolean getBoolean​(java.lang.String key)
          +
          • +
        + + + +
          +
        • +

          getString

          +
          java.lang.String getString​(java.lang.String key)
          +
          • +
        + + + +
          +
        • +

          clear

          +
          void clear()
          +
          • +
        + + + +
          +
        • +

          setFastMode

          +
          void setFastMode​(boolean on)
          +
          • +
        + + + +
          +
        • +

          remove

          +
          void remove​(java.lang.String key)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/properties/MockPermamentStorage.html b/javadoc/xbot/common/properties/MockPermamentStorage.html new file mode 100644 index 00000000..4d3206ec --- /dev/null +++ b/javadoc/xbot/common/properties/MockPermamentStorage.html @@ -0,0 +1,309 @@ + + + + + +MockPermamentStorage (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class MockPermamentStorage

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MockPermamentStorage

          +
          @Inject
+public MockPermamentStorage()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/PermanentStorage.html b/javadoc/xbot/common/properties/PermanentStorage.html new file mode 100644 index 00000000..ab797225 --- /dev/null +++ b/javadoc/xbot/common/properties/PermanentStorage.html @@ -0,0 +1,220 @@ + + + + + +PermanentStorage (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Interface PermanentStorage

    +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/properties/PreferenceStorage.html b/javadoc/xbot/common/properties/PreferenceStorage.html new file mode 100644 index 00000000..df246f7d --- /dev/null +++ b/javadoc/xbot/common/properties/PreferenceStorage.html @@ -0,0 +1,507 @@ + + + + + +PreferenceStorage (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class PreferenceStorage

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.properties.PreferenceStorage
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected static org.apache.log4j.Loggerlog 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        PreferenceStorage() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidclear() 
        java.lang.BooleangetBoolean​(java.lang.String key) 
        java.lang.DoublegetDouble​(java.lang.String key) 
        java.lang.StringgetString​(java.lang.String key) 
        voidremove​(java.lang.String key) 
        voidsetBoolean​(java.lang.String key, + boolean value) 
        voidsetDouble​(java.lang.String key, + double value) 
        voidsetFastMode​(boolean on) 
        voidsetString​(java.lang.String key, + java.lang.String value) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          log

          +
          protected static org.apache.log4j.Logger log
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PreferenceStorage

          +
          @Inject
+public PreferenceStorage()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setDouble

          +
          public void setDouble​(java.lang.String key,
+                      double value)
          +
          +
          Specified by:
          +
          setDouble in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setBoolean

          +
          public void setBoolean​(java.lang.String key,
+                       boolean value)
          +
          +
          Specified by:
          +
          setBoolean in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setString

          +
          public void setString​(java.lang.String key,
+                      java.lang.String value)
          +
          +
          Specified by:
          +
          setString in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getDouble

          +
          public java.lang.Double getDouble​(java.lang.String key)
          +
          +
          Specified by:
          +
          getDouble in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getBoolean

          +
          public java.lang.Boolean getBoolean​(java.lang.String key)
          +
          +
          Specified by:
          +
          getBoolean in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getString

          +
          public java.lang.String getString​(java.lang.String key)
          +
          +
          Specified by:
          +
          getString in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          clear

          +
          public void clear()
          +
          +
          Specified by:
          +
          clear in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setFastMode

          +
          public void setFastMode​(boolean on)
          +
          +
          Specified by:
          +
          setFastMode in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          remove

          +
          public void remove​(java.lang.String key)
          +
          +
          Specified by:
          +
          remove in interface ITableProxy
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/Property.PropertyLevel.html b/javadoc/xbot/common/properties/Property.PropertyLevel.html new file mode 100644 index 00000000..e9c8785f --- /dev/null +++ b/javadoc/xbot/common/properties/Property.PropertyLevel.html @@ -0,0 +1,380 @@ + + + + + +Property.PropertyLevel (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Enum Property.PropertyLevel

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        Debug 
        Important 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static Property.PropertyLevelvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static Property.PropertyLevel[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Property.PropertyLevel[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Property.PropertyLevel c : Property.PropertyLevel.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Property.PropertyLevel valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/Property.PropertyPersistenceType.html b/javadoc/xbot/common/properties/Property.PropertyPersistenceType.html new file mode 100644 index 00000000..03003402 --- /dev/null +++ b/javadoc/xbot/common/properties/Property.PropertyPersistenceType.html @@ -0,0 +1,383 @@ + + + + + +Property.PropertyPersistenceType (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Enum Property.PropertyPersistenceType

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<Property.PropertyPersistenceType>
      +
      +
      +
      Enclosing class:
      +
      Property
      +
      +
      +
      public static enum Property.PropertyPersistenceType
+extends java.lang.Enum<Property.PropertyPersistenceType>
      +
      New enum to determine property persistence + Ephemeral properties will not be saved or load from a persistent storage + Persistent properties will be saved and load from a persistent storage
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        Ephemeral 
        Persistent 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static Property.PropertyPersistenceTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static Property.PropertyPersistenceType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Property.PropertyPersistenceType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Property.PropertyPersistenceType c : Property.PropertyPersistenceType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Property.PropertyPersistenceType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/Property.html b/javadoc/xbot/common/properties/Property.html new file mode 100644 index 00000000..526430d7 --- /dev/null +++ b/javadoc/xbot/common/properties/Property.html @@ -0,0 +1,523 @@ + + + + + +Property (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class Property

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.properties.Property
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      BooleanProperty, DoubleProperty, StringProperty
      +
      +
      +
      public abstract class Property
+extends java.lang.Object
      +
      There are many values on the robot that we want to configure on the fly as + well as persist once we're happy with the result. We call these Properties. + They can be read/written to rapidly using a RandomAccessStore, and know how + to save themselves to PermanentStorage when a save is necessary.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + + + + + +
          +
        • +

          Property

          +
          public Property​(java.lang.String key,
+                XPropertyManager manager,
+                Property.PropertyPersistenceType persistenceType)
          +
          The name of the property. This should be unique unless you really know + what you're doing. + New builder with persistence type. Old builder will be deprecated.
          +
          • +
        + + + +
          +
        • +

          Property

          +
          public Property​(java.lang.String key,
+                XPropertyManager manager)
          +
          The name of the property. This should be unique unless you really know + what you're doing.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          save

          +
          public abstract void save()
          +
          Save the property permanently. This shouldn't happen very often (I/O is + expensive).
          +
          • +
        + + + +
          +
        • +

          load

          +
          public abstract void load()
          +
          Load the property from storage. This shouldn't happen very often (I/O is + expensive).
          +
          • +
        + + + +
          +
        • +

          isSetToDefault

          +
          public abstract boolean isSetToDefault()
          +
          Checks if the property's current value matches the default.
          +
          +
          Returns:
          +
          True if the current value is the default.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/PropertyFactory.html b/javadoc/xbot/common/properties/PropertyFactory.html new file mode 100644 index 00000000..7bf59942 --- /dev/null +++ b/javadoc/xbot/common/properties/PropertyFactory.html @@ -0,0 +1,630 @@ + + + + + +PropertyFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class PropertyFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.properties.PropertyFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class PropertyFactory
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          log

          +
          protected org.apache.log4j.Logger log
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setPrefix

          +
          public void setPrefix​(java.lang.String prefix)
          +
          • +
        + + + + + + + +
          +
        • +

          appendPrefix

          +
          public void appendPrefix​(java.lang.String toAppend)
          +
          • +
        + + + +
          +
        • +

          setTopLevelPrefix

          +
          public void setTopLevelPrefix()
          +
          • +
        + + + +
          +
        • +

          getPrefix

          +
          public java.lang.String getPrefix()
          +
          • +
        + + + +
          +
        • +

          createFullKey

          +
          public java.lang.String createFullKey​(java.lang.String key)
          +
          • +
        + + + + + + + +
          +
        • +

          createEphemeralProperty

          +
          public BooleanProperty createEphemeralProperty​(java.lang.String key,
+                                               boolean defaultValue)
          +
          Method for creating a boolean ephemeral property
          +
          • +
        + + + +
          +
        • +

          createEphemeralProperty

          +
          public BooleanProperty createEphemeralProperty​(java.lang.String key,
+                                               boolean defaultValue,
+                                               Property.PropertyLevel level)
          +
          Method for creating a boolean ephemeral property
          +
          • +
        + + + +
          +
        • +

          createEphemeralProperty

          +
          public StringProperty createEphemeralProperty​(java.lang.String key,
+                                              java.lang.String defaultValue,
+                                              Property.PropertyLevel level)
          +
          Method for creating a string ephemeral property
          +
          • +
        + + + +
          +
        • +

          createEphemeralProperty

          +
          public StringProperty createEphemeralProperty​(java.lang.String key,
+                                              java.lang.String defaultValue)
          +
          Method for creating a string ephemeral property
          +
          • +
        + + + +
          +
        • +

          createEphemeralProperty

          +
          public DoubleProperty createEphemeralProperty​(java.lang.String key,
+                                              double defaultValue)
          +
          Method for creating a double ephemeral property
          +
          • +
        + + + +
          +
        • +

          createEphemeralProperty

          +
          public DoubleProperty createEphemeralProperty​(java.lang.String key,
+                                              double defaultValue,
+                                              Property.PropertyLevel level)
          +
          Method for creating a double ephemeral property
          +
          • +
        + + + +
          +
        • +

          createPersistentProperty

          +
          public BooleanProperty createPersistentProperty​(java.lang.String key,
+                                                boolean defaultValue)
          +
          Method for creating a double persistent property
          +
          • +
        + + + +
          +
        • +

          createPersistentProperty

          +
          public BooleanProperty createPersistentProperty​(java.lang.String key,
+                                                boolean defaultValue,
+                                                Property.PropertyLevel level)
          +
          Method for creating a double persistent property
          +
          • +
        + + + +
          +
        • +

          createPersistentProperty

          +
          public StringProperty createPersistentProperty​(java.lang.String key,
+                                               java.lang.String defaultValue)
          +
          Method for creating a double persistent property
          +
          • +
        + + + +
          +
        • +

          createPersistentProperty

          +
          public StringProperty createPersistentProperty​(java.lang.String key,
+                                               java.lang.String defaultValue,
+                                               Property.PropertyLevel level)
          +
          Method for creating a double persistent property
          +
          • +
        + + + +
          +
        • +

          createPersistentProperty

          +
          public DoubleProperty createPersistentProperty​(java.lang.String key,
+                                               double defaultValue)
          +
          Method for creating a double persistent property
          +
          • +
        + + + +
          +
        • +

          createPersistentProperty

          +
          public DoubleProperty createPersistentProperty​(java.lang.String key,
+                                               double defaultValue,
+                                               Property.PropertyLevel level)
          +
          Method for creating a double persistent property
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/SmartDashboardTableWrapper.html b/javadoc/xbot/common/properties/SmartDashboardTableWrapper.html new file mode 100644 index 00000000..ae8087d7 --- /dev/null +++ b/javadoc/xbot/common/properties/SmartDashboardTableWrapper.html @@ -0,0 +1,465 @@ + + + + + +SmartDashboardTableWrapper (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class SmartDashboardTableWrapper

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.properties.SmartDashboardTableWrapper
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ITableProxy
      +
      +
      +
      @Singleton
+public class SmartDashboardTableWrapper
+extends java.lang.Object
+implements ITableProxy
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidclear() 
        java.lang.BooleangetBoolean​(java.lang.String key) 
        java.lang.DoublegetDouble​(java.lang.String key) 
        java.lang.StringgetString​(java.lang.String key) 
        voidremove​(java.lang.String key) 
        voidsetBoolean​(java.lang.String key, + boolean value) 
        voidsetDouble​(java.lang.String key, + double value) 
        voidsetFastMode​(boolean on) 
        voidsetString​(java.lang.String key, + java.lang.String value) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          SmartDashboardTableWrapper

          +
          @Inject
+public SmartDashboardTableWrapper()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setDouble

          +
          public void setDouble​(java.lang.String key,
+                      double value)
          +
          +
          Specified by:
          +
          setDouble in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          clear

          +
          public void clear()
          +
          +
          Specified by:
          +
          clear in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getDouble

          +
          public java.lang.Double getDouble​(java.lang.String key)
          +
          +
          Specified by:
          +
          getDouble in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setBoolean

          +
          public void setBoolean​(java.lang.String key,
+                       boolean value)
          +
          +
          Specified by:
          +
          setBoolean in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getBoolean

          +
          public java.lang.Boolean getBoolean​(java.lang.String key)
          +
          +
          Specified by:
          +
          getBoolean in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setString

          +
          public void setString​(java.lang.String key,
+                      java.lang.String value)
          +
          +
          Specified by:
          +
          setString in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getString

          +
          public java.lang.String getString​(java.lang.String key)
          +
          +
          Specified by:
          +
          getString in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setFastMode

          +
          public void setFastMode​(boolean on)
          +
          +
          Specified by:
          +
          setFastMode in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          remove

          +
          public void remove​(java.lang.String key)
          +
          +
          Specified by:
          +
          remove in interface ITableProxy
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/StringProperty.html b/javadoc/xbot/common/properties/StringProperty.html new file mode 100644 index 00000000..5d874e33 --- /dev/null +++ b/javadoc/xbot/common/properties/StringProperty.html @@ -0,0 +1,470 @@ + + + + + +StringProperty (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class StringProperty

    +
    +
    + +
    +
      +
    • +
      +
      public class StringProperty
+extends Property
      +
      A type of Property that manages a String value.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          get

          +
          public java.lang.String get()
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(java.lang.String value)
          +
          • +
        + + + +
          +
        • +

          save

          +
          public void save()
          +
          We only save the property if it's from a persistent type
          +
          +
          Specified by:
          +
          save in class Property
          +
          +
          • +
        + + + +
          +
        • +

          load

          +
          public void load()
          +
          Description copied from class: Property
          +
          Load the property from storage. This shouldn't happen very often (I/O is + expensive).
          +
          +
          Specified by:
          +
          load in class Property
          +
          +
          • +
        + + + +
          +
        • +

          isSetToDefault

          +
          public boolean isSetToDefault()
          +
          Description copied from class: Property
          +
          Checks if the property's current value matches the default.
          +
          +
          Specified by:
          +
          isSetToDefault in class Property
          +
          Returns:
          +
          True if the current value is the default.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/TableProxy.html b/javadoc/xbot/common/properties/TableProxy.html new file mode 100644 index 00000000..50455a02 --- /dev/null +++ b/javadoc/xbot/common/properties/TableProxy.html @@ -0,0 +1,511 @@ + + + + + +TableProxy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class TableProxy

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.properties.TableProxy
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        java.util.Hashtable<java.lang.String,​java.lang.String>table 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        TableProxy() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidclear() 
        java.lang.BooleangetBoolean​(java.lang.String key) 
        java.lang.DoublegetDouble​(java.lang.String key) 
        java.lang.StringgetString​(java.lang.String key) 
        voidremove​(java.lang.String key) 
        voidsetBoolean​(java.lang.String key, + boolean value) 
        voidsetDouble​(java.lang.String key, + double value) 
        voidsetFastMode​(boolean on) 
        voidsetString​(java.lang.String key, + java.lang.String value) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          table

          +
          public java.util.Hashtable<java.lang.String,​java.lang.String> table
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TableProxy

          +
          @Inject
+public TableProxy()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          clear

          +
          public void clear()
          +
          +
          Specified by:
          +
          clear in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setDouble

          +
          public void setDouble​(java.lang.String key,
+                      double value)
          +
          +
          Specified by:
          +
          setDouble in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getDouble

          +
          public java.lang.Double getDouble​(java.lang.String key)
          +
          +
          Specified by:
          +
          getDouble in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setBoolean

          +
          public void setBoolean​(java.lang.String key,
+                       boolean value)
          +
          +
          Specified by:
          +
          setBoolean in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getBoolean

          +
          public java.lang.Boolean getBoolean​(java.lang.String key)
          +
          +
          Specified by:
          +
          getBoolean in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setString

          +
          public void setString​(java.lang.String key,
+                      java.lang.String value)
          +
          +
          Specified by:
          +
          setString in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          getString

          +
          public java.lang.String getString​(java.lang.String key)
          +
          +
          Specified by:
          +
          getString in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          setFastMode

          +
          public void setFastMode​(boolean on)
          +
          +
          Specified by:
          +
          setFastMode in interface ITableProxy
          +
          +
          • +
        + + + +
          +
        • +

          remove

          +
          public void remove​(java.lang.String key)
          +
          +
          Specified by:
          +
          remove in interface ITableProxy
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/XPropertyManager.html b/javadoc/xbot/common/properties/XPropertyManager.html new file mode 100644 index 00000000..ccf48188 --- /dev/null +++ b/javadoc/xbot/common/properties/XPropertyManager.html @@ -0,0 +1,453 @@ + + + + + +XPropertyManager (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.properties
    +

    Class XPropertyManager

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.properties.XPropertyManager
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Singleton
+public class XPropertyManager
+extends java.lang.Object
      +
      The PropertyManager keeps track of all properties in CoreCode. All properties are implicitly added into its storage. + It is capable of loading or saving all properties via permanentStorage, and getting updates to these properties via + the RandomAccessStore.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          IN_MEMORY_STORE_NAME

          +
          public static final java.lang.String IN_MEMORY_STORE_NAME
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          properties

          +
          public final java.util.ArrayList<Property> properties
          +
          • +
        + + + + + + + +
          +
        • +

          randomAccessStore

          +
          public final ITableProxy randomAccessStore
          +
          • +
        + + + +
          +
        • +

          inMemoryRandomAccessStore

          +
          public final ITableProxy inMemoryRandomAccessStore
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XPropertyManager

          +
          @Inject
+public XPropertyManager​(PermanentStorage permanentStore,
+                        ITableProxy randomAccessStore,
+                        @Named("InMemoryStore")
+                        ITableProxy inMemoryRandomAccessStore)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          registerProperty

          +
          public void registerProperty​(Property property)
          +
          Adds the property to the local collection.
          +
          • +
        + + + +
          +
        • +

          loadPropertiesFromStorage

          +
          public void loadPropertiesFromStorage()
          +
          Loads all properties from storage into the PermanentStore's table.
          +
          • +
        + + + +
          +
        • +

          saveOutAllProperties

          +
          public void saveOutAllProperties()
          +
          Save all properties into permanent storage.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/properties/package-summary.html b/javadoc/xbot/common/properties/package-summary.html new file mode 100644 index 00000000..caf3deb2 --- /dev/null +++ b/javadoc/xbot/common/properties/package-summary.html @@ -0,0 +1,274 @@ + + + + + +xbot.common.properties (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.properties

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/properties/package-tree.html b/javadoc/xbot/common/properties/package-tree.html new file mode 100644 index 00000000..25749128 --- /dev/null +++ b/javadoc/xbot/common/properties/package-tree.html @@ -0,0 +1,213 @@ + + + + + +xbot.common.properties Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.properties

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/resiliency/DeviceHealth.html b/javadoc/xbot/common/resiliency/DeviceHealth.html new file mode 100644 index 00000000..b9df7d7d --- /dev/null +++ b/javadoc/xbot/common/resiliency/DeviceHealth.html @@ -0,0 +1,376 @@ + + + + + +DeviceHealth (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.resiliency
    +

    Enum DeviceHealth

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<DeviceHealth>
        • +
      • +
          +
        • xbot.common.resiliency.DeviceHealth
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<DeviceHealth>
      +
      +
      +
      public enum DeviceHealth
+extends java.lang.Enum<DeviceHealth>
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        Healthy 
        Unhealthy 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static DeviceHealthvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static DeviceHealth[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static DeviceHealth[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (DeviceHealth c : DeviceHealth.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static DeviceHealth valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/resiliency/package-summary.html b/javadoc/xbot/common/resiliency/package-summary.html new file mode 100644 index 00000000..3f0ee896 --- /dev/null +++ b/javadoc/xbot/common/resiliency/package-summary.html @@ -0,0 +1,164 @@ + + + + + +xbot.common.resiliency (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.resiliency

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      DeviceHealth 
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/resiliency/package-tree.html b/javadoc/xbot/common/resiliency/package-tree.html new file mode 100644 index 00000000..26ed11e0 --- /dev/null +++ b/javadoc/xbot/common/resiliency/package-tree.html @@ -0,0 +1,165 @@ + + + + + +xbot.common.resiliency Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.resiliency

    +Package Hierarchies: + +
    +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/simulation/BaseSimulationTest.html b/javadoc/xbot/common/simulation/BaseSimulationTest.html new file mode 100644 index 00000000..db738d8a --- /dev/null +++ b/javadoc/xbot/common/simulation/BaseSimulationTest.html @@ -0,0 +1,418 @@ + + + + + +BaseSimulationTest (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.simulation
    +

    Class BaseSimulationTest

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.simulation.BaseSimulationTest
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class BaseSimulationTest
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BaseSimulationTest

          +
          public BaseSimulationTest()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setUp

          +
          public void setUp()
          +
          • +
        + + + +
          +
        • +

          createSimpleSensorPayload

          +
          protected org.json.JSONObject createSimpleSensorPayload​(java.lang.String id,
+                                                        org.json.JSONObject keysAndValues)
          +
          • +
        + + + +
          +
        • +

          createSimpleWorldPosePayload

          +
          protected org.json.JSONObject createSimpleWorldPosePayload​(org.json.JSONObject keysAndValues)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/simulation/ISimulatableMotor.html b/javadoc/xbot/common/simulation/ISimulatableMotor.html new file mode 100644 index 00000000..8cbe45a5 --- /dev/null +++ b/javadoc/xbot/common/simulation/ISimulatableMotor.html @@ -0,0 +1,268 @@ + + + + + +ISimulatableMotor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.simulation
    +

    Interface ISimulatableMotor

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSimulationData

          +
          org.json.JSONObject getSimulationData()
          +
          • +
        + + + +
          +
        • +

          buildMotorObject

          +
          default org.json.JSONObject buildMotorObject​(java.lang.String name,
+                                             float value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/simulation/ISimulatableSensor.html b/javadoc/xbot/common/simulation/ISimulatableSensor.html new file mode 100644 index 00000000..0d803957 --- /dev/null +++ b/javadoc/xbot/common/simulation/ISimulatableSensor.html @@ -0,0 +1,252 @@ + + + + + +ISimulatableSensor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.simulation
    +

    Interface ISimulatableSensor

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          ingestSimulationData

          +
          void ingestSimulationData​(org.json.JSONObject payload)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/simulation/ISimulatableSolenoid.html b/javadoc/xbot/common/simulation/ISimulatableSolenoid.html new file mode 100644 index 00000000..66cc99de --- /dev/null +++ b/javadoc/xbot/common/simulation/ISimulatableSolenoid.html @@ -0,0 +1,314 @@ + + + + + +ISimulatableSolenoid (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.simulation
    +

    Interface ISimulatableSolenoid

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      MockSolenoid
      +
      +
      +
      public interface ISimulatableSolenoid
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          SOLENOID_POWER_MODE

          +
          static final java.lang.String SOLENOID_POWER_MODE
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSimulationData

          +
          org.json.JSONObject getSimulationData()
          +
          • +
        + + + +
          +
        • +

          buildMotorObject

          +
          default org.json.JSONObject buildMotorObject​(int channel,
+                                             boolean isOn)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/simulation/ResetSimulatorPositionCommand.html b/javadoc/xbot/common/simulation/ResetSimulatorPositionCommand.html new file mode 100644 index 00000000..85eccbfe --- /dev/null +++ b/javadoc/xbot/common/simulation/ResetSimulatorPositionCommand.html @@ -0,0 +1,439 @@ + + + + + +ResetSimulatorPositionCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.simulation
    +

    Class ResetSimulatorPositionCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public class ResetSimulatorPositionCommand
+extends BaseCommand
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute() 
        voidinitialize() 
        booleanisFinished() 
        voidsetTargetPose​(FieldPose p) 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setTargetPose

          +
          public void setTargetPose​(FieldPose p)
          +
          • +
        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          initialize in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/simulation/SimulationPayloadDistributor.html b/javadoc/xbot/common/simulation/SimulationPayloadDistributor.html new file mode 100644 index 00000000..27aba106 --- /dev/null +++ b/javadoc/xbot/common/simulation/SimulationPayloadDistributor.html @@ -0,0 +1,315 @@ + + + + + +SimulationPayloadDistributor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.simulation
    +

    Class SimulationPayloadDistributor

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.simulation.SimulationPayloadDistributor
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Singleton
+public class SimulationPayloadDistributor
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voiddistributeSimulationPayload​(org.json.JSONObject allSensorsPayload) +
        Fans out data from a simulation (like Webots) to all the simulatable devices registered on the robot.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          distributeSimulationPayload

          +
          public void distributeSimulationPayload​(org.json.JSONObject allSensorsPayload)
          +
          Fans out data from a simulation (like Webots) to all the simulatable devices registered on the robot.
          +
          +
          Parameters:
          +
          allSensorsPayload - The JSON sensor payload, containing all sensor data from the simulation environment
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/simulation/WebotsClient.html b/javadoc/xbot/common/simulation/WebotsClient.html new file mode 100644 index 00000000..4fc5ddea --- /dev/null +++ b/javadoc/xbot/common/simulation/WebotsClient.html @@ -0,0 +1,457 @@ + + + + + +WebotsClient (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.simulation
    +

    Class WebotsClient

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.simulation.WebotsClient
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Singleton
+public class WebotsClient
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voiddrawArrow​(java.lang.String name, + XYPair point1, + XYPair point2, + edu.wpi.first.wpilibj.util.Color color, + float zIndex) 
        voiddrawCircle​(java.lang.String name, + XYPair center, + float radius, + edu.wpi.first.wpilibj.util.Color color, + float zIndex) 
        voiddrawLine​(java.lang.String name, + XYPair point1, + XYPair point2, + edu.wpi.first.wpilibj.util.Color color, + float zIndex) 
        voidhandleSimulatorPose​(org.json.JSONObject worldPose) 
        voidinitialize() 
        voidresetPosition() 
        voidresetPosition​(double x, + double y, + double rotationInDegrees) 
        org.json.JSONObjectsendMotors​(java.util.List<org.json.JSONObject> motorValues) 
        voidsetFieldPoseOffset​(FieldPose offset) +
        In the case where the origin of the field doesn't match our traditional convention (with 0,0 + on the bottom-left vertex of the rectangular FRC field if viewed from above with your alliance + driver station at the bottom), then we need to shift X,Y coordinates to get everything to line up.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          WebotsClient

          +
          @Inject
+public WebotsClient​(PropertyFactory propertyFactory)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setFieldPoseOffset

          +
          public void setFieldPoseOffset​(FieldPose offset)
          +
          In the case where the origin of the field doesn't match our traditional convention (with 0,0 + on the bottom-left vertex of the rectangular FRC field if viewed from above with your alliance + driver station at the bottom), then we need to shift X,Y coordinates to get everything to line up.
          +
          +
          Parameters:
          +
          offset - A FieldPose that represents the bottom-left part of the field in Webots (in absolute inches)
          +
          +
          • +
        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          • +
        + + + +
          +
        • +

          sendMotors

          +
          public org.json.JSONObject sendMotors​(java.util.List<org.json.JSONObject> motorValues)
          +
          • +
        + + + +
          +
        • +

          handleSimulatorPose

          +
          public void handleSimulatorPose​(org.json.JSONObject worldPose)
          +
          • +
        + + + +
          +
        • +

          resetPosition

          +
          public void resetPosition()
          +
          • +
        + + + +
          +
        • +

          resetPosition

          +
          public void resetPosition​(double x,
+                          double y,
+                          double rotationInDegrees)
          +
          • +
        + + + +
          +
        • +

          drawLine

          +
          public void drawLine​(java.lang.String name,
+                     XYPair point1,
+                     XYPair point2,
+                     edu.wpi.first.wpilibj.util.Color color,
+                     float zIndex)
          +
          • +
        + + + +
          +
        • +

          drawArrow

          +
          public void drawArrow​(java.lang.String name,
+                      XYPair point1,
+                      XYPair point2,
+                      edu.wpi.first.wpilibj.util.Color color,
+                      float zIndex)
          +
          • +
        + + + +
          +
        • +

          drawCircle

          +
          public void drawCircle​(java.lang.String name,
+                       XYPair center,
+                       float radius,
+                       edu.wpi.first.wpilibj.util.Color color,
+                       float zIndex)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/simulation/package-summary.html b/javadoc/xbot/common/simulation/package-summary.html new file mode 100644 index 00000000..cbf7671e --- /dev/null +++ b/javadoc/xbot/common/simulation/package-summary.html @@ -0,0 +1,199 @@ + + + + + +xbot.common.simulation (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.simulation

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/simulation/package-tree.html b/javadoc/xbot/common/simulation/package-tree.html new file mode 100644 index 00000000..ef198d99 --- /dev/null +++ b/javadoc/xbot/common/simulation/package-tree.html @@ -0,0 +1,180 @@ + + + + + +xbot.common.simulation Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.simulation

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/subsystems/BaseXCANTalonPairSpeedControlledSubsystem.html b/javadoc/xbot/common/subsystems/BaseXCANTalonPairSpeedControlledSubsystem.html new file mode 100644 index 00000000..ecac43bd --- /dev/null +++ b/javadoc/xbot/common/subsystems/BaseXCANTalonPairSpeedControlledSubsystem.html @@ -0,0 +1,432 @@ + + + + + +BaseXCANTalonPairSpeedControlledSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems
    +

    Class BaseXCANTalonPairSpeedControlledSubsystem

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          followerMotor

          +
          protected XCANTalon followerMotor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BaseXCANTalonPairSpeedControlledSubsystem

          +
          public BaseXCANTalonPairSpeedControlledSubsystem​(java.lang.String name,
+                                                 int masterChannel,
+                                                 int followChannel,
+                                                 boolean invertMaster,
+                                                 boolean invertMasterSensor,
+                                                 boolean invertFollower,
+                                                 XCANTalon.XCANTalonFactory factory,
+                                                 PIDPropertyManager pidPropertyManager,
+                                                 PropertyFactory propManager)
          +
          +
          Parameters:
          +
          name - What the system is called. This will apply to various Properties.
          +
          masterChannel - The CAN index of the master motor (or the only motor, for a simple system)
          +
          followChannel - The CAN index of the follow motor (-1 if no follow motor)
          +
          factory - The WPIFactory
          +
          pidPropertyManager - The default PIDF values the system should use
          +
          propManager - The PropertyFactory
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          initializeFollowerMotorConfiguration

          +
          protected void initializeFollowerMotorConfiguration​(boolean motorInverted)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/BaseXCANTalonSpeedControlledSubsystem.html b/javadoc/xbot/common/subsystems/BaseXCANTalonSpeedControlledSubsystem.html new file mode 100644 index 00000000..c9e370bd --- /dev/null +++ b/javadoc/xbot/common/subsystems/BaseXCANTalonSpeedControlledSubsystem.html @@ -0,0 +1,669 @@ + + + + + +BaseXCANTalonSpeedControlledSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems
    +

    Class BaseXCANTalonSpeedControlledSubsystem

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem, IPropertySupport
      +
      +
      +
      Direct Known Subclasses:
      +
      BaseXCANTalonPairSpeedControlledSubsystem
      +
      +
      +
      public abstract class BaseXCANTalonSpeedControlledSubsystem
+extends BaseSubsystem
      +
      We have a few Subsystems that have one primary goal: + -Get a motor to rotate at a specific controlled speed. + -Occasionally set the motor to use a specific power. + This requires a decent amount of overhead in terms of Properties and + other configuration, and is something that could be mostly delegated to this class, + as the only significant point of difference is how many motors are controlled + by the Subsystem. + + If the system has more than one motor it is typically + configured into follower mode, so almost no extra configuration is needed.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BaseXCANTalonSpeedControlledSubsystem

          +
          public BaseXCANTalonSpeedControlledSubsystem​(java.lang.String name,
+                                             int masterChannel,
+                                             boolean invertMaster,
+                                             boolean invertMasterSensor,
+                                             XCANTalon.XCANTalonFactory factory,
+                                             PIDPropertyManager pidPropertyManager,
+                                             PropertyFactory propManager)
          +
          +
          Parameters:
          +
          name - What the system is called. This will apply to various Properties.
          +
          masterChannel - The CAN index of the master motor (or the only motor, for a simple system)
          +
          factory - The WPIFactory
          +
          pidPropertyManager - The default PIDF values the system should use
          +
          propManager - The PropertyFactory
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          initializeMasterMotorConfiguration

          +
          protected void initializeMasterMotorConfiguration​(boolean motorInverted,
+                                                  boolean motorSensorInverted)
          +
          • +
        + + + +
          +
        • +

          setPower

          +
          public void setPower​(double power)
          +
          Sets the output power of the system directly - no PID of any kind
          +
          +
          Parameters:
          +
          power - is set to system
          +
          +
          • +
        + + + +
          +
        • +

          getPower

          +
          public double getPower()
          +
          Returns the current "robot power" (e.g. -1 == full reverse, 1 == full forward)
          +
          +
          Returns:
          +
          Last Motor power
          +
          +
          • +
        + + + +
          +
        • +

          setTargetSpeed

          +
          public void setTargetSpeed​(double speed)
          +
          Gives the system a new speed goal.
          +
          +
          Parameters:
          +
          speed - in Rotations per Second (RPS)
          +
          +
          • +
        + + + +
          +
        • +

          getSpeed

          +
          public double getSpeed()
          +
          • +
        + + + +
          +
        • +

          isAtSpeed

          +
          public boolean isAtSpeed()
          +
          • +
        + + + +
          +
        • +

          getTargetSpeed

          +
          public double getTargetSpeed()
          +
          • +
        + + + +
          +
        • +

          periodic

          +
          public void periodic()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/autonomous/AutonomousCommandSelector.html b/javadoc/xbot/common/subsystems/autonomous/AutonomousCommandSelector.html new file mode 100644 index 00000000..d20256e9 --- /dev/null +++ b/javadoc/xbot/common/subsystems/autonomous/AutonomousCommandSelector.html @@ -0,0 +1,439 @@ + + + + + +AutonomousCommandSelector (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.autonomous
    +

    Class AutonomousCommandSelector

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem, IPropertySupport
      +
      +
      +
      @Singleton
+public class AutonomousCommandSelector
+extends BaseSubsystem
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          currentAutonomousCommandName

          +
          public final StringProperty currentAutonomousCommandName
          +
          • +
        + + + +
          +
        • +

          currentAutonomousState

          +
          public final StringProperty currentAutonomousState
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AutonomousCommandSelector

          +
          @Inject
+public AutonomousCommandSelector​(PropertyFactory propFactory)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCurrentAutonomousCommand

          +
          public edu.wpi.first.wpilibj2.command.Command getCurrentAutonomousCommand()
          +
          • +
        + + + +
          +
        • +

          setCurrentAutonomousCommand

          +
          public void setCurrentAutonomousCommand​(edu.wpi.first.wpilibj2.command.Command currentAutonomousCommand)
          +
          • +
        + + + +
          +
        • +

          setCurrentAutonomousCommandSupplier

          +
          public void setCurrentAutonomousCommandSupplier​(java.util.function.Supplier<edu.wpi.first.wpilibj2.command.Command> supplier)
          +
          • +
        + + + +
          +
        • +

          setAutonomousState

          +
          public void setAutonomousState​(java.lang.String state)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/autonomous/SetAutonomousCommand.html b/javadoc/xbot/common/subsystems/autonomous/SetAutonomousCommand.html new file mode 100644 index 00000000..42912abe --- /dev/null +++ b/javadoc/xbot/common/subsystems/autonomous/SetAutonomousCommand.html @@ -0,0 +1,455 @@ + + + + + +SetAutonomousCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.autonomous
    +

    Class SetAutonomousCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public class SetAutonomousCommand
+extends BaseCommand
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute() 
        voidinitialize() 
        booleanisFinished() 
        booleanrunsWhenDisabled() 
        voidsetAutoCommand​(edu.wpi.first.wpilibj2.command.Command autonomousCommand) 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          runsWhenDisabled

          +
          public boolean runsWhenDisabled()
          +
          +
          Specified by:
          +
          runsWhenDisabled in interface edu.wpi.first.wpilibj2.command.Command
          +
          Overrides:
          +
          runsWhenDisabled in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          setAutoCommand

          +
          public void setAutoCommand​(edu.wpi.first.wpilibj2.command.Command autonomousCommand)
          +
          • +
        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          initialize in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/autonomous/package-summary.html b/javadoc/xbot/common/subsystems/autonomous/package-summary.html new file mode 100644 index 00000000..635bd546 --- /dev/null +++ b/javadoc/xbot/common/subsystems/autonomous/package-summary.html @@ -0,0 +1,168 @@ + + + + + +xbot.common.subsystems.autonomous (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.subsystems.autonomous

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/autonomous/package-tree.html b/javadoc/xbot/common/subsystems/autonomous/package-tree.html new file mode 100644 index 00000000..a7d510fc --- /dev/null +++ b/javadoc/xbot/common/subsystems/autonomous/package-tree.html @@ -0,0 +1,178 @@ + + + + + +xbot.common.subsystems.autonomous Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.subsystems.autonomous

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • edu.wpi.first.wpilibj2.command.CommandBase (implements edu.wpi.first.wpilibj2.command.Command, edu.wpi.first.util.sendable.Sendable) + +
        • +
      • edu.wpi.first.wpilibj2.command.SubsystemBase (implements edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/subsystems/compressor/CompressorSubsystem.html b/javadoc/xbot/common/subsystems/compressor/CompressorSubsystem.html new file mode 100644 index 00000000..450ddb93 --- /dev/null +++ b/javadoc/xbot/common/subsystems/compressor/CompressorSubsystem.html @@ -0,0 +1,416 @@ + + + + + +CompressorSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.compressor
    +

    Class CompressorSubsystem

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem, IPropertySupport
      +
      +
      +
      @Singleton
+public class CompressorSubsystem
+extends BaseSubsystem
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voiddisable() 
        voidenable() 
        edu.wpi.first.wpilibj2.command.CommandgetDisableCommand() 
        edu.wpi.first.wpilibj2.command.CommandgetEnableCommand() 
        voidperiodic() 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.SubsystemBase

          +addChild, getName, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Subsystem

          +getCurrentCommand, getDefaultCommand, register, removeDefaultCommand, run, runEnd, runOnce, setDefaultCommand, simulationPeriodic, startEnd
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          enable

          +
          public void enable()
          +
          • +
        + + + +
          +
        • +

          disable

          +
          public void disable()
          +
          • +
        + + + +
          +
        • +

          getEnableCommand

          +
          public edu.wpi.first.wpilibj2.command.Command getEnableCommand()
          +
          • +
        + + + +
          +
        • +

          getDisableCommand

          +
          public edu.wpi.first.wpilibj2.command.Command getDisableCommand()
          +
          • +
        + + + +
          +
        • +

          periodic

          +
          public void periodic()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/compressor/package-summary.html b/javadoc/xbot/common/subsystems/compressor/package-summary.html new file mode 100644 index 00000000..f0d95a2e --- /dev/null +++ b/javadoc/xbot/common/subsystems/compressor/package-summary.html @@ -0,0 +1,164 @@ + + + + + +xbot.common.subsystems.compressor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.subsystems.compressor

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/compressor/package-tree.html b/javadoc/xbot/common/subsystems/compressor/package-tree.html new file mode 100644 index 00000000..ad069e5f --- /dev/null +++ b/javadoc/xbot/common/subsystems/compressor/package-tree.html @@ -0,0 +1,169 @@ + + + + + +xbot.common.subsystems.compressor Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.subsystems.compressor

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • edu.wpi.first.wpilibj2.command.SubsystemBase (implements edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/subsystems/drive/BaseDriveSubsystem.html b/javadoc/xbot/common/subsystems/drive/BaseDriveSubsystem.html new file mode 100644 index 00000000..b025098c --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/BaseDriveSubsystem.html @@ -0,0 +1,721 @@ + + + + + +BaseDriveSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Class BaseDriveSubsystem

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem, IPropertySupport
      +
      +
      +
      Direct Known Subclasses:
      +
      MockDriveSubsystem
      +
      +
      +
      public abstract class BaseDriveSubsystem
+extends BaseSubsystem
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        BaseDriveSubsystem() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidarcadeDrive​(double yTranslation, + double rotation) +
        Classic arcade drive
        +
        voidcheesyDrive​(double translation, + double rotation) +
        Slightly adapted from 254's 2016 CheesyDriveHelper.java.
        +
        voiddrive​(double left, + double right) +
        Classic tank drive.
        +
        voiddrive​(XYPair translation, + double rotation) +
        Commands each of the XCANTalons to respond to translation/rotation input.
        +
        voiddrive​(XYPair translation, + double rotation, + boolean normalize) +
        Commands each of the XCANTalons to respond to translation/rotation input.
        +
        voidfieldOrientedDrive​(XYPair translation, + double rotation, + double currentHeading, + boolean normalize) 
        abstract doublegetLeftTotalDistance() +
        Returns the total distance tracked by the encoder + - On the LEFT side of the robot + - Pointing in the direction of +Y travel
        +
        protected doublegetMaxOutput​(XYPair translation, + double rotation) +
        Determine the largest commanded output for a given wheel for a given + translation/rotation input.
        +
        abstract PIDManagergetPositionalPid() 
        abstract doublegetRightTotalDistance() +
        Returns the total distance tracked by the encoder + - On the RIGHT side of the robot + - Pointing in the direction of +Y travel
        +
        abstract PIDManagergetRotateDecayPid() 
        abstract PIDManagergetRotateToHeadingPid() 
        abstract doublegetTransverseDistance() +
        Returns the total distance tracked by the encoder + - In the center of the robot + - Pointing in the direction of +X travel
        +
        abstract voidmove​(XYPair translate, + double rotate) 
        voidsetQuickTurn​(boolean value) 
        voidstop() 
        voidtankDrive​(double left, + double right) +
        Classic tank drive.
        +
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.SubsystemBase

          +addChild, getName, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Subsystem

          +getCurrentCommand, getDefaultCommand, periodic, register, removeDefaultCommand, run, runEnd, runOnce, setDefaultCommand, simulationPeriodic, startEnd
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BaseDriveSubsystem

          +
          public BaseDriveSubsystem()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPositionalPid

          +
          public abstract PIDManager getPositionalPid()
          +
          • +
        + + + +
          +
        • +

          getRotateToHeadingPid

          +
          public abstract PIDManager getRotateToHeadingPid()
          +
          • +
        + + + +
          +
        • +

          getRotateDecayPid

          +
          public abstract PIDManager getRotateDecayPid()
          +
          • +
        + + + +
          +
        • +

          move

          +
          public abstract void move​(XYPair translate,
+                          double rotate)
          +
          • +
        + + + +
          +
        • +

          getLeftTotalDistance

          +
          public abstract double getLeftTotalDistance()
          +
          Returns the total distance tracked by the encoder + - On the LEFT side of the robot + - Pointing in the direction of +Y travel
          +
          • +
        + + + +
          +
        • +

          getRightTotalDistance

          +
          public abstract double getRightTotalDistance()
          +
          Returns the total distance tracked by the encoder + - On the RIGHT side of the robot + - Pointing in the direction of +Y travel
          +
          • +
        + + + +
          +
        • +

          getTransverseDistance

          +
          public abstract double getTransverseDistance()
          +
          Returns the total distance tracked by the encoder + - In the center of the robot + - Pointing in the direction of +X travel
          +
          • +
        + + + +
          +
        • +

          drive

          +
          public void drive​(XYPair translation,
+                  double rotation,
+                  boolean normalize)
          +
          Commands each of the XCANTalons to respond to translation/rotation input. + Each "wheel" is independently responsible, and as such there isn't any actual + drive logic in this method.
          +
          +
          Parameters:
          +
          translation - +Y is towards the front of the robot, +X is towards the right of the robot. Range between -1 and 1.
          +
          rotation - +Rotation is left turn, -Rotation is right turn. Range between -1 and 1.
          +
          normalize - If the largest output is greater than 1, should all outputs be + normalized so that 1 is the maximum?
          +
          +
          • +
        + + + +
          +
        • +

          drive

          +
          public void drive​(XYPair translation,
+                  double rotation)
          +
          Commands each of the XCANTalons to respond to translation/rotation input. + Each "wheel" is independently responsible, and as such there isn't any actual + drive logic in this method.
          +
          +
          Parameters:
          +
          translation - +Y is towards the front of the robot, +X is towards the right of the robot. Range between -1 and 1
          +
          rotation - +Rotation is left turn, -Rotation is right turn. Range between -1 and 1.
          +
          +
          • +
        + + + +
          +
        • +

          drive

          +
          public void drive​(double left,
+                  double right)
          +
          Classic tank drive.
          +
          +
          Parameters:
          +
          left - Power to the left drive motor. Range between -1 and 1.
          +
          right - Power to the right drive motor. Range between -1 and 1.
          +
          +
          • +
        + + + +
          +
        • +

          fieldOrientedDrive

          +
          public void fieldOrientedDrive​(XYPair translation,
+                               double rotation,
+                               double currentHeading,
+                               boolean normalize)
          +
          • +
        + + + +
          +
        • +

          setQuickTurn

          +
          public void setQuickTurn​(boolean value)
          +
          • +
        + + + +
          +
        • +

          cheesyDrive

          +
          public void cheesyDrive​(double translation,
+                        double rotation)
          +
          Slightly adapted from 254's 2016 CheesyDriveHelper.java.
          +
          • +
        + + + +
          +
        • +

          stop

          +
          public void stop()
          +
          • +
        + + + +
          +
        • +

          arcadeDrive

          +
          public void arcadeDrive​(double yTranslation,
+                        double rotation)
          +
          Classic arcade drive
          +
          +
          Parameters:
          +
          yTranslation - Translation power. Range between -1 and 1.
          +
          rotation - Rotation power. Range between -1 and 1.
          +
          +
          • +
        + + + +
          +
        • +

          tankDrive

          +
          public void tankDrive​(double left,
+                      double right)
          +
          Classic tank drive.
          +
          +
          Parameters:
          +
          left - Power to the left drive motor. Range between -1 and 1.
          +
          right - Power to the right drive motor. Range between -1 and 1.
          +
          +
          • +
        + + + +
          +
        • +

          getMaxOutput

          +
          protected double getMaxOutput​(XYPair translation,
+                              double rotation)
          +
          Determine the largest commanded output for a given wheel for a given + translation/rotation input. For example, you would see a maximum output of + two in a Tank Drive system that's commanded to go forward at full speed AND + rotate at full speed.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/ConfigurablePurePursuitCommand.html b/javadoc/xbot/common/subsystems/drive/ConfigurablePurePursuitCommand.html new file mode 100644 index 00000000..443a9fb6 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/ConfigurablePurePursuitCommand.html @@ -0,0 +1,509 @@ + + + + + +ConfigurablePurePursuitCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Class ConfigurablePurePursuitCommand

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/MockDriveSubsystem.html b/javadoc/xbot/common/subsystems/drive/MockDriveSubsystem.html new file mode 100644 index 00000000..02f3f9fe --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/MockDriveSubsystem.html @@ -0,0 +1,731 @@ + + + + + +MockDriveSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Class MockDriveSubsystem

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem, IPropertySupport
      +
      +
      +
      @Singleton
+public class MockDriveSubsystem
+extends BaseDriveSubsystem
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/PurePursuitCommand.PointLoadingMode.html b/javadoc/xbot/common/subsystems/drive/PurePursuitCommand.PointLoadingMode.html new file mode 100644 index 00000000..5a858e4a --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/PurePursuitCommand.PointLoadingMode.html @@ -0,0 +1,380 @@ + + + + + +PurePursuitCommand.PointLoadingMode (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Enum PurePursuitCommand.PointLoadingMode

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        Absolute 
        Relative 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static PurePursuitCommand.PointLoadingModevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static PurePursuitCommand.PointLoadingMode[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static PurePursuitCommand.PointLoadingMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (PurePursuitCommand.PointLoadingMode c : PurePursuitCommand.PointLoadingMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static PurePursuitCommand.PointLoadingMode valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/PurePursuitCommand.RabbitChaseInfo.html b/javadoc/xbot/common/subsystems/drive/PurePursuitCommand.RabbitChaseInfo.html new file mode 100644 index 00000000..ef0a9baa --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/PurePursuitCommand.RabbitChaseInfo.html @@ -0,0 +1,410 @@ + + + + + +PurePursuitCommand.RabbitChaseInfo (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Class PurePursuitCommand.RabbitChaseInfo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.subsystems.drive.PurePursuitCommand.RabbitChaseInfo
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      PurePursuitCommand
      +
      +
      +
      public class PurePursuitCommand.RabbitChaseInfo
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          translation

          +
          public double translation
          +
          • +
        + + + +
          +
        • +

          rotation

          +
          public double rotation
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          distanceRemaining

          +
          public double distanceRemaining
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RabbitChaseInfo

          +
          public RabbitChaseInfo​(double translation,
+                       double rotation)
          +
          • +
        + + + +
          +
        • +

          RabbitChaseInfo

          +
          public RabbitChaseInfo​(double translation,
+                       double rotation,
+                       FieldPose target,
+                       FieldPose rabbit)
          +
          • +
        + + + +
          +
        • +

          RabbitChaseInfo

          +
          public RabbitChaseInfo​(double translation,
+                       double rotation,
+                       FieldPose target,
+                       FieldPose rabbit,
+                       double distanceRemaining)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/PurePursuitCommand.html b/javadoc/xbot/common/subsystems/drive/PurePursuitCommand.html new file mode 100644 index 00000000..7e5536e8 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/PurePursuitCommand.html @@ -0,0 +1,764 @@ + + + + + +PurePursuitCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Class PurePursuitCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PurePursuitCommand

          +
          public PurePursuitCommand​(HeadingModule.HeadingModuleFactory headingModuleFactory,
+                          BasePoseSubsystem pose,
+                          BaseDriveSubsystem drive,
+                          PropertyFactory propMan)
          +
          An implementation of Pure Pursuit for FRC. We got the basic idea from here: + http://www8.cs.umu.se/kurser/TDBD17/VT06/utdelat/Assignment%20Papers/Path%20Tracking%20for%20a%20Miniature%20Robot.pdf + Fundamentally, you can add field points to this command (x,y, and rotation) and the robot will attempt to reach all those points + with a smooth path. This works for any drive base, but presumably, holonomic robots can solve this problem more effectively. + + You will see references to rabbits, or "chasing the rabbit". This is alluding to how greyhoud races use mechanical rabbits, + which is designed to always stay ahead of them, regardless of their speed. This is similiar to how, as the robot uses pure + pursuit, it is always chasing a point it can never reach.
          +
          +
          Parameters:
          +
          headingModuleFactory - HeadingModuleFactory
          +
          pose - BasePoseSubsystem
          +
          drive - BaseDriveSubsystem
          +
          propMan - PropertyManager
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setPIDs

          +
          public void setPIDs​(HeadingModule headingModule,
+                    PIDManager positionalPid)
          +
          By default, the PurePursuitCommand uses the HeadingModule and PositionalPid from the DriveSubsystem. However, + if you want to change the PIDs used on the fly, you can here.
          +
          +
          Parameters:
          +
          headingModule - Used for rotation
          +
          positionalPid - Used for translation
          +
          +
          • +
        + + + +
          +
        • +

          setPIDsToDefault

          +
          public void setPIDsToDefault()
          +
          • +
        + + + +
          +
        • +

          setDotProductDrivingEnabled

          +
          public void setDotProductDrivingEnabled​(boolean enabled)
          +
          • +
        + + + +
          +
        • +

          getOriginalPoints

          +
          protected abstract java.util.List<RabbitPoint> getOriginalPoints()
          +
          • +
        + + + + + + + +
          +
        • +

          getPlannedPointsToVisit

          +
          public java.util.List<RabbitPoint> getPlannedPointsToVisit()
          +
          If you want to see where this command is heading in the future (for visualization purposes, perhaps) you can + get that information here.
          +
          +
          Returns:
          +
          List of points to visit
          +
          +
          • +
        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          initialize in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        + + + + + + + +
          +
        • +

          evaluateCurrentPoint

          +
          public PurePursuitCommand.RabbitChaseInfo evaluateCurrentPoint()
          +
          This is the core method that looks at the point list, figures out which point to be heading towards, + and doing the math on how to get there.
          +
          +
          Returns:
          +
          Information about what the robot would like to do in order to reach its points.
          +
          +
          • +
        + + + +
          +
        • +

          end

          +
          public void end​(boolean interrupted)
          +
          • +
        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        + + + +
          +
        • +

          getMotionBudget

          +
          public double getMotionBudget()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/RabbitPoint.PointDriveStyle.html b/javadoc/xbot/common/subsystems/drive/RabbitPoint.PointDriveStyle.html new file mode 100644 index 00000000..ee7ba48c --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/RabbitPoint.PointDriveStyle.html @@ -0,0 +1,380 @@ + + + + + +RabbitPoint.PointDriveStyle (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Enum RabbitPoint.PointDriveStyle

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        Macro 
        Micro 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static RabbitPoint.PointDriveStylevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static RabbitPoint.PointDriveStyle[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static RabbitPoint.PointDriveStyle[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (RabbitPoint.PointDriveStyle c : RabbitPoint.PointDriveStyle.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static RabbitPoint.PointDriveStyle valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/RabbitPoint.PointTerminatingType.html b/javadoc/xbot/common/subsystems/drive/RabbitPoint.PointTerminatingType.html new file mode 100644 index 00000000..89bfc3c3 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/RabbitPoint.PointTerminatingType.html @@ -0,0 +1,380 @@ + + + + + +RabbitPoint.PointTerminatingType (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Enum RabbitPoint.PointTerminatingType

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        Continue 
        Stop 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static RabbitPoint.PointTerminatingTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static RabbitPoint.PointTerminatingType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static RabbitPoint.PointTerminatingType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (RabbitPoint.PointTerminatingType c : RabbitPoint.PointTerminatingType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static RabbitPoint.PointTerminatingType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/RabbitPoint.PointType.html b/javadoc/xbot/common/subsystems/drive/RabbitPoint.PointType.html new file mode 100644 index 00000000..8a5af809 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/RabbitPoint.PointType.html @@ -0,0 +1,393 @@ + + + + + +RabbitPoint.PointType (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Enum RabbitPoint.PointType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static RabbitPoint.PointTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static RabbitPoint.PointType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static RabbitPoint.PointType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (RabbitPoint.PointType c : RabbitPoint.PointType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static RabbitPoint.PointType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/RabbitPoint.html b/javadoc/xbot/common/subsystems/drive/RabbitPoint.html new file mode 100644 index 00000000..0a116f4c --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/RabbitPoint.html @@ -0,0 +1,488 @@ + + + + + +RabbitPoint (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Class RabbitPoint

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.subsystems.drive.RabbitPoint
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class RabbitPoint
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/RabbitPointBuilder.html b/javadoc/xbot/common/subsystems/drive/RabbitPointBuilder.html new file mode 100644 index 00000000..72eea1c1 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/RabbitPointBuilder.html @@ -0,0 +1,360 @@ + + + + + +RabbitPointBuilder (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Class RabbitPointBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.subsystems.drive.RabbitPointBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class RabbitPointBuilder
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/SimulatedPurePursuitCommand.html b/javadoc/xbot/common/subsystems/drive/SimulatedPurePursuitCommand.html new file mode 100644 index 00000000..5d716c60 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/SimulatedPurePursuitCommand.html @@ -0,0 +1,453 @@ + + + + + +SimulatedPurePursuitCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive
    +

    Class SimulatedPurePursuitCommand

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/control_logic/HeadingAssistModule.HeadingAssistMode.html b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingAssistModule.HeadingAssistMode.html new file mode 100644 index 00000000..12388057 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingAssistModule.HeadingAssistMode.html @@ -0,0 +1,380 @@ + + + + + +HeadingAssistModule.HeadingAssistMode (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive.control_logic
    +

    Enum HeadingAssistModule.HeadingAssistMode

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static HeadingAssistModule.HeadingAssistModevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static HeadingAssistModule.HeadingAssistMode[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HeadingAssistModule.HeadingAssistMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HeadingAssistModule.HeadingAssistMode c : HeadingAssistModule.HeadingAssistMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HeadingAssistModule.HeadingAssistMode valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/control_logic/HeadingAssistModule.HeadingAssistModuleFactory.html b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingAssistModule.HeadingAssistModuleFactory.html new file mode 100644 index 00000000..97f13631 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingAssistModule.HeadingAssistModuleFactory.html @@ -0,0 +1,344 @@ + + + + + +HeadingAssistModule.HeadingAssistModuleFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive.control_logic
    +

    Class HeadingAssistModule.HeadingAssistModuleFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.subsystems.drive.control_logic.HeadingAssistModule.HeadingAssistModuleFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      HeadingAssistModule
      +
      +
      +
      @AssistedFactory
+public abstract static class HeadingAssistModule.HeadingAssistModuleFactory
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HeadingAssistModuleFactory

          +
          public HeadingAssistModuleFactory()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public abstract HeadingAssistModule create​(@Assisted("headingModule")
+                                           HeadingModule headingModule,
+                                           @Assisted("decayModule")
+                                           HeadingModule decayModule,
+                                           @Assisted("prefix")
+                                           java.lang.String prefix)
          +
          Creates a heading assist module. Can either hold an orientation, or resist + rotational motion.
          +
          +
          Parameters:
          +
          headingModule - Tune this one to rotate to a target orientation (PD, or + PID controller)
          +
          decayModule - Tune this one to resist rotation (D controller)
          +
          Returns:
          +
          HeadingAssistModule instance
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/control_logic/HeadingAssistModule.html b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingAssistModule.html new file mode 100644 index 00000000..db569507 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingAssistModule.html @@ -0,0 +1,400 @@ + + + + + +HeadingAssistModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive.control_logic
    +

    Class HeadingAssistModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.subsystems.drive.control_logic.HeadingAssistModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class HeadingAssistModule
+extends java.lang.Object
      +
      Encaspulates a useful bit of driving logic: - The robot should attempt to + hold its current heading, even if it's temporarily rotated by outside forces. + - If the human driver wants the robot to turn (above some small threshold), + then the robot should turn according to human desires. - After a few moments, + the robot should memorize its current heading, and attempt to hold it again. + + The automatic response can take one of two forms: - Hold a specific heading, + as mentioned above, using a PID controller - Resist changes in rotational + velocity using a D-only controller.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HeadingAssistModule

          +
          @AssistedInject
+public HeadingAssistModule​(@Assisted("headingModule")
+                           HeadingModule headingModule,
+                           @Assisted("decayModule")
+                           HeadingModule decayModule,
+                           @Assisted("prefix")
+                           java.lang.String prefix,
+                           PropertyFactory propMan,
+                           BasePoseSubsystem pose)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          • +
        + + + +
          +
        • +

          calculateHeadingPower

          +
          public double calculateHeadingPower​(double humanRotationalPower)
          +
          Core method of the HeadingAssistModule. You input the human rotational power + input, + and this will determine whether or not to have the human drive the robot or + whether the robot + should continue on its last heading. + + In either case, it will return the suggested power output to the drive + subsystem in order to achieve + those goals.
          +
          +
          Parameters:
          +
          humanRotationalPower - - values between -1 and 1, in terms of "maximum + rotational power"
          +
          Returns:
          +
          values between -1 and 1, in terms of "how hard you should try in + order to satisfy rotational goals."
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/control_logic/HeadingModule.HeadingModuleFactory.html b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingModule.HeadingModuleFactory.html new file mode 100644 index 00000000..d6efee8c --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingModule.HeadingModuleFactory.html @@ -0,0 +1,310 @@ + + + + + +HeadingModule.HeadingModuleFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive.control_logic
    +

    Class HeadingModule.HeadingModuleFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.subsystems.drive.control_logic.HeadingModule.HeadingModuleFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      HeadingModule
      +
      +
      +
      @AssistedFactory
+public abstract static class HeadingModule.HeadingModuleFactory
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        abstract HeadingModulecreate​(PIDManager headingDrivePid) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          HeadingModuleFactory

          +
          public HeadingModuleFactory()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/control_logic/HeadingModule.html b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingModule.html new file mode 100644 index 00000000..470c2a99 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/control_logic/HeadingModule.html @@ -0,0 +1,424 @@ + + + + + +HeadingModule (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.drive.control_logic
    +

    Class HeadingModule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.subsystems.drive.control_logic.HeadingModule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class HeadingModule
+extends java.lang.Object
      +
      Encapsulates the logic needed to rotate the robot to a specific angle. + When using a PD or PID controller, it will attempt to reach that angle. + When using a D-only controller, it will just resist any rotational motion.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isOnTarget

          +
          public boolean isOnTarget()
          +
          • +
        + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          • +
        + + + +
          +
        • +

          calculateHeadingPower

          +
          public double calculateHeadingPower​(double desiredHeading)
          +
          • +
        + + + +
          +
        • +

          calculateHeadingPower

          +
          public double calculateHeadingPower​(edu.wpi.first.math.geometry.Rotation2d desiredHeading)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/drive/control_logic/package-summary.html b/javadoc/xbot/common/subsystems/drive/control_logic/package-summary.html new file mode 100644 index 00000000..4718ab05 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/control_logic/package-summary.html @@ -0,0 +1,196 @@ + + + + + +xbot.common.subsystems.drive.control_logic (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.subsystems.drive.control_logic

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/drive/control_logic/package-tree.html b/javadoc/xbot/common/subsystems/drive/control_logic/package-tree.html new file mode 100644 index 00000000..51df1d6b --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/control_logic/package-tree.html @@ -0,0 +1,178 @@ + + + + + +xbot.common.subsystems.drive.control_logic Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.subsystems.drive.control_logic

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/subsystems/drive/package-summary.html b/javadoc/xbot/common/subsystems/drive/package-summary.html new file mode 100644 index 00000000..cfc7a8d9 --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/package-summary.html @@ -0,0 +1,215 @@ + + + + + +xbot.common.subsystems.drive (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.subsystems.drive

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/drive/package-tree.html b/javadoc/xbot/common/subsystems/drive/package-tree.html new file mode 100644 index 00000000..f7eeac7e --- /dev/null +++ b/javadoc/xbot/common/subsystems/drive/package-tree.html @@ -0,0 +1,210 @@ + + + + + +xbot.common.subsystems.drive Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.subsystems.drive

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/subsystems/feedback/IRumbler.html b/javadoc/xbot/common/subsystems/feedback/IRumbler.html new file mode 100644 index 00000000..5b3d9e74 --- /dev/null +++ b/javadoc/xbot/common/subsystems/feedback/IRumbler.html @@ -0,0 +1,252 @@ + + + + + +IRumbler (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.feedback
    +

    Interface IRumbler

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/feedback/RumbleManager.RumbleManagerFactory.html b/javadoc/xbot/common/subsystems/feedback/RumbleManager.RumbleManagerFactory.html new file mode 100644 index 00000000..84e51d94 --- /dev/null +++ b/javadoc/xbot/common/subsystems/feedback/RumbleManager.RumbleManagerFactory.html @@ -0,0 +1,319 @@ + + + + + +RumbleManager.RumbleManagerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.feedback
    +

    Class RumbleManager.RumbleManagerFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.subsystems.feedback.RumbleManager.RumbleManagerFactory
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      +
      • +
    +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/feedback/RumbleManager.html b/javadoc/xbot/common/subsystems/feedback/RumbleManager.html new file mode 100644 index 00000000..fa307a91 --- /dev/null +++ b/javadoc/xbot/common/subsystems/feedback/RumbleManager.html @@ -0,0 +1,430 @@ + + + + + +RumbleManager (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.feedback
    +

    Class RumbleManager

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • xbot.common.subsystems.feedback.RumbleManager
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      XRumbleManager
      +
      +
      +
      public class RumbleManager
+extends java.lang.Object
+implements XRumbleManager
      +
      Wrappers around gamepad rumble behavior to control intensity and duration.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        RumbleManager​(XJoystick gamepad) +
        Creates a new RumbleManager instance.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleangetIsRumbling() +
        Gets the current rumble state.
        +
        voidperiodic() +
        Called periodically to update the rumble state.
        +
        voidrumbleGamepad​(double intensity, + double length) +
        Rumbles the gamepad at the specified intensity for the given duration.
        +
        voidstopGamepadRumble() +
        Immediately stops rumbling on the gamepad.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          RumbleManager

          +
          @AssistedInject
+public RumbleManager​(@Assisted("gamepad")
+                     XJoystick gamepad)
          +
          Creates a new RumbleManager instance.
          +
          +
          Parameters:
          +
          gamepad - The gamepad in which to control rumble on.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          rumbleGamepad

          +
          public void rumbleGamepad​(double intensity,
+                          double length)
          +
          Description copied from interface: XRumbleManager
          +
          Rumbles the gamepad at the specified intensity for the given duration.
          +
          +
          Specified by:
          +
          rumbleGamepad in interface XRumbleManager
          +
          Parameters:
          +
          intensity - Rumble intensity, between 0 and 1.
          +
          length - Rumble duration, in seconds
          +
          +
          • +
        + + + +
          +
        • +

          getIsRumbling

          +
          public boolean getIsRumbling()
          +
          Description copied from interface: XRumbleManager
          +
          Gets the current rumble state.
          +
          +
          Specified by:
          +
          getIsRumbling in interface XRumbleManager
          +
          Returns:
          +
          true if the gamepad is currently rumbling.
          +
          +
          • +
        + + + +
          +
        • +

          periodic

          +
          public void periodic()
          +
          Description copied from interface: XRumbleManager
          +
          Called periodically to update the rumble state.
          +
          +
          Specified by:
          +
          periodic in interface XRumbleManager
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/feedback/XRumbleManager.XRumbleManagerFactory.html b/javadoc/xbot/common/subsystems/feedback/XRumbleManager.XRumbleManagerFactory.html new file mode 100644 index 00000000..b2f15815 --- /dev/null +++ b/javadoc/xbot/common/subsystems/feedback/XRumbleManager.XRumbleManagerFactory.html @@ -0,0 +1,256 @@ + + + + + +XRumbleManager.XRumbleManagerFactory (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.feedback
    +

    Interface XRumbleManager.XRumbleManagerFactory

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/feedback/XRumbleManager.html b/javadoc/xbot/common/subsystems/feedback/XRumbleManager.html new file mode 100644 index 00000000..4fdf3ad5 --- /dev/null +++ b/javadoc/xbot/common/subsystems/feedback/XRumbleManager.html @@ -0,0 +1,340 @@ + + + + + +XRumbleManager (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.feedback
    +

    Interface XRumbleManager

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      RumbleManager
      +
      +
      +
      public interface XRumbleManager
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        booleangetIsRumbling() +
        Gets the current rumble state.
        +
        voidperiodic() +
        Called periodically to update the rumble state.
        +
        voidrumbleGamepad​(double intensity, + double length) +
        Rumbles the gamepad at the specified intensity for the given duration.
        +
        voidstopGamepadRumble() +
        Immediately stops rumbling on the gamepad.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          rumbleGamepad

          +
          void rumbleGamepad​(double intensity,
+                   double length)
          +
          Rumbles the gamepad at the specified intensity for the given duration.
          +
          +
          Parameters:
          +
          intensity - Rumble intensity, between 0 and 1.
          +
          length - Rumble duration, in seconds
          +
          +
          • +
        + + + +
          +
        • +

          stopGamepadRumble

          +
          void stopGamepadRumble()
          +
          Immediately stops rumbling on the gamepad.
          +
          • +
        + + + +
          +
        • +

          getIsRumbling

          +
          boolean getIsRumbling()
          +
          Gets the current rumble state.
          +
          +
          Returns:
          +
          true if the gamepad is currently rumbling.
          +
          +
          • +
        + + + +
          +
        • +

          periodic

          +
          void periodic()
          +
          Called periodically to update the rumble state.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/feedback/package-summary.html b/javadoc/xbot/common/subsystems/feedback/package-summary.html new file mode 100644 index 00000000..c508b334 --- /dev/null +++ b/javadoc/xbot/common/subsystems/feedback/package-summary.html @@ -0,0 +1,193 @@ + + + + + +xbot.common.subsystems.feedback (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.subsystems.feedback

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/feedback/package-tree.html b/javadoc/xbot/common/subsystems/feedback/package-tree.html new file mode 100644 index 00000000..81f45f96 --- /dev/null +++ b/javadoc/xbot/common/subsystems/feedback/package-tree.html @@ -0,0 +1,170 @@ + + + + + +xbot.common.subsystems.feedback Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.subsystems.feedback

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/subsystems/package-summary.html b/javadoc/xbot/common/subsystems/package-summary.html new file mode 100644 index 00000000..f9bf8e99 --- /dev/null +++ b/javadoc/xbot/common/subsystems/package-summary.html @@ -0,0 +1,171 @@ + + + + + +xbot.common.subsystems (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.subsystems

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/package-tree.html b/javadoc/xbot/common/subsystems/package-tree.html new file mode 100644 index 00000000..8336d891 --- /dev/null +++ b/javadoc/xbot/common/subsystems/package-tree.html @@ -0,0 +1,173 @@ + + + + + +xbot.common.subsystems Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.subsystems

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/xbot/common/subsystems/pose/BasePoseSubsystem.html b/javadoc/xbot/common/subsystems/pose/BasePoseSubsystem.html new file mode 100644 index 00000000..b6f1d4c4 --- /dev/null +++ b/javadoc/xbot/common/subsystems/pose/BasePoseSubsystem.html @@ -0,0 +1,1176 @@ + + + + + +BasePoseSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.pose
    +

    Class BasePoseSubsystem

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem, IPropertySupport
      +
      +
      +
      Direct Known Subclasses:
      +
      MockBasePoseSubsystem
      +
      +
      +
      public abstract class BasePoseSubsystem
+extends BaseSubsystem
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          imu

          +
          public final XGyro imu
          +
          • +
        + + + +
          +
        • +

          leftDriveDistance

          +
          protected final DoubleProperty leftDriveDistance
          +
          • +
        + + + +
          +
        • +

          rightDriveDistance

          +
          protected final DoubleProperty rightDriveDistance
          +
          • +
        + + + +
          +
        • +

          totalDistanceX

          +
          protected final DoubleProperty totalDistanceX
          +
          • +
        + + + +
          +
        • +

          totalDistanceY

          +
          protected final DoubleProperty totalDistanceY
          +
          • +
        + + + +
          +
        • +

          totalDistanceYRobotPerspective

          +
          protected final DoubleProperty totalDistanceYRobotPerspective
          +
          • +
        + + + + + + + + + + + + + + + + + + + +
          +
        • +

          currentHeadingProp

          +
          protected final DoubleProperty currentHeadingProp
          +
          • +
        + + + +
          +
        • +

          currentCompassHeadingProp

          +
          protected final DoubleProperty currentCompassHeadingProp
          +
          • +
        + + + +
          +
        • +

          headingAngularVelocityProp

          +
          protected final DoubleProperty headingAngularVelocityProp
          +
          • +
        + + + +
          +
        • +

          headingOffset

          +
          protected double headingOffset
          +
          • +
        + + + +
          +
        • +

          FACING_AWAY_FROM_DRIVERS

          +
          public static final double FACING_AWAY_FROM_DRIVERS
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          FACING_TOWARDS_DRIVERS

          +
          public static final double FACING_TOWARDS_DRIVERS
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          INCHES_IN_A_METER

          +
          public static final double INCHES_IN_A_METER
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          inherentRioPitch

          +
          protected final DoubleProperty inherentRioPitch
          +
          • +
        + + + +
          +
        • +

          inherentRioRoll

          +
          protected final DoubleProperty inherentRioRoll
          +
          • +
        + + + +
          +
        • +

          previousLeftDistance

          +
          protected double previousLeftDistance
          +
          • +
        + + + +
          +
        • +

          previousRightDistance

          +
          protected double previousRightDistance
          +
          • +
        + + + +
          +
        • +

          classInstantiationTime

          +
          protected final double classInstantiationTime
          +
          • +
        + + + +
          +
        • +

          isNavXReady

          +
          protected boolean isNavXReady
          +
          • +
        + + + + + + + +
          +
        • +

          firstUpdate

          +
          protected boolean firstUpdate
          +
          • +
        + + + +
          +
        • +

          lastSetHeadingTime

          +
          protected double lastSetHeadingTime
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCompassHeading

          +
          protected double getCompassHeading​(edu.wpi.first.math.geometry.Rotation2d standardHeading)
          +
          • +
        + + + +
          +
        • +

          updateCurrentHeading

          +
          protected void updateCurrentHeading()
          +
          • +
        + + + +
          +
        • +

          updateOdometry

          +
          protected void updateOdometry()
          +
          • +
        + + + +
          +
        • +

          getCurrentHeading

          +
          public WrappedRotation2d getCurrentHeading()
          +
          +
          Returns:
          +
          Current heading but if the navX is still booting up it will return 0
          +
          +
          • +
        + + + +
          +
        • +

          getFieldOrientedTotalDistanceTraveled

          +
          public XYPair getFieldOrientedTotalDistanceTraveled()
          +
          • +
        + + + +
          +
        • +

          getTravelVector

          +
          protected XYPair getTravelVector()
          +
          • +
        + + + +
          +
        • +

          getCurrentFieldPose

          +
          public FieldPose getCurrentFieldPose()
          +
          • +
        + + + +
          +
        • +

          getCurrentPose2d

          +
          public edu.wpi.first.math.geometry.Pose2d getCurrentPose2d()
          +
          • +
        + + + +
          +
        • +

          getCurrentVelocity

          +
          public XYPair getCurrentVelocity()
          +
          • +
        + + + +
          +
        • +

          getCurrentHeadingAngularVelocity

          +
          public double getCurrentHeadingAngularVelocity()
          +
          • +
        + + + +
          +
        • +

          getRobotOrientedTotalDistanceTraveled

          +
          public double getRobotOrientedTotalDistanceTraveled()
          +
          Returns the distance the robot has traveled forward. Rotations are ignored - if you drove forward 100 inches, + then turned 180 degrees and drove another 100 inches, this would tell you that you have traveled 200 inches.
          +
          +
          Returns:
          +
          Distance in inches traveled forward from the robot perspective
          +
          +
          • +
        + + + +
          +
        • +

          resetDistanceTraveled

          +
          public void resetDistanceTraveled()
          +
          • +
        + + + +
          +
        • +

          setCurrentHeading

          +
          public void setCurrentHeading​(double headingInDegrees)
          +
          • +
        + + + +
          +
        • +

          setCurrentPosition

          +
          public void setCurrentPosition​(double newXPosition,
+                               double newYPosition)
          +
          • +
        + + + +
          +
        • +

          getHeadingResetRecently

          +
          public boolean getHeadingResetRecently()
          +
          • +
        + + + +
          +
        • +

          updatePose

          +
          protected void updatePose()
          +
          This should be called as often as reasonably possible, to increase accuracy + of the "distance traveled" calculation. + + The PoseSubsystem can't directly own positional sensors, so some command will need to feed in the + distance values coming from the DriveSubsystem. In order to have accurate calculations, these + values need to be in inches, and should never be reset - any resetting should be done here + in the PoseSubsystem
          +
          • +
        + + + +
          +
        • +

          getLeftDriveDistance

          +
          protected abstract double getLeftDriveDistance()
          +
          • +
        + + + +
          +
        • +

          getRightDriveDistance

          +
          protected abstract double getRightDriveDistance()
          +
          • +
        + + + +
          +
        • +

          getRobotPitch

          +
          public double getRobotPitch()
          +
          • +
        + + + +
          +
        • +

          getRobotRoll

          +
          public double getRobotRoll()
          +
          • +
        + + + +
          +
        • +

          getRobotYaw

          +
          protected WrappedRotation2d getRobotYaw()
          +
          If the RoboRIO is mounted in a position other than "flat" (e.g. with the pins facing upward) + then this method will need to be overridden.
          +
          • +
        + + + +
          +
        • +

          getUntrimmedPitch

          +
          protected double getUntrimmedPitch()
          +
          • +
        + + + +
          +
        • +

          getUntrimmedRoll

          +
          protected double getUntrimmedRoll()
          +
          • +
        + + + +
          +
        • +

          calibrateInherentRioOrientation

          +
          public void calibrateInherentRioOrientation()
          +
          • +
        + + + +
          +
        • +

          getYawAngularVelocity

          +
          public double getYawAngularVelocity()
          +
          • +
        + + + +
          +
        • +

          getNavXReady

          +
          public boolean getNavXReady()
          +
          • +
        + + + +
          +
        • +

          periodic

          +
          public void periodic()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/pose/MockBasePoseSubsystem.html b/javadoc/xbot/common/subsystems/pose/MockBasePoseSubsystem.html new file mode 100644 index 00000000..c285f90f --- /dev/null +++ b/javadoc/xbot/common/subsystems/pose/MockBasePoseSubsystem.html @@ -0,0 +1,449 @@ + + + + + +MockBasePoseSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.pose
    +

    Class MockBasePoseSubsystem

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem, IPropertySupport
      +
      +
      +
      @Singleton
+public class MockBasePoseSubsystem
+extends BasePoseSubsystem
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setDriveTalons

          +
          public void setDriveTalons​(XCANTalon left,
+                           XCANTalon right)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setDriveEncoderDistances

          +
          public void setDriveEncoderDistances​(int left,
+                                     int right)
          +
          • +
        + + + +
          +
        • +

          forceTotalXandY

          +
          public void forceTotalXandY​(double x,
+                            double y)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/pose/commands/ResetDistanceCommand.html b/javadoc/xbot/common/subsystems/pose/commands/ResetDistanceCommand.html new file mode 100644 index 00000000..454e9c3a --- /dev/null +++ b/javadoc/xbot/common/subsystems/pose/commands/ResetDistanceCommand.html @@ -0,0 +1,473 @@ + + + + + +ResetDistanceCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.pose.commands
    +

    Class ResetDistanceCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public class ResetDistanceCommand
+extends BaseCommand
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected BasePoseSubsystemposeSubsystem 
        + +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute() 
        voidinitialize() 
        booleanisFinished() 
        booleanrunsWhenDisabled() 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResetDistanceCommand

          +
          @Inject
+public ResetDistanceCommand​(BasePoseSubsystem poseSubsystem)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          runsWhenDisabled

          +
          public boolean runsWhenDisabled()
          +
          +
          Specified by:
          +
          runsWhenDisabled in interface edu.wpi.first.wpilibj2.command.Command
          +
          Overrides:
          +
          runsWhenDisabled in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          initialize in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/pose/commands/SetRobotHeadingCommand.html b/javadoc/xbot/common/subsystems/pose/commands/SetRobotHeadingCommand.html new file mode 100644 index 00000000..40fa80f5 --- /dev/null +++ b/javadoc/xbot/common/subsystems/pose/commands/SetRobotHeadingCommand.html @@ -0,0 +1,501 @@ + + + + + +SetRobotHeadingCommand (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.pose.commands
    +

    Class SetRobotHeadingCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • edu.wpi.first.wpilibj2.command.CommandBase
        • +
      • + +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Command, IPropertySupport
      +
      +
      +
      public class SetRobotHeadingCommand
+extends BaseCommand
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

          +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        protected BasePoseSubsystemposeSubsystem 
        + +
          +
        • + + +

          Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +m_requirements
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute() 
        voidinitialize() 
        booleanisFinished() 
        booleanrunsWhenDisabled() 
        voidsetHeadingToApply​(double heading) 
        voidsetHeadingToApply​(java.util.function.Supplier<java.lang.Double> headingSupplier) 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase

          +addRequirements, getName, getRequirements, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

          +alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SetRobotHeadingCommand

          +
          @Inject
+public SetRobotHeadingCommand​(BasePoseSubsystem poseSubsystem)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          runsWhenDisabled

          +
          public boolean runsWhenDisabled()
          +
          +
          Specified by:
          +
          runsWhenDisabled in interface edu.wpi.first.wpilibj2.command.Command
          +
          Overrides:
          +
          runsWhenDisabled in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          setHeadingToApply

          +
          public void setHeadingToApply​(double heading)
          +
          • +
        + + + +
          +
        • +

          setHeadingToApply

          +
          public void setHeadingToApply​(java.util.function.Supplier<java.lang.Double> headingSupplier)
          +
          • +
        + + + +
          +
        • +

          initialize

          +
          public void initialize()
          +
          +
          Specified by:
          +
          initialize in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          initialize in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute()
          +
          +
          Specified by:
          +
          execute in interface edu.wpi.first.wpilibj2.command.Command
          +
          Specified by:
          +
          execute in class BaseCommand
          +
          +
          • +
        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/pose/commands/package-summary.html b/javadoc/xbot/common/subsystems/pose/commands/package-summary.html new file mode 100644 index 00000000..e9bd10b0 --- /dev/null +++ b/javadoc/xbot/common/subsystems/pose/commands/package-summary.html @@ -0,0 +1,168 @@ + + + + + +xbot.common.subsystems.pose.commands (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.subsystems.pose.commands

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/pose/commands/package-tree.html b/javadoc/xbot/common/subsystems/pose/commands/package-tree.html new file mode 100644 index 00000000..ce3f89a0 --- /dev/null +++ b/javadoc/xbot/common/subsystems/pose/commands/package-tree.html @@ -0,0 +1,170 @@ + + + + + +xbot.common.subsystems.pose.commands Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.subsystems.pose.commands

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • edu.wpi.first.wpilibj2.command.CommandBase (implements edu.wpi.first.wpilibj2.command.Command, edu.wpi.first.util.sendable.Sendable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/subsystems/pose/package-summary.html b/javadoc/xbot/common/subsystems/pose/package-summary.html new file mode 100644 index 00000000..95c4460d --- /dev/null +++ b/javadoc/xbot/common/subsystems/pose/package-summary.html @@ -0,0 +1,168 @@ + + + + + +xbot.common.subsystems.pose (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.subsystems.pose

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/pose/package-tree.html b/javadoc/xbot/common/subsystems/pose/package-tree.html new file mode 100644 index 00000000..2132ed95 --- /dev/null +++ b/javadoc/xbot/common/subsystems/pose/package-tree.html @@ -0,0 +1,173 @@ + + + + + +xbot.common.subsystems.pose Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.subsystems.pose

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • edu.wpi.first.wpilibj2.command.SubsystemBase (implements edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/xbot/common/subsystems/simplemotor/SimpleMotorSubsystem.html b/javadoc/xbot/common/subsystems/simplemotor/SimpleMotorSubsystem.html new file mode 100644 index 00000000..24e67453 --- /dev/null +++ b/javadoc/xbot/common/subsystems/simplemotor/SimpleMotorSubsystem.html @@ -0,0 +1,487 @@ + + + + + +SimpleMotorSubsystem (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package xbot.common.subsystems.simplemotor
    +

    Class SimpleMotorSubsystem

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem, IPropertySupport
      +
      +
      +
      public abstract class SimpleMotorSubsystem
+extends BaseSubsystem
      +
      Generic subsystem that handles a single motor which can be drivven in forward and reverse.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        SimpleMotorSubsystem​(java.lang.String name, + PropertyFactory pf) +
        Create an instance with default power settings.
        +
        SimpleMotorSubsystem​(java.lang.String name, + PropertyFactory pf, + double defaultForwardPower, + double defaultReversePower) +
        Create an instance with the specified default forward and reverse power.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        edu.wpi.first.wpilibj2.command.CommandgetForwardCommand() 
        edu.wpi.first.wpilibj2.command.CommandgetReverseCommand() 
        edu.wpi.first.wpilibj2.command.CommandgetStopCommand() 
        voidsetForward() 
        abstract voidsetPower​(double power) +
        Sets the motor output power.
        +
        voidsetReverse() 
        voidstop() 
        + +
          +
        • + + +

          Methods inherited from class edu.wpi.first.wpilibj2.command.SubsystemBase

          +addChild, getName, getSubsystem, initSendable, setName, setSubsystem
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface edu.wpi.first.wpilibj2.command.Subsystem

          +getCurrentCommand, getDefaultCommand, periodic, register, removeDefaultCommand, run, runEnd, runOnce, setDefaultCommand, simulationPeriodic, startEnd
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SimpleMotorSubsystem

          +
          public SimpleMotorSubsystem​(java.lang.String name,
+                            PropertyFactory pf,
+                            double defaultForwardPower,
+                            double defaultReversePower)
          +
          Create an instance with the specified default forward and reverse power.
          +
          +
          Parameters:
          +
          name - The name of the subsystem
          +
          pf - The property factory
          +
          defaultForwardPower - The default power to use in the forward direction
          +
          defaultReversePower - The default power to use in the reverse direction
          +
          +
          • +
        + + + +
          +
        • +

          SimpleMotorSubsystem

          +
          public SimpleMotorSubsystem​(java.lang.String name,
+                            PropertyFactory pf)
          +
          Create an instance with default power settings.
          +
          +
          Parameters:
          +
          name - The name of the subsystem
          +
          pf - The property factory
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setPower

          +
          public abstract void setPower​(double power)
          +
          Sets the motor output power.
          +
          +
          Parameters:
          +
          power - The output power, from -1.0 to 1.0
          +
          +
          • +
        + + + +
          +
        • +

          setForward

          +
          public void setForward()
          +
          • +
        + + + +
          +
        • +

          setReverse

          +
          public void setReverse()
          +
          • +
        + + + +
          +
        • +

          stop

          +
          public void stop()
          +
          • +
        + + + +
          +
        • +

          getForwardCommand

          +
          public edu.wpi.first.wpilibj2.command.Command getForwardCommand()
          +
          • +
        + + + +
          +
        • +

          getReverseCommand

          +
          public edu.wpi.first.wpilibj2.command.Command getReverseCommand()
          +
          • +
        + + + +
          +
        • +

          getStopCommand

          +
          public edu.wpi.first.wpilibj2.command.Command getStopCommand()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/xbot/common/subsystems/simplemotor/package-summary.html b/javadoc/xbot/common/subsystems/simplemotor/package-summary.html new file mode 100644 index 00000000..d154eeee --- /dev/null +++ b/javadoc/xbot/common/subsystems/simplemotor/package-summary.html @@ -0,0 +1,166 @@ + + + + + +xbot.common.subsystems.simplemotor (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package xbot.common.subsystems.simplemotor

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      SimpleMotorSubsystem +
      Generic subsystem that handles a single motor which can be drivven in forward and reverse.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/xbot/common/subsystems/simplemotor/package-tree.html b/javadoc/xbot/common/subsystems/simplemotor/package-tree.html new file mode 100644 index 00000000..ca3670a9 --- /dev/null +++ b/javadoc/xbot/common/subsystems/simplemotor/package-tree.html @@ -0,0 +1,169 @@ + + + + + +xbot.common.subsystems.simplemotor Class Hierarchy (SeriouslyCommonLib API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package xbot.common.subsystems.simplemotor

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • edu.wpi.first.wpilibj2.command.SubsystemBase (implements edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem) + +
        • +
      +
      • +
    +
    +
    +
    + + +