Package dev.narlyx.tweetybird

Class TweetyBird.Builder

java.lang.Object
dev.narlyx.tweetybird.TweetyBird.Builder
Enclosing class:
TweetyBird
public static class TweetyBird.Builder extends Object
Use this method to properly set up TweetyBird using Java's builder pattern.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Builder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    TweetyBird
    build()
    Will construct TweetyBird with the configuration defined within this builder and return a new copy of TweetyBird.
    TweetyBird.Builder
    setDebuggingEnabled(boolean debuggingEnabled)
    NOT RECOMMENDED This wil flood your console with debug messages, only use for development and will slow the runtime loop without a linear op mode, the default value is false
    TweetyBird.Builder
    setDistanceBuffer(double distanceBuffer)
    OPTIONAL This value will define how close TweetyBird needs to move be to its target to consider itself to be okay to stop moving, the default value is 1.
    TweetyBird.Builder
    setDriver(TweetyBird.Driver driver)
    REQUIRED A new class that implements TweetyBird's Driver interface, TweetyBird will use this class to output motion.
    TweetyBird.Builder
    setLinearOpMode(com.qualcomm.robotcore.eventloop.opmode.LinearOpMode opMode)
    REQUIRED FOR FTC Sets the LinearOpMode that TweetyBird will use, this will be used to start and stop TweetyBird.
    TweetyBird.Builder
    setMaximumSpeed(double maxSpeed)
    OPTIONAL This value will define how fast TweetyBird is allowed to move, the default value is 1.
    TweetyBird.Builder
    setMinimumSpeed(double minSpeed)
    OPTIONAL This value will define how slow TweetyBird is allowed to move, the default value is 0.1.
    TweetyBird.Builder
    setOdometer(TweetyBird.Odometer odometer)
    REQUIRED A new class that implements TweetyBird's Odometer interface, TweetyBird will use this class to receive input on the robot's location.
    TweetyBird.Builder
    setRotationBuffer(double rotationBuffer)
    OPTIONAL This value will define how close TweetyBird needs to rotate to its target to consider itself to be okay to stop rotating, the default value is 1 degree.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • setLinearOpMode

      public TweetyBird.Builder setLinearOpMode(com.qualcomm.robotcore.eventloop.opmode.LinearOpMode opMode)
      REQUIRED FOR FTC Sets the LinearOpMode that TweetyBird will use, this will be used to start and stop TweetyBird.
      Parameters:
      opMode - Passed OpMode
      Returns:
      Updated builder

    • setOdometer

      public TweetyBird.Builder setOdometer(TweetyBird.Odometer odometer)
      REQUIRED A new class that implements TweetyBird's Odometer interface, TweetyBird will use this class to receive input on the robot's location.
      Parameters:
      odometer - Passed Odometer
      Returns:
      Updated builder

    • setDriver

      public TweetyBird.Builder setDriver(TweetyBird.Driver driver)
      REQUIRED A new class that implements TweetyBird's Driver interface, TweetyBird will use this class to output motion.
      Parameters:
      driver - Passed Odometer
      Returns:
      Updated builder

    • setMinimumSpeed

      public TweetyBird.Builder setMinimumSpeed(double minSpeed)
      OPTIONAL This value will define how slow TweetyBird is allowed to move, the default value is 0.1.
      Parameters:
      minSpeed - A number between 0 and 1
      Returns:
      Updated builder

    • setMaximumSpeed

      public TweetyBird.Builder setMaximumSpeed(double maxSpeed)
      OPTIONAL This value will define how fast TweetyBird is allowed to move, the default value is 1.
      Parameters:
      maxSpeed - A number between 0 and 1, must be greater than the minimum speed
      Returns:
      Updated builder

    • setDistanceBuffer

      public TweetyBird.Builder setDistanceBuffer(double distanceBuffer)
      OPTIONAL This value will define how close TweetyBird needs to move be to its target to consider itself to be okay to stop moving, the default value is 1.
      Parameters:
      distanceBuffer - Number of units of measurement
      Returns:
      Updated builder

    • setRotationBuffer

      public TweetyBird.Builder setRotationBuffer(double rotationBuffer)
      OPTIONAL This value will define how close TweetyBird needs to rotate to its target to consider itself to be okay to stop rotating, the default value is 1 degree.
      Parameters:
      rotationBuffer - Number in degrees
      Returns:
      Updated builder

    • setDebuggingEnabled

      public TweetyBird.Builder setDebuggingEnabled(boolean debuggingEnabled)
      NOT RECOMMENDED This wil flood your console with debug messages, only use for development and will slow the runtime loop without a linear op mode, the default value is false
      Parameters:
      debuggingEnabled - Weather to enable debug logs
      Returns:
      Updated builder

    • build

      public TweetyBird build()
      Will construct TweetyBird with the configuration defined within this builder and return a new copy of TweetyBird.
      Returns:
      TweetyBird