fipa::acl::ACLMessage Class Reference

This class provides a representation of a message conforming to the FIPA specification SC00061. More...

#include <acl_message.h>

Public Types
enum	Performative {   ACCEPT_PROPOSAL = 0, AGREE, CANCEL, CALL_FOR_PROPOSAL,   CONFIRM, DISCONFIRM, FAILURE, INFORM,   INFORM_IF, INFORM_REF, NOT_UNDERSTOOD, PROPAGATE,   PROPOSE, PROXY, QUERY_IF, QUERY_REF,   REFUSE, REJECT_PROPOSAL, REQUEST, REQUEST_WHEN,   REQUEST_WHENEVER, SUBSCRIBE, END_PERFORMATIVE }
	an enum of all the predefined fipa message performatives so far, presented in the order used in the message and encoding specifications More...

Public Member Functions
	ACLMessage ()
	Default constructor. More...
	ACLMessage (Performative performative)
	constructor of an ACLMessage with a predefined performative More...
	ACLMessage (const std::string &perf)
	constructor of an ACLMessage with a custom performative More...
bool	operator== (const ACLMessage &other) const
void	setPerformative (Performative perf)
	Set performative. More...
void	setPerformative (const std::string &str)
	the method checks whether the passed performative string is a word or not(according to the fipa spec) More...
std::string	getPerformative () const
Performative	getPerformativeAsEnum () const
void	addReceiver (const AgentID &aid)
void	deleteReceiver (const AgentID &aid)
void	clearReceivers ()
AgentIDList	getAllReceivers () const
void	setAllReceivers (const AgentIDList &receivers)
void	addReplyTo (const AgentID &aid)
void	deleteReplyTo (const AgentID &aid)
void	clearReplyTo ()
AgentIDList	getAllReplyTo () const
void	setAllReplyTo (const AgentIDList &replyTo)
void	setInReplyTo (const std::string &str)
std::string	getInReplyTo () const
void	setReplyWith (const std::string &str)
std::string	getReplyWith () const
void	setConversationID (const std::string &str)
std::string	getConversationID () const
void	setProtocol (const std::string &str)
	the method checks whether the passed protocol string is a word or not(according to the fipa spec) More...
std::string	getProtocol () const
void	setOntology (const std::string &str)
std::string	getOntology () const
void	setEncoding (const std::string &str)
std::string	getEncoding () const
void	setLanguage (const std::string &str)
std::string	getLanguage () const
void	setContent (const std::string &content)
void	setBinaryContent (const std::vector< uint8_t > &content)
bool	hasBinaryContent () const
std::string	getContent () const
const std::string *	getContentPtr () const
void	setSender (const AgentID &sender)
AgentID	getSender () const
void	addUserdefParam (const UserdefParam &p)
std::vector< UserdefParam >	getUserdefParams () const
void	setUserdefParams (const std::vector< UserdefParam > &p)
base::Time	getReplyBy () const
void	setReplyBy (const base::Time &time)
std::string	toString () const

Static Public Member Functions
static Performative	performativeFromString (const std::string &performative)

Friends
class	MessageFormat

Detailed Description

This class provides a representation of a message conforming to the FIPA specification SC00061.

