fipa::acl::ReceivedObject Class Reference

#include <received_object.h>

Public Member Functions
bool	operator== (const ReceivedObject &receivedObject) const
const URL &	getBy () const
void	setBy (const URL &by)
const URL &	getFrom () const
void	setFrom (const URL &from)
const base::Time &	getDate () const
void	setDate (const base::Time &date)
const ID &	getId () const
void	setId (const ID &id)
const Via &	getVia () const
void	setVia (const Via &via)
std::string	toString (size_t indent=0) const
const UserdefinedParameterList &	getUserdefinedParameters () const
void	setUserdefinedParameters (const UserdefinedParameterList &paramList)

Detailed Description

Received object is attached to the message envelope by each Message Transport Service

Definition at line 19 of file received_object.h.

Member Function Documentation

getBy()

const URL& fipa::acl::ReceivedObject::getBy ( ) const

inline

Get URL representing the transport address of the receiving ACC

Definition at line 62 of file received_object.h.

{ return mBy; }

getDate()

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

inline

Get the date when the message was received

Definition at line 82 of file received_object.h.

{ return mDate; }

getFrom()

const URL& fipa::acl::ReceivedObject::getFrom ( ) const

inline

Get URL representing the transport address of the sending ACC

Definition at line 72 of file received_object.h.

{ return mFrom; }

getId()

const ID& fipa::acl::ReceivedObject::getId ( ) const

inline

Get the unique id of the message - unique within the scope of the sending ACC

Definition at line 92 of file received_object.h.

{ return mId; }

getUserdefinedParameters()

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

inline

Get userdefined parameters

Definition at line 117 of file received_object.h.

{ return mUserdefinedParameters; }

getVia()

const Via& fipa::acl::ReceivedObject::getVia ( ) const

inline

Get the via - the MTP the message was delivered over

Definition at line 102 of file received_object.h.

{ return mVia; }

operator==()

bool fipa::acl::ReceivedObject::operator== ( const ReceivedObject &  receivedObject ) const

inline

Definition at line 57 of file received_object.h.

{ return true; }

setBy()

void fipa::acl::ReceivedObject::setBy ( const URL &  by )

inline

Set URL representing the transport address of the receiving ACC

Definition at line 67 of file received_object.h.

{ mBy = by; }

setDate()

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

inline

Set the date when the message was received

Definition at line 87 of file received_object.h.

{ mDate = date; }

setFrom()

void fipa::acl::ReceivedObject::setFrom ( const URL &  from )

inline

Set URL representing the transport address of the sending ACC

Definition at line 77 of file received_object.h.

{ mFrom = from; }

setId()

void fipa::acl::ReceivedObject::setId ( const ID &  id )

inline

Set the unique id of the message - unique within the scope of the sending ACC

Definition at line 97 of file received_object.h.

{ mId = id; }

setUserdefinedParameters()

void fipa::acl::ReceivedObject::setUserdefinedParameters ( const UserdefinedParameterList &  paramList )

inline

Set userdefined parameters

Definition at line 122 of file received_object.h.

{ mUserdefinedParameters = paramList; }

setVia()

void fipa::acl::ReceivedObject::setVia ( const Via &  via )

inline

Set via

Definition at line 107 of file received_object.h.

{ mVia = via; }

toString()

std::string fipa::acl::ReceivedObject::toString

(

size_t

indent = 0

)

const

Create to string methods

Definition at line 7 of file received_object.cpp.

{
    std::string hspace(indent,' ');
    std::stringstream ss;
    ss << hspace << "ReceivedObject:" << std::endl;
    ss << hspace << "    by: " << mBy << std::endl;
    ss << hspace << "    from: " << mFrom << std::endl;
    ss << hspace << "    date: " << mDate.toString() << std::endl;
    ss << hspace << "    id: " << mId << std::endl;
    ss << hspace << "    via: " << mVia << std::endl;
    ss << hspace << "    user-defined-parameters:" << std::endl;
    std::vector<UserdefParam>::const_iterator cit = mUserdefinedParameters.begin();
    for(; cit != mUserdefinedParameters.end(); ++cit)
    {
        ss << hspace << "        " << cit->toString() << std::endl;
    }

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