Message< Iterator > Struct Template Reference

#include <grammar_bitefficient.h>

Inherits grammar< Iterator, fipa::acl::Message()>.

Public Member Functions
	Message ()

Public Attributes
qi::rule< Iterator, fipa::acl::Message()>	aclCommunicativeAct
qi::rule< Iterator >	message
qi::rule< Iterator, fipa::acl::Header()>	header
qi::rule< Iterator, char()>	messageId
qi::rule< Iterator, char()>	version
qi::rule< Iterator >	endOfMessage
qi::rule< Iterator >	endOfCollection
qi::rule< Iterator, std::string() >	messageType
qi::rule< Iterator, std::string() >	userDefinedMessageType
BinWord< Iterator >	messageTypeName
qi::rule< Iterator, fipa::acl::message::Parameter() >	messageParameter
qi::rule< Iterator, fipa::acl::message::Parameter() >	userDefinedMessageParameter
qi::rule< Iterator, fipa::acl::message::Parameter() >	predefinedMessageParameter
BinWord< Iterator >	parameterName
BinExpression< Iterator >	parameterValue
qi::rule< Iterator, std::string() >	predefinedMessageType
UserdefinedParameter< Iterator >	userDefinedParameter
qi::rule< Iterator, std::vector < fipa::acl::AgentIdentifier >) >	recipientExpr
AgentIdentifier< Iterator >	agentIdentifier
BinExpression< Iterator >	binExpression
BinWord< Iterator >	binWord
BinString< Iterator >	binString
BinString< Iterator >	msgContent
BinExpression< Iterator >	replyWithParam
BinDateTime< Iterator >	replyByParam
BinExpression< Iterator >	inReplyToParam
qi::rule< Iterator, std::vector < fipa::acl::AgentIdentifier >) >	replyToParam
BinExpression< Iterator >	language
BinExpression< Iterator >	encoding
BinExpression< Iterator >	ontology
BinWord< Iterator >	protocol
BinExpression< Iterator >	conversationId

Detailed Description

template<typename Iterator>
struct Message< Iterator >

Definition at line 420 of file grammar_bitefficient.h.

Constructor & Destructor Documentation

template<typename Iterator >

Message< Iterator >::Message ( )

inline