The class implements the general structure of an ACLMessage. It follows the FIPA specification SC00061(http://www.fipa.org/specs/fipa00061/index.html) with emphasis of what is needed in order to encode it (so far according to the bit efficient specification SC00069 - http://www.fipa.org/specs/fipa00069/index.html) Important notice regarding using the class: The copy constructor provided and the overloaded assignment operator provide deep-copy methods for the class objects, HOWEVER the setter and getter methods(for the pointer fields i.e. sender) do not. Some fields were made pointers for reasons of using as little memory as possible at runtime; if the conclusion is reached that this is not needed, it should be a fairly simple task to make the class own all of its fields(even by leaving the fields as pointers)with the provided deep-copy methods(just allocate memory for the owned field and use the asignment operator to assign the value of the passed parameter)

Definition at line 55 of file acl_message.h.

Member Enumeration Documentation

enum fipa::acl::ACLMessage::Performative

an enum of all the predefined fipa message performatives so far, presented in the order used in the message and encoding specifications

Enumerator
ACCEPT_PROPOSAL
AGREE
CANCEL
CALL_FOR_PROPOSAL
CONFIRM
DISCONFIRM
FAILURE
INFORM
INFORM_IF
INFORM_REF
NOT_UNDERSTOOD
PROPAGATE
PROPOSE
PROXY
QUERY_IF
QUERY_REF
REFUSE
REJECT_PROPOSAL
REQUEST
REQUEST_WHEN
REQUEST_WHENEVER
SUBSCRIBE
END_PERFORMATIVE

Definition at line 64 of file acl_message.h.

                      { ACCEPT_PROPOSAL = 0, AGREE, CANCEL, CALL_FOR_PROPOSAL, CONFIRM, DISCONFIRM, FAILURE, INFORM,
                INFORM_IF, INFORM_REF, NOT_UNDERSTOOD, PROPAGATE, PROPOSE, PROXY, QUERY_IF, QUERY_REF, REFUSE,
                REJECT_PROPOSAL, REQUEST, REQUEST_WHEN, REQUEST_WHENEVER, SUBSCRIBE, END_PERFORMATIVE
              };

Constructor & Destructor Documentation

fipa::acl::ACLMessage::ACLMessage

(

)

Default constructor.

Definition at line 56 of file acl_message.cpp.

{
    mPerformative = PerformativeTxt[INFORM];
}

fipa::acl::ACLMessage::ACLMessage

(

Performative

performative

)

constructor of an ACLMessage with a predefined performative

Parameters

performative

a predefined fipa performative(represented by its index in the perfs vector)

Definition at line 61 of file acl_message.cpp.

{
    mPerformative = PerformativeTxt[performative];
}

fipa::acl::ACLMessage::ACLMessage

(

const std::string &

perf

)

constructor of an ACLMessage with a custom performative

Parameters

perf	string representing the custom performative(but it can just as well be one of the pre-defined ones)

Definition at line 66 of file acl_message.cpp.

{
    if ( (perf.find_first_of(illegalWordChars) != std::string::npos) || (illegalWordStart.find_first_of(perf.c_str()[0]) != std::string::npos) )
    {
        char buffer[512];
        snprintf(buffer, 512,"Illegal characters in given performative: %s", perf.c_str());
    throw std::runtime_error(buffer);
    } else {
        mPerformative = perf;
    }
}

Member Function Documentation

void fipa::acl::ACLMessage::addReceiver

(

const AgentID &

aid

)

Add an agent id to the list of receivers

Definition at line 146 of file acl_message.cpp.

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

void fipa::acl::ACLMessage::addReplyTo

(

const AgentID &

aid

)

Add agent id to reply to list

Definition at line 172 of file acl_message.cpp.

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

void fipa::acl::ACLMessage::addUserdefParam

(

const UserdefParam &

p

)

Add a userdefined parameter

Parameters

p	userdefined parameter

Definition at line 216 of file acl_message.cpp.

{
    if (find (mParameters.begin(),mParameters.end(),p) == mParameters.end() )
    {
        mParameters.insert(mParameters.begin(),p);
    }
}

void fipa::acl::ACLMessage::clearReceivers

(

)

Clear list of receivers

Definition at line 167 of file acl_message.cpp.

{
    mReceivers.clear();
}

void fipa::acl::ACLMessage::clearReplyTo

(

)

Clear reply to list

Definition at line 193 of file acl_message.cpp.

{
    mReplyTo.clear(); 
}

void fipa::acl::ACLMessage::deleteReceiver

(

const AgentID &

aid

)

Delete an agent id from the list of receivers

Definition at line 156 of file acl_message.cpp.

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

void fipa::acl::ACLMessage::deleteReplyTo

(

const AgentID &

aid

)

Delete an agent id from the reply to list

Definition at line 182 of file acl_message.cpp.

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

AgentIDList fipa::acl::ACLMessage::getAllReceivers ( ) const

inline

Retrieve list of all receivers

Returns

List of all receivers

Definition at line 166 of file acl_message.h.

{ return mReceivers; }

AgentIDList fipa::acl::ACLMessage::getAllReplyTo ( ) const

inline

Get reply to list

Returns

reply to list

Definition at line 192 of file acl_message.h.

{ return mReplyTo; }

std::string fipa::acl::ACLMessage::getContent ( ) const

inline

Get content as string If the content is binary use string's data() function to access the underlying array

Returns

content data

Definition at line 294 of file acl_message.h.

{ return mContent; }

const std::string* fipa::acl::ACLMessage::getContentPtr ( ) const

inline

Get reference to content object in order to avoid unnecessary content copies

Definition at line 299 of file acl_message.h.

{ return &mContent; }

std::string fipa::acl::ACLMessage::getConversationID ( ) const

inline

Get conversation id

Definition at line 227 of file acl_message.h.

{ return mConversationId; }

std::string fipa::acl::ACLMessage::getEncoding ( ) const

inline

Get encoding

Definition at line 258 of file acl_message.h.

{ return mEncoding; }

std::string fipa::acl::ACLMessage::getInReplyTo ( ) const

inline

Get in reply to parameter

Definition at line 207 of file acl_message.h.

{ return mInReplyTo; }

std::string fipa::acl::ACLMessage::getLanguage ( ) const

inline

Get language

Definition at line 268 of file acl_message.h.

{ return mLanguage; }

std::string fipa::acl::ACLMessage::getOntology ( ) const

inline

Get ontology parameter

Definition at line 248 of file acl_message.h.

{ return mOntology; }

std::string fipa::acl::ACLMessage::getPerformative ( ) const

inline

Get Performative

Returns

performative as string

Definition at line 139 of file acl_message.h.

{ return mPerformative; }

Performative fipa::acl::ACLMessage::getPerformativeAsEnum ( ) const

inline

Get Performative

Returns

performative as enum

Definition at line 145 of file acl_message.h.

{ return performativeFromString(mPerformative); }

std::string fipa::acl::ACLMessage::getProtocol ( ) const

inline

Get protocol

Definition at line 238 of file acl_message.h.

{ return mProtocol; }

base::Time fipa::acl::ACLMessage::getReplyBy ( ) const

inline

Return reply by as time object

Definition at line 334 of file acl_message.h.

{ return mReplyBy; }

std::string fipa::acl::ACLMessage::getReplyWith ( ) const

inline

Get reply with parameter

Definition at line 217 of file acl_message.h.

{ return mReplyWith; }

AgentID fipa::acl::ACLMessage::getSender ( ) const

inline

Get the senders AgentID

Returns

AgentID of the sender

Definition at line 311 of file acl_message.h.

{ return mSender; }

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

inline

Retrieve any userdefined parameters this message contains

Returns

List of userdefined parameters

Definition at line 323 of file acl_message.h.

{ return mParameters;  }

bool fipa::acl::ACLMessage::hasBinaryContent

(

)

const

Check whether the content has to be treated as binary or not. This is done by simply checking on the existance of a \0 (0x00) in the data.

Returns

bool if the data contains at least one 0x00 markers within

Definition at line 210 of file acl_message.cpp.

{
    // Check on the existance of 0x00 in the content
    return ( strlen(mContent.c_str()) != mContent.size() );
}

bool fipa::acl::ACLMessage::operator==

(

const ACLMessage &

other

)

const

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 230 of file acl_message.cpp.

{
    if (getPerformative().compare(other.getPerformative()))
        return false;
    if (getContent().compare(other.getContent()))
        return false;
    if (getLanguage().compare(other.getLanguage()))
        return false;
    if (getEncoding().compare(other.getEncoding()))
        return false;
    if (getOntology().compare(other.getOntology()))
        return false;
    if (getProtocol().compare(other.getProtocol()))
        return false;
    if (getConversationID().compare(other.getConversationID()))
        return false;
    if (getReplyWith().compare(other.getReplyWith()))
        return false;
    if (getInReplyTo().compare(other.getInReplyTo()))
        return false;
    if (getReplyBy() != other.getReplyBy())
        return false;
    if (!(getSender() == other.getSender()) )
        return false;
    
    // checking if receivers sets of the message are the same
    AgentIDList agentsA = getAllReceivers();
    AgentIDList agentsB = other.getAllReceivers();
    AgentIDList::iterator ait = agentsA.begin();
    AgentIDList::iterator bit = agentsB.begin();
    
    int found_one = 0; // flag variable to control flow through inner loops

    while (ait != agentsA.end())
    {
        found_one = 0;
        bit = agentsB.begin();
        while (bit != agentsB.end())
        {
      if ( AgentID::compareEqual((*ait),(*bit),AgentID::msResolverComparisonDepth)) 
      {
          agentsA.erase(ait);
          ait = agentsA.begin();
          agentsB.erase(bit);
          bit = agentsB.end();
          found_one = 1;
          
      } else {
         ++bit;
      }
        }

        if (!found_one) 
    {
       ++ait;
    }
    }
    
    if (!agentsA.empty() || !agentsB.empty())
        return false;
    
    //checking if reply_to sets of the message are  the same
    agentsA = getAllReplyTo();
    agentsB = other.getAllReplyTo();
    ait = agentsA.begin();
    bit = agentsB.begin();
    while (ait != agentsA.end())
    {
        found_one = 0;
        bit = agentsB.begin();
        while (bit != agentsB.end())
        {
      if ( AgentID::compareEqual((*ait),(*bit),AgentID::msResolverComparisonDepth)) 
      {
          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; }
    
    
    std::vector<UserdefParam> paramsA = getUserdefParams();
    std::vector<UserdefParam> paramsB = other.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);
            pita = paramsA.begin();
            paramsB.erase(pitb);
            pitb = paramsB.end();
            found_one = 1;
            
        } else {
                pitb++;
        }
        }

        if (!found_one)
            pita++;
    }
    
    if (!paramsA.empty())
        return false;

    if (!paramsB.empty())
        return false;
   
    return true;
}

