add description, pre and post condition comments

[3501/stronghold-2016] / src / org / usfirst / frc / team3501 / robot / commands / driving / TurnForTime.java

package org.usfirst.frc.team3501.robot.commands.driving;

import org.usfirst.frc.team3501.robot.Constants.Direction;
import org.usfirst.frc.team3501.robot.Robot;

import edu.wpi.first.wpilibj.Timer;
import edu.wpi.first.wpilibj.command.Command;

/***
 * This command turns the robot in a specified direction for a specified
 * duration.
 *
 * pre-condition: robot is on a flat surface
 *
 * post-condition: robot has turned in the specified direction for the specified
 * time
 *
 * @author Meryem, Avi, and Sarvesh
 *
 */

public class TurnForTime extends Command {
  private final double SPEED = 0.5;
  private Direction direction;
  private double seconds;
  private Timer timer;

  public TurnForTime(double seconds, Direction direction) {
    this.seconds = seconds;
    this.direction = direction;
  }

  @Override
  protected void initialize() {
    timer = new Timer();
    timer.start();
  }

  @Override
  protected void execute() {
    if (direction == Direction.RIGHT) {
      Robot.driveTrain.setMotorSpeeds(SPEED, -SPEED);
    } else if (direction == Direction.LEFT) {
      Robot.driveTrain.setMotorSpeeds(-SPEED, SPEED);
    }
  }

  @Override
  protected boolean isFinished() {
    if (timer.get() >= seconds)
      return true;
    return false;
  }

  @Override
  protected void end() {
  }

  @Override
  protected void interrupted() {
  }
}