The ACLBaseEnvelope defines the layout for an envelope with which ACLMessage data can be wrapped. Multiple ACLBaseEnvelopes are part of the ACLEnvelope in order to implement the basic functionality of the Agent Communication Channel (ACC) More...

#include <acl_envelope.h>

Public Member Functions
	ACLBaseEnvelope ()

bool	contains (envelope::ParameterId id) const

const AgentIDList &	getTo () const

void	addTo (const AgentID &agent)

void	setTo (const AgentIDList &receivers)

bool	removeTo (const AgentID &agentId)

void	clearAllTo ()

const AgentID &	getFrom () const

void	setFrom (const AgentID &from)

const Comments &	getComments () const

void	setComments (const Comments &comments)

const representation::Type &	getACLRepresentation () const

const std::string &	getACLRepresentationString () const

void	setACLRepresentation (representation::Type representation)

void	setACLRepresentation (const std::string &represention)

const PayloadLength &	getPayloadLength () const

void	setPayloadLength (const PayloadLength &length)

const PayloadEncoding &	getPayloadEncoding () const

void	setPayloadEncoding (const PayloadEncoding &encoding)

const base::Time &	getDate () const

void	setDate (const base::Time &date)

const AgentIDList &	getIntendedReceivers () const

void	setIntendedReceivers (const AgentIDList &receivers)

void	addIntendedReceiver (const AgentID &agent)

bool	removeIntendedReceiver (const AgentID &agent)

void	clearAllIntendedReceivers ()

const ReceivedObject &	getReceivedObject () const

void	setReceivedObject (const ReceivedObject &receivedObject)

bool	hasReceivedObject (const ReceivedObject &receivedObject) const

const TransportBehaviour &	getTransportBehaviour () const

void	setTransportBehaviour (const TransportBehaviour &transportBehaviour)

const UserdefinedParameterList &	getUserdefinedParameters () const

void	setUserdefinedParameters (const UserdefinedParameterList &parameters)

ACLBaseEnvelope	merge (const ACLBaseEnvelope &other) const

ACLBaseEnvelope	flatten (const ACLBaseEnvelopeList &extraEnvelopes) const

void	stamp (const ReceivedObject &receivedObject)

bool	hasStamp (const ReceivedObject &receivedObject) const

Detailed Description

The ACLBaseEnvelope defines the layout for an envelope with which ACLMessage data can be wrapped. Multiple ACLBaseEnvelopes are part of the ACLEnvelope in order to implement the basic functionality of the Agent Communication Channel (ACC)

See also: http://www.fipa.org/specs/fipa00067/SC00067F.html

Definition at line 36 of file acl_envelope.h.

Constructor & Destructor Documentation

◆ ACLBaseEnvelope()

fipa::acl::ACLBaseEnvelope::ACLBaseEnvelope ( )

DefaultConstructor

Definition at line 22 of file acl_envelope.cpp.

     : mParameters(NONE)
     , mACLRepresentation(representation::UNKNOWN)
     , mPayloadEncoding("US-ASCII")
 {}

Member Function Documentation

◆ addIntendedReceiver()

void fipa::acl::ACLBaseEnvelope::addIntendedReceiver ( const AgentID & agent )

Add intended receiver to the list of intended receivers

Definition at line 115 of file acl_envelope.cpp.

 {
      AgentIDList::const_iterator it = find_if(mIntendedReceivers.begin(), mIntendedReceivers.end(), arg1 == agentId);
      if(it == mIntendedReceivers.end())
      {
          mIntendedReceivers.push_back(agentId);
      }
 }

◆ addTo()

void fipa::acl::ACLBaseEnvelope::addTo ( const AgentID & agent )

Add an agent identifier to the destination list

Definition at line 28 of file acl_envelope.cpp.

 {
     AgentID agent = agentId;
     AgentIDList::const_iterator it = find_if(mTo.begin(), mTo.end(), arg1 == agentId );
     if(it == mTo.end())
     {
         mTo.push_back(agentId);
     }
 }

◆ clearAllIntendedReceivers()

void fipa::acl::ACLBaseEnvelope::clearAllIntendedReceivers ( )

inline

Clear list of intended receivers

Definition at line 276 of file acl_envelope.h.

276 { mIntendedReceivers.clear(); }

◆ clearAllTo()

void fipa::acl::ACLBaseEnvelope::clearAllTo ( )

inline

Clear 'to' list

Definition at line 173 of file acl_envelope.h.

173 { mTo.clear(); }

◆ contains()

bool fipa::acl::ACLBaseEnvelope::contains ( envelope::ParameterId id ) const

inline

Test wether a certain content element is set in this envelope object

Definition at line 144 of file acl_envelope.h.

144 { return mParameters & id; }

◆ flatten()

ACLBaseEnvelope fipa::acl::ACLBaseEnvelope::flatten ( const ACLBaseEnvelopeList & extraEnvelopes ) const

Flatten the current envelope plus the extra envelopes (the most current/latest has to be at the end of the list

Parameters

extraEnvelopes list of overlay envelopes

Returns: the most current ACLBaseEnvelope representation

Definition at line 224 of file acl_envelope.cpp.

 {
     ACLBaseEnvelope envelope = *this;
     ACLBaseEnvelopeList::const_iterator cit = extraEnvelopes.begin();
     for(; cit != extraEnvelopes.end(); ++cit)
     {
         envelope = envelope.merge(*cit);
     }
 
     return envelope;
 }

◆ getACLRepresentation()

const representation::Type& fipa::acl::ACLBaseEnvelope::getACLRepresentation ( ) const

inline

Get the ACLRepresentation in use

Returns: acl representation

Definition at line 203 of file acl_envelope.h.

203 { return mACLRepresentation; }

◆ getACLRepresentationString()

const std::string& fipa::acl::ACLBaseEnvelope::getACLRepresentationString ( ) const

inline

Get the ACLRepresentation in use

Returns: acl representation

Definition at line 209 of file acl_envelope.h.

209 { return representation::TypeTxt[mACLRepresentation]; }

fipa::acl::representation::TypeTxt

const std::string TypeTxt[]

Definition: types.h:28

◆ getComments()

const Comments& fipa::acl::ACLBaseEnvelope::getComments ( ) const

inline

Get comments

Returns: comments

Definition at line 191 of file acl_envelope.h.

191 { return mComments; }

◆ getDate()

const base::Time& fipa::acl::ACLBaseEnvelope::getDate ( ) const

inline

Retrieve creation date and time of the message envelope

Definition at line 246 of file acl_envelope.h.

246 { return mDate; }

◆ getFrom()

const AgentID& fipa::acl::ACLBaseEnvelope::getFrom ( ) const

inline

Get sender id

Returns: agent id of sender

Definition at line 179 of file acl_envelope.h.

179 { return mFrom; }

◆ getIntendedReceivers()

const AgentIDList& fipa::acl::ACLBaseEnvelope::getIntendedReceivers ( ) const

inline

Get intended receivers

Definition at line 256 of file acl_envelope.h.

256 { return mIntendedReceivers; }

◆ getPayloadEncoding()

const PayloadEncoding& fipa::acl::ACLBaseEnvelope::getPayloadEncoding ( ) const

inline

Get the payload encoding (default is US-ASCII)

Definition at line 236 of file acl_envelope.h.

236 { return mPayloadEncoding; }

◆ getPayloadLength()

const PayloadLength& fipa::acl::ACLBaseEnvelope::getPayloadLength ( ) const

inline

Get the length of the payload

Definition at line 226 of file acl_envelope.h.

226 { return mPayloadLength; }

◆ getReceivedObject()

const ReceivedObject& fipa::acl::ACLBaseEnvelope::getReceivedObject ( ) const

inline

Get the associated received object

Definition at line 281 of file acl_envelope.h.

281 { return mReceivedObject; }

◆ getTo()

const AgentIDList& fipa::acl::ACLBaseEnvelope::getTo ( ) const

inline

Get destination

Returns: destination of this message envelope as list of agents

Definition at line 150 of file acl_envelope.h.

150 { return mTo; }

◆ getTransportBehaviour()

const TransportBehaviour& fipa::acl::ACLBaseEnvelope::getTransportBehaviour ( ) const

inline

Get the transport behaviour

Definition at line 297 of file acl_envelope.h.

297 { return mTransportBehaviour; }

◆ getUserdefinedParameters()

const UserdefinedParameterList& fipa::acl::ACLBaseEnvelope::getUserdefinedParameters ( ) const

inline

Get userdefined parameter list

Definition at line 307 of file acl_envelope.h.

307 { return mUserdefinedParameters; }

◆ hasReceivedObject()

bool fipa::acl::ACLBaseEnvelope::hasReceivedObject ( const ReceivedObject & receivedObject ) const

Test whether the received object has the same sender

Returns: true if the By field is the same, false otherwise

Definition at line 141 of file acl_envelope.cpp.

 {
     if (mParameters & RECEIVED_OBJECT)
     {
         return receivedObject.getBy() == mReceivedObject.getBy();
     }
 
     return false;
 }

◆ hasStamp()

bool fipa::acl::ACLBaseEnvelope::hasStamp ( const ReceivedObject & receivedObject ) const

inline

Test whether this envelope has been stamped. This is an alias for hasReceivedObject

Returns: true if the sender has already stamped this message

Definition at line 336 of file acl_envelope.h.

336 { return hasReceivedObject(receivedObject); }

fipa::acl::ACLBaseEnvelope::hasReceivedObject

bool hasReceivedObject(const ReceivedObject &receivedObject) const

Definition: acl_envelope.cpp:141

◆ merge()

ACLBaseEnvelope fipa::acl::ACLBaseEnvelope::merge ( const ACLBaseEnvelope & other ) const

Merges the information of two envelopes – only empty field in this will be overwritten by other

Definition at line 163 of file acl_envelope.cpp.

 {
     ACLBaseEnvelope envelope(*this);
     if(other.contains(TO))
     {
         envelope.setTo(other.getTo());
     }
 
     if(other.contains(FROM))
     {
         envelope.setFrom(other.getFrom());
     }
 
     if(other.contains(COMMENTS))
     {
         envelope.setComments(other.getComments());
     }
 
     if(other.contains(ACL_REPRESENTATION))
     {
         envelope.setACLRepresentation(other.getACLRepresentation());
     }
 
     if(other.contains(PAYLOAD_LENGTH))
     {
         envelope.setPayloadLength(other.getPayloadLength());
     }
 
     if(other.contains(PAYLOAD_ENCODING))
     {
         envelope.setPayloadEncoding(other.getPayloadEncoding());
     }
 
     if(other.contains(DATE))
     {
         envelope.setDate(other.getDate());
     }
 
     if(other.contains(INTENDED_RECEIVERS))
     {
         envelope.setIntendedReceivers(other.getIntendedReceivers());
     }
 
     if(other.contains(RECEIVED_OBJECT))
     {
         envelope.setReceivedObject(other.getReceivedObject());
     }
 
     if(other.contains(TRANSPORT_BEHAVIOUR))
     {
         envelope.setTransportBehaviour(other.getTransportBehaviour());
     }
 
     if(other.contains(USERDEFINED_PARAMETERS))
     {
         envelope.setUserdefinedParameters(other.getUserdefinedParameters());
     }
 
     return envelope;
 }

◆ removeIntendedReceiver()

bool fipa::acl::ACLBaseEnvelope::removeIntendedReceiver ( const AgentID & agent )

Remove an intended receiver from this list of intended receivers

Definition at line 124 of file acl_envelope.cpp.

 {
      AgentIDList::iterator it = find_if(mIntendedReceivers.begin(), mIntendedReceivers.end(), arg1 == agentId);
      if(it != mIntendedReceivers.end())
      {
          mIntendedReceivers.erase(it);
          return true;
      }
      return false;
 }

◆ removeTo()

bool fipa::acl::ACLBaseEnvelope::removeTo ( const AgentID & agentId )

Remove an agents from the 'to' list

Returns: true upon success, i.e. if the agent was is this list false otherwise

Definition at line 44 of file acl_envelope.cpp.

 {
     AgentIDList::iterator it = find_if(mTo.begin(), mTo.end(), arg1 == agentId);
     if(it != mTo.end())
     {
         mTo.erase(it);
         return true;
     }
     return false;
 }

◆ setACLRepresentation() [1/2]

void fipa::acl::ACLBaseEnvelope::setACLRepresentation ( representation::Type representation )

Set the acl representation in use "This is the name of the syntax representation of the message payload." [http://www.fipa.org/specs/fipa00067/SC00067F.html#_Toc26669814]

Definition at line 69 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | ACL_REPRESENTATION);
     mACLRepresentation = representation;
 }