Definition at line 423 of file grammar_bitefficient.h.

              : Message::base_type(aclCommunicativeAct, "message-bitefficient_grammar")
    {
        using phoenix::construct;
        using phoenix::val;

        using qi::lit;
        using qi::lexeme; // prevents character skipping
                using qi::byte_;
        
        
        // To avoid namespace clashes with boost::bind
        namespace label = qi::labels;

        // Explanation:
        // at_c<0>(label::_val) = label::_1
        // set the first element (position 0) of the element synthesized attribute,i.e._val, to the parsed value, i.e. _1
        // the synthesized attribute might be a fipa::acl::message, and the element ordering depends on the structure as
        // defined with the BOOST_FUSION_ADAPT_STRUCT definition
        aclCommunicativeAct = header                 [ phoenix::at_c<0>(label::_val) = label::_1 ]
                      >> messageType         [ phoenix::at_c<1>(label::_val) = label::_1 ]
                      >> *messageParameter       [ phoenix::push_back(phoenix::at_c<2>(label::_val), label::_1) ]
                      >> endOfMessage           // No action here
                     ;

        header = messageId  [ phoenix::at_c<0>(label::_val) = label::_1 ] 
             >> version [ phoenix::at_c<1>(label::_val) = label::_1 ]
            ;
        
        // byte_() does only return an unused_type, so if we want to save the value, we have to assign it directly
        messageId = byte_(0xFA)  [ label::_val = 0xfa ] 
              | byte_(0xFB)  [ label::_val = 0xfb ]
                          | byte_(0xFC)  [ label::_val = 0xfc ]
             ; 
             

        version = byte_;                     
        endOfMessage %= endOfCollection;
        endOfCollection %= byte_(0x01); 
        
        // we do not support dynamic code tables or user defined values
        // message type is a string
        // the types in the rule definition have to match to apply alias()
        messageType = predefinedMessageType | userDefinedMessageType;

        userDefinedMessageType = byte_(0x00)
                       >> messageTypeName   [ label::_val = label::_1 ]
                       ;

        
        // Note: never do a direct assignment like
        // messageParameter = predefinedMessageParameter or you will be getting runtime errors  
        // use messageParameter = predefinedMessageParameter.alias() instead
        messageParameter = predefinedMessageParameter | userDefinedMessageParameter;

        userDefinedMessageParameter = byte_(0x00)
                        >> parameterName        [ phoenix::at_c<0>(label::_val) = label::_1 ]
                        >> parameterValue           [ phoenix::at_c<1>(label::_val) = label::_1 ]
                        ;

        // Converting message type into predefined strings
        predefinedMessageType = byte_(0x01)    [ label::_val = "accept-proposal" ]
                    | byte_(0x02)  [ label::_val = "agree" ]  
                    | byte_(0x03)  [ label::_val = "cancel" ]   
                    | byte_(0x04)  [ label::_val = "cfp" ]    
                    | byte_(0x05)  [ label::_val = "confirm" ]
                    | byte_(0x06)  [ label::_val = "disconfirm" ]
                    | byte_(0x07)  [ label::_val = "failure" ]
                    | byte_(0x08)  [ label::_val = "inform" ]
                    | byte_(0x09)  [ label::_val = "inform-if" ]
                    | byte_(0x0a)  [ label::_val = "inform-ref" ]
                    | byte_(0x0b)  [ label::_val = "not-understood" ]
                    | byte_(0x0c)  [ label::_val = "propagate" ]
                    | byte_(0x0d)  [ label::_val = "propose" ]
                    | byte_(0x0e)  [ label::_val = "proxy" ] 
                    | byte_(0x0f)  [ label::_val = "query-if" ]
                    | byte_(0x10)  [ label::_val = "query-ref" ]
                    | byte_(0x11)  [ label::_val = "refuse" ]   
                    | byte_(0x12)  [ label::_val = "reject-proposal" ]
                    | byte_(0x13)  [ label::_val = "request" ]
                    | byte_(0x14)  [ label::_val = "request-when" ] 
                    | byte_(0x15)  [ label::_val = "request-whenever" ]
                    | byte_(0x16)  [ label::_val = "subscribe" ]  
                    ; 
                                
        // predefinedMessageParameter uses a boost::variant
        predefinedMessageParameter = byte_(0x02) [ phoenix::at_c<0>(label::_val) = "sender" ]       >> agentIdentifier [ phoenix::at_c<1>(label::_val) = label::_1 ]    // sender
                    | byte_(0x03) [ phoenix::at_c<0>(label::_val) = "receiver" ]        >> recipientExpr   [ phoenix::at_c<1>(label::_val) = label::_1 ]   // receiver 
                    | byte_(0x04) [ phoenix::at_c<0>(label::_val) = "content" ]         >> msgContent      [ phoenix::at_c<1>(label::_val) = label::_1 ]   // content 
                    | byte_(0x05) [ phoenix::at_c<0>(label::_val) = "reply-with" ]      >> replyWithParam  [ phoenix::at_c<1>(label::_val) = label::_1 ]   // reply-with
                    | byte_(0x06) [ phoenix::at_c<0>(label::_val) = "reply-by" ]        >> replyByParam    [ phoenix::at_c<1>(label::_val) = label::_1 ]  // reply-by 
                    | byte_(0x07) [ phoenix::at_c<0>(label::_val) = "in-reply-to" ]     >> inReplyToParam  [ phoenix::at_c<1>(label::_val) = label::_1 ]  // in-reply-to 
                    | byte_(0x08) [ phoenix::at_c<0>(label::_val) = "reply-to" ]        >> replyToParam    [ phoenix::at_c<1>(label::_val) = label::_1 ] // reply-to   
                    | byte_(0x09) [ phoenix::at_c<0>(label::_val) = "language" ]        >> language        [ phoenix::at_c<1>(label::_val) = label::_1 ] // language  
                    | byte_(0x0a) [ phoenix::at_c<0>(label::_val) = "encoding" ]        >> encoding        [ phoenix::at_c<1>(label::_val) = label::_1 ] // encoding 
                    | byte_(0x0b) [ phoenix::at_c<0>(label::_val) = "ontology" ]        >> ontology        [ phoenix::at_c<1>(label::_val) = label::_1 ] // ontology
                    | byte_(0x0c) [ phoenix::at_c<0>(label::_val) = "protocol" ]        >> protocol        [ phoenix::at_c<1>(label::_val) = label::_1 ] // protocol
                    | byte_(0x0d) [ phoenix::at_c<0>(label::_val) = "conversation-id" ] >> conversationId  [ phoenix::at_c<1>(label::_val) = label::_1 ] // conversation-id
                    ; 

        recipientExpr = *agentIdentifier            [ phoenix::push_back(label::_val, label::_1) ]
                >> endOfCollection;
        
        replyToParam = recipientExpr.alias();

    // Enables the debug tree when debug mode is active
    // requires the include of stream operators as well
    // since every type will be printed to the outputstream (standard is cout)
        // see also: debug.h
    #ifdef BOOST_SPIRIT_DEBUG
    // http://boost-spirit.com/home/articles/doc-addendum/debugging/
        BOOST_SPIRIT_DEBUG_NODE(header);
        BOOST_SPIRIT_DEBUG_NODE(messageId);
        BOOST_SPIRIT_DEBUG_NODE(version);
        BOOST_SPIRIT_DEBUG_NODE(messageType);
        BOOST_SPIRIT_DEBUG_NODE(userDefinedMessageType);
        BOOST_SPIRIT_DEBUG_NODE(messageParameter);
        BOOST_SPIRIT_DEBUG_NODE(userDefinedMessageParameter);
        BOOST_SPIRIT_DEBUG_NODE(predefinedMessageParameter);
        BOOST_SPIRIT_DEBUG_NODE(predefinedMessageType);
    #endif
        
    }

Member Data Documentation

template<typename Iterator >

qi::rule<Iterator, fipa::acl::Message()> Message< Iterator >::aclCommunicativeAct

Definition at line 563 of file grammar_bitefficient.h.

template<typename Iterator >

AgentIdentifier<Iterator> Message< Iterator >::agentIdentifier

Definition at line 587 of file grammar_bitefficient.h.

template<typename Iterator >

BinExpression<Iterator> Message< Iterator >::binExpression

Definition at line 589 of file grammar_bitefficient.h.

template<typename Iterator >

BinString<Iterator> Message< Iterator >::binString

Definition at line 591 of file grammar_bitefficient.h.

template<typename Iterator >

BinWord<Iterator> Message< Iterator >::binWord

Definition at line 590 of file grammar_bitefficient.h.

template<typename Iterator >

BinExpression<Iterator> Message< Iterator >::conversationId

Definition at line 602 of file grammar_bitefficient.h.

template<typename Iterator >

BinExpression<Iterator> Message< Iterator >::encoding

Definition at line 599 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator> Message< Iterator >::endOfCollection

Definition at line 569 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator> Message< Iterator >::endOfMessage

Definition at line 568 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, fipa::acl::Header()> Message< Iterator >::header

Definition at line 565 of file grammar_bitefficient.h.

template<typename Iterator >

BinExpression<Iterator> Message< Iterator >::inReplyToParam

Definition at line 596 of file grammar_bitefficient.h.

template<typename Iterator >

BinExpression<Iterator> Message< Iterator >::language

Definition at line 598 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator> Message< Iterator >::message

Definition at line 564 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, char()> Message< Iterator >::messageId

Definition at line 566 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, fipa::acl::message::Parameter() > Message< Iterator >::messageParameter

Definition at line 575 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, std::string() > Message< Iterator >::messageType

Definition at line 571 of file grammar_bitefficient.h.

template<typename Iterator >

BinWord<Iterator> Message< Iterator >::messageTypeName

Definition at line 573 of file grammar_bitefficient.h.

template<typename Iterator >

BinString<Iterator> Message< Iterator >::msgContent

Definition at line 592 of file grammar_bitefficient.h.

template<typename Iterator >

BinExpression<Iterator> Message< Iterator >::ontology

Definition at line 600 of file grammar_bitefficient.h.

template<typename Iterator >

BinWord<Iterator> Message< Iterator >::parameterName

Definition at line 579 of file grammar_bitefficient.h.

template<typename Iterator >

BinExpression<Iterator> Message< Iterator >::parameterValue

Definition at line 580 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, fipa::acl::message::Parameter() > Message< Iterator >::predefinedMessageParameter

Definition at line 577 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, std::string() > Message< Iterator >::predefinedMessageType

Definition at line 582 of file grammar_bitefficient.h.

template<typename Iterator >

BinWord<Iterator> Message< Iterator >::protocol

Definition at line 601 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, std::vector<fipa::acl::AgentIdentifier>) > Message< Iterator >::recipientExpr

Definition at line 585 of file grammar_bitefficient.h.

template<typename Iterator >

BinDateTime<Iterator> Message< Iterator >::replyByParam

Definition at line 595 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, std::vector<fipa::acl::AgentIdentifier>) > Message< Iterator >::replyToParam

Definition at line 597 of file grammar_bitefficient.h.

template<typename Iterator >

BinExpression<Iterator> Message< Iterator >::replyWithParam

Definition at line 594 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, fipa::acl::message::Parameter() > Message< Iterator >::userDefinedMessageParameter

Definition at line 576 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, std::string() > Message< Iterator >::userDefinedMessageType

Definition at line 572 of file grammar_bitefficient.h.

template<typename Iterator >

UserdefinedParameter<Iterator> Message< Iterator >::userDefinedParameter

Definition at line 583 of file grammar_bitefficient.h.

template<typename Iterator >

qi::rule<Iterator, char()> Message< Iterator >::version

Definition at line 567 of file grammar_bitefficient.h.

---

The documentation for this struct was generated from the following file:

• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/message_parser/grammar/grammar_bitefficient.h