fipa::acl::AgentID Class Reference

Implements the general AgentID functionality, which is present throughout the fipa specifications(FIPA at http://www.fipa.org). Functionality may need to be extended as further modules are implemented Important notice: the probably main field of an AgentID, the actual id, is not yet declared/implemented, as it was not need for the encoding and it was not discussed what should it be. More...

#include <agent_id.h>

Inherited by fipa::acl::UndefinedAgentID.

Public Member Functions
bool	isValid () const
	AgentID ()
	Default constructor. More...
	AgentID (const std::string &name)
	Construct an AgentID by name. More...
const std::string &	getName () const
	setter and getter methods for all fields; they do not result in deep-copies assignments/retreivals, but this can be easily changed if needed through the overloaded operator which do More...
void	setName (const std::string &name)
	the method checks whether the passed name string is a word or not(according to the fipa spec) More...
void	addAddress (const std::string &adr)
	the method checks whether the passed address string is a word or not(according to the fipa spec) More...
const std::vector< std::string > &	getAddresses () const
	Retrieve list of addresses. More...
void	setAddresses (const std::vector< std::string > &addresses)
	Set list of addresses – overwrites existing list of addresses. More...
void	addResolver (const AgentID &aid)
	Add resolver. More...
const Resolvers &	getResolvers () const
	Get list of resolvers. More...
void	setResolvers (const Resolvers &resolvers)
	Set list of resolvers. More...
void	deleteResolver (const AgentID &id)
	Delete a resolver. More...
void	addUserdefParam (const UserdefParam &p)
	Add a userdefined parameter. More...
const std::vector< UserdefParam > &	getUserdefParams () const
	Get the all userdefined parameter. More...
void	setUserdefParams (const std::vector< UserdefParam > &params)
bool	empty () const
	Check if AgentId is empty, i.e. does not contain a name. More...
bool	operator== (const AgentID &other) const
	overloaded equality operator for AgentID; the signature of the function was intentionally changed from the normal operator== (const type&, const type&) More...
bool	operator!= (const AgentID &other) const
	Allow testing on inequality of agents based on the agents' names only. More...
bool	operator< (const AgentID &other) const
	Allow comparing two agents, based on the agent name only. More...
std::string	toString (size_t indent=0) const

Static Public Member Functions
static bool	compareEqual (const AgentID &a, const AgentID &b, int depth)
	alternative function for equality operator; the depth can be specified through the depth param More...

Static Public Attributes
static int	msResolverComparisonDepth = 1

Protected Attributes
std::string	mName

Static Protected Attributes
static const std::string	UNDEFINED = "agent_id:undefined"

Friends
class	ACLMessage

Detailed Description

Implements the general AgentID functionality, which is present throughout the fipa specifications(FIPA at http://www.fipa.org). Functionality may need to be extended as further modules are implemented Important notice: the probably main field of an AgentID, the actual id, is not yet declared/implemented, as it was not need for the encoding and it was not discussed what should it be.

Definition at line 37 of file agent_id.h.

Constructor & Destructor Documentation

AgentID() [1/2]

fipa::acl::AgentID::AgentID

(

)

Default constructor.

Definition at line 21 of file agent_id.cpp.

{
    setName(AgentID::UNDEFINED);
}

AgentID() [2/2]

fipa::acl::AgentID::AgentID

(

const std::string &

name

)

Construct an AgentID by name.

Parameters

name

Definition at line 26 of file agent_id.cpp.

{
    setName(name);
}

Member Function Documentation

addAddress()

void fipa::acl::AgentID::addAddress

(

const std::string &

adr

)

the method checks whether the passed address string is a word or not(according to the fipa spec)

Parameters

adr

Address

Exceptions

if	address contains invalid characters

Definition at line 48 of file agent_id.cpp.

{
    if ( (address.find_first_of(illegalWordChars) != std::string::npos) || (illegalWordStart.find_first_of(address.c_str()[0]) != std::string::npos) )
    {
        char buffer[128];
        snprintf(buffer, 128, "fipa::acl::AgentID: address '%s' contains invalid characters", address.c_str());
        throw std::runtime_error(buffer);
    }
    mAddresses.push_back(address);
}

addResolver()

void fipa::acl::AgentID::addResolver

(

const AgentID &

aid

)

Add resolver.

Parameters

aid	Resolver identified by its agentid

Definition at line 59 of file agent_id.cpp.

{
    // prevent entering duplicates
    // NOTE: this function searches for the resolver and uses the overloaded == op not the compareEqual()
    if ( find(mResolvers.begin(), mResolvers.end(),aid) == mResolvers.end() )
    {
        mResolvers.push_back(aid);
    }
}

addUserdefParam()

void fipa::acl::AgentID::addUserdefParam

(

const UserdefParam &

p

)

Add a userdefined parameter.

Parameters

p	The userdefined parameter

Definition at line 80 of file agent_id.cpp.

{
    mParameters.push_back(p);
}

compareEqual()

bool fipa::acl::AgentID::compareEqual ( const AgentID &  a, const AgentID &  b, int  depth  )

static

alternative function for equality operator; the depth can be specified through the depth param

Definition at line 90 of file agent_id.cpp.

{
    if (a.getName() != b.getName())
    {
        return false;
    }
    
    // comparing addresses
    std::vector<std::string> addrA = a.getAddresses();
    std::vector<std::string> addrB = b.getAddresses();
    std::vector<std::string>::iterator sita = addrA.begin();
    std::vector<std::string>::iterator sitb = addrB.begin();
    int found_one = 0; // flag variable to control flow through inner loops
    while (sita != addrA.end())
    {
        found_one = 0;
        sitb = addrB.begin();
        while (sitb != addrB.end())
        {
            if (*sita == *sitb) 
            {
                addrA.erase(sita);
                sita = addrA.begin();
                addrB.erase(sitb);
                sitb = addrB.end();
                found_one = 1;
            } else {
                sitb++;
            }
       }

       if (!found_one)
          sita++;
    }
    
    if (!addrA.empty())
        return false;
    if (!addrB.empty())
        return false;
    
    // only check the resolvers if the resCompDepth > 0; 
    if (depth > 0 )
    {
        // the resolvers are compared with up to resCompDepth -1 in the resolver network
        //AgentID::setResCompDepth(depth-1);
        // comparing resolvers
        std::vector<AgentID> agentsA = a.getResolvers();
        std::vector<AgentID> agentsB = b.getResolvers();
        std::vector<AgentID>::iterator ait = agentsA.begin();
        std::vector<AgentID>::iterator bit = agentsB.begin();
        
        while (ait != agentsA.end())
        {
            found_one = 0;
        bit = agentsB.begin();
        while (bit != agentsB.end())
        {
            if ( compareEqual((*ait),(*bit),depth-1)) 
            {
                     agentsA.erase(ait);
                     ait = agentsA.begin();
                     agentsB.erase(bit);
                     bit = agentsB.end();
                     found_one = 1;
                } else {
               ++bit;
                }
            }
            if (!found_one)
               ++ait;
        }
    
        if (!agentsA.empty())
            return false; 
        if (!agentsB.empty())
            return false; 
    }
    
    // comparing userdefined parameters
    // Copy lists and delete identical elements
    // When both list are empty the compared objects are equal
    std::vector<UserdefParam> paramsA = a.getUserdefParams();
    std::vector<UserdefParam> paramsB = b.getUserdefParams();
    std::vector<UserdefParam>::iterator pita = paramsA.begin();
    std::vector<UserdefParam>::iterator pitb = paramsB.begin();
     
    while (pita != paramsA.end())
    {
        found_one = 0;
        pitb = paramsB.begin();

        while (pitb != paramsB.end())
        {
        if (*pita == *pitb) 
        {
                paramsA.erase(pita);
                paramsB.erase(pitb);

                pita = paramsA.begin();
            // in order to break the inner while, set it to end()
                pitb = paramsB.end();

                found_one = 1;
            } else { 
                pitb++;
            }
        }

        if (!found_one) 
            pita++;
    }
    
    // Both lists are empty when they contained the same Parameters
    // before
    if ( paramsA.empty() && paramsB.empty())
        return true;
    
    return false;
}

deleteResolver()

void fipa::acl::AgentID::deleteResolver

(

const AgentID &

id

)

Delete a resolver.

Parameters

id	Resolver to delete

Definition at line 69 of file agent_id.cpp.

{
    std::vector<AgentID>::iterator it  = find(mResolvers.begin(), mResolvers.end(),aid);
    // prevent entering duplicates
    // NOTE: this function searches for the resolver using the overloaded == op not the compareEqual()
    if( it != mResolvers.end() )
    {
        mResolvers.erase(it);
    }
}

empty()

bool fipa::acl::AgentID::empty

(

)

const

Check if AgentId is empty, i.e. does not contain a name.

Returns

True, if empty, False otherwise

Definition at line 210 of file agent_id.cpp.

{
    return mName.empty();
}

getAddresses()

const std::vector<std::string>& fipa::acl::AgentID::getAddresses ( ) const

inline

Retrieve list of addresses.

Returns

List of addresses

Definition at line 110 of file agent_id.h.

{ return mAddresses; }

getName()

const std::string& fipa::acl::AgentID::getName ( ) const

inline

setter and getter methods for all fields; they do not result in deep-copies assignments/retreivals, but this can be easily changed if needed through the overloaded operator which do

Definition at line 90 of file agent_id.h.

{ return mName; }

getResolvers()

const Resolvers& fipa::acl::AgentID::getResolvers ( ) const

inline

Get list of resolvers.

Returns

list of resolvers, i.e. agentids

Definition at line 127 of file agent_id.h.

{ return mResolvers; }

getUserdefParams()

const std::vector<UserdefParam>& fipa::acl::AgentID::getUserdefParams ( ) const

inline

Get the all userdefined parameter.

Returns

List of userdefined parameters

Definition at line 150 of file agent_id.h.

{ return mParameters; }

isValid()

bool fipa::acl::AgentID::isValid

(

)

const

Test if this is a valid agent, i.e. is neither an instance of an undefined agent nor has it an empty name field

Definition at line 31 of file agent_id.cpp.

{
    return mName != AgentID::UNDEFINED && !empty();
}

operator!=()

bool fipa::acl::AgentID::operator!= ( const AgentID &  other ) const

inline

Allow testing on inequality of agents based on the agents' names only.

Returns

true if the agents' names are different, false otherwise

Definition at line 179 of file agent_id.h.

{ return !(*this == other); }

operator<()

bool fipa::acl::AgentID::operator< ( const AgentID &  other ) const

inline

Allow comparing two agents, based on the agent name only.

Returns

True if first agent's name < other agent's name

Definition at line 185 of file agent_id.h.

{ return this->getName() < other.getName(); }

operator==()

bool fipa::acl::AgentID::operator==

(

const AgentID &

other

)

const

overloaded equality operator for AgentID; the signature of the function was intentionally changed from the normal operator== (const type&, const type&)

The parameters are not passed by reference on purpose so that the copy constructor of the class is called. This is necessary because in the comparison, pointer fields are modified(removed) and we don't want this to affect the original object

Definition at line 85 of file agent_id.cpp.

{
    return compareEqual(*this, other, AgentID::msResolverComparisonDepth);
}

setAddresses()

void fipa::acl::AgentID::setAddresses ( const std::vector< std::string > &  addresses )

inline

Set list of addresses – overwrites existing list of addresses.

Definition at line 115 of file agent_id.h.

{ mAddresses = addresses; }

setName()

void fipa::acl::AgentID::setName

(

const std::string &

name

)

the method checks whether the passed name string is a word or not(according to the fipa spec)

Parameters

name

Name

Exceptions

if	name contains invalid characters

Definition at line 36 of file agent_id.cpp.

{
    if ( (name.find_first_of(illegalWordChars) != std::string::npos) || (illegalWordStart.find_first_of(name.c_str()[0]) != std::string::npos) )
    {
        char buffer[128];
        snprintf(buffer, 128, "fipa::acl::AgentID: name '%s' contains invalid characters", name.c_str());
        throw std::runtime_error(buffer);
    }

    mName = name;
}

setResolvers()

void fipa::acl::AgentID::setResolvers ( const Resolvers &  resolvers )

inline

Set list of resolvers.

Definition at line 132 of file agent_id.h.

{ mResolvers = resolvers; }

setUserdefParams()

void fipa::acl::AgentID::setUserdefParams ( const std::vector< UserdefParam > &  params )

inline

Set all userdefined parameters

Definition at line 155 of file agent_id.h.

{ mParameters = params; }

toString()

std::string fipa::acl::AgentID::toString

(

size_t

indent = 0

)

const

Stringify object

Returns

string representation of agent id

Definition at line 215 of file agent_id.cpp.

{
    std::string hspace(indent,' ');
    std::stringstream ss;
    ss << hspace << "AgentID: " << mName << std::endl;
    ss << hspace << "    addresses:" << std::endl;
    std::vector<std::string>::const_iterator ait = mAddresses.begin();
    for(; ait != mAddresses.end(); ++ait)
    {
        ss << hspace << *ait << std::endl;
    }
    ss << hspace << "    resolvers:" << std::endl;
    AgentIDList::const_iterator rit = mResolvers.begin();
    for(; rit != mResolvers.end(); ++rit)
    {
        ss << rit->toString(indent + 4) << std::endl;
    }
    ss << hspace << "    parameters:" << std::endl;
    std::vector<UserdefParam>::const_iterator pit = mParameters.begin();
    for(; pit != mParameters.end(); ++pit)
    {
        ss << hspace << pit->toString() << std::endl;
    }
    return ss.str();
}

Friends And Related Function Documentation

ACLMessage

friend class ACLMessage

friend

Definition at line 39 of file agent_id.h.

Member Data Documentation

mName

std::string fipa::acl::AgentID::mName

protected

name of the agent

Definition at line 57 of file agent_id.h.

msResolverComparisonDepth

int fipa::acl::AgentID::msResolverComparisonDepth = 1

static

Definition at line 65 of file agent_id.h.

UNDEFINED

const std::string fipa::acl::AgentID::UNDEFINED = "agent_id:undefined"

staticprotected

name representing an undefined agent

Definition at line 60 of file agent_id.h.

---

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

• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/message_generator/agent_id.h
• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/message_generator/agent_id.cpp