fipa::acl::RoleMapping Class Reference

Mapping between roles and actual agent ids. More...

#include <role.h>

Public Member Functions
	RoleMapping ()
const std::map< Role, AgentIDList > &	getMapping () const
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

Detailed Description

Mapping between roles and actual agent ids.

Definition at line 98 of file role.h.

Constructor & Destructor Documentation

RoleMapping()

fipa::acl::RoleMapping::RoleMapping

(

)

Default constructor

Definition at line 36 of file role.cpp.

{
    addRole(SelfRole());
    addExpectedAgent(SelfRole(), UndefinedAgentID());
}

Member Function Documentation

addExpectedAgent()

void fipa::acl::RoleMapping::addExpectedAgent	(	const Role &	role,
		const AgentID &	agent
	)

Add an agent to the list of expected agents for a specific role

Definition at line 83 of file role.cpp.

{
    std::map<Role, AgentIDList>::iterator it = mExpectedAgentMapping.find(role);
    if(it == mExpectedAgentMapping.end())
    {
        std::string msg = "Unexpected role '" + role.toString() + "'.";
        LOG_ERROR("%s", msg.c_str());
        throw std::runtime_error(msg);
    }
   
    AgentIDList& expectedAgents = it->second; 
    AgentIDList::iterator eit = std::find(expectedAgents.begin(), expectedAgents.end(), agent);
    if(eit == expectedAgents.end())
    {
        expectedAgents.push_back(agent);
    }

    return;
}

addRole()

void fipa::acl::RoleMapping::addRole

(

const Role &

role

)

Add a role to this rolemapping

Definition at line 78 of file role.cpp.

{
    mExpectedAgentMapping.insert( std::pair<Role, AgentIDList>(role, AgentIDList()));
}

clearExpectedAgents()

void fipa::acl::RoleMapping::clearExpectedAgents

(

const Role &

role

)

Clear list of expected agents for a specific role

Definition at line 103 of file role.cpp.

{
    std::map<Role, AgentIDList>::iterator it = mExpectedAgentMapping.find(role);
    if(it != mExpectedAgentMapping.end())
    {
        it->second.clear();
    }
}

getExpectedAgents()

const AgentIDList & fipa::acl::RoleMapping::getExpectedAgents

(

const Role &

role

)

const

Get the list of expected agents for a given role

Exceptions

std::runtime_error

if the role does not exist

Definition at line 153 of file role.cpp.

{
    std::map<Role, AgentIDList>::const_iterator it = mExpectedAgentMapping.find(role);
    if(it == mExpectedAgentMapping.end())
    {
        std::string msg = "Unexpected role '" + role.toString() + "'.";
        LOG_ERROR("%s", msg.c_str());
        throw std::runtime_error(msg);
    }
    return it->second;
}

getMapping()

const std::map<Role, AgentIDList>& fipa::acl::RoleMapping::getMapping ( ) const

inline

Returns the mapping

Definition at line 114 of file role.h.

{ return mExpectedAgentMapping; }

getSelf()

AgentID fipa::acl::RoleMapping::getSelf

(

)

const

Retrieve the AgentID of self

Definition at line 59 of file role.cpp.

{
    std::map<Role, AgentIDList>::const_iterator it = mExpectedAgentMapping.find(SelfRole());
    if(it != mExpectedAgentMapping.end())
    {
        return it->second.front();
    } else {
        // AgentID has never been set -- should never happen 
        assert(false);
    }

    return UndefinedAgentID();
}

isExpected()

bool fipa::acl::RoleMapping::isExpected	(	const Role &	role,
		const AgentID &	agent
	)		const

Check whether the given agent belongs to the list of expected receivers

Exceptions

If	role is completely unknown to this role mapping

Definition at line 120 of file role.cpp.

{
    // Check first if role regex matches agent name
    // afterwards try to resolve roles
    boost::regex roleRegex(role.getId());
    if(regex_match(agent.getName(), roleRegex))
    {
        return true;
    }

    const AgentIDList& expectedAgents = getExpectedAgents(role);

    bool expected = false;
    // Indication of an unassigned role -- this should be valid
    if(expectedAgents.empty())
    {
        return true;
    }

    // Agent has to match against one in the list
    AgentIDList::const_iterator eit = expectedAgents.begin(); 
    for(; eit != expectedAgents.end(); ++eit)
    {
        boost::regex regex(eit->getName() + "$");
        if(regex_match(agent.getName(), regex))
        {
            expected = true;
        }
    }

    return expected;
}

isSelf()

bool fipa::acl::RoleMapping::isSelf

(

const AgentID &

id

)

const

Test whether an agent id represents 'self'

Definition at line 73 of file role.cpp.

{
    return getSelf() == id;
}

resetExpectedAgents()

void fipa::acl::RoleMapping::resetExpectedAgents

(

)

Clear list of expected agents for all known roles

Note that the self role remains with will be reset to UndefinedAgentID

Definition at line 112 of file role.cpp.

{
    mExpectedAgentMapping.clear();

    addRole(SelfRole());
    addExpectedAgent(SelfRole(), UndefinedAgentID());
}

setSelf()

void fipa::acl::RoleMapping::setSelf

(

const AgentID &

id

)

Add the role 'self'

Definition at line 42 of file role.cpp.

{
    std::map<Role, AgentIDList>::iterator it = mExpectedAgentMapping.find(SelfRole());
    // Internal error if AgentID for 'self' is not set
    assert(!it->second.empty());

    if(it->second.front() == UndefinedAgentID())
    {
        it->second.clear();
        addExpectedAgent(SelfRole(), id);
    } else {
        std::string msg = "Self is already set";
        LOG_WARN_S << msg;
        throw std::runtime_error(msg);
    }
}

toString()

std::string fipa::acl::RoleMapping::toString

(

)

const

Stringify role mapping

Definition at line 165 of file role.cpp.

{
    std::stringstream ss;
    std::map<Role, AgentIDList>::const_iterator cit = mExpectedAgentMapping.begin();
    for(; cit != mExpectedAgentMapping.end(); ++cit)
    {
        ss << "'" << cit->first.toString() << "': ";
        AgentIDList list = cit->second;
        ss << list;
    }
    return ss.str();
}

---

The documentation for this class was generated from the following files:

• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/conversation_monitor/role.h
• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/conversation_monitor/role.cpp