wpi::CounterBase Class Reference

Interface for counting the number of ticks on a digital input channel. More...

#include <wpi/hardware/discrete/CounterBase.hpp>

Inheritance diagram for wpi::CounterBase:

Public Types
enum class	EncodingType { X1 , X2 , X4 }
	The number of edges for the CounterBase to increment or decrement on. More...

Public Member Functions
	CounterBase ()=default
virtual	~CounterBase ()=default
	CounterBase (CounterBase &&)=default
CounterBase &	operator= (CounterBase &&)=default
virtual int	Get () const =0
virtual void	Reset ()=0
virtual wpi::units::second_t	GetPeriod () const =0
virtual void	SetMaxPeriod (wpi::units::second_t maxPeriod)=0
virtual bool	GetStopped () const =0
virtual bool	GetDirection () const =0

Detailed Description

Interface for counting the number of ticks on a digital input channel.

Encoders, Gear tooth sensors, and counters should all subclass this so it can be used to build more advanced classes for control and driving.

All counters will immediately start counting - Reset() them if you need them to be zeroed before use.

Member Enumeration Documentation

EncodingType

enum class wpi::CounterBase::EncodingType

strong

The number of edges for the CounterBase to increment or decrement on.

Enumerator
X1
X2
X4

Constructor & Destructor Documentation

CounterBase() [1/2]

wpi::CounterBase::CounterBase ( )

default

~CounterBase()

virtual wpi::CounterBase::~CounterBase ( )

virtualdefault

CounterBase() [2/2]

wpi::CounterBase::CounterBase ( CounterBase && )

default

Member Function Documentation

Get()

virtual int wpi::CounterBase::Get ( ) const

pure virtual

Implemented in wpi::Encoder.

GetDirection()

virtual bool wpi::CounterBase::GetDirection ( ) const

pure virtual

Implemented in wpi::Encoder.

GetPeriod()

virtual wpi::units::second_t wpi::CounterBase::GetPeriod ( ) const

pure virtual

Implemented in wpi::Encoder.

GetStopped()

virtual bool wpi::CounterBase::GetStopped ( ) const

pure virtual

Implemented in wpi::Encoder.

operator=()

CounterBase & wpi::CounterBase::operator= ( CounterBase && )

default

Reset()

virtual void wpi::CounterBase::Reset ( )

pure virtual

Implemented in wpi::Encoder.

SetMaxPeriod()

virtual void wpi::CounterBase::SetMaxPeriod ( wpi::units::second_t maxPeriod )

pure virtual

Implemented in wpi::Encoder.

---

The documentation for this class was generated from the following file:

• wpi/hardware/discrete/CounterBase.hpp