Modules/LEDControl/LEDControl.h

Go to the documentation of this file.

/**
* @file LEDControl.h
* 
* Definition of class LEDControlInterfaces
*/

#ifndef __LEDControl_h_
#define __LEDControl_h_

#include "Tools/Module/Module.h"

#include "Representations/Motion/LEDRequest.h"
#include "Representations/Motion/LEDValue.h"

/**
* @class LEDControlInterfaces
*
* Interfaces of the LEDControl Module.
*/
class LEDControlInterfaces
{
public:
  /** Constructor 
  * @param frameNumber The number of the frame
  * @param ledRequest A request how to set the leds from the behavior
  * @param wLanStatus The status of the WLan connection 1 to be displayed with the green leds
  * @param ledValue The value of the led to be filled
  */
  LEDControlInterfaces(
    const unsigned long& frameNumber,
    const LEDRequest& ledRequest,
    const int& wLanStatus,
    LEDValue& ledValue)
    : 
    frameNumber(frameNumber),
    ledRequest(ledRequest),
    wLanStatus(wLanStatus),
    ledValue(ledValue)
  {}
protected:    
  /** A reference to the frame number */
  const unsigned long& frameNumber;

  /** A request how to set the leds from the behavior */
  const LEDRequest& ledRequest;
  
  /** The status of the WLan connection to be displayed with the green leds */
  const int& wLanStatus;
  
  /** The value of the led to be filled */
  LEDValue& ledValue;
};

/** 
* @class LEDControl
* 
* A generic class for LED control modules 
*/
class LEDControl : public Module, public LEDControlInterfaces
{
public:
/*
* Constructor.
* @param interfaces The paramters of the LEDControl module.
  */
  LEDControl(const LEDControlInterfaces& interfaces)
    : LEDControlInterfaces(interfaces)
  {}

  /** Destructor */
  virtual ~LEDControl() {}
};

#endif //__LEDControl_h_

---