Representations/JoystickData.h

Go to the documentation of this file.

/**
 * @file JoystickData.h
 * Declaration of class JoystickData.
 *
 * @author <a href=mailto:dueffert@informatik.hu-berlin.de>Uwe Düffert</a>
 */

#ifndef __JOYSTICKDATA_H__
#define __JOYSTICKDATA_H__

#include "Representations/Motion/MotionRequest.h"
#include "Tools/Streams/InOut.h"

/** the maximum number of configurable buttons */
static const int numOfJoystickButtons = 12;

/**
 * @class JoystickData
 * A class for holdung all data produced by a joystick or a key equivalent.
 */
class JoystickData
{
public:
  /** Constructor */
  JoystickData();

  /** The value of the three joystick axes in [-1,1] */
  double x,y,z;

  /** The value of the accelerator in [0,1] */
  double accel;
  
  /** Bit array of the pressed buttons */
  int button;
  
  /** The value of the coolie: 0 or 1..8 */
  int coolie;

  /** Boolean if a special-action is given to be executed */
  bool directSpecialAction;
  
  /** The id of the special-action to be executed directly */
  SpecialActionRequest::SpecialActionID specialActionID;
  
  /** 
  * The timestamp when the last data was received.
  * Note that this value is set in the In streaming operator.
  */
  unsigned long timeStamp;
};

/**
 * Streaming operator that reads a JoystickData from a stream.
 * @param stream The stream from which is read.
 * @param joystickData The JoystickData object.
 * @return The stream.
 */ 
In& operator>>(In& stream,JoystickData& joystickData);
 
/**
 * Streaming operator that writes a JoystickData to a stream.
 * @param stream The stream to write on.
 * @param joystickData The JoystickData object.
 * @return The stream.
 */ 
Out& operator<<(Out& stream, const JoystickData& joystickData);

#endif // __JOYSTICKDATA_H__

---