wpi::UpDownCounter Class Reference

Up Down Counter. More...

#include <wpi/counter/UpDownCounter.hpp>

Inheritance diagram for wpi::UpDownCounter:

Public Member Functions
	UpDownCounter (int channel, EdgeConfiguration configuration)
	Constructs a new UpDown Counter.
	UpDownCounter (UpDownCounter &&)=default
UpDownCounter &	operator= (UpDownCounter &&)=default
	~UpDownCounter () override=default
int	GetCount () const
	Gets the current count.
void	Reset ()
	Resets the current count.
void	SetEdgeConfiguration (EdgeConfiguration configuration)
	Sets the configuration for the channel.
Public Member Functions inherited from wpi::util::Sendable
virtual constexpr	~Sendable ()=default
Public Member Functions inherited from wpi::util::SendableHelper< UpDownCounter >
constexpr	SendableHelper (const SendableHelper &rhs)=default
constexpr SendableHelper &	operator= (const SendableHelper &rhs)=default

Protected Member Functions
void	InitSendable (wpi::util::SendableBuilder &builder) override
	Initializes this Sendable object.
Protected Member Functions inherited from wpi::util::SendableHelper< UpDownCounter >
constexpr	~SendableHelper ()

Detailed Description

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 & Destructor Documentation

UpDownCounter() [1/2]

wpi::UpDownCounter::UpDownCounter	(	int	channel,
		EdgeConfiguration	configuration )

Constructs a new UpDown Counter.

Parameters

channel	The DIO channel
configuration	Edge configuration

UpDownCounter() [2/2]

wpi::UpDownCounter::UpDownCounter ( UpDownCounter && )

default

~UpDownCounter()

wpi::UpDownCounter::~UpDownCounter ( )

overridedefault

Member Function Documentation

GetCount()

int wpi::UpDownCounter::GetCount

(

)

const

Gets the current count.

Returns

The current count.

InitSendable()

void wpi::UpDownCounter::InitSendable ( wpi::util::SendableBuilder & builder )

overrideprotectedvirtual

Initializes this Sendable object.

Parameters

builder

sendable builder

Implements wpi::util::Sendable.

operator=()

UpDownCounter & wpi::UpDownCounter::operator= ( UpDownCounter && )

default

Reset()

void wpi::UpDownCounter::Reset

(

)

Resets the current count.

SetEdgeConfiguration()

void wpi::UpDownCounter::SetEdgeConfiguration

(

EdgeConfiguration

configuration

)

Sets the configuration for the channel.

Parameters

configuration

The channel configuration.

---

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

• wpi/counter/UpDownCounter.hpp