transition.h

Go to the documentation of this file.

#ifndef _FIPAACL_CONVMONITOR_TRANSITION_H_
#define _FIPAACL_CONVMONITOR_TRANSITION_H_

#include <fipa_acl/bitefficient_message.h>
#include <algorithm>
#include <fipa_acl/conversation_monitor/role.h>
#include <fipa_acl/conversation_monitor/state.h>

namespace fipa {
namespace acl {

namespace validation {
        enum Flags { NONE = 0x00, ALL = 0xFFFF, PERFORMATIVE=0x01, SENDER = 0x02, RECEIVERS = 0x04, CONVERSATION_ID = 0x08,
            PROTOCOL = 0x10, ENCODING = 0x20, LANGUAGE=0x40, ONTOLOGY = 0x80, IN_REPLY_TO=0x100 };
}

class Transition 
{
    private:
        Role mSenderRole;
        
        Role mReceiverRole;
        
        std::string mPerformativeRegExp;

        // Source state where this transition starts from
        StateId mSourceStateId;
        
        // state that this transition ends in
        StateId mTargetStateId;

    public:

        Transition();
        
        Transition(const Role& senderRole, const Role& receiverRole, const fipa::acl::ACLMessage::Performative& performative, const fipa::acl::StateId& sourceState, const fipa::acl::StateId& targetState);

        Transition(const Role& senderRole, const Role& receiverRole, const std::string& performativeRegExp, const StateId& sourceState, const StateId& targetState);
        
        bool triggers(const ACLMessage &msg, const ACLMessage& initiatingMsg, const RoleMapping& roleMapping) const;
        
        bool validateMessage(const ACLMessage &msg, const ACLMessage& validatorMsg, const RoleMapping& roleMapping, validation::Flags flags = validation::ALL) const;

        void setPerformativeRegExp(const std::string& performativeRegExp) {  mPerformativeRegExp = performativeRegExp; }
        
        void setPerformative(const fipa::acl::ACLMessage::Performative& performative) {  mPerformativeRegExp = fipa::acl::PerformativeTxt[performative]; }

        void setSourceState(const StateId& stateId) { mSourceStateId = stateId; }

        void setTargetState(const StateId& stateId) { mTargetStateId = stateId; }

        void setSenderRole(const Role& role) { mSenderRole = role; }

        void setReceiverRole(const Role& role)  { mReceiverRole = role; }

        Role getSenderRole() const { return mSenderRole; }

        Role getReceiverRole() const { return mReceiverRole; }

        
        std::string getPerformativeRegExp() const { return mPerformativeRegExp; }

        StateId getSourceStateId() const { return mSourceStateId; }

        StateId getTargetStateId() const { return mTargetStateId; }

        std::string toString() const;

        std::string toXML() const;

        bool operator==(const Transition& t) const;

    private:
        
        bool validateReceivers(const ACLMessage& msg, const RoleMapping& roleMapping) const;
};

namespace default_transition 
{
    class NotUnderstood : public Transition
    {
    public:
        NotUnderstood(const Role& senderRole, const Role& receiverRole, const StateId& stateId);
    };

    class ConversationCancelling : public Transition
    {
    public:
        ConversationCancelling(const Role& senderRole, const Role& receiverRole, const StateId& stateId);

    };

    class ConversationCancelSuccess : public Transition
    {
    public:
        ConversationCancelSuccess();

    };

    class ConversationCancelFailure : public Transition
    {
    public:
        ConversationCancelFailure();

    };

    class GeneralFailure : public Transition
    {
    public:
        GeneralFailure(const StateId& sourceState);
    };
}

    
} // end of acl
} // end of fipa

#endif