soarapi.h

Go to the documentation of this file.

#ifndef _SOARAPI_H__            /* excludeFromBuildInfo */
#define _SOARAPI_H__

#include "soarkernel.h"
#include "soar_core_api.h"
#include "soar_ecore_api.h"
#include "soarapi_datatypes.h"

#ifdef USE_DEBUG_UTILS
#include "debugutil.h"
#endif

/* *************************************************************************
 * *************************************************************************/

/* *************************************************************************
 * *************************************************************************/

/*
 *
 *   Initialize Soar 
 * 
 *   Soar must be initialized before any of the API functions are 
 *   called.  Because this initialization must only be done once,
 *   it makes little sense to make it a part of this high level API.
 *   (it will never be called using a UI).  Thus initialization
 *   must be done with the core api function soar_cInitializeSoar()
 *
 *   See soar_core_api.h for the real documentation of this function
 */

extern int soar_ReInitSoar(int argc, const char *argv[], soarResult * res);

extern int soar_CreateAgent(int argc, const char *argv[], soarResult * res);

extern int soar_Run(int argc, const char *argv[], soarResult * res);

extern int soar_DestroyAgent(int argc, const char *argv[], soarResult * res);

extern int soar_Quit(int argc, const char *argv[], soarResult * res);

/* *************************************************************************
 * *************************************************************************/

/* *************************************************************************
 * *************************************************************************/

extern int soar_ReteNet(int argc, const char *argv[], soarResult * res);

extern int soar_AddWme(int argc, const char *argv[], soarResult * res);

extern int soar_RemoveWme(int argc, const char *argv[], soarResult * res);

extern int soar_Excise(int argc, const char *argv[], soarResult * res);

/* *************************************************************************
 * *************************************************************************/

/* *************************************************************************
 * *************************************************************************/
#ifdef USE_CAPTURE_REPLAY

extern int soar_CaptureInput(int argc, const char *argv[], soarResult * res);

extern int soar_ReplayInput(int argc, const char *argv[], soarResult * res);
#endif

extern int soar_ChunkNameFormat(int argc, const char *argv[], soarResult * res);

extern int soar_Learn(int argc, const char *argv[], soarResult * res);

extern int soar_MaxElaborations(int argc, const char *argv[], soarResult * res);

extern int soar_MaxChunks(int argc, const char *argv[], soarResult * res);

extern int soar_Operand2(int argc, const char *argv[], soarResult * res);

extern int soar_WaitSNC(int argc, const char *argv[], soarResult * res);

extern int soar_InputPeriod(int argc, const char *argv[], soarResult * res);

extern int soar_MultiAttributes(int argc, const char *argv[], soarResult * res);

extern int soar_NumericIndifferentMode(int argc, const char *argv[], soarResult * res);

extern int soar_OSupportMode(int argc, const char *argv[], soarResult * res);

/* End of core commands */

extern int soar_ExplainBacktraces(int argc, const char *argv[], soarResult * res);

extern int soar_FiringCounts(int argc, const char *argv[], soarResult * res);

extern int soar_FormatWatch(int argc, const char *argv[], soarResult * res);

extern int soar_IndifferentSelection(int argc, const char *argv[], soarResult * res);

extern int soar_InternalSymbols(int argc, const char *argv[], soarResult * res);

extern int soar_Matches(int argc, const char *argv[], soarResult * res);

extern int soar_Memories(int argc, const char *argv[], soarResult * res);

extern int soar_ProductionFind(int argc, const char *argv[], soarResult * res);

extern int soar_Preferences(int argc, const char *argv[], soarResult * res);

extern int soar_Print(int argc, const char *argv[], soarResult * res);

extern int soar_PWatch(int argc, const char *argv[], soarResult * res);

#ifdef USE_DEBUG_UTILS
extern int soar_Pool(int argc, const char *argv[], soarResult * res);
#endif

extern int soar_Sp(int argc, const char *argv[], soarResult * res);

extern int soar_Stats(int argc, const char *argv[], soarResult * res);

extern int soar_Stop(int argc, const char *argv[], soarResult * res);

extern int soar_Verbose(int argc, const char *argv[], soarResult * res);

extern int soar_Warnings(int argc, const char *argv[], soarResult * res);

extern int soar_Log(int argc, const char *argv[], soarResult * res);

extern int soar_AttributePreferencesMode(int argc, const char *argv[], soarResult * res);

extern int soar_Watch(int argc, const char *argv[], soarResult * res);

extern int soar_DefaultWmeDepth(int argc, const char *argv[], soarResult * res);

extern int soar_BuildInfo(int argc, const char *argv[], soarResult * res);

extern int soar_ExcludedBuildInfo(int argc, const char *argv[], soarResult * res);

/*
 *----------------------------------------------------------------------
 *
 * soar_Interrupt --
 *
 * \brief  This command sets and queries information regarding
 *         interrupts on productions.  It can turn interrupts on single
 *         productions on or off, list the current setting for a
 *         production, or list all productions which currently have
 *         interrupts on or off.
 *
 * \param  "-> argc" The number of arguments is the \c argv block
 * \param  "-> argv" An array of strings, each of which is a word in the
 *                   argument list to this function
 * \param  "<- res"  A SoarResult structure which will be filled in by the
 *                   function.
 *
 * \par    Syntax:
   \verbatim
           interrupt [-on|-off] [production name]
   \endverbatim
 *
 * \return Returns a Soar completion code.
 *
 * \par    SoarResult:
 *           \arg On \c SOAR_ERROR:  Contains details about error.
 *           \arg On \c SOAR_OK:     Is empty.
 *
 *
 * \par    Side effects:
 *           Sets the interrupt byte for a production or prints
 *           current interrupt settings
 *
 *
 *----------------------------------------------------------------------
 */

extern int soar_Interrupt(int argc, const char *argv[], soarResult * res);

#endif

---