Incorrect SML Event Enum Documentation - Githubissues

SoarGroup / Soar

Soar, a general cognitive architecture for systems that exhibit intelligent behavior.

http://soar.eecs.umich.edu

Other

321 stars 70 forks source link

Incorrect SML Event Enum Documentation #441

Open Bryan-Stearns opened 3 months ago

Bryan-Stearns commented 3 months ago

In sml_ClientKernel.h, the brief documenting RegisterForSystemEvent() says that the list of system events is:

smlEVENT_BEFORE_SHUTDOWN,
smlEVENT_AFTER_CONNECTION_LOST,
smlEVENT_BEFORE_RESTART,
smlEVENT_AFTER_RESTART,
smlEVENT_BEFORE_RHS_FUNCTION_ADDED,
smlEVENT_AFTER_RHS_FUNCTION_ADDED,
smlEVENT_BEFORE_RHS_FUNCTION_REMOVED,
smlEVENT_AFTER_RHS_FUNCTION_REMOVED,
smlEVENT_BEFORE_RHS_FUNCTION_EXECUTED,
smlEVENT_AFTER_RHS_FUNCTION_EXECUTED,

But in sml_Events.h, the list of system events is:

smlEVENT_BEFORE_SHUTDOWN
smlEVENT_AFTER_CONNECTION
smlEVENT_SYSTEM_START
smlEVENT_BEFORE_AGENTS_RUN_STEP
smlEVENT_SYSTEM_STOP
smlEVENT_INTERRUPT_CHECK
smlEVENT_SYSTEM_PROPERTY_CHANGED

(The other event registration doc briefs should be double checked also.)

P.S. Also, smlEVENT_AFTER_CONNECTION_LOST sounds like it could be very useful. Is this actually available in Soar? Currently it appears not to be.

garfieldnate commented 2 months ago

I don't see smlEVENT_AFTER_CONNECTION_LOST used anywhere, unfortunately. It might have been removed.