Method Interrupt

Core/KernelSML/src/sml_AgentSML.cpp:400–423

============================= Request that the agent stop soon. =============================

// Request that the agent stop soon.
//=============================
void AgentSML::Interrupt(smlStopLocationFlags stopLoc)
{
    // Tell the agent where to stop
    m_interruptFlags = stopLoc;
    
    // If the request for interrupt is sml_STOP_AFTER_DECISION_CYCLE, then it
    // will be caught in the RunScheduler::CompletedRunType() and/or IsAgentFinished().
    // We don't want to interrupt agents until the appropriate time if the request is
    // sml_STOP_AFTER_DECISION_CYCLE.
    
    // These are immediate requests for interrupt, such as from RHS or application
    if ((sml_STOP_AFTER_SMALLEST_STEP == stopLoc) || (sml_STOP_AFTER_PHASE == stopLoc))
    {
        m_agent->stop_soar = true;
        // If the agent is not running, we should set the runState flag now so agent won't run
        if (m_runState == sml_RUNSTATE_STOPPED)
        {
            m_runState = sml_RUNSTATE_INTERRUPTED;
        }
        // Running agents must test stopLoc & stop_soar in Step method to see if interrupted.
        // Because we set m_agent->stop_soar == true above, any running agents should return to
        // gSKI at the end of the current phase, even if interleaving by larger steps.  KJC
    }
}

//=============================
// Clear any existing interrupt requests