com.explodingbacon.bcnlib.sensors

Class AbstractEncoder

java.lang.Object

com.explodingbacon.bcnlib.sensors.AbstractEncoder

All Implemented Interfaces:

PIDSource

Direct Known Subclasses:

Encoder

public abstract class AbstractEncoder
extends java.lang.Object
implements PIDSource

A abstract class for Encoders.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractEncoder.PIDMode

Constructor Summary

Constructors

Constructor and Description
AbstractEncoder()

Method Summary

Modifier and Type	Method and Description
abstract int	get() Gets the value of this Encoder.
double	getForPID() Gets the value being used for PID.
AbstractEncoder.PIDMode	getPIDMode() Gets the PID Mode of this Encoder.
abstract double	getRate() Gets the rate of this Encoder.
boolean	isReversed() Checks if this Encoder is reversed.
abstract void	reset() Resets this PIDSource.
void	setPIDMode(AbstractEncoder.PIDMode p) Sets the PID Mode of this Encoder.
void	setReversed(boolean r) Sets if this Encoder should be reversed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEncoder

public AbstractEncoder()

Method Detail

setPIDMode

public void setPIDMode(AbstractEncoder.PIDMode p)

Sets the PID Mode of this Encoder.

Parameters:

p - The PID mode.

getPIDMode

public AbstractEncoder.PIDMode getPIDMode()

Gets the PID Mode of this Encoder.

Returns:

The PID Mode of this Encoder.

getRate

public abstract double getRate()

Gets the rate of this Encoder.

Returns:

The rate of this Encoder.

get

public abstract int get()

Gets the value of this Encoder.

Returns:

The value of this Encoder.

isReversed

public boolean isReversed()

Checks if this Encoder is reversed.

Returns:

If this Encoder is reversed.

setReversed

public void setReversed(boolean r)

Sets if this Encoder should be reversed.

Parameters:

r - If this Encoder should be reversed.

getForPID

public double getForPID()

Description copied from interface: PIDSource

Gets the value being used for PID.

Specified by:

getForPID in interface PIDSource

Returns:

The value being used for PID.

reset

public abstract void reset()

Description copied from interface: PIDSource

Resets this PIDSource.

Specified by:

reset in interface PIDSource