Open FFBoard
Open source force feedback firmware
Public Member Functions | Private Attributes | List of all members
EffectsControlItf Class Referenceabstract

#include <EffectsCalculator.h>

Inheritance diagram for EffectsControlItf:
HidFFB SerialFFB

Public Member Functions

virtual void set_FFB (bool state)=0
 
virtual void stop_FFB ()
 
virtual void start_FFB ()
 
virtual void reset_ffb ()=0
 
virtual uint32_t getConstantForceRate ()
 
virtual uint32_t getRate ()
 
virtual bool getFfbActive ()=0
 
virtual void set_gain (uint8_t gain)=0
 
virtual void cfUpdateEvent ()
 
virtual void fxUpdateEvent ()
 

Private Attributes

FastMovingAverage< float > fxPeriodAvg {20}
 
FastMovingAverage< float > cfUpdatePeriodAvg {20}
 
uint32_t lastFxUpdate = 0
 
uint32_t lastCfUpdate = 0
 

Detailed Description

Helper interface class for common effects calculator related control functions

Definition at line 141 of file EffectsCalculator.h.

Member Function Documentation

◆ cfUpdateEvent()

void EffectsControlItf::cfUpdateEvent ( )
virtual

Definition at line 1028 of file EffectsCalculator.cpp.

◆ fxUpdateEvent()

void EffectsControlItf::fxUpdateEvent ( )
virtual

Definition at line 1033 of file EffectsCalculator.cpp.

◆ getConstantForceRate()

uint32_t EffectsControlItf::getConstantForceRate ( )
virtual

Calculates the frequency of the CF effect only

Definition at line 1016 of file EffectsCalculator.cpp.

◆ getFfbActive()

virtual bool EffectsControlItf::getFfbActive ( )
pure virtual

Implemented in HidFFB, and SerialFFB.

◆ getRate()

uint32_t EffectsControlItf::getRate ( )
virtual

Calculates the frequency of hid out reports

Definition at line 1002 of file EffectsCalculator.cpp.

◆ reset_ffb()

virtual void EffectsControlItf::reset_ffb ( )
pure virtual

Implemented in HidFFB, and SerialFFB.

◆ set_FFB()

virtual void EffectsControlItf::set_FFB ( bool  state)
pure virtual

Implemented in HidFFB, and SerialFFB.

◆ set_gain()

virtual void EffectsControlItf::set_gain ( uint8_t  gain)
pure virtual

Implemented in HidFFB, and SerialFFB.

◆ start_FFB()

virtual void EffectsControlItf::start_FFB ( )
inlinevirtual

Reimplemented in HidFFB.

Definition at line 145 of file EffectsCalculator.h.

◆ stop_FFB()

virtual void EffectsControlItf::stop_FFB ( )
inlinevirtual

Reimplemented in HidFFB.

Definition at line 144 of file EffectsCalculator.h.

Member Data Documentation

◆ cfUpdatePeriodAvg

FastMovingAverage<float> EffectsControlItf::cfUpdatePeriodAvg {20}
private

Definition at line 156 of file EffectsCalculator.h.

◆ fxPeriodAvg

FastMovingAverage<float> EffectsControlItf::fxPeriodAvg {20}
private

Definition at line 155 of file EffectsCalculator.h.

◆ lastCfUpdate

uint32_t EffectsControlItf::lastCfUpdate = 0
private

Definition at line 159 of file EffectsCalculator.h.

◆ lastFxUpdate

uint32_t EffectsControlItf::lastFxUpdate = 0
private

Definition at line 158 of file EffectsCalculator.h.

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