add class level comment for Shooter class- describe mechanism

[3501/stronghold-2016] / src / org / usfirst / frc / team3501 / robot / subsystems / Shooter.java

diff --git a/src/org/usfirst/frc/team3501/robot/subsystems/Shooter.java b/src/org/usfirst/frc/team3501/robot/subsystems/Shooter.java
index 035ee86ce029e831dec3242fc8f3692e6c1a6114..cbf6df66b7408e50802b37240811c49f1c246af9 100755 (executable)
--- a/src/org/usfirst/frc/team3501/robot/subsystems/Shooter.java
+++ b/src/org/usfirst/frc/team3501/robot/subsystems/Shooter.java
@@ -3,24 +3,53 @@ package org.usfirst.frc.team3501.robot.subsystems;
 import org.usfirst.frc.team3501.robot.Constants;
 
 import edu.wpi.first.wpilibj.CANTalon;
+import edu.wpi.first.wpilibj.CounterBase.EncodingType;
 import edu.wpi.first.wpilibj.DoubleSolenoid;
+import edu.wpi.first.wpilibj.Encoder;
 import edu.wpi.first.wpilibj.command.Subsystem;
 
+/***
+ * The Shooter consists of a platform and wheel, each controlled by
+ * separate motors. The motor controlling the platform pushes the ball onto the
+ * wheel. The wheel is controlled by a motor, which runs once the ball is pushed
+ * onto the wheel. The spinning wheel propels the ball.
+ *
+ * @author superuser
+ *
+ */
+
 public class Shooter extends Subsystem {
   private CANTalon shooter;
   private CANTalon angleAdjuster;
   private DoubleSolenoid punch;
+  private Encoder encoder;
 
   public Shooter() {
     shooter = new CANTalon(Constants.Shooter.PORT);
-    punch = new DoubleSolenoid(Constants.Shooter.FORWARD_PORT,
-        Constants.Shooter.REVERSE_PORT);
+    angleAdjuster = new CANTalon(Constants.Shooter.ANGLE_ADJUSTER_PORT);
+    punch = new DoubleSolenoid(Constants.Shooter.PUNCH_FORWARD_PORT,
+        Constants.Shooter.PUNCH_REVERSE_PORT);
+
+    encoder = new Encoder(Constants.Shooter.ENCODER_PORT_A,
+        Constants.Shooter.ENCODER_PORT_B, false, EncodingType.k4X);
   }
 
   public double getCurrentSetPoint() {
     return shooter.get();
   }
 
+  /***
+   * This method checks to see if the ball has successfully passed through the
+   * intake rollers and is inside.
+   *
+   * @return whether the presence of the ball is true or false and returns the
+   *         state of the condition (true or false).
+   */
+
+  public boolean isBallInside() {
+    return true;
+  }
+
   public void setSpeed(double speed) {
     if (speed > 1.0)
       shooter.set(1.0);
@@ -34,7 +63,12 @@ public class Shooter extends Subsystem {
     this.setSpeed(0.0);
   }
 
+  public double getSpeed() {
+    return encoder.getRate();
+  }
+
   // Use negative # for decrement. Positive for increment.
+
   public void changeSpeed(double change) {
     double newSpeed = getCurrentSetPoint() + change;
     if (newSpeed > 1.0)