gov.sandia.cognition.framework.learning
Class StatefulEvaluatorBasedCognitiveModule<InputType,OutputType>

java.lang.Object
  gov.sandia.cognition.framework.concurrent.AbstractConcurrentCognitiveModule
      gov.sandia.cognition.framework.learning.EvaluatorBasedCognitiveModule<InputType,OutputType>
          gov.sandia.cognition.framework.learning.StatefulEvaluatorBasedCognitiveModule<InputType,OutputType>

Type Parameters:

InputType - Input type of the embedded Evaluator

OutputType - Output type of the embedded Evaluator

All Implemented Interfaces:

CognitiveModule, ConcurrentCognitiveModule, Serializable

public class StatefulEvaluatorBasedCognitiveModule<InputType,OutputType>
extends EvaluatorBasedCognitiveModule<InputType,OutputType>

The StatefulEvaluatorBasedCognitiveModule implements a CognitiveModule that wraps a StatefulEvaluator object.

Since:

2.0

Author:

Justin Basilico, Kevin R. Dixon, Zachary Benz

See Also:

Serialized Form

Field Summary

Fields inherited from class gov.sandia.cognition.framework.learning.EvaluatorBasedCognitiveModule

DEFAULT_NAME, input, output

Constructor Summary

StatefulEvaluatorBasedCognitiveModule(CognitiveModel model, EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> settings, String name)
Creates a new instance of StatefulEvaluatorBasedCognitiveModule.

Method Summary

gov.sandia.cognition.evaluator.StatefulEvaluator<InputType,OutputType,gov.sandia.cognition.util.CloneableSerializable>	getStatefulEvaluator() Gets the StatefulEvaluator used by the module.
CognitiveModuleState	initializeState(CognitiveModelState modelState)
void	readState(CognitiveModelState modelState, CognitiveModuleState previousModuleState)
CognitiveModuleState	writeState(CognitiveModelState modelState)

Methods inherited from class gov.sandia.cognition.framework.learning.EvaluatorBasedCognitiveModule

evaluate, getEvaluator, getInputConverter, getName, getOutputConverter, getSettings, setName, setSettings

Methods inherited from class gov.sandia.cognition.framework.concurrent.AbstractConcurrentCognitiveModule

update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatefulEvaluatorBasedCognitiveModule

public StatefulEvaluatorBasedCognitiveModule(CognitiveModel model,
                                             EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> settings,
                                             String name)

Creates a new instance of StatefulEvaluatorBasedCognitiveModule.

Parameters:

model - The model to create the module for.

settings - The settings of the module.

name - High-level descriptive name of the module

Method Detail

initializeState

public CognitiveModuleState initializeState(CognitiveModelState modelState)

Specified by:

initializeState in interface CognitiveModule

Overrides:

initializeState in class EvaluatorBasedCognitiveModule<InputType,OutputType>

Parameters:

modelState -

Returns:

readState

public void readState(CognitiveModelState modelState,
                      CognitiveModuleState previousModuleState)

Specified by:

readState in interface ConcurrentCognitiveModule

Overrides:

readState in class EvaluatorBasedCognitiveModule<InputType,OutputType>

Parameters:

modelState -

previousModuleState -

Since:

2.0

writeState

public CognitiveModuleState writeState(CognitiveModelState modelState)

Specified by:

writeState in interface ConcurrentCognitiveModule

Overrides:

writeState in class EvaluatorBasedCognitiveModule<InputType,OutputType>

Parameters:

modelState -

Returns:

Since:

2.0

getStatefulEvaluator

public gov.sandia.cognition.evaluator.StatefulEvaluator<InputType,OutputType,gov.sandia.cognition.util.CloneableSerializable> getStatefulEvaluator()

Gets the StatefulEvaluator used by the module.

Returns:

The StatefulEvaluator used by the module.