Representations/Sound/SoundRequest.h

Go to the documentation of this file.

/**
 * @file SoundRequest.h
 * 
 * Declaration of class SoundRequest
 * 
 * @author Oliver Giese
 *
 */ 
#ifndef __SoundRequest_h_
#define __SoundRequest_h_

#include "Platform/SystemCall.h"

#include "Tools/Streams/InOut.h"

/** 
* @class SoundRequest 
*
* Represents an acoustic message
*/
class SoundRequest
{
public:
  /** 
  ** ids for all acoustic message Ids
  ** signals have to be enumerated first
  **/
  enum SoundID{
    none,
      test,
      bark1,
      bark2,
      bark3,
      hurtdog,
      howl,
      growl,
      startMe,
      ring,
      space,
      bing01,
      bing02,
      bing03,
      bing04,
      bing05,
      bing06,
      bing07,
      rob001,
      rob002,
      rob003,
      rob004,
      rob005,
      rob006,
      rob101,
      okay,
      notokay,
      accuracy,
      impressive,
      excellent,
      baetsch,
      klick,
      highvolt,
      alert,
      alarm,
      alarm2,
      evilaugh,
      fanfare,
      kuckuck,
      growl2,
      richtig,
    numOfSoundIDs
  };

  static const char* getSoundIDName(SoundID id)
  {
    switch (id)
    {
    case none: return "none";
    case test: return "test";
    case bark1: return "bark1";
    case bark2: return "bark2";
    case bark3: return "bark3";
    case hurtdog: return "hurtdog";
    case howl: return "howl";
    case growl: return "growl";
    case startMe: return "startMe";
    case ring: return "ring";
    case space: return "space";
    case bing01: return "bing01";
    case bing02: return "bing02";
    case bing03: return "bing03";
    case bing04: return "bing04";
    case bing05: return "bing05";
    case bing06: return "bing06";
    case bing07: return "bing07";
    case rob001: return "rob001";
    case rob002: return "rob002";
    case rob003: return "rob003";
    case rob004: return "rob004";
    case rob005: return "rob005";
    case rob006: return "rob006";
    case rob101: return "rob101";
    case okay: return "okay";
    case notokay: return "notokay";
    case accuracy: return "accuracy";
    case impressive: return "imprssve";
    case excellent: return "xcellent";
    case baetsch: return "baetsch";
    case highvolt: return "highvolt";
    case klick: return "klick";
    case alert: return "alert";
    case alarm: return "alarm";
    case alarm2: return "alarm2";
    case evilaugh: return "evilaugh";
    case fanfare: return "fanfare";
    case kuckuck: return "kuckuck";
    case growl2: return "growl2";
    case richtig: return "richtig";
    default: return "please edit SoundRequest::getSoundRequestName";
    }
  }

  /** constructor */
  SoundRequest() 
    :soundID(none)
  {
  }
  
  bool operator==(const SoundRequest& other) const
  {
    return (soundID == other.soundID);
  }

  bool operator!=(const SoundRequest& other) const
  { return !(*this==other); }

  /** the id of the request */
  SoundID soundID;
};

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



#endif //__SoundRequest_h_

---