Modules/SoundControl/SoundControl.h

Go to the documentation of this file.

/**
* @file SoundControl.h
* 
* Implementation of class SoundControl.
*
* @author <a href="mailto:Oliver.Giese@uni-dortmund.de">Oliver Giese</a>
* @author <a href="mailto:matthias.hebbel@uni-dortmund.de">Matthias Hebbel</a>
*/

#ifndef __SoundControl_h_
#define __SoundControl_h_

#include "Tools/Module/Module.h"

#include "Representations/Sound/SoundRequest.h"
#include "Representations/Sound/SoundData.h"

/**
* @class SoundControlInterfaces
* 
* Interfaces of the SoundControl module.
*/
class SoundControlInterfaces
{
public:
  /** Constructor */
  SoundControlInterfaces(const SoundRequest& soundRequest, 
    SoundData& soundData)
    : soundRequest(soundRequest),
    soundData(soundData)
  {};
protected:  
  /** A request from the behavior control to play a specific sound */
  const SoundRequest& soundRequest; 
  
  /** The sound data to be generated */
  SoundData& soundData;
};

/**
* @class SoundControl
*
* A generic class for SoundControl modules.
*
* SoundControl is responsible for generating audio data.
*/
class SoundControl : public Module, public SoundControlInterfaces
{
public:
/*
* Constructor.
* @param interfaces The paramters of the SoundControl module.
  */
  SoundControl(const SoundControlInterfaces& interfaces)
    : SoundControlInterfaces(interfaces)
  {}
  
  /** Destructor */
  virtual ~SoundControl() {}
};

#endif //__SoundControl_h_

---