Package xbot.common.controls.sensors

Class XEncoder

java.lang.Object

xbot.common.controls.sensors.XEncoder

All Implemented Interfaces:

DataFrameRefreshable

Direct Known Subclasses:

EncoderWPIAdapter, MockEncoder

public abstract class XEncoder
extends Object
implements DataFrameRefreshable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	XEncoder.XEncoderFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected DoubleProperty	distancePerPulse
protected DoubleSupplier	distancePerPulseSupplier
protected boolean	isInverted

Constructor Summary

Constructors

Constructor	Description
XEncoder(String name, int aChannel, int bChannel, double defaultDistancePerPulse, String owningSystemPrefix, PropertyFactory propMan, DevicePolice police)

Method Summary

Modifier and Type	Method	Description
double	getAdjustedDistance()
double	getAdjustedRate()
protected abstract double	getDistance()
protected abstract double	getRate()
void	refreshDataFrame()	Consumes and processes inputs from the device or subsystem.
void	setDistancePerPulseSupplier(DoubleSupplier supplier)
void	setInverted(boolean inverted)
abstract void	setSamplesToAverage(int samples)
abstract void	updateInputs(XEncoderInputs inputs)

Methods inherited from class java.lang.Object

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

Field Details

isInverted

protected boolean isInverted

distancePerPulse

protected DoubleProperty distancePerPulse

distancePerPulseSupplier

protected DoubleSupplier distancePerPulseSupplier

Constructor Details

XEncoder

public XEncoder(String name,
 int aChannel,
 int bChannel,
 double defaultDistancePerPulse,
 String owningSystemPrefix,
 PropertyFactory propMan,
 DevicePolice police)

Method Details

setDistancePerPulseSupplier

public void setDistancePerPulseSupplier(DoubleSupplier supplier)

getAdjustedDistance

public double getAdjustedDistance()

getAdjustedRate

public double getAdjustedRate()

setInverted

public void setInverted(boolean inverted)

getRate

protected abstract double getRate()

getDistance

protected abstract double getDistance()

setSamplesToAverage

public abstract void setSamplesToAverage(int samples)

updateInputs

public abstract void updateInputs(XEncoderInputs inputs)

refreshDataFrame

public void refreshDataFrame()

Description copied from interface: DataFrameRefreshable

Consumes and processes inputs from the device or subsystem.

Specified by:

refreshDataFrame in interface DataFrameRefreshable