Package edu.wpi.first.wpilibj.counter
Class UpDownCounter
java.lang.Object
edu.wpi.first.wpilibj.counter.UpDownCounter
- All Implemented Interfaces:
Sendable,AutoCloseable
Up Down Counter.
This class can count edges on a single digital input or count up based on an edge from one digital input and down on an edge from another digital input.
-
Constructor Summary
ConstructorsConstructorDescriptionUpDownCounter(DigitalSource upSource, DigitalSource downSource) Constructs a new UpDown Counter. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()intgetCount()Gets the current count.voidinitSendable(SendableBuilder builder) Initializes thisSendableobject.final voidreset()Resets the current count.voidsetDownEdgeConfiguration(EdgeConfiguration configuration) Sets the configuration for the down source.voidsetReverseDirection(boolean reverseDirection) Sets to reverse the counter direction.voidsetUpEdgeConfiguration(EdgeConfiguration configuration) Sets the configuration for the up source.
-
Constructor Details
-
UpDownCounter
Constructs a new UpDown Counter.- Parameters:
upSource- The up count source (can be null).downSource- The down count source (can be null).
-
-
Method Details
-
close
- Specified by:
closein interfaceAutoCloseable
-
setUpEdgeConfiguration
Sets the configuration for the up source.- Parameters:
configuration- The up source configuration.
-
setDownEdgeConfiguration
Sets the configuration for the down source.- Parameters:
configuration- The down source configuration.
-
reset
Resets the current count. -
setReverseDirection
Sets to reverse the counter direction.- Parameters:
reverseDirection- True to reverse counting direction.
-
getCount
Gets the current count.- Returns:
- The current count.
-
initSendable
Description copied from interface:SendableInitializes thisSendableobject.- Specified by:
initSendablein interfaceSendable- Parameters:
builder- sendable builder
-