GroupBase.h

Go to the documentation of this file.

#ifndef   _GAMS_GROUPS_GROUP_BASE_H_
#define   _GAMS_GROUPS_GROUP_BASE_H_

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

#include "madara/knowledge/KnowledgeBase.h"

#include "gams/GamsExport.h"
#include "GroupTypesEnum.h"

namespace gams
{
  namespace groups
  {
    typedef std::vector <std::string> AgentVector;

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

    int find_member_index (const std::string & prefix,
      const AgentVector & members);

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

      virtual ~GroupBase ();

      virtual void add_members (const AgentVector & members) = 0;

      virtual void clear_members (void) = 0;

      virtual void get_members (AgentVector & members) const = 0;

      virtual bool is_member (const std::string & id) const = 0;

      virtual void write (const std::string & prefix = "",
        madara::knowledge::KnowledgeBase * knowledge = 0) const = 0;

      virtual void set_prefix (const std::string & prefix,
        madara::knowledge::KnowledgeBase * knowledge = 0);

      virtual size_t size (void) = 0;

      virtual void sync (void) = 0;

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

    protected:

      mutable madara::knowledge::KnowledgeBase * knowledge_;

      std::string prefix_;
    };
  }
}

#include "GroupBase.inl"

#endif // _GAMS_GROUPS_GROUP_BASE_H_