IJoystick.h

Go to the documentation of this file.

#ifndef _ARDUINOUNIVERSALINPUTS_IJOYSTICK_H
#define _ARDUINOUNIVERSALINPUTS_IJOYSTICK_H

#include "IInputDevice.h"
#include "IValueTransform.h"

class IJoystick : public IInputDevice
{
public:
  IJoystick(inputid_t id);
  virtual ~IJoystick();

  inputtype_t type() const { return UIT_JOYSTICK; }

  bool poll();

  inputanalog_t getRawValue() const { return m_value; }

  inputanalog_t getCentredValue() const;
  inputanalog_t getValue() const;

  void setTransformation(IValueTransform *transform);

  bool setThreshold(inputanalog_t threshold);

  inputanalog_t getThreshold() const { return m_threshold; }

  bool setPoints(inputanalog_t low, inputanalog_t centre, inputanalog_t high);
  bool setPoints(inputanalog_t low, inputanalog_t high);
  bool setDeadbands(inputanalog_t low, inputanalog_t centre,
                    inputanalog_t high);
  bool setDeadbands(inputanalog_t low, inputanalog_t high);

  inputanalog_t getLowPoint() const { return m_low; }

  inputanalog_t getCentrePoint() const { return m_centre; }

  inputanalog_t getHighPoint() const { return m_high; }

  inputanalog_t getLowDeadband() const { return m_deadbandLow; }

  inputanalog_t getCentreDeadband() const { return m_deadbandCentre; }

  inputanalog_t getHighDeadband() const { return m_deadbandHigh; }

protected:
  virtual inputanalog_t getPhysicalValue() const = 0;

private:
  bool withinTolerance(inputanalog_t a, inputanalog_t b,
                       inputanalog_t tolerance) const;

  IValueTransform *m_transform; 
  inputanalog_t
      m_threshold; 

  inputanalog_t m_value; 

  inputanalog_t m_low;    
  inputanalog_t m_centre; 
  inputanalog_t m_high;   

  inputanalog_t m_deadbandLow;    
  inputanalog_t m_deadbandCentre; 
  inputanalog_t m_deadbandHigh;   
};

#endif