WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::DigitalGlitchFilter Class Reference

Class to enable glitch filtering on a set of digital inputs. More...

#include <DigitalGlitchFilter.h>

Inheritance diagram for frc::DigitalGlitchFilter:
frc::ErrorBase frc::SendableBase frc::Sendable

Public Member Functions

 DigitalGlitchFilter (DigitalGlitchFilter &&rhs)
 
DigitalGlitchFilteroperator= (DigitalGlitchFilter &&rhs)
 
void Add (DigitalSource *input)
 Assigns the DigitalSource to this glitch filter. More...
 
void Add (Encoder *input)
 Assigns the Encoder to this glitch filter. More...
 
void Add (Counter *input)
 Assigns the Counter to this glitch filter. More...
 
void Remove (DigitalSource *input)
 Removes a digital input from this filter. More...
 
void Remove (Encoder *input)
 Removes an encoder from this filter. More...
 
void Remove (Counter *input)
 Removes a counter from this filter. More...
 
void SetPeriodCycles (int fpgaCycles)
 Sets the number of cycles that the input must not change state for. More...
 
void SetPeriodNanoSeconds (uint64_t nanoseconds)
 Sets the number of nanoseconds that the input must not change state for. More...
 
int GetPeriodCycles ()
 Gets the number of cycles that the input must not change state for. More...
 
uint64_t GetPeriodNanoSeconds ()
 Gets the number of nanoseconds that the input must not change state for. More...
 
void InitSendable (SendableBuilder &builder) override
 Initializes this Sendable object. More...
 
- Public Member Functions inherited from frc::ErrorBase
 ErrorBase (ErrorBase &&)=default
 
ErrorBaseoperator= (ErrorBase &&)=default
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 Retrieve the current error. More...
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
virtual void SetErrnoError (const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set error information associated with a C library call that set an error to the "errno" global variable. More...
 
virtual void SetImaqError (int success, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetErrorRange (Error::Code code, int32_t minRange, int32_t maxRange, int32_t requestedValue, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (const wpi::Twine &errorMessage, Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const ErrorBase &rhs) const
 
virtual bool StatusIsFatal () const
 Check if the current error code represents a fatal error. More...
 
- Public Member Functions inherited from frc::SendableBase
 SendableBase (bool addLiveWindow=true)
 Creates an instance of the sensor base. More...
 
 SendableBase (SendableBase &&rhs)
 
SendableBaseoperator= (SendableBase &&rhs)
 
std::string GetName () const final
 Gets the name of this Sendable object. More...
 
void SetName (const wpi::Twine &name) final
 Sets the name of this Sendable object. More...
 
std::string GetSubsystem () const final
 Gets the subsystem name of this Sendable object. More...
 
void SetSubsystem (const wpi::Twine &subsystem) final
 Sets the subsystem name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Sendable
 Sendable (Sendable &&)=default
 
Sendableoperator= (Sendable &&)=default
 
void SetName (const wpi::Twine &subsystem, const wpi::Twine &name)
 Sets both the subsystem name and device name of this Sendable object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from frc::ErrorBase
static void SetGlobalError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber)
 
static void SetGlobalWPIError (const wpi::Twine &errorMessage, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber)
 
static const ErrorGetGlobalError ()
 Retrieve the current global error.
 
- Protected Member Functions inherited from frc::SendableBase
void AddChild (std::shared_ptr< Sendable > child)
 Add a child component. More...
 
void AddChild (void *child)
 Add a child component. More...
 
void SetName (const wpi::Twine &moduleType, int channel)
 Sets the name of the sensor with a channel number. More...
 
void SetName (const wpi::Twine &moduleType, int moduleNumber, int channel)
 Sets the name of the sensor with a module and channel number. More...
 
- Protected Attributes inherited from frc::ErrorBase
Error m_error
 

Detailed Description

Class to enable glitch filtering on a set of digital inputs.

This class will manage adding and removing digital inputs from a FPGA glitch filter. The filter lets the user configure the time that an input must remain high or low before it is classified as high or low.

Member Function Documentation

void frc::DigitalGlitchFilter::Add ( DigitalSource input)

Assigns the DigitalSource to this glitch filter.

Parameters
inputThe DigitalSource to add.
void frc::DigitalGlitchFilter::Add ( Encoder input)

Assigns the Encoder to this glitch filter.

Parameters
inputThe Encoder to add.
void frc::DigitalGlitchFilter::Add ( Counter input)

Assigns the Counter to this glitch filter.

Parameters
inputThe Counter to add.
int frc::DigitalGlitchFilter::GetPeriodCycles ( )

Gets the number of cycles that the input must not change state for.

Returns
The number of cycles.
uint64_t frc::DigitalGlitchFilter::GetPeriodNanoSeconds ( )

Gets the number of nanoseconds that the input must not change state for.

Returns
The number of nanoseconds.
void frc::DigitalGlitchFilter::InitSendable ( SendableBuilder builder)
overridevirtual

Initializes this Sendable object.

Parameters
buildersendable builder

Implements frc::Sendable.

void frc::DigitalGlitchFilter::Remove ( DigitalSource input)

Removes a digital input from this filter.

Removes the DigitalSource from this glitch filter and re-assigns it to the default filter.

Parameters
inputThe DigitalSource to remove.
void frc::DigitalGlitchFilter::Remove ( Encoder input)

Removes an encoder from this filter.

Removes the Encoder from this glitch filter and re-assigns it to the default filter.

Parameters
inputThe Encoder to remove.
void frc::DigitalGlitchFilter::Remove ( Counter input)

Removes a counter from this filter.

Removes the Counter from this glitch filter and re-assigns it to the default filter.

Parameters
inputThe Counter to remove.
void frc::DigitalGlitchFilter::SetPeriodCycles ( int  fpgaCycles)

Sets the number of cycles that the input must not change state for.

Parameters
fpgaCyclesThe number of FPGA cycles.
void frc::DigitalGlitchFilter::SetPeriodNanoSeconds ( uint64_t  nanoseconds)

Sets the number of nanoseconds that the input must not change state for.

Parameters
nanosecondsThe number of nanoseconds.

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