com.ridgesoft.robotics
Interface ShaftEncoder

All Known Implementing Classes:

AnalogShaftEncoder, IntelliBrainShaftEncoder

public interface ShaftEncoder

Generic interface to a shaft encoder.

The maximum rate at which a particular shaft encoder can count is determined by the implementation of this class and may vary. Consult the documentation for the class which implement this interface for specific details.

Method Summary

int	getCounts() Reads the current shaft encoder counter value.
int	getRate() Reads the current counting rate of the shaft encoder.

Method Detail

getCounts

public int getCounts()

Reads the current shaft encoder counter value.

Returns:

counter value

getRate

public int getRate()

Reads the current counting rate of the shaft encoder.

The period over which this rate is calculated is determined by the class which implements this interface. Consult the documentation for the class which implement this interface for specific details.

Returns:

current encoder counting rate