gov.sandia.cognition.framework
Interface CognitiveModelState

All Superinterfaces:
Cloneable, CloneableSerializable, Serializable
All Known Implementing Classes:
CognitiveModelLiteState

public interface CognitiveModelState
extends CloneableSerializable

The CognitiveModelState interface defines the general functionality required of an object that represents the state of a CognitiveModel. This should contain the complete persistent storage of the CognitiveModel and should not be operated on by side-effect except by objects contained within the CognitiveModel.

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

Method Summary
 CognitiveModelState clone()
          A deep copy clone of this state.
 CogxelState getCogxels()
          Gets the CogxelState.
 CognitiveModelInput getInput()
          Gets the input to the model for this state.
 Collection<CognitiveModuleState> getModuleStates()
          Gets the collection of module states.
 void setInput(CognitiveModelInput input)
          Sets the input for this model state.
 

Method Detail

clone

CognitiveModelState clone()
A deep copy clone of this state.

Specified by:
clone in interface CloneableSerializable
Returns:
A deep copy of this state.

getInput

CognitiveModelInput getInput()
Gets the input to the model for this state.

Returns:
The model input.

getCogxels

CogxelState getCogxels()
Gets the CogxelState.

Returns:
The current state of the Cogxels.

getModuleStates

Collection<CognitiveModuleState> getModuleStates()
Gets the collection of module states.

Returns:
The collection of module states.

setInput

void setInput(CognitiveModelInput input)
Sets the input for this model state.

Parameters:
input - The new input.