WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
DigitalGlitchFilter Class Reference

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

#include <DigitalGlitchFilter.h>

Inheritance diagram for DigitalGlitchFilter:
SensorBase ErrorBase

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 (uint32_t fpga_cycles)
 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...
 
uint32_t 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...
 
- Public Member Functions inherited from SensorBase
 SensorBase ()
 Creates an instance of the sensor base and gets an FPGA handle.
 
 SensorBase (const SensorBase &)=delete
 
SensorBaseoperator= (const SensorBase &)=delete
 
- Public Member Functions inherited from ErrorBase
 ErrorBase (const ErrorBase &)=delete
 
ErrorBaseoperator= (const ErrorBase &)=delete
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 
virtual void SetErrnoError (llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t 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, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (llvm::StringRef errorMessage, Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from SensorBase
static void DeleteSingletons ()
 Delete all the singleton classes on the list. More...
 
static uint32_t GetDefaultSolenoidModule ()
 
static bool CheckSolenoidModule (uint8_t moduleNumber)
 Check that the solenoid module number is valid. More...
 
static bool CheckDigitalChannel (uint32_t channel)
 Check that the digital channel number is valid. More...
 
static bool CheckRelayChannel (uint32_t channel)
 Check that the digital channel number is valid. More...
 
static bool CheckPWMChannel (uint32_t channel)
 Check that the digital channel number is valid. More...
 
static bool CheckAnalogInput (uint32_t channel)
 Check that the analog input number is value. More...
 
static bool CheckAnalogOutput (uint32_t channel)
 Check that the analog output number is valid. More...
 
static bool CheckSolenoidChannel (uint32_t channel)
 Verify that the solenoid channel number is within limits. More...
 
static bool CheckPDPChannel (uint32_t channel)
 Verify that the power distribution channel number is within limits. More...
 
- Static Public Member Functions inherited from ErrorBase
static void SetGlobalError (Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber)
 
static void SetGlobalWPIError (llvm::StringRef errorMessage, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber)
 
static ErrorGetGlobalError ()
 Retrieve the current global error.
 
- Static Public Attributes inherited from SensorBase
static const uint32_t kDigitalChannels = 26
 
static const uint32_t kAnalogInputs = 8
 
static const uint32_t kAnalogOutputs = 2
 
static const uint32_t kSolenoidChannels = 8
 
static const uint32_t kSolenoidModules = 2
 
static const uint32_t kPwmChannels = 20
 
static const uint32_t kRelayChannels = 8
 
static const uint32_t kPDPChannels = 16
 
static const uint32_t kChassisSlots = 8
 
- Protected Member Functions inherited from SensorBase
void AddToSingletonList ()
 Add sensor to the singleton list. More...
 
- Protected Attributes inherited from ErrorBase
Error m_error
 
- Static Protected Attributes inherited from SensorBase
static void * m_digital_ports [kDigitalChannels]
 
static void * m_relay_ports [kRelayChannels]
 
static void * m_pwm_ports [kPwmChannels]
 
- Static Protected Attributes inherited from ErrorBase
static priority_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.
uint32_t 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::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 ( uint32_t  fpga_cycles)

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

Parameters
fpga_cyclesThe 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: