soarapi_datatypes.h File Reference

This file contains datatypes used by the Soar API. More...

Go to the source code of this file.

Data Structures
struct	ask_cb_data_st
	The ASK Callback sends the following datastructure to the function which is registered with the Soar kernel. More...
struct	sapiwme_st
struct	soar_apiAgentIter_struct
	An iteration structure. More...
struct	soarResult_struct
	The soarResult structure contains a string message, containing information about the last high-level api function invocation. More...
Typedefs
typedef soarResult_struct	soarResult
	The soarResult structure contains a string message, containing information about the last high-level api function invocation.
typedef void *	psoar_agent
	A generic pointer to a soar agent.
typedef void *	psoar_wme
	A generic pointer to a soar agent.
typedef soar_apiAgentIter_struct	soar_apiAgentIterator
	An iteration structure.
typedef ask_cb_data_st	soar_apiAskCallbackData
	The ASK Callback sends the following datastructure to the function which is registered with the Soar kernel.
typedef sapiwme_st	soarapi_wme
Enumerations
enum	soar_apiResult { SOAR_OK, SOAR_ERROR }
	A soar api function return code. More...
enum	soar_apiProductionType {   CHUNKS, DEFAULT, TASK, USER,   ALL }
enum	soar_apiLearningSetting {   ON, OFF, EXCEPT, ONLY,   ALL_LEVELS, BOTTOM_UP }
enum	soar_apiSlotType {   NO_SLOT, STATE_SLOT, OPERATOR_SLOT, SUPERSTATE_SLOT,   SUPEROPERATOR_SLOT, SUPERSUPERSTATE_SLOT, SUPERSUPEROPERATOR_SLOT }
enum	soar_apiInterruptSetting { INTERRUPT_OFF, INTERRUPT_ON, INTERRUPT_PRINT }
Functions
void	setSoarResultResult (soarResult *res, const char *format,...)
void	setSoarResultResult ()
void	appendSoarResultResult (soarResult *res, const char *format,...)
void	appendSoarResultResult ()
void	appendSymbolsToSoarResultResult (soarResult *res, const char *format,...)
void	appendSymbolsToSoarResultResult ()

---

Detailed Description

This file contains datatypes used by the Soar API.

Definition in file soarapi_datatypes.h.

---

Typedef Documentation

typedef void* psoar_agent

A generic pointer to a soar agent. this pointer should be used outside of the Soar kernel proper. It encapsulates the agent's internal data structure and provides some degree of safety. Definition at line 64 of file soarapi_datatypes.h. Referenced by soar_cDestroyAgentByAddress(), soar_cDestroyAgentById(), soar_cDestroyAgentByName(), soar_cDestroyAllAgentsWithName(), soar_cGetAgentByName(), soar_cGetAgentId(), soar_cGetAgentInputLinkId(), soar_cGetAgentOutputLinkId(), soar_cGetCurrentAgent(), soar_cGetIdForAgentByName(), soar_cSetCurrentAgent(), soar_cSetCurrentAgentByName(), and soar_default_destroy_agent_procedure().

typedef void* psoar_wme

A generic pointer to a soar agent. this pointer should be used outside of the Soar kernel proper. It encapsulates the agent's internal data structure and provides some degree of safety. Definition at line 74 of file soarapi_datatypes.h. Referenced by replay_input_wme(), soar_AddWme(), soar_cAddFloatWme(), soar_cAddIntWme(), soar_cAddWme(), soar_cGetWmeAttr(), soar_cGetWmeId(), soar_cGetWmeTimetag(), soar_cGetWmeValue(), and soar_cRemoveWme().

typedef struct soar_apiAgentIter_struct soar_apiAgentIterator

An iteration structure. This structure is used to iterate though the agent list. All fields should be considered private expect for the more field. Referenced by soar_cInitAgentIterator(), and soar_cStepAgentIterator().

typedef struct ask_cb_data_st soar_apiAskCallbackData

The ASK Callback sends the following datastructure to the function which is registered with the Soar kernel. Referenced by run_preference_semantics(), and soar_cDefaultAskCallback().

typedef struct sapiwme_st soarapi_wme

Referenced by capture_input_wme(), replay_input_wme(), soar_cAddWme(), soar_cRemoveWme(), and soar_ecReplayInput().

typedef struct soarResult_struct soarResult

The soarResult structure contains a string message, containing information about the last high-level api function invocation. Referenced by cb_appendToSoarResultResult(), cb_soarResult_AppendResult(), parse_go_command(), parse_memory_stats(), parse_rete_stats(), parse_run_command(), parse_system_stats(), set_watch_prod_group_setting(), set_watch_setting(), setSoarResultResult(), soar_AddWme(), soar_AttributePreferencesMode(), soar_BuildInfo(), soar_CaptureInput(), soar_ChunkNameFormat(), soar_CreateAgent(), soar_DefaultWmeDepth(), soar_DestroyAgent(), soar_Excise(), soar_ExcludedBuildInfo(), soar_ExplainBacktraces(), soar_FiringCounts(), soar_FormatWatch(), soar_GDSPrint(), soar_IndifferentSelection(), soar_InputPeriod(), soar_InternalSymbols(), soar_Interrupt(), soar_Learn(), soar_Log(), soar_Matches(), soar_MaxChunks(), soar_MaxElaborations(), soar_Memories(), soar_MultiAttributes(), soar_NumericIndifferentMode(), soar_Operand2(), soar_OSupportMode(), soar_Pool(), soar_Preferences(), soar_Print(), soar_ProductionFind(), soar_PWatch(), soar_Quit(), soar_ReInitSoar(), soar_RemoveWme(), soar_ReplayInput(), soar_ReteNet(), soar_Run(), soar_Sp(), soar_Stats(), soar_Stop(), soar_Verbose(), soar_WaitSNC(), soar_Warnings(), and soar_Watch().

---

Enumeration Type Documentation

enum soar_apiInterruptSetting

Enumeration values: INTERRUPT_OFF  INTERRUPT_ON  INTERRUPT_PRINT  Definition at line 167 of file soarapi_datatypes.h. Referenced by soar_Interrupt().

enum soar_apiLearningSetting

Enumeration values: ON  OFF  EXCEPT  ONLY  ALL_LEVELS  BOTTOM_UP  Definition at line 122 of file soarapi_datatypes.h.

enum soar_apiProductionType

Enumeration values: CHUNKS  DEFAULT  TASK  USER  ALL  Definition at line 110 of file soarapi_datatypes.h.

enum soar_apiResult

A soar api function return code. Enumeration values: SOAR_OK  SOAR_ERROR  Definition at line 101 of file soarapi_datatypes.h.

enum soar_apiSlotType

Enumeration values: NO_SLOT  STATE_SLOT  OPERATOR_SLOT  SUPERSTATE_SLOT  SUPEROPERATOR_SLOT  SUPERSUPERSTATE_SLOT  SUPERSUPEROPERATOR_SLOT  Definition at line 135 of file soarapi_datatypes.h.

---

Function Documentation

void appendSoarResultResult (   )

Referenced by cb_appendToSoarResultResult(), cb_soarResult_AppendResult(), setSoarResultResult(), soar_AddWme(), soar_CaptureInput(), soar_Interrupt(), soar_Learn(), soar_Log(), soar_ReplayInput(), and soar_Watch().

void appendSoarResultResult (  soarResult *  res, const char *  format, ...  )

void appendSymbolsToSoarResultResult (   )

Referenced by setSoarResultResult(), and soar_AddWme().

void appendSymbolsToSoarResultResult (  soarResult *  res, const char *  format, ...  )

void setSoarResultResult (   )

Referenced by parse_go_command(), parse_memory_stats(), parse_rete_stats(), parse_run_command(), parse_system_stats(), set_watch_prod_group_setting(), set_watch_setting(), setSoarResultResult(), soar_AddWme(), soar_AttributePreferencesMode(), soar_BuildInfo(), soar_CaptureInput(), soar_ChunkNameFormat(), soar_CreateAgent(), soar_DefaultWmeDepth(), soar_DestroyAgent(), soar_Excise(), soar_ExcludedBuildInfo(), soar_ExplainBacktraces(), soar_FormatWatch(), soar_IndifferentSelection(), soar_InputPeriod(), soar_InternalSymbols(), soar_Interrupt(), soar_Learn(), soar_Log(), soar_Matches(), soar_MaxChunks(), soar_MaxElaborations(), soar_Memories(), soar_MultiAttributes(), soar_NumericIndifferentMode(), soar_Operand2(), soar_OSupportMode(), soar_Pool(), soar_Preferences(), soar_Print(), soar_ProductionFind(), soar_PWatch(), soar_RemoveWme(), soar_ReplayInput(), soar_ReteNet(), soar_Sp(), soar_Stats(), soar_Stop(), soar_Verbose(), soar_WaitSNC(), soar_Warnings(), and soar_Watch().

void setSoarResultResult (  soarResult *  res, const char *  format, ...  )

Definition at line 5 of file soarapi_datatypes.c. References appendSoarResultResult(), appendSymbolsToSoarResultResult(), format, soarResult_struct::result, soarResult_struct::resultLength, setSoarResultResult(), soarResult, Symbol, and symbol_to_string().

---