gov.sandia.cognition.framework
Interface CognitiveModel

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractCognitiveModel, AbstractCognitiveModelLite, CognitiveModelLite, MultithreadedCognitiveModel

public interface CognitiveModel
extends Serializable

The CognitiveModel interface defines the basic functionality of a cognitive model. In particular, a model must have an update function, a method for getting the current state, a method for resetting the state, and methods for attaching listeners to the model.

Since:
1.0
Author:
Justin Basilico, Kevin R. Dixon

Method Summary
 void addCognitiveModelListener(CognitiveModelListener listener)
          Adds a CognitiveModelListener to this model.
 CognitiveModelState getCurrentState()
          Gets the current state of the model.
 List<? extends CognitiveModule> getModules()
          Gets the modules that are instantiated for this model.
 SemanticIdentifierMap getSemanticIdentifierMap()
          Gets teh semantic identifier database used by the model.
 void removeCognitiveModelListener(CognitiveModelListener listener)
          Removes a CognitiveModelListener from this model.
 void resetCognitiveState()
          Resets the current cognitive state.
 void update(CognitiveModelInput input)
          Updates the model by updating all the modules using the given input.
 

Method Detail

update

void update(CognitiveModelInput input)
Updates the model by updating all the modules using the given input.

Parameters:
input - The input to the model

getModules

List<? extends CognitiveModule> getModules()
Gets the modules that are instantiated for this model.

Returns:
The modules contained in this model

resetCognitiveState

void resetCognitiveState()
Resets the current cognitive state.


getCurrentState

CognitiveModelState getCurrentState()
Gets the current state of the model.

Returns:
The model's current state.

getSemanticIdentifierMap

SemanticIdentifierMap getSemanticIdentifierMap()
Gets teh semantic identifier database used by the model.

Returns:
The semantic identifier database used by the model.

addCognitiveModelListener

void addCognitiveModelListener(CognitiveModelListener listener)
Adds a CognitiveModelListener to this model.

Parameters:
listener - The listener to add

removeCognitiveModelListener

void removeCognitiveModelListener(CognitiveModelListener listener)
Removes a CognitiveModelListener from this model.

Parameters:
listener - The listener to remove