role.h

Go to the documentation of this file.

#ifndef FIPA_ACL_ROLE_H
#define FIPA_ACL_ROLE_H

#include <map>
#include <string>
#include <fipa_acl/message_generator/agent_id.h>

namespace fipa {
namespace acl {

class AgentID;

typedef std::string RoleId;

class Role 
{

private:
    RoleId mId;

protected:
    const static RoleId UNDEFINED_ID;
    const static RoleId SELF_ID;

public:
    Role();

    Role(const RoleId& id);

    Role(const Role&);

    static const Role self();

    RoleId getId() const { return mId; }

    std::string toString() const { return mId; }

    bool operator<(const Role& other) const
    {
        return mId < other.mId;
    }

    bool operator!=(const Role& other) const
    {
        return !(mId == other.mId);
    }

    bool operator==(const Role& other) const
    {
        return mId == other.mId;
    }

    Role& operator=(const Role& other)
    {
        mId = other.mId;
        return *this;
    }
};

class UndefinedRole : public Role
{
public:
    UndefinedRole();
};

class SelfRole : public Role
{
public:
    SelfRole();
};

class RoleMapping
{
private:
    // The mapping between roles and actual agents
    std::map<Role, AgentIDList> mExpectedAgentMapping;

public:

    RoleMapping();

    const std::map<Role, AgentIDList>& getMapping() const { return mExpectedAgentMapping; }

    void setSelf(const AgentID& id);

    bool isSelf(const AgentID& id) const;

    AgentID getSelf() const;

    void addRole(const Role& role);

    void addExpectedAgent(const Role& role, const AgentID& agent);

    void clearExpectedAgents(const Role& role);

    void resetExpectedAgents();

    const AgentIDList& getExpectedAgents(const Role& role) const;

    bool isExpected(const Role& role, const AgentID& agent) const;

    std::string toString() const;
};

} // end namespace acl
} // end namespace fipa
#endif // FIPA_ACL_ROLE_H