Representations/Perception/SpecialVisionRequest.h

Go to the documentation of this file.

/**
 * @file SpecialVisionRequest.h
 * 
 * Declaration of class SpecialVisionRequest
 * 
 * @author Matthias Juengel
 */ 

#ifndef __SpecialVisionRequest_h_
#define __SpecialVisionRequest_h_

#include "Tools/Streams/InOut.h"

/** 
* @class SpecialVisionRequest 
*
* Represents a request for special visons (challenges ...).
*/
class SpecialVisionRequest
{
public:

  /** constructor */
  SpecialVisionRequest();

  /** destructor */
  ~SpecialVisionRequest();

  enum SpecialVisionRequests 
  {
    none,
    barCode,
    autoShutter,
    challengeLearnOrientation,
    challengeFindOrientation,
    challengeGetOrientation,
    numOfSpecialVisionRequests,
    imageBrightness
  };

  SpecialVisionRequests specialVisionRequest;

  //! Returns the name of a SpecialVisionRequest. 
  static char* getSpecialVisionRequestName(SpecialVisionRequests  specialVisionRequest)
  {
    switch(specialVisionRequest)
    {
    case none:        return "none";
    case barCode:     return "barCode";
    case autoShutter: return "autoShutter";
    case challengeLearnOrientation: return "challengeLearnOrientation";
    case challengeFindOrientation: return "challengeFindOrientation";
    case challengeGetOrientation: return "challengeGetOrientation";
    case imageBrightness: return "estimated image brightness";
    default:          return "undefined SpecialVisionRequest";
    }
  };
};


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



#endif //__SpecialVisionRequest_h_

---