encoder.h
Go to the documentation of this file.
1 #ifndef PHIDGETS_API_ENCODER_H
2 #define PHIDGETS_API_ENCODER_H
3 
4 #include "phidgets_api/phidget.h"
5 
6 namespace phidgets
7 {
8 
9 class Encoder: public Phidget
10 {
11 public:
12  Encoder();
13 
15  int getInputCount();
16 
19  bool getInputState(int index);
20 
22  int getEncoderCount();
23 
26  int getPosition(int index);
27 
31  void setPosition(int index, int position);
32 
36  int getIndexPosition(int index);
37 
40  bool getEnabled(int index);
41 
46  void setEnabled(int index, bool enabled);
47 
48 protected:
49  CPhidgetEncoderHandle encoder_handle_;
50 
51  virtual void inputChangeHandler(int index, int inputState);
52  virtual void positionChangeHandler(int index, int time, int positionChange);
53  virtual void indexHandler(int index, int indexPosition);
54 
55 private:
56  static int InputChangeHandler(CPhidgetEncoderHandle phid, void *userPtr, int index, int inputState);
57  static int PositionChangeHandler(CPhidgetEncoderHandle phid, void *userPtr, int index, int time, int positionChange);
58  static int IndexHandler(CPhidgetEncoderHandle phid, void *userPtr, int index, int indexPosition);
59 };
60 
61 } //namespace phidgets
62 
63 #endif // PHIDGETS_API_ENCODEr_H
CPhidgetEncoderHandle encoder_handle_
Definition: encoder.h:49
static int InputChangeHandler(CPhidgetEncoderHandle phid, void *userPtr, int index, int inputState)
Definition: encoder.cpp:104
virtual void indexHandler(int index, int indexPosition)
Definition: encoder.cpp:132
int getInputCount()
Gets the number of digital input channels supported by this board.
Definition: encoder.cpp:27
int getIndexPosition(int index)
Gets the position of an encoder the last time an index pulse occured. An index pulse in this context ...
Definition: encoder.cpp:74
virtual void inputChangeHandler(int index, int inputState)
Definition: encoder.cpp:122
void setEnabled(int index, bool enabled)
Set the powered state of an encoder. If an encoder is not enabled, it will not be given power...
Definition: encoder.cpp:97
int getEncoderCount()
Gets the number of encoder input channels supported by this board.
Definition: encoder.cpp:47
int getPosition(int index)
Reads the current position of an encoder.
Definition: encoder.cpp:57
static int PositionChangeHandler(CPhidgetEncoderHandle phid, void *userPtr, int index, int time, int positionChange)
Definition: encoder.cpp:110
bool getInputState(int index)
Reads the current state of a digital input.
Definition: encoder.cpp:37
static int IndexHandler(CPhidgetEncoderHandle phid, void *userPtr, int index, int indexPosition)
Definition: encoder.cpp:116
void setPosition(int index, int position)
Sets the offset of an encoder such that current position is the specified value.
Definition: encoder.cpp:67
bool getEnabled(int index)
Checks if an encoder is powered on and receiving events.
Definition: encoder.cpp:87
virtual void positionChangeHandler(int index, int time, int positionChange)
Definition: encoder.cpp:127


phidgets_api
Author(s): Tully Foote, Ivan Dryanovski
autogenerated on Tue May 7 2019 03:19:24