ScoreBoard.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_BOM_SCOREBOARD_HPP
#define __OPENTREP_BOM_SCOREBOARD_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <map>
// OpenTrep
#include <opentrep/OPENTREP_Types.hpp>
#include <opentrep/basic/ScoreType.hpp>
#include <opentrep/basic/StructAbstract.hpp>
// Xapian
#include <xapian.h>

namespace OPENTREP {

  struct ScoreBoard : public StructAbstract {
  public:
    // //////////////// Type definitions /////////////////
    typedef std::map<ScoreType::EN_ScoreType, Score_T> ScoreMap_T;


  public:
    // ////////////////// Getters ////////////////
    const TravelQuery_T& getQueryString() const {
      return _queryString;
    }

    const ScoreMap_T& getScoreMap() const {
     return _scoreMap;
    }

    Score_T getScore (const ScoreType&) const;

    Score_T getCombinedWeight() const {
      return getScore (ScoreType::COMBINATION);
    }


  public:
    // //////////////////// Setters //////////////////
    void setQueryString (const TravelQuery_T& iQueryString) {
      _queryString = iQueryString;
    }

    void setScore (const ScoreType&, const Score_T&);

    void setCombinedWeight (const Score_T& iScore) {
      setScore (ScoreType::COMBINATION, iScore);
    }

    Percentage_T calculateCombinedWeight();


  public:
    // //////////////// Business methods ////////////////


  public:
    // /////////// Display support methods /////////
    void toStream (std::ostream&) const;

    void fromStream (std::istream&);

    std::string describeKey() const;

    std::string describe() const;


  public:
    // //////////////// Constructors and Destructors /////////////
    ScoreBoard (const TravelQuery_T&, const ScoreType&, const Score_T&);

    ScoreBoard (const TravelQuery_T&);

    ScoreBoard (const ScoreBoard&);

    ~ScoreBoard();

    
  private:
    // ///////////////// Attributes //////////////////
    TravelQuery_T _queryString;

    ScoreMap_T _scoreMap;
  };

}
#endif // __OPENTREP_BOM_SCOREBOARD_HPP