ACLMessage::Performative fipa::acl::ACLMessage::performativeFromString ( const std::string &  performative )

static

Get Performative from string

Exceptions

std::runtime_error

when string is not a known representation of a performative

Definition at line 42 of file acl_message.cpp.

{
    std::map<ACLMessage::Performative, std::string>::const_iterator it = PerformativeTxt.begin();
    for(; it != PerformativeTxt.end(); ++it)
    {
        if(it->second == performative)
        {
            return it->first;
        }
    }
    std::string msg = "String '" + performative + "' does not match any existing performative definition";
    throw std::runtime_error(msg);
}

void fipa::acl::ACLMessage::setAllReceivers ( const AgentIDList &  receivers )

inline

Set list of all receivers

Definition at line 171 of file acl_message.h.

{ mReceivers = receivers; }

void fipa::acl::ACLMessage::setAllReplyTo ( const AgentIDList &  replyTo )

inline

Set reply to list

Definition at line 197 of file acl_message.h.

{ mReplyTo = replyTo; }

void fipa::acl::ACLMessage::setBinaryContent ( const std::vector< uint8_t > &  content )

inline

Set content using a byte vector

Parameters

content

binary content

Definition at line 280 of file acl_message.h.

{ mContent.assign(content.begin(), content.end()); }

