edu.memphis.ccrg.lida.framework.initialization
Interface Initializable

All Known Subinterfaces:

Action, ActionSelection, Activatible, Agent, AttentionCodelet, Behavior, BroadcastQueue, Coalition, Codelet, CodeletManagerModule, Condition, DecayStrategy, DetectionAlgorithm, Environment, EpisodicMemory, ExciteStrategy, FrameworkModule, FrameworkTask, FullyInitializable, GlobalWorkspace, Learnable, Link, Linkable, Node, PamLink, PamLinkable, PamNode, PerceptualAssociativeMemory, ProceduralMemory, ProceduralUnit, PropagationStrategy, RootableNode, Scheme, SensoryMemory, SensoryMotorMemory, Strategy, StructureBuildingCodelet, TaskSpawner, TotalActivationStrategy, Workspace, WorkspaceBuffer

All Known Implementing Classes:

ActionImpl, ActivatibleImpl, AddLinkToPerceptTask, AddNodeStructureToPerceptTask, AddNodeToPerceptTask, AgentImpl, AttentionCodeletImpl, AttentionCodeletModule, BasicActionSelection, BasicAttentionCodelet, BasicDetectionAlgorithm, BasicSensoryMotorMemory, BasicStructureBuildingCodelet, BehaviorImpl, BehaviorNetwork, BroadcastQueueImpl, CoalitionImpl, CodeletImpl, CueBackgroundTask, DefaultAttentionCodelet, DefaultTotalActivationStrategy, EnvironmentImpl, EpisodicMemoryImpl, ExcitationTask, FrameworkModuleImpl, FrameworkTaskImpl, GlobalWorkspaceImpl, InitializableImpl, LearnableImpl, LinearDecayStrategy, LinearExciteStrategy, LinkImpl, MultipleDetectionAlgorithm, NeighborhoodAttentionCodelet, NoDecayStrategy, NodeImpl, NoExciteStrategy, PamLinkImpl, PamNodeImpl, PerceptualAssociativeMemoryImpl, ProceduralMemoryImpl, PropagationTask, RandomizingTaskSpawner, RootableNodeImpl, SchemeImpl, SensoryMemoryBackgroundTask, SensoryMemoryImpl, SigmoidDecayStrategy, SigmoidExciteStrategy, StrategyImpl, StructureBuildingCodeletImpl, StructureBuildingCodeletModule, TaskSpawnerImpl, TriggerTask, UpdateCsmBackgroundTask, UpscalePropagationStrategy, WorkspaceBufferImpl, WorkspaceImpl

public interface Initializable

An object that can be configured with parameters.

Author:

Ryan J. McCall

Method Summary

boolean	containsParameter(java.lang.String key) Returns whether a parameter with specified key is in this Initializable
<T> T	getParam(java.lang.String name, T defaultValue) Method to read parameters from the Map of properties set by the init(Map) method.
java.util.Map<java.lang.String,?>	getParameters() Returns the Map of parameters of this initializable
void	init() This is a convenience method to initialize this Object with parameters.
void	init(java.util.Map<java.lang.String,?> parameters) Initialize this object with parameters.

Method Detail

init

void init(java.util.Map<java.lang.String,?> parameters)

Initialize this object with parameters.

Parameters:

parameters - Map of parameters indexed by their String names

See Also:

AgentXmlFactory

init

void init()

This is a convenience method to initialize this Object with parameters. It is called from init(Map). Subclasses can overwrite this method and initialize their parameters. Make sure to call super.init() at the beginning of this method so the init() method of superclasses will run.

getParam

<T> T getParam(java.lang.String name,
               T defaultValue)

Method to read parameters from the Map of properties set by the init(Map) method.

Type Parameters:

T - expected type of the parameter

Parameters:

name - the parameter name

defaultValue - the default value to be returned if the parameter doesn't exist

Returns:

the value of the parameter or the default value

containsParameter

boolean containsParameter(java.lang.String key)

Returns whether a parameter with specified key is in this Initializable

Parameters:

key - String

Returns:

true if specified key exists

getParameters

java.util.Map<java.lang.String,?> getParameters()

Returns the Map of parameters of this initializable

Returns:

the Map of parameters