com.explodingbacon.bcnlib.sensors

Class Encoder

java.lang.Object

com.explodingbacon.bcnlib.sensors.AbstractEncoder

com.explodingbacon.bcnlib.sensors.Encoder

All Implemented Interfaces:

PIDSource

public class Encoder
extends AbstractEncoder

A class for standard Encoders.

Nested Class Summary

Nested classes/interfaces inherited from class com.explodingbacon.bcnlib.sensors.AbstractEncoder

AbstractEncoder.PIDMode

Constructor Summary

Constructors

Constructor and Description
Encoder(int aChannel, int bChannel) Creates an Encoder.
Encoder(int aChannel, int bChannel, boolean reverse) Creates an Encoder that is optionally reversed.

Method Summary

Modifier and Type	Method and Description
int	get() Gets the value of this Encoder.
double	getRate() Gets the rate of this Encoder.
void	reset() Resets this PIDSource.

Methods inherited from class com.explodingbacon.bcnlib.sensors.AbstractEncoder

getForPID, getPIDMode, isReversed, setPIDMode, setReversed

Methods inherited from class java.lang.Object

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

Constructor Detail

Encoder

public Encoder(int aChannel,
               int bChannel)

Creates an Encoder.

Parameters:

aChannel - This Encoder's first port.

bChannel - This Encoder's second port.

Encoder

public Encoder(int aChannel,
               int bChannel,
               boolean reverse)

Creates an Encoder that is optionally reversed.

Parameters:

aChannel - This Encoder's first port.

bChannel - This Encoder's second port.

reverse - If this Encoder should be reversed.

Method Detail

reset

public void reset()

Description copied from interface: PIDSource

Resets this PIDSource.

Specified by:

reset in interface PIDSource

Specified by:

reset in class AbstractEncoder

get

public int get()

Description copied from class: AbstractEncoder

Gets the value of this Encoder.

Specified by:

get in class AbstractEncoder

Returns:

The value of this Encoder.

getRate

public double getRate()

Description copied from class: AbstractEncoder

Gets the rate of this Encoder.

Specified by:

getRate in class AbstractEncoder

Returns:

The rate of this Encoder.