From 64f47e4f4ef66e40434502fcbcc3d6972f969419 Mon Sep 17 00:00:00 2001 From: Shaina Chen Date: Thu, 4 Feb 2016 18:49:10 -0800 Subject: [PATCH] change method name from getDistance to getAngleForLevel and add javadoc style comment for getAngleForLevel method --- .../frc/team3501/robot/subsystems/DefenseArm.java | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java b/src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java index 3c6309b4..81365c88 100755 --- a/src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java +++ b/src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java @@ -39,7 +39,18 @@ public class DefenseArm extends Subsystem { return defenseHandPotentiometer.get(); } - public double getDistance(int desiredArmLocation) { + /*** + * This method takes an arm location as input (range of [0,2]) + * Returns the angle of the arm corresponding to that arm location + * + * @param desiredArmLocation + * takes an arm location ranging from [0,2] + * 0 is the lowest position of arm + * 2 is the highest position of arm + * @return + * the angle of the arm corresponding to that arm location + */ + public double getAngleForLocation(int desiredArmLocation) { return potAngles[desiredArmLocation]; } -- 2.30.2