com.arcrobotics.ftclib.hardware

Class SensorDistanceEx.DistanceTarget

java.lang.Object

com.arcrobotics.ftclib.hardware.SensorDistanceEx.DistanceTarget

Enclosing interface:

SensorDistanceEx

public static class SensorDistanceEx.DistanceTarget
extends java.lang.Object

Represents a target distance

Constructor Summary

Constructors

Constructor and Description
DistanceTarget(DistanceUnit unit, double target) Target must be within the range of the Rev 2m Sensor, which is 2 meters
DistanceTarget(DistanceUnit unit, double target, double threshold)
DistanceTarget(DistanceUnit unit, double target, double threshold, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
boolean	atTarget(double currentDistance) Determines if the sensor reached the target value (within the threshold error range)
java.lang.String	getName()
double	getTarget()
double	getThreshold() Gets the acceptable error range
DistanceUnit	getUnit() Gets the unit of distance
void	setName(java.lang.String name) Changes the name of the sensor
void	setTarget(double target) Change the target value
void	setUnit(DistanceUnit unit) Changes the unit of measurement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DistanceTarget

public DistanceTarget(DistanceUnit unit,
                      double target)

Target must be within the range of the Rev 2m Sensor, which is 2 meters

Parameters:

unit - user-defined unit of distance

target - the target distance

DistanceTarget

public DistanceTarget(DistanceUnit unit,
                      double target,
                      double threshold)

Parameters:

unit - user-defined unit of distance

target - the target distance

threshold - the acceptable error range

DistanceTarget

public DistanceTarget(DistanceUnit unit,
                      double target,
                      double threshold,
                      java.lang.String name)

Parameters:

unit - the user-defined unit of distance

target - the target distance

threshold - the acceptable error range

name - the name of the sensor

Method Detail

atTarget

public boolean atTarget(double currentDistance)

Determines if the sensor reached the target value (within the threshold error range)

Parameters:

currentDistance - the current distance to the target

Returns:

whether the the sensor reached the the target value (within the threshold error range)

setTarget

public void setTarget(double target)

Change the target value

Parameters:

target - the new target

setUnit

public void setUnit(DistanceUnit unit)

Changes the unit of measurement

Parameters:

unit - the new unit value

setName

public void setName(java.lang.String name)

Changes the name of the sensor

Parameters:

name - the new name of the sensor

getUnit

public DistanceUnit getUnit()

Gets the unit of distance

Returns:

the unit of distance

getThreshold

public double getThreshold()

Gets the acceptable error range

Returns:

the threshold (acceptable error range)

getTarget

public double getTarget()

Returns:

the target distance

getName

public java.lang.String getName()

Returns:

the name of the sensor