Method CheckStopBeforePhase

Core/KernelSML/src/sml_OldRunScheduler.cpp:474–503

* @brief Users and applications can choose to have agents always * stop before a particular phase. If all agents have finished * finished running, this routine will check whether they * need to be stepped to a different phase. *********************************************************************/

*            need to be stepped to a different phase.
*********************************************************************/
void RunScheduler::CheckStopBeforePhase(egSKIRunType runStepSize)
{
    // If we ran by decision and we've run the appropriate number of decisions,
    // then  step agent until it reached the correct phase where it should stop.
    // Just before this point, (end of while loop above) we've checked and fired the
    // OutputComplete and OutputGenerated events, so it should be fine to step
    // an agent by phases until it gets to StopBefore, and then step the other
    // agents in turn.  UNLESS we were interrupted.  Then we'd need to cross the
    // Output-Input Boundary together and generate events...  For now, if interrupted,
    // or error or halted, we won't do anything here.
    
    if ((runStepSize == gSKI_RUN_DECISION_CYCLE) && (m_StopBeforePhase != gSKI_INPUT_PHASE))
    {
        for (AgentMapIter iter = m_pKernelSML->m_AgentMap.begin() ; iter != m_pKernelSML->m_AgentMap.end() ; iter++)
        {
            AgentSML* pAgentSML = iter->second ;
            gSKI::IAgent* pAgent = pAgentSML->GetIAgent() ;
            egSKIPhaseType phase = pAgent->GetCurrentPhase() ;
            egSKIRunResult runResult = pAgentSML->GetResultOfLastRun() ;
            
            while ((phase != m_StopBeforePhase) && (gSKI_RUN_COMPLETED == runResult))
            {
                runResult = pAgent->StepInClientThread(gSKI_INTERLEAVE_PHASE, 1) ;
                phase = pAgent->GetCurrentPhase() ;
            }
            // Notify listeners that this agent is finished running
            pAgent->FireRunEndsEvent() ;
        }
    }
}

/********************************************************************
* @brief    Called when the agent completes a given phase.