io.github.robolib.module.sensor

Class CounterBase

java.lang.Object

io.github.robolib.module.sensor.CounterBase

All Implemented Interfaces:

CounterSource

Direct Known Subclasses:

Counter, Encoder

public abstract class CounterBase
extends java.lang.Object
implements CounterSource

Author:

noriah

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CounterBase.EncodingType Possible Encoding types

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_index

Constructor Summary

Constructors

Constructor and Description
CounterBase()

Method Summary

Modifier and Type	Method and Description
int	get() Read the current counter value.
abstract int	getCount() Read the current counter value.
(package private) abstract boolean	getDirection() Determine which direction the counter is going
int	getFPGAIndex()
(package private) abstract double	getPeriod() Get the time between the last two edges counted
(package private) abstract boolean	getStopped() Determine if the counter is not moving
abstract void	reset() Reset the count to zero
(package private) abstract void	setMaxPeriod(double max) Set the maximum time between edges to be considered stalled

Methods inherited from class java.lang.Object

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

Field Detail

m_index

protected int m_index

Constructor Detail

CounterBase

public CounterBase()

Method Detail

getFPGAIndex

public int getFPGAIndex()

Returns:

the Counter's FPGA index

get

public int get()

Read the current counter value. Read the value at this instant. It may still be running, so it reflects the current value. Next time it is read, it might have a different value.

getCount

public abstract int getCount()

Read the current counter value. Read the value at this instant. It may still be running, so it reflects the current value. Next time it is read, it might have a different value.

Specified by:

getCount in interface CounterSource

Returns:

the count of this counter

reset

public abstract void reset()

Reset the count to zero

Specified by:

reset in interface CounterSource

getPeriod

abstract double getPeriod()

Get the time between the last two edges counted

Returns:

the time beteween the last two ticks in seconds

setMaxPeriod

abstract void setMaxPeriod(double max)

Set the maximum time between edges to be considered stalled

Parameters:

max - the maximum period in seconds

getStopped

abstract boolean getStopped()

Determine if the counter is not moving

Returns:

true if the counter has not changed for the max period

getDirection

abstract boolean getDirection()

Determine which direction the counter is going

Returns:

true for one direction, false for the other