fipa::acl::XMLFormat Class Reference

#include <xml_format.h>

Static Public Member Functions
static TiXmlElement *	getReceivedObject (const ReceivedObject &receivedObject)
static TiXmlElement *	getDate (const base::Time &date)
static const std::string	dateToStr (const base::Time &date)
static TiXmlElement *	getURL (const std::string &url, bool useHref)
static TiXmlElement *	getName (const std::string &name, bool useId)
static TiXmlElement *	getAgentID (const AgentID &aid, bool useNameId, bool useUrlHref)
static std::vector< TiXmlElement *>	getAgentIDSequence (const AgentIDList &aidl, bool useNameId, bool useUrlHref)
static std::vector< TiXmlElement *>	getUserdefinedParameters (const UserdefinedParameterList &params)

Detailed Description

Definition at line 14 of file xml_format.h.

Member Function Documentation

dateToStr()

const std::string fipa::acl::XMLFormat::dateToStr ( const base::Time &  date )

static

Definition at line 15 of file xml_format.cpp.

{
    std::string dateStr = date.toString(base::Time::Milliseconds, "%Y%m%dT%H%M%S");
    boost::erase_all(dateStr, ":"); // Erase the colon
    return dateStr;
}

getAgentID()

TiXmlElement * fipa::acl::XMLFormat::getAgentID ( const AgentID &  aid, bool  useNameId, bool  useUrlHref  )

static

Definition at line 61 of file xml_format.cpp.

{
    TiXmlElement* aidElem = new TiXmlElement("agent-identifier");
    
    TiXmlElement* nameElem = getName(aid.getName(), useNameId);
    aidElem->LinkEndChild(nameElem);
    
    std::vector<std::string> addresses = aid.getAddresses();
    if(!addresses.empty())
    {
        TiXmlElement* addressesElem = new TiXmlElement("addresses");
        BOOST_FOREACH(std::string address, addresses)
        {
            TiXmlElement* urlElem = getURL(address, useUrlHref);
            addressesElem->LinkEndChild(urlElem);
        }
        aidElem->LinkEndChild(addressesElem);
    }
    
    Resolvers resolvers = aid.getResolvers();
    if(!resolvers.empty())
    {
        TiXmlElement* resolversElem = new TiXmlElement("resolvers");
        BOOST_FOREACH(TiXmlElement* resolverElem, getAgentIDSequence(resolvers, useNameId, useUrlHref))
        {
            resolversElem->LinkEndChild(resolverElem);
        }
        aidElem->LinkEndChild(resolversElem);
    }
    
    BOOST_FOREACH(TiXmlElement* elem, getUserdefinedParameters(aid.getUserdefParams()))
    {
        aidElem->LinkEndChild(elem);
    }
    
    return aidElem;
}

getAgentIDSequence()

std::vector< TiXmlElement *> fipa::acl::XMLFormat::getAgentIDSequence ( const AgentIDList &  aidl, bool  useNameId, bool  useUrlHref  )

static

Definition at line 51 of file xml_format.cpp.

{
    std::vector<TiXmlElement*> vec;
    BOOST_FOREACH(AgentID aid, aidl)
    {
        vec.push_back(getAgentID(aid, useNameId, useUrlHref));
    }
    return vec;
}

getDate()

TiXmlElement * fipa::acl::XMLFormat::getDate ( const base::Time &  date )

static

Definition at line 8 of file xml_format.cpp.

{
    TiXmlElement* dateElem = new TiXmlElement("date");
    dateElem->LinkEndChild(new TiXmlText(dateToStr(date)));
    return dateElem;
}

getName()

TiXmlElement * fipa::acl::XMLFormat::getName ( const std::string &  name, bool  useId  )

static

Definition at line 36 of file xml_format.cpp.

{
    TiXmlElement* nameElem = new TiXmlElement("name");
    if(useId)
    {
        // XXX What is the difference between id and refid
        nameElem->SetAttribute("id", name);
    }
    else
    {
        nameElem->LinkEndChild(new TiXmlText(name));
    }
    return nameElem;
}

getReceivedObject()

TiXmlElement * fipa::acl::XMLFormat::getReceivedObject ( const ReceivedObject &  receivedObject )

static

Definition at line 99 of file xml_format.cpp.

{
    // by/from definition uses url, example uses attribute "value"
    // Jade also uses example spec, not ACTUAL spec!
    
    TiXmlElement* recvElem = new TiXmlElement( "received" );
    
    // As received objects are only used by envelopes, which have URLs without
    // href attribute, getURL must be called with useHref=false
    TiXmlElement* recvByElem = new TiXmlElement("received-by");
    recvByElem->SetAttribute("value", receivedObject.getBy());
    recvElem->LinkEndChild(recvByElem);
    
    if(receivedObject.getFrom() != "")
    {
        TiXmlElement* recvFromElem = new TiXmlElement("received-from");
        recvFromElem->SetAttribute("value", receivedObject.getFrom());
        recvElem->LinkEndChild(recvFromElem);
    }
    
    TiXmlElement* recvDateElem = new TiXmlElement("received-date");
    recvDateElem->SetAttribute("value", dateToStr(receivedObject.getDate()));
    recvElem->LinkEndChild(recvDateElem);
    
    if(receivedObject.getId() != "")
    {
        TiXmlElement* recvIdElem = new TiXmlElement("received-id");
        recvIdElem->SetAttribute("value", receivedObject.getId());
        recvElem->LinkEndChild(recvIdElem);
    }
    
    if(receivedObject.getVia() != "")
    {
        TiXmlElement* recvViaElem = new TiXmlElement("received-via");
        recvViaElem->SetAttribute("value", receivedObject.getVia());
        recvElem->LinkEndChild(recvViaElem);
    }
    
    BOOST_FOREACH(TiXmlElement* elem, getUserdefinedParameters(receivedObject.getUserdefinedParameters()))
    {
        recvElem->LinkEndChild(elem);
    }
    
    return recvElem;
}

getURL()

TiXmlElement * fipa::acl::XMLFormat::getURL ( const std::string &  url, bool  useHref  )

static

Definition at line 22 of file xml_format.cpp.

{
    TiXmlElement* urlElem = new TiXmlElement("url");
    if(useHref)
    {
        urlElem->SetAttribute("href", url);
    }
    else
    {
        urlElem->LinkEndChild(new TiXmlText(url));
    }
    return urlElem;
}

getUserdefinedParameters()

std::vector< TiXmlElement *> fipa::acl::XMLFormat::getUserdefinedParameters ( const UserdefinedParameterList &  params )

static

Definition at line 145 of file xml_format.cpp.

{
    std::vector<TiXmlElement*> vec;
    BOOST_FOREACH(UserdefParam userdefParam, params)
    {
        TiXmlElement* userdefParamElem = new TiXmlElement("user-defined");
        userdefParamElem->SetAttribute("href", "X-" + userdefParam.getName());
        userdefParamElem->SetAttribute("type", "string");
        userdefParamElem->LinkEndChild(new TiXmlText(userdefParam.getValue()));
        vec.push_back(userdefParamElem);
    }
    return vec;
}

---

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

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