void fipa::acl::ACLMessage::setContent ( const std::string &  content )

inline

Set content

Parameters

content

Content as string (can be binary content as well)

Definition at line 274 of file acl_message.h.

{ mContent = content; }

void fipa::acl::ACLMessage::setConversationID ( const std::string &  str )

inline

Set conversation id

Definition at line 222 of file acl_message.h.

{ mConversationId = str; }

void fipa::acl::ACLMessage::setEncoding ( const std::string &  str )

inline

Set encoding

Definition at line 253 of file acl_message.h.

{ mEncoding = str; }

void fipa::acl::ACLMessage::setInReplyTo ( const std::string &  str )

inline

Set reply to

Definition at line 202 of file acl_message.h.

{ mInReplyTo = str; }

void fipa::acl::ACLMessage::setLanguage ( const std::string &  str )

inline

Set language

Definition at line 263 of file acl_message.h.

{ mLanguage = str; }

void fipa::acl::ACLMessage::setOntology ( const std::string &  str )

inline

Set ontology parameter

Definition at line 243 of file acl_message.h.

{ mOntology = str; }

void fipa::acl::ACLMessage::setPerformative

(

Performative

perf

)

Set performative.

Exceptions

runtime_error

if performative does not exist

Definition at line 121 of file acl_message.cpp.

{
    std::map<Performative, std::string>::iterator it;
    it = PerformativeTxt.find(perf);
    if(it == PerformativeTxt.end())
    {
    throw std::runtime_error("Cannot set performative. Performative unknown");
    }

    mPerformative = it->second;
}

void fipa::acl::ACLMessage::setPerformative

(

const std::string &

str

)

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

Exceptions

runtime_error

if performative does not exist or is illegal

Definition at line 133 of file acl_message.cpp.

{
    if ( (str.find_first_of(illegalWordChars) != std::string::npos) || (illegalWordStart.find_first_of(str.c_str()[0]) != std::string::npos) )
    {

        char buffer[512];
        snprintf(buffer, 512,"Illegal characters in given performative: %s", str.c_str());
    throw std::runtime_error(buffer);
    }

    mPerformative = str; 
}

void fipa::acl::ACLMessage::setProtocol

(

const std::string &

str

)

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

Exceptions

runtime_error

when protocol name contains illegal characters

Definition at line 198 of file acl_message.cpp.

{
    if ( (str.find_first_of(illegalWordChars) != std::string::npos) || (illegalWordStart.find_first_of(str.c_str()[0]) != std::string::npos) )
    {
        char buffer[512];
        snprintf(buffer, 512, "Protocol name contains illegal characters: %s", str.c_str());
        throw std::runtime_error(buffer);
    }

    mProtocol = str; 
}

void fipa::acl::ACLMessage::setReplyBy ( const base::Time &  time )

inline

Set reply by as time object

Parameters

time

Time

Definition at line 340 of file acl_message.h.

{ mReplyBy = time; }

void fipa::acl::ACLMessage::setReplyWith ( const std::string &  str )

inline

Set in reply with parameter

Definition at line 212 of file acl_message.h.

{ mReplyWith = str; }

void fipa::acl::ACLMessage::setSender ( const AgentID &  sender )

inline

Set the sender of this message

Parameters

sender

Sender's AgentID

Definition at line 305 of file acl_message.h.

{ mSender = sender; }

void fipa::acl::ACLMessage::setUserdefParams

(

const std::vector< UserdefParam > &

p

)

Set the list of userdefined parameter of this message Overwrites an already existing parameter list

Definition at line 224 of file acl_message.cpp.

{
    mParameters.clear();
    mParameters.insert(mParameters.begin(),p.begin(),p.end());
}

std::string fipa::acl::ACLMessage::toString

(

)

const

Convert message to string

Returns

Message in string format

Definition at line 363 of file acl_message.cpp.

{
    std::stringstream ss;
    ss << "(";
    ss << mPerformative << std::endl;
    ss << ":sender (agent-identifier :name " << mSender.getName() << " )" << std::endl;

    if(!mReceivers.empty())
    {
        ss << ":receiver (set "<< std::endl;
        BOOST_FOREACH(const AgentID& agent, mReceivers)
        {
            ss << "\t(agent-identifier ";
            ss << ":name " << agent.getName();
            ss << ") " << std::endl;
        }
        ss << ")" << std::endl;
    }

    if(!mLanguage.empty())
    {
        ss << ":language " << mLanguage << std::endl;
    }

    if(!mEncoding.empty())
    {
        ss << ":encoding " << mEncoding << std::endl;
    }

    if(!mOntology.empty())
    {
        ss << ":ontology " << mOntology << std::endl;
    }

    if(!mProtocol.empty())
    {
        ss << ":protocol " << mProtocol << std::endl;
    }

    if(!mConversationId.empty())
    {
        ss << ":conversation-id " << mConversationId << std::endl;
    }

    if(!mReplyWith.empty())
    {
        ss << ":reply-with " << mReplyWith << std::endl;
    }

    if(!mInReplyTo.empty())
    {
        ss << ":in-reply-to " << mInReplyTo << std::endl;
    }

    if(!mReplyBy.isNull())
    {
        ss << ":reply-by " << mReplyBy.toString() << std::endl;
    }

    if(!mParameters.empty())
    {
        BOOST_FOREACH(const UserdefParam& param, mParameters)
        {
            ss << param.getName() << " " << param.getValue() << std::endl;
        }
    }

    if(!mContent.empty())
    {
        ss << ":content " << mContent << std::endl;
    }


    ss << ")" << std::endl;
    return ss.str();
}

Friends And Related Function Documentation

friend class MessageFormat

friend

Definition at line 57 of file acl_message.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/acl_message.h
• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/message_generator/acl_message.cpp