WPILibC++  unspecified
frc::DigitalGlitchFilter Class Reference

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

#include <DigitalGlitchFilter.h>

Inheritance diagram for frc::DigitalGlitchFilter:
Collaboration diagram for frc::DigitalGlitchFilter:

Public Member Functions

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::SensorBase
 SensorBase (const SensorBase &)=delete
 
SensorBaseoperator= (const SensorBase &)=delete
 
- Public Member Functions inherited from frc::ErrorBase
 ErrorBase (const ErrorBase &)=delete
 
ErrorBaseoperator= (const ErrorBase &)=delete
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 
virtual void SetErrnoError (const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::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 llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::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 llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (const llvm::Twine &errorMessage, Error::Code code, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const ErrorBase &rhs) const
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
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 () override
 Free the resources used by this object.
 
std::string GetName () const final
 Gets the name of this Sendable object. More...
 
void SetName (const llvm::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 llvm::Twine &subsystem) final
 Sets the subsystem name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Sendable
void SetName (const llvm::Twine &subsystem, const llvm::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::SensorBase
static int GetDefaultSolenoidModule ()
 
static bool CheckSolenoidModule (int moduleNumber)
 Check that the solenoid module number is valid. More...
 
static bool CheckDigitalChannel (int channel)
 Check that the digital channel number is valid. More...
 
static bool CheckRelayChannel (int channel)
 Check that the relay channel number is valid. More...
 
static bool CheckPWMChannel (int channel)
 Check that the digital channel number is valid. More...
 
static bool CheckAnalogInputChannel (int channel)
 Check that the analog input number is value. More...
 
static bool CheckAnalogOutputChannel (int channel)
 Check that the analog output number is valid. More...
 
static bool CheckSolenoidChannel (int channel)
 Verify that the solenoid channel number is within limits. More...
 
static bool CheckPDPChannel (int channel)
 Verify that the power distribution channel number is within limits. More...
 
- Static Public Member Functions inherited from frc::ErrorBase
static void SetGlobalError (Error::Code code, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber)
 
static void SetGlobalWPIError (const llvm::Twine &errorMessage, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber)
 
static ErrorGetGlobalError ()
 Retrieve the current global error.
 
- Static Public Attributes inherited from frc::SensorBase
static const int kDigitalChannels = HAL_GetNumDigitalChannels()
 
static const int kAnalogInputs = HAL_GetNumAnalogInputs()
 
static const int kAnalogOutputs
 
static const int kSolenoidChannels = HAL_GetNumSolenoidChannels()
 
static const int kSolenoidModules = HAL_GetNumPCMModules()
 
static const int kPwmChannels = HAL_GetNumPWMChannels()
 
static const int kRelayChannels = HAL_GetNumRelayHeaders()
 
static const int kPDPChannels = HAL_GetNumPDPChannels()
 
- 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 llvm::Twine &moduleType, int channel)
 Sets the name of the sensor with a channel number. More...
 
void SetName (const llvm::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
 
- Static Protected Attributes inherited from frc::ErrorBase
static wpi::mutex _globalErrorMutex
 
static Error _globalError
 

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 DigitalGlitchFilter::Add ( DigitalSource input)

Assigns the DigitalSource to this glitch filter.

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

Assigns the Encoder to this glitch filter.

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

Assigns the Counter to this glitch filter.

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

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

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

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

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

Initializes this Sendable object.

Parameters
buildersendable builder

Implements frc::Sendable.

void 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 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 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 DigitalGlitchFilter::SetPeriodCycles ( int  fpgaCycles)

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

Parameters
fpgaCyclesThe number of FPGA cycles.
void 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 files: