bool StateMachineImp::HandleEvent ( const EventImp &  evt )

protected

This is the event handler. Depending on the type of event it calles the function associated with the event, the Transition() or Configure() function.

It first checks if the given even is valid in the current state. If it is not valid the function returns with true.

If it is valid, it is checked whether a function is associated with the event. If this is the case, evt.Exec() is called and HandleNewState called with its return value.

If the event's target state is negative (unnamed Event) the Configure() function is called with the event as argument and HandleNewState with its returned new state.

If the event's target state is 0 or positive (named Event) the Transition() function is called with the event as argument and HandleNewState with its returned new state.

In all three cases the return value of HandleNewState is returned.

Any of the three commands should usually return the current state or (in case of the Transition() command) return the new state. However, all three command can issue a state change by returning a new state. However, this will just change the internal state. Any action which is connected with the state change must have been executed already.

Parameters

evt	a reference to the event which should be handled

Returns

false in case one of the commands changed the state to kSM_FataError, true otherwise

Definition at line 882 of file StateMachineImp.cc.

References MessageImp::Debug(), EventImp::ExecFunc(), fCurrentState, EventImp::GetName(), EventImp::GetSize(), GetStateDescription(), HandleNewState(), EventImp::HasFunc(), EventImp::IsStateAllowed(), and MessageImp::Warn().

Referenced by PostEvent(), Run(), and Wrapper().

{
    if (!evt.HasFunc())
    {
        Warn(evt.GetName()+": No function assigned... ignored.");
        return true;

    }

#ifdef DEBUG
    ostringstream out;
    out << "Handle: " << evt.GetName() << "[" << evt.GetSize() << "]";
    Debug(out);
#endif

    // Check if the received command is allow in the current state
    if (!evt.IsStateAllowed(fCurrentState))
    {
        Warn(evt.GetName()+": Not allowed in state "+GetStateDescription()+"... ignored.");
        return true;
    }

    return HandleNewState(evt.ExecFunc(), &evt,
                          "by ExecFunc function-call");
}

Here is the call graph for this function:

Here is the caller graph for this function: