Add javadoc comments to command class constructors
[3501/2017steamworks] / src / org / usfirst / frc / team3501 / robot / commands / shooter / RunIndexWheel.java
1 package org.usfirst.frc.team3501.robot.commands.shooter;
2
3 import edu.wpi.first.wpilibj.command.Command;
4
5 /**
6 * This command runs index wheel at a given speed for given time in seconds.
7 *
8 * pre-condition: fly wheel is running at full speed to prepare for shooting
9 * fuel
10 *
11 * @author Shaina
12 */
13 public class RunIndexWheel extends Command {
14 private double time;
15 private double motorVal;
16
17 /**
18 * See JavaDoc comment in class for details
19 *
20 * @param motorVal
21 * value range from -1 to 1
22 * @param time
23 * in seconds, amount of time to run index wheel motor
24 */
25 public RunIndexWheel(double motorVal, double time) {
26 this.motorVal = motorVal;
27 this.time = time;
28 }
29
30 // Called just before this Command runs the first time
31 @Override
32 protected void initialize() {
33 }
34
35 // Called repeatedly when this Command is scheduled to run
36 @Override
37 protected void execute() {
38 }
39
40 // Called once after isFinished returns true
41 @Override
42 protected void end() {
43 }
44
45 // Called when another command which requires one or more of the same
46 // subsystems is scheduled to run
47 @Override
48 protected void interrupted() {
49 }
50
51 @Override
52 protected boolean isFinished() {
53 return false;
54 }
55
56 }