Method Commit

Core/ClientSML/src/sml_ClientWorkingMemory.cpp:1327–1380

* @brief Send the most recent list of changes to working memory * over to the kernel. *************************************************************/

*        over to the kernel.
*************************************************************/
bool WorkingMemory::Commit()
{
    int deltas = m_DeltaList.GetSize() ;
    
    // If nothing has changed, we have no work to do.
    // This allows us to call Commit() multiple times without causing problems
    // as later calls will be ignored if the current set of changes has been sent already.
    if (deltas == 0)
    {
        return true ;
    }
    
    // Build the SML message we're doing to send.
    ElementXML* pMsg = GetConnection()->CreateSMLCommand(sml_Names::kCommand_Input) ;
    
    // Add the agent parameter and as a side-effect, get a pointer to the <command> tag.  This is an optimization.
    ElementXML_Handle hCommand = GetConnection()->AddParameterToSMLCommand(pMsg, sml_Names::kParamAgent, GetAgentName()) ;
    ElementXML command(hCommand) ;
    
    // Build the list of WME changes
    for (int i = 0 ; i < deltas ; i++)
    {
        // Get the next change
        TagWme* pDelta = m_DeltaList.GetDelta(i) ;
        
        // Add it as a child of the command tag
        // (the command takes ownership of the delta)
        command.AddChild(pDelta) ;
    }
    
    // This is important.  We are working with a subpart of pMsg.
    // If we retain ownership of the handle and delete the object
    // it will release the handle...deleting part of our message.
    command.Detach() ;
    
    // We have transfered the list of deltas over to pMsg
    // so we need to clear the list, but not delete the tags that it contains.
    m_DeltaList.Clear(false) ;
    
#ifdef _DEBUG
    // Generate a text form of the XML so we can look at it in the debugger.
    char* pStr = pMsg->GenerateXMLString(true) ;
    pMsg->DeleteString(pStr) ;
#endif
    
    // Send the message
    AnalyzeXML response ;
    bool ok = GetConnection()->SendMessageGetResponse(&response, pMsg) ;
    
    // Clean up
    delete pMsg ;
    
    return ok ;
}

/*************************************************************
* @brief Resend the complete input link to the kernel