com.arcrobotics.ftclib.hardware

Class SensorRevTOFDistance

java.lang.Object

com.arcrobotics.ftclib.hardware.SensorRevTOFDistance

All Implemented Interfaces:

HardwareDevice, SensorDistance, SensorDistanceEx

public class SensorRevTOFDistance
extends java.lang.Object
implements SensorDistanceEx

Class for a time-of-flight distance sensor

Nested Class Summary

Nested classes/interfaces inherited from interface com.arcrobotics.ftclib.hardware.SensorDistanceEx

SensorDistanceEx.DistanceTarget

Constructor Summary

Constructors

Constructor and Description
SensorRevTOFDistance(DistanceSensor distanceSensor) Makes a distance sensor from an FTC DistanceSensor device.
SensorRevTOFDistance(DistanceSensor distanceSensor, java.util.List<SensorDistanceEx.DistanceTarget> targetList) Makes a distance sensor from an FTC DistanceSensor device and a given list of DistanceTargets
SensorRevTOFDistance(HardwareMap hardwareMap, java.lang.String name) Makes a distance sensor object from a given HardwareMap and name.
SensorRevTOFDistance(HardwareMap hardwareMap, java.lang.String name, java.util.List<SensorDistanceEx.DistanceTarget> targetList) Makes a distance sensor from a given HardwareMap and name and a given list of DistanceTargets

Method Summary

Modifier and Type	Method and Description
void	addTarget(SensorDistanceEx.DistanceTarget target) Adds a DistanceTarget.
void	addTargets(java.util.List<SensorDistanceEx.DistanceTarget> targets) Adds an List of DistanceTargets to the targets associated with this device.
java.util.HashMap<SensorDistanceEx.DistanceTarget,java.lang.Boolean>	checkAllTargets() Checks all targets currently associated with this device and returns a Map with the results.
void	disable()
java.lang.String	getDeviceType()
double	getDistance(DistanceUnit unit) Gets the current distance from the sensor.
boolean	targetReached(SensorDistanceEx.DistanceTarget target) Returns whether a given DistanceTarget has been reached

Methods inherited from class java.lang.Object

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

Constructor Detail

SensorRevTOFDistance

public SensorRevTOFDistance(DistanceSensor distanceSensor)

Makes a distance sensor from an FTC DistanceSensor device.

Parameters:

distanceSensor - the FTC DistanceSensor device

SensorRevTOFDistance

public SensorRevTOFDistance(HardwareMap hardwareMap,
                            java.lang.String name)

Makes a distance sensor object from a given HardwareMap and name.

Parameters:

hardwareMap - the hardware map the DistanceSensor is registered to

name - the name of the DistanceSensor

SensorRevTOFDistance

public SensorRevTOFDistance(DistanceSensor distanceSensor,
                            java.util.List<SensorDistanceEx.DistanceTarget> targetList)

Makes a distance sensor from an FTC DistanceSensor device and a given list of DistanceTargets

Parameters:

distanceSensor - the DistanceSensor object

targetList - an ArrayList of DistanceTargets for the SensorTOFDistance

SensorRevTOFDistance

public SensorRevTOFDistance(HardwareMap hardwareMap,
                            java.lang.String name,
                            java.util.List<SensorDistanceEx.DistanceTarget> targetList)

Makes a distance sensor from a given HardwareMap and name and a given list of DistanceTargets

Parameters:

hardwareMap - the HardwareMap the DistanceSensor is registered to

name - the name of the DistanceSensor on the hardwareMap

targetList - the ArrayList of DistanceTargets for the SensorTFODistance

Method Detail

getDistance

public double getDistance(DistanceUnit unit)

Gets the current distance from the sensor.

Specified by:

getDistance in interface SensorDistance

Parameters:

unit - The distance unit to return in.

Returns:

the distance in the indicated unit.

targetReached

public boolean targetReached(SensorDistanceEx.DistanceTarget target)

Returns whether a given DistanceTarget has been reached

Specified by:

targetReached in interface SensorDistanceEx

addTarget

public void addTarget(SensorDistanceEx.DistanceTarget target)

Adds a DistanceTarget.

Specified by:

addTarget in interface SensorDistanceEx

addTargets

public void addTargets(java.util.List<SensorDistanceEx.DistanceTarget> targets)

Adds an List of DistanceTargets to the targets associated with this device.

Specified by:

addTargets in interface SensorDistanceEx

checkAllTargets

public java.util.HashMap<SensorDistanceEx.DistanceTarget,java.lang.Boolean> checkAllTargets()

Checks all targets currently associated with this device and returns a Map with the results.

Specified by:

checkAllTargets in interface SensorDistanceEx

Returns:

The results of the checking.

disable

public void disable()

Specified by:

disable in interface HardwareDevice

getDeviceType

public java.lang.String getDeviceType()

Specified by:

getDeviceType in interface HardwareDevice