Add Javadoc comment to hallEffectBuffer class

[3501/2017steamworks] / src / org / usfirst / frc / team3501 / robot / subsystems / HallEffectBuffer.java

package org.usfirst.frc.team3501.robot.subsystems;

/**
 * This command calculates the average of a set of rpm from the HallEffectSensor
 * class
 * 
 * @author shaina
 *
 */
public class HallEffectBuffer {
  int length;
  int index;
  double[] bufferVals;

  public HallEffectBuffer(int length) {
    this.length = length;
    bufferVals = new double[length];
    index = 0;
  }

  public void add(double val) {
    bufferVals[index++] = val;
    if (index >= bufferVals.length) {
      index = 0;
    }
  }

  /**
   * Gets average buffer value from array of existing buffer vals
   *
   * @return average buffered speed
   */
  public double getAverage() {
    double total = 0;
    for (int i = 0; i < index; i++) {
      total += bufferVals[i];
    }
    return total / bufferVals.length;
  }
}