fipa::acl::StateMachine Class Reference

#include <statemachine.h>

Public Member Functions
std::map< StateId, State >	getStates () const
const RoleMapping &	getRoleMapping () const
const State &	getCurrentState () const
State &	getCurrentStateModifiably ()
void	setCurrentStateId (const StateId &stateId)
StateId	getCurrentStateId () const
StateId	getInitialStateId () const
void	setProtocol (const fipa::acl::Protocol &protocol)
fipa::acl::Protocol	getProtocol () const
void	setSelf (const AgentID &self)
void	consumeMessage (const ACLMessage &msg)
void	consumeSubStateMachineMessage (const ACLMessage &msg, const fipa::acl::StateMachine &stateMachine, int numberOfSubConversations)
bool	inFinalState () const
bool	inFailureState () const
bool	cancelled () const
std::string	toString () const
std::string	toXML () const

Protected Member Functions
void	validate () const
void	reset ()
void	setInitialState (const StateId &stateId)
void	addState (const State &state)
void	updateRoles ()
void	updateRoleMapping (const ACLMessage &msg, const Transition &transition)

Friends
class	StateMachineReader

Detailed Description

Definition at line 22 of file statemachine.h.

Member Function Documentation

void fipa::acl::StateMachine::addState ( const State &  state )

protected

Add a state to the state machine – the state might already contain transition definitions in order to check for properly defined transitions, validate needs to be called

Definition at line 67 of file statemachine.cpp.

{
    std::map<StateId, State>::const_iterator it = mStates.find(state.getId());
    if(it != mStates.end())
    {
        std::string msg = "State '" + state.getId() + "' already defined";
        LOG_ERROR("%s", msg.c_str());
        throw std::runtime_error(msg);
    } else {
        mStates[state.getId()] = state;
    }
}

bool fipa::acl::StateMachine::cancelled

(

)

const

Check whether the conversation has been successfully cancelled

Returns

true if the conversation was successfully cancelled

Definition at line 227 of file statemachine.cpp.

{
    return mCurrentStateId == State::CONVERSATION_CANCEL_SUCCESS;
}

void fipa::acl::StateMachine::consumeMessage

(

const ACLMessage &

msg

)

Consume a message If this is the first message it will initialize the roles for the first state

Parameters

msg	Message which should be consumed

Exceptions

std::runtime_error

if message could not be consumed

Definition at line 187 of file statemachine.cpp.

{
    LOG_DEBUG("StateMachine consumeMessage");
    
    try
    {
        const State& currentState = getCurrentState();
        const Transition& transition = currentState.getTransition(msg, mMessageArchive, mRoleMapping);
        updateRoleMapping(msg, transition);
        mMessageArchive.addMessage(msg);

        // Perform transition
        mCurrentStateId = transition.getTargetStateId();
    }
    catch(const std::exception& e)
    {
        LOG_DEBUG("StateMachine consumeMessage trying substatemachine proxied transition");
        // Retry with substatemachineproxied transition
        State& currentState = getCurrentStateModifiably();
        const Transition& transition = currentState.getSubstateMachineProxiedTransition(msg, mMessageArchive, mRoleMapping);
        updateRoleMapping(msg, transition);
        mMessageArchive.addMessage(msg);

        // Perform transition
        mCurrentStateId = transition.getTargetStateId();
    }
}

void fipa::acl::StateMachine::consumeSubStateMachineMessage	(	const ACLMessage &	msg,
		const fipa::acl::StateMachine &	stateMachine,
		int	numberOfSubConversations
	)

Consume a message meant for sub state machine. The given stateMachine is only used to be copied, if necessary.

Parameters

msg	Message which should be consumed

Exceptions

std::runtime_error

if message could not be consumed

Definition at line 179 of file statemachine.cpp.

{
    LOG_DEBUG("StateMachine consumeSubStateMachineMessage");
    
    State& currentState = getCurrentStateModifiably();
    currentState.consumeSubStateMachineMessage(msg, stateMachine, mRoleMapping, numberOfSubConversations);
}

const State & fipa::acl::StateMachine::getCurrentState

(

)

const

Get current state.

Exceptions

std::runtime_error

if statemachine has not been properly initialized

Definition at line 148 of file statemachine.cpp.

{
    if(mCurrentStateId.empty())
    {
        throw std::runtime_error("Statemachine has not been properly initialized: current state not set");
    } else {
        std::map<StateId, State>::const_iterator it = mStates.find(mCurrentStateId);
        if(it == mStates.end())
        {
            throw std::runtime_error("Statemachine has not been properly initialized: current state not found");
        }
        return it->second;
    }
}

StateId fipa::acl::StateMachine::getCurrentStateId ( ) const

inline

Get the current state

Returns

state id

Definition at line 129 of file statemachine.h.

{ return mCurrentStateId; }

State & fipa::acl::StateMachine::getCurrentStateModifiably

(

)

Get current state. Non const!

Exceptions

std::runtime_error

if statemachine has not been properly initialized

Definition at line 132 of file statemachine.cpp.

{
    if(mCurrentStateId.empty())
    {
        throw std::runtime_error("Statemachine has not been properly initialized: current state not set");
    } else {
        std::map<StateId, State>::iterator it = mStates.find(mCurrentStateId);
        if(it == mStates.end())
        {
            throw std::runtime_error("Statemachine has not been properly initialized: current state not found");
        }
        return it->second;
    }
}

StateId fipa::acl::StateMachine::getInitialStateId ( ) const

inline

Get the id initial state

Returns

id of the initial state

Definition at line 135 of file statemachine.h.

{ return mInitialStateId; }

fipa::acl::Protocol fipa::acl::StateMachine::getProtocol ( ) const

inline

Get protocol (which is set by the initiating message)

Returns

Protocol

Definition at line 146 of file statemachine.h.

{ return mProtocol; }

const RoleMapping& fipa::acl::StateMachine::getRoleMapping ( ) const

inline

Get the RoleMapping

Definition at line 109 of file statemachine.h.

{ return mRoleMapping; }

std::map<StateId, State> fipa::acl::StateMachine::getStates ( ) const

inline

Get the states mapping

Returns

states container

Definition at line 104 of file statemachine.h.

{ return mStates; }

bool fipa::acl::StateMachine::inFailureState

(

)

const

Check if state machine is in a known failure state

Returns

true if the current state of the machine is in a (known) error state

Definition at line 222 of file statemachine.cpp.

{
    return mCurrentStateId == State::GENERAL_FAILURE_STATE || mCurrentStateId == State::CONVERSATION_CANCEL_FAILURE;
}

bool fipa::acl::StateMachine::inFinalState

(

)

const

Check if the state machine is in a final state, i.e. the conversation has ended

Returns

true if the current state of the state machine is final

Definition at line 215 of file statemachine.cpp.

{
    const State& currentState = getCurrentState();
    // Use isFinished instead of isFinal
    return currentState.isFinished();
}

void fipa::acl::StateMachine::reset ( )

protected

Reset the current state to the initial state

Definition at line 62 of file statemachine.cpp.

{
    mCurrentStateId = mInitialStateId;
}

void fipa::acl::StateMachine::setCurrentStateId ( const StateId &  stateId )

inline

Definition at line 123 of file statemachine.h.

{ mCurrentStateId = stateId; }

void fipa::acl::StateMachine::setInitialState ( const StateId &  stateId )

inlineprotected

Set the initial state

Parameters

stateId

State to which the state machine should be set

Definition at line 79 of file statemachine.h.

{ mInitialStateId = stateId; }

void fipa::acl::StateMachine::setProtocol ( const fipa::acl::Protocol &  protocol )

inline

Set the protocol for this conversation

Definition at line 140 of file statemachine.h.

{ mProtocol = protocol; }

void fipa::acl::StateMachine::setSelf

(

const AgentID &

self

)

Set self agents id – can only be called once per state machine

Definition at line 163 of file statemachine.cpp.

{
    mRoleMapping.setSelf(self);
}

std::string fipa::acl::StateMachine::toString

(

)

const

Convert statemachine to string

Definition at line 232 of file statemachine.cpp.

{
    std::stringstream statemachine;
    statemachine << "Statemachine: (" << mProtocol << ")\n";
    std::map<StateId, State>::const_iterator it = mStates.begin();
    for(; it != mStates.end(); ++it)
    {
        statemachine << it->second.toString();
    }
    return statemachine.str();
}

std::string fipa::acl::StateMachine::toXML

(

)

const

Definition at line 255 of file statemachine.cpp.

{
    std::stringstream ss;
    ss << "<scxml version=\"1.0\" initial=\"1\">" << std::endl;
    std::map<StateId, State>::const_iterator it = mStates.begin();
    for(; it != mStates.end(); ++it)
    {
        ss << it->second.toXML();
    }
    ss << "</scxml>" << std::endl;

    return ss.str();
}

void fipa::acl::StateMachine::updateRoleMapping ( const ACLMessage &  msg, const Transition &  transition  )

protected

Update the role mapping

Parameters

msg	Message
transition	Transition which is associated with the given message

Definition at line 168 of file statemachine.cpp.

{
    mRoleMapping.addExpectedAgent(transition.getSenderRole(), msg.getSender());
    AgentIDList receivers = msg.getAllReceivers();
    AgentIDList::const_iterator it = receivers.begin();
    for(; it != receivers.end(); ++it)
    {
        mRoleMapping.addExpectedAgent(transition.getReceiverRole(), *it);
    }
}

void fipa::acl::StateMachine::updateRoles ( )

protected

Given all states update the roles

Definition at line 80 of file statemachine.cpp.

{
    std::map<StateId, State>::iterator it = mStates.begin();
    for(; it != mStates.end(); ++it)
    {
        std::vector<Transition> transitions = it->second.getTransitions();
        std::vector<Transition>::const_iterator transitionIt = transitions.begin();
        for(; transitionIt != transitions.end(); ++transitionIt)
        {
            mRoleMapping.addRole(transitionIt->getSenderRole());
            mRoleMapping.addRole(transitionIt->getReceiverRole());
        }
    }

}

void fipa::acl::StateMachine::validate ( ) const

protected

Check wether the state and transition in this state machine are valid

Exceptions

std::runtime_error

if the machine cannot be properly validated

Definition at line 29 of file statemachine.cpp.

{
    // Testing whether there are any undefined state referred to 
    // Selection of unique state ids
    std::set<StateId> referencedStates;
    std::map<StateId, State>::const_iterator statesIt = mStates.begin();

    for(; statesIt != mStates.end(); ++statesIt)
    {
        const State& state = statesIt->second;
        std::vector<Transition> transitions = state.getTransitions();
        std::vector<Transition>::const_iterator transitionsIt = transitions.begin();

        for(; transitionsIt != transitions.end(); ++transitionsIt)
        {
            referencedStates.insert(transitionsIt->getTargetStateId());
            referencedStates.insert(transitionsIt->getSourceStateId());
        }
    }

    std::set<StateId>::const_iterator referencedStatesIt = referencedStates.begin();
    for(; referencedStatesIt != referencedStates.end(); ++referencedStatesIt)
    {
        statesIt = mStates.find(*referencedStatesIt);
        if(statesIt == mStates.end())
        {
            std::string msg = "Unknown state '" + *referencedStatesIt + "' referred to in statemachine";
            LOG_ERROR("%s", msg.c_str());
            throw std::runtime_error(msg);
        }
    }
}

Friends And Related Function Documentation

friend class StateMachineReader

friend

Definition at line 24 of file statemachine.h.

---

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

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