frc::UpDownCounter Class Reference

Up Down Counter. More...

#include <frc/counter/UpDownCounter.h>

Inheritance diagram for frc::UpDownCounter:

Public Member Functions
	UpDownCounter (DigitalSource &upSource, DigitalSource &downSource)
	Constructs a new UpDown Counter.
	UpDownCounter (std::shared_ptr< DigitalSource > upSource, std::shared_ptr< DigitalSource > downSource)
	Constructs a new UpDown Counter.
	UpDownCounter (UpDownCounter &&)=default
UpDownCounter &	operator= (UpDownCounter &&)=default
	~UpDownCounter () override=default
int	GetCount () const
	Gets the current count.
void	SetReverseDirection (bool reverseDirection)
	Sets to revert the counter direction.
void	Reset ()
	Resets the current count.
void	SetUpEdgeConfiguration (EdgeConfiguration configuration)
	Sets the configuration for the up source.
void	SetDownEdgeConfiguration (EdgeConfiguration configuration)
	Sets the configuration for the down source.
Public Member Functions inherited from wpi::Sendable
virtual constexpr	~Sendable ()=default
Public Member Functions inherited from wpi::SendableHelper< UpDownCounter >
constexpr	SendableHelper (const SendableHelper &rhs)=default
constexpr	SendableHelper (SendableHelper &&rhs)
constexpr SendableHelper &	operator= (const SendableHelper &rhs)=default
constexpr SendableHelper &	operator= (SendableHelper &&rhs)

Protected Member Functions
void	InitSendable (wpi::SendableBuilder &builder) override
	Initializes this Sendable object.
Protected Member Functions inherited from wpi::SendableHelper< UpDownCounter >
constexpr	SendableHelper ()=default
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/3]

frc::UpDownCounter::UpDownCounter	(	DigitalSource &	upSource,
		DigitalSource &	downSource )

Constructs a new UpDown Counter.

Parameters

upSource	The up count source (can be null).
downSource	The down count source (can be null).

UpDownCounter() [2/3]

frc::UpDownCounter::UpDownCounter	(	std::shared_ptr< DigitalSource >	upSource,
		std::shared_ptr< DigitalSource >	downSource )

Constructs a new UpDown Counter.

Parameters

upSource	The up count source (can be null).
downSource	The down count source (can be null).

UpDownCounter() [3/3]

frc::UpDownCounter::UpDownCounter ( UpDownCounter && )

default

~UpDownCounter()

frc::UpDownCounter::~UpDownCounter ( )

overridedefault

Member Function Documentation

GetCount()

int frc::UpDownCounter::GetCount

(

)

const

Gets the current count.

Returns

The current count.

InitSendable()

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

overrideprotectedvirtual

Initializes this Sendable object.

Parameters

builder

sendable builder

Implements wpi::Sendable.

operator=()

UpDownCounter & frc::UpDownCounter::operator= ( UpDownCounter && )

default

Reset()

void frc::UpDownCounter::Reset

(

)

Resets the current count.

SetDownEdgeConfiguration()

void frc::UpDownCounter::SetDownEdgeConfiguration

(

EdgeConfiguration

configuration

)

Sets the configuration for the down source.

Parameters

configuration

The down source configuration.

SetReverseDirection()

void frc::UpDownCounter::SetReverseDirection

(

bool

reverseDirection

)

Sets to revert the counter direction.

Parameters

reverseDirection

True to reverse counting direction.

SetUpEdgeConfiguration()

void frc::UpDownCounter::SetUpEdgeConfiguration

(

EdgeConfiguration

configuration

)

Sets the configuration for the up source.

Parameters

configuration

The up source configuration.

---

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

• frc/counter/UpDownCounter.h