ScoreType.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_BAS_SCORETYPE_HPP
#define __OPENTREP_BAS_SCORETYPE_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <string>
// OpenTrep
#include <opentrep/basic/StructAbstract.hpp>

namespace OPENTREP {

  struct ScoreType : public StructAbstract {
  public:
    typedef enum {
      COMBINATION = 0,
      XAPIAN_PCT,
      PAGE_RANK,
      PAX_NB,
      HEURISTIC,
      ENV_ID,
      CODE_FULL_MATCH,
      LAST_VALUE
    } EN_ScoreType;

    static const std::string& getLabel (const EN_ScoreType&);

    const std::string& getLongLabel() const;

    static char getTypeLabel (const EN_ScoreType&);

    static std::string getTypeLabelAsString (const EN_ScoreType&);

    static std::string describeLabels();

    EN_ScoreType getType() const;

    std::string getTypeAsString() const;

    std::string describe() const;

    bool isIndividualScore() const;

    static bool isIndividualScore (const EN_ScoreType&);


  public:
    bool operator== (const EN_ScoreType&) const;

  public:
    ScoreType (const EN_ScoreType&);

    ScoreType (const char iType);


  private:
    static const std::string _labels[LAST_VALUE];

    static const char _typeLabels[LAST_VALUE];


  private:
    // //////// Attributes /////////
    EN_ScoreType _type;
  };

}
#endif // __OPENTREP_BAS_SCORETYPE_HPP