ElectionBase.h

Go to the documentation of this file.

#ifndef   _GAMS_ELECTIONS_ELECTION_BASE_H_
#define   _GAMS_ELECTIONS_ELECTION_BASE_H_

#include <vector>
#include <string>
#include <map>

#include "madara/knowledge/KnowledgeBase.h"
#include "madara/knowledge/containers/Map.h"

#include "ElectionTypesEnum.h"
#include "gams/groups/GroupBase.h"
#include "gams/GamsExport.h"

namespace gams
{
  namespace elections
  {
    typedef  std::vector<std::string> CandidateList;

    typedef std::map <std::string,
      madara::knowledge::KnowledgeRecord::Integer> CandidateVotes;

    class GAMS_EXPORT ElectionBase
    {
    public:
      ElectionBase (const std::string & election_prefix = "",
        const std::string & agent_prefix = "",
        madara::knowledge::KnowledgeBase * knowledge = 0);

      virtual ~ElectionBase ();

      virtual bool has_voted (const std::string & agent_prefix);

      virtual void get_votes (CandidateVotes & results);

      virtual void get_votes (
        groups::GroupBase * group, CandidateVotes & results);

      virtual void set_agent_prefix (const std::string & prefix);

      virtual void set_election_prefix (const std::string & prefix);

      virtual void set_knowledge_base (
        madara::knowledge::KnowledgeBase * knowledge);

      virtual void sync (void);

      const std::string & get_agent_prefix (void) const;

      const std::string & get_election_prefix (void) const;

      void vote (const std::string & candidate, int votes = 1);

      virtual void vote (const std::string & agent,
        const std::string & candidate, int votes = 1);

      virtual CandidateList get_leaders (int num_leaders = 1) = 0;

      virtual void advance_round (void);

      int get_round (void) const;

      virtual void reset_round (void);

    protected:

      void reset_votes_pointer (void);

      mutable madara::knowledge::KnowledgeBase * knowledge_;

      std::string election_prefix_;

      std::string agent_prefix_;

      int round_;

      madara::knowledge::containers::Map votes_;
    };
  }
}

#include "ElectionBase.inl"

#endif // _GAMS_ELECTIONS_ELECTION_BASE_H_