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

java.lang.Object
  extended by gov.sandia.cognition.framework.learning.EvaluatorBasedCognitiveModuleSettings<InputType,OutputType>
Type Parameters:
InputType - Input type of the embedded Evaluator
OutputType - Output type of the embedded Evaluator
All Implemented Interfaces:
CognitiveModuleSettings, CloneableSerializable, Serializable, Cloneable

public class EvaluatorBasedCognitiveModuleSettings<InputType,OutputType>
extends Object
implements CognitiveModuleSettings, Serializable

The EvaluatorBasedCognitiveModuleSettings class implements the settings for the EvaluatorBasedCognitiveModule. It contains the evaluator to be wrapped along with the converters to convert the input Cogxels to the InputType and the OutputType back to Cogxels.

Since:
2.0
Author:
Justin Basilico, Kevin R. Dixon
See Also:
Serialized Form

Constructor Summary
EvaluatorBasedCognitiveModuleSettings()
          Creates a new instance of EvaluatorBasedCognitiveModuleSettings.
EvaluatorBasedCognitiveModuleSettings(Evaluator<? super InputType,? extends OutputType> evaluator, CogxelConverter<InputType> inputConverter, CogxelConverter<OutputType> outputConverter)
          Creates a new instance of EvaluatorBasedCognitiveModuleSettings.
EvaluatorBasedCognitiveModuleSettings(EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> other)
          Creates a new instance of EvaluatorBasedCognitiveModuleSettings that is a copy of the given EvaluatorBasedCognitiveModuleSettings.
 
Method Summary
 EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> clone()
          Creates a clone of this EvaluatorBasedCognitiveModuleSettings.
 Evaluator<? super InputType,? extends OutputType> getEvaluator()
          Gets the evaluator to be used by the module.
 CogxelConverter<InputType> getInputConverter()
          Gets the CogxelConverter used to convert from a CogxelState to InputType.
 CogxelConverter<OutputType> getOutputConverter()
          Gets the CogxelConverter used to convert OutputType to a CogxelState.
 void setEvaluator(Evaluator<? super InputType,? extends OutputType> evaluator)
          Sets the evaluator to be used by the module.
 void setInputConverter(CogxelConverter<InputType> inputConverter)
          Sets the CogxelConverter used to convert from a CogxelState to InputType.
 void setOutputConverter(CogxelConverter<OutputType> outputConverter)
          Sets the CogxelConverter used to convert OutputType to a CogxelState.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EvaluatorBasedCognitiveModuleSettings

public EvaluatorBasedCognitiveModuleSettings()
Creates a new instance of EvaluatorBasedCognitiveModuleSettings.


EvaluatorBasedCognitiveModuleSettings

public EvaluatorBasedCognitiveModuleSettings(Evaluator<? super InputType,? extends OutputType> evaluator,
                                             CogxelConverter<InputType> inputConverter,
                                             CogxelConverter<OutputType> outputConverter)
Creates a new instance of EvaluatorBasedCognitiveModuleSettings.

Parameters:
evaluator - The evaluator to be used by the module.
inputConverter - The CogxelConverter used to convert from a CogxelState to InputType.
outputConverter - The CogxelConverter used to convert OutputType to a CogxelState.

EvaluatorBasedCognitiveModuleSettings

public EvaluatorBasedCognitiveModuleSettings(EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> other)
Creates a new instance of EvaluatorBasedCognitiveModuleSettings that is a copy of the given EvaluatorBasedCognitiveModuleSettings. This involves cloning the input and output converters and passing a reference to the evaluator to be used.

Parameters:
other - The other EvaluatorBasedCognitiveModuleSettings to copy.
Method Detail

clone

public EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> clone()
Creates a clone of this EvaluatorBasedCognitiveModuleSettings. For this clone the input converter and output converter are cloned, but the evaluator is passed by reference.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class Object
Returns:
A clone of this object.

getEvaluator

public Evaluator<? super InputType,? extends OutputType> getEvaluator()
Gets the evaluator to be used by the module.

Returns:
The evaluator to be used by the module.

setEvaluator

public void setEvaluator(Evaluator<? super InputType,? extends OutputType> evaluator)
Sets the evaluator to be used by the module.

Parameters:
evaluator - The evaluator to be used by the module.

getInputConverter

public CogxelConverter<InputType> getInputConverter()
Gets the CogxelConverter used to convert from a CogxelState to InputType.

Returns:
The CogxelConverter used to convert from a CogxelState to InputType.

setInputConverter

public void setInputConverter(CogxelConverter<InputType> inputConverter)
Sets the CogxelConverter used to convert from a CogxelState to InputType.

Parameters:
inputConverter - The CogxelConverter used to convert from a CogxelState to InputType.

getOutputConverter

public CogxelConverter<OutputType> getOutputConverter()
Gets the CogxelConverter used to convert OutputType to a CogxelState.

Returns:
The CogxelConverter used to convert OutputType to a CogxelState.

setOutputConverter

public void setOutputConverter(CogxelConverter<OutputType> outputConverter)
Sets the CogxelConverter used to convert OutputType to a CogxelState.

Parameters:
outputConverter - The CogxelConverter used to convert OutputType to a CogxelState.