fipa::acl::Transition Class Reference

#include <transition.h>

Inherited by fipa::acl::default_transition::ConversationCancelFailure, fipa::acl::default_transition::ConversationCancelling, fipa::acl::default_transition::ConversationCancelSuccess, fipa::acl::default_transition::GeneralFailure, and fipa::acl::default_transition::NotUnderstood.

Public Member Functions
	Transition ()
	empty constructor for the transition class; initializes fields More...
	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
	check whether a certain message trigger the execution of the transition More...
bool	validateMessage (const ACLMessage &msg, const ACLMessage &validatorMsg, const RoleMapping &roleMapping, validation::Flags flags=validation::ALL) const
	method that validates all parameters of a message More...
void	setPerformativeRegExp (const std::string &performativeRegExp)
	setter methods for various fields of the class More...
void	setPerformative (const fipa::acl::ACLMessage::Performative &performative)
	setter methods for various fields of the class More...
void	setSourceState (const StateId &stateId)
void	setTargetState (const StateId &stateId)
void	setSenderRole (const Role &role)
void	setReceiverRole (const Role &role)
Role	getSenderRole () const
Role	getReceiverRole () const
std::string	getPerformativeRegExp () const
	getter methods for various fields of the class More...
StateId	getSourceStateId () const
StateId	getTargetStateId () const
std::string	toString () const
std::string	toXML () const
bool	operator== (const Transition &t) const

Detailed Description

A transition that can be associated with a state object

Definition at line 26 of file transition.h.

Constructor & Destructor Documentation

Transition() [1/3]

fipa::acl::Transition::Transition

(

)

empty constructor for the transition class; initializes fields

Definition at line 14 of file transition.cpp.

    : mSenderRole()
    , mReceiverRole()
    , mPerformativeRegExp()
    , mSourceStateId()
    , mTargetStateId()
{
}

Transition() [2/3]

fipa::acl::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 constructor using an explicit Performative instead of a regular expression

Definition at line 23 of file transition.cpp.

    : mSenderRole(senderRole)
    , mReceiverRole(receiverRole)
    , mPerformativeRegExp(PerformativeTxt[performative])
    , mSourceStateId(sourceState)
    , mTargetStateId(targetState)
{
}

Transition() [3/3]

fipa::acl::Transition::Transition	(	const Role &	senderRole,
		const Role &	receiverRole,
		const std::string &	performativeRegExp,
		const StateId &	sourceState,
		const StateId &	targetState
	)

Transition constructor

Definition at line 33 of file transition.cpp.

    : mSenderRole(senderRole)
    , mReceiverRole(receiverRole)
    , mPerformativeRegExp(performativeRegExp)
    , mSourceStateId(sourceState)
    , mTargetStateId(targetState)
{
}

Member Function Documentation

getPerformativeRegExp()

std::string fipa::acl::Transition::getPerformativeRegExp ( ) const

inline

getter methods for various fields of the class

Definition at line 128 of file transition.h.

{ return mPerformativeRegExp; }

getReceiverRole()

Role fipa::acl::Transition::getReceiverRole ( ) const

inline

Get the receiver role

Definition at line 121 of file transition.h.

{ return mReceiverRole; }

getSenderRole()

Role fipa::acl::Transition::getSenderRole ( ) const

inline

Get the sender role

Definition at line 116 of file transition.h.

{ return mSenderRole; }

getSourceStateId()

StateId fipa::acl::Transition::getSourceStateId ( ) const

inline

Get the state id of the source state

Definition at line 133 of file transition.h.

{ return mSourceStateId; }

getTargetStateId()

StateId fipa::acl::Transition::getTargetStateId ( ) const

inline

Get the state id of the target state

Definition at line 138 of file transition.h.

{ return mTargetStateId; }

operator==()

bool fipa::acl::Transition::operator==

(

const Transition &

t

)

const

Equals operator

Definition at line 198 of file transition.cpp.

{
    if(mSourceStateId != other.mSourceStateId)
    {
        return false;
    } else if (mTargetStateId != other.mTargetStateId)
    {
        return false;
    } else if (mSenderRole != other.mSenderRole)
    {
        return false;
    } else if (mReceiverRole != other.mReceiverRole)
    {
        return false;
    } else if (mPerformativeRegExp != other.mPerformativeRegExp)
    {
        return false;
    }

    return true;
}

setPerformative()

void fipa::acl::Transition::setPerformative ( const fipa::acl::ACLMessage::Performative &  performative )

inline

setter methods for various fields of the class

Definition at line 91 of file transition.h.

{  mPerformativeRegExp = fipa::acl::PerformativeTxt[performative]; }

setPerformativeRegExp()

void fipa::acl::Transition::setPerformativeRegExp ( const std::string &  performativeRegExp )

inline

setter methods for various fields of the class

Definition at line 85 of file transition.h.

{  mPerformativeRegExp = performativeRegExp; }

setReceiverRole()

void fipa::acl::Transition::setReceiverRole ( const Role &  role )

inline

Set the receiver role

Definition at line 111 of file transition.h.

{ mReceiverRole = role; }

setSenderRole()

void fipa::acl::Transition::setSenderRole ( const Role &  role )

inline

Set the sender role

Definition at line 106 of file transition.h.

{ mSenderRole = role; }

setSourceState()

void fipa::acl::Transition::setSourceState ( const StateId &  stateId )

inline

Set the source state of this transition

Definition at line 96 of file transition.h.

{ mSourceStateId = stateId; }

setTargetState()

void fipa::acl::Transition::setTargetState ( const StateId &  stateId )

inline

Set the target state of this transition

Definition at line 101 of file transition.h.

{ mTargetStateId = stateId; }

toString()

std::string fipa::acl::Transition::toString

(

)

const

Convert transition to string

Definition at line 150 of file transition.cpp.

{
    std::stringstream transition;
    transition << "transition: sender role: '" << mSenderRole.getId() << "', "; 
    transition << "receiver role: '" << mReceiverRole.getId() << "', ";
    transition << "performative: '" << mPerformativeRegExp << "', ";
    transition << "source state: '" << mSourceStateId << "', ";
    transition << "target state: '" << mTargetStateId << "'";

    return transition.str();
}

toXML()

std::string fipa::acl::Transition::toXML

(

)

const

Convert transition to XML

Definition at line 162 of file transition.cpp.

{
    std::stringstream transition;
    transition << "<transition ";
    transition << "performative=\"" << mPerformativeRegExp << "\" ";
    transition << "from=\"" << mSenderRole.getId() << "\" ";
    transition << "to=\"" << mReceiverRole.getId() << "\" ";
    transition << "target=\"" << mTargetStateId << "\" ";
    transition << "/>";

    return transition.str();
}

triggers()

bool fipa::acl::Transition::triggers	(	const ACLMessage &	msg,
		const ACLMessage &	initiatingMsg,
		const RoleMapping &	roleMapping
	)		const

check whether a certain message trigger the execution of the transition

Parameters

msg	message to process
initiatingMsg	message that initiated the conversation or represents the direct predecessor of the current one
roleMapping	Current role mapping

Returns

true if message triggers this transition, false otherwise

Definition at line 42 of file transition.cpp.

{
    // Set the standard validation flags
    validation::Flags flags = (validation::Flags) (validation::PERFORMATIVE | validation::SENDER | validation::RECEIVERS | validation::CONVERSATION_ID | validation::PROTOCOL);
    if( validateMessage(msg, initiatingMsg, roleMapping, flags) )
    {
    return true;
    } else {
        LOG_DEBUG("Message validation failed: message does not apply to transition");
    }
    return false;
}

validateMessage()

bool fipa::acl::Transition::validateMessage	(	const ACLMessage &	msg,
		const ACLMessage &	validatorMsg,
		const RoleMapping &	roleMapping,
		validation::Flags	flags = validation::ALL
	)		const

method that validates all parameters of a message

Parameters

msg	message passed as parameter to be checked
validatorMsg	To validate conversation id, protocol, encoding, language, ontology and in_reply_to the validatorMsg is referred to
roleMapping	Current role mapping
flags	Flag which shall be considered during validation

Returns

true if message is valid false otherwise

Definition at line 55 of file transition.cpp.

{
    if( flags == validation::NONE)
    {
        return true;
    }

    // Test performative against transition performative
    // not the validator message one
    if (validation::PERFORMATIVE & flags)
    {
        boost::regex performativeRegex(mPerformativeRegExp);
        if(!regex_match(msg.getPerformative(), performativeRegex))
        {
            LOG_DEBUG("Performative validation failed: was '%s' but expected: '%s'", msg.getPerformative().c_str(), mPerformativeRegExp.c_str()); 
            return false;
        }
    }

    if( validation::SENDER & flags)
    {
        AgentID senderAgent = msg.getSender(); 
        if(!roleMapping.isExpected(mSenderRole, senderAgent))
        {
                LOG_DEBUG("Sender validation failed: '%s' unexpected for role '%s'", senderAgent.getName().c_str(), mSenderRole.getId().c_str()); 
                return false;
        }
    }

    if(validation::RECEIVERS & flags)
    {
        if(!validateReceivers(msg, roleMapping))
        {
            LOG_DEBUG("Receivers validation failed"); 
            return false;
        }
    }

    if(validation::CONVERSATION_ID & flags)
    {
        if (msg.getConversationID() != validatorMsg.getConversationID())
        { 
            LOG_DEBUG("ConversationID validation failed: was '%s' but expected: '%s'", msg.getConversationID().c_str(), validatorMsg.getConversationID().c_str()); 
            return false; 
        }
    }

    if(validation::PROTOCOL & flags)
    {
        if (msg.getProtocol() != validatorMsg.getProtocol())
        { 
            LOG_DEBUG("Protocol validation failed: was '%s' but expected: '%s'", msg.getProtocol().c_str(), validatorMsg.getProtocol().c_str());
            return false;
        }
    }

    if(validation::ENCODING & flags)
    {
        if (msg.getEncoding() != validatorMsg.getEncoding())
        { 
            LOG_DEBUG("Encoding validation failed: was '%s' but expected: '%s'", msg.getEncoding().c_str(), validatorMsg.getEncoding().c_str()); 
            return false; 
        }
    }

    if(validation::LANGUAGE & flags)
    {
        if (msg.getLanguage() != validatorMsg.getLanguage())
        {
            LOG_DEBUG("Language validation failed: was '%s' but expected: '%s'", msg.getLanguage().c_str(), validatorMsg.getLanguage().c_str());
            return false;
        }
    }

    if(validation::ONTOLOGY & flags)
    {
        if (msg.getOntology() != validatorMsg.getOntology())
        {
            LOG_DEBUG("Ontology validation failed: was '%s' but expected: '%s'", msg.getOntology().c_str(), validatorMsg.getOntology().c_str());
            return false;
        }
    }

    if(validation::IN_REPLY_TO & flags)
    {
        if (msg.getInReplyTo() != validatorMsg.getInReplyTo())
        {
            LOG_DEBUG("InReplyTo validation failed: was '%s' but expected: '%s'", msg.getInReplyTo().c_str(), validatorMsg.getInReplyTo().c_str());
            return false;
        }
    }

    return true;
}

---

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

• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/conversation_monitor/transition.h
• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/conversation_monitor/transition.cpp