◆ setACLRepresentation() [2/2]

void fipa::acl::ACLBaseEnvelope::setACLRepresentation ( const std::string & represention )

Set ACLRepresentation from string as defined in standard specification

Exceptions

if	the ACLRepresentation in unknown to the system

Definition at line 76 of file acl_envelope.cpp.

 {
     for(int i = (int) representation::UNKNOWN; i < (int) representation::END_MARKER; ++i)
     {
         if(representation == representation::TypeTxt[i])
         {
             setACLRepresentation((representation::Type) i);
             return;
         }
     }
     std::string msg = "Trying to set unknown representation '" + representation + "'";
     LOG_ERROR_S << msg;
     throw std::runtime_error(msg);
 }

◆ setComments()

void fipa::acl::ACLBaseEnvelope::setComments ( const Comments & comments )

Set comments

Parameters

comments Comments to be set

Definition at line 63 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | COMMENTS);
     mComments = comments;
 }

◆ setDate()

void fipa::acl::ACLBaseEnvelope::setDate ( const base::Time & date )

Set creation date and time of the message envelope

Definition at line 103 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | DATE);
     mDate = date;
 }

◆ setFrom()

void fipa::acl::ACLBaseEnvelope::setFrom ( const AgentID & from )

Set sender id

Parameters

from

Definition at line 56 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | FROM);
     mFrom = from;
 }

◆ setIntendedReceivers()

void fipa::acl::ACLBaseEnvelope::setIntendedReceivers ( const AgentIDList & receivers )

Set intended receivers

Definition at line 109 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | INTENDED_RECEIVERS);
     mIntendedReceivers = receivers;
 }

◆ setPayloadEncoding()

void fipa::acl::ACLBaseEnvelope::setPayloadEncoding ( const PayloadEncoding & encoding )

Set the payload encoding (default is US-ASCII)

Definition at line 97 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | PAYLOAD_ENCODING);
     mPayloadEncoding = encoding;
 }

◆ setPayloadLength()

void fipa::acl::ACLBaseEnvelope::setPayloadLength ( const PayloadLength & length )

Set the length of the payload

Definition at line 91 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | PAYLOAD_LENGTH);
     mPayloadLength = length;
 }

◆ setReceivedObject()

void fipa::acl::ACLBaseEnvelope::setReceivedObject ( const ReceivedObject & receivedObject )

Set the received object list

Definition at line 135 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | RECEIVED_OBJECT);
     mReceivedObject = receivedObject;
 }

◆ setTo()

void fipa::acl::ACLBaseEnvelope::setTo ( const AgentIDList & receivers )

Set destination

Parameters

receivers receiver list

Definition at line 38 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | TO);
     mTo = receivers;
 }

◆ setTransportBehaviour()

void fipa::acl::ACLBaseEnvelope::setTransportBehaviour ( const TransportBehaviour & transportBehaviour )

Set the transport behaviour

Definition at line 151 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | TRANSPORT_BEHAVIOUR);
     mTransportBehaviour = transportBehaviour;
 }

◆ setUserdefinedParameters()

void fipa::acl::ACLBaseEnvelope::setUserdefinedParameters ( const UserdefinedParameterList & parameters )

Set userdefined parameters

Definition at line 157 of file acl_envelope.cpp.

 {
     mParameters = (ParameterId) (mParameters | USERDEFINED_PARAMETERS);
     mUserdefinedParameters = parameters;
 }

◆ stamp()

void fipa::acl::ACLBaseEnvelope::stamp ( const ReceivedObject & receivedObject )

inline

Add a receipt for this message, i.e. add a received object to the envelope. This function is an alias for setReceivedObject

Definition at line 330 of file acl_envelope.h.

330 { setReceivedObject(receivedObject); }

fipa::acl::ACLBaseEnvelope::setReceivedObject

void setReceivedObject(const ReceivedObject &receivedObject)

Definition: acl_envelope.cpp:135

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_envelope.h
/build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/message_generator/acl_envelope.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ACLBaseEnvelope()

Member Function Documentation

◆ addIntendedReceiver()

◆ addTo()

◆ clearAllIntendedReceivers()

◆ clearAllTo()

◆ contains()

◆ flatten()

◆ getACLRepresentation()

◆ getACLRepresentationString()

◆ getComments()

◆ getDate()

◆ getFrom()

◆ getIntendedReceivers()

◆ getPayloadEncoding()

◆ getPayloadLength()

◆ getReceivedObject()

◆ getTo()

◆ getTransportBehaviour()

◆ getUserdefinedParameters()

◆ hasReceivedObject()

◆ hasStamp()

◆ merge()

◆ removeIntendedReceiver()

◆ removeTo()

◆ setACLRepresentation() [1/2]

◆ setACLRepresentation() [2/2]

◆ setComments()

◆ setDate()

◆ setFrom()

◆ setIntendedReceivers()

◆ setPayloadEncoding()

◆ setPayloadLength()

◆ setReceivedObject()

◆ setTo()

◆ setTransportBehaviour()

◆ setUserdefinedParameters()

◆ stamp()