edu.memphis.ccrg.lida.workspace.structurebuildingcodelets
Class BasicStructureBuildingCodelet

java.lang.Object
  extended by edu.memphis.ccrg.lida.framework.initialization.InitializableImpl
      extended by edu.memphis.ccrg.lida.framework.shared.activation.ActivatibleImpl
          extended by edu.memphis.ccrg.lida.framework.shared.activation.LearnableImpl
              extended by edu.memphis.ccrg.lida.framework.tasks.FrameworkTaskImpl
                  extended by edu.memphis.ccrg.lida.framework.tasks.CodeletImpl
                      extended by edu.memphis.ccrg.lida.workspace.structurebuildingcodelets.StructureBuildingCodeletImpl
                          extended by edu.memphis.ccrg.lida.workspace.structurebuildingcodelets.BasicStructureBuildingCodelet
All Implemented Interfaces:
FullyInitializable, Initializable, Activatible, Learnable, Codelet, FrameworkTask, StructureBuildingCodelet, java.util.concurrent.Callable<FrameworkTask>

public class BasicStructureBuildingCodelet
extends StructureBuildingCodeletImpl

Default implementation of StructureBuildingCodelet. Checks for sought content in all accessible WorkspaceBuffers and adds all buffer content to the Current Situational Model.

Author:
Ryan J. McCall

Field Summary
 
Fields inherited from class edu.memphis.ccrg.lida.workspace.structurebuildingcodelets.StructureBuildingCodeletImpl
readableBuffers, runResults, writableBuffer
 
Fields inherited from class edu.memphis.ccrg.lida.framework.tasks.CodeletImpl
soughtContent
 
Fields inherited from class edu.memphis.ccrg.lida.framework.tasks.FrameworkTaskImpl
status
 
Fields inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Learnable
DEFAULT_BASE_LEVEL_ACTIVATION, DEFAULT_LEARNABLE_REMOVAL_THRESHOLD
 
Fields inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Activatible
DEFAULT_ACTIVATIBLE_REMOVAL_THRESHOLD, DEFAULT_ACTIVATION
 
Constructor Summary
BasicStructureBuildingCodelet()
          Default constructor
 
Method Summary
 boolean bufferContainsSoughtContent(WorkspaceBuffer buffer)
          Returns true if specified WorkspaceBuffer contains this codelet's sought content.
 NodeStructure retrieveWorkspaceContent(WorkspaceBuffer buffer)
          Returns sought content and related content from specified WorkspaceBuffer.
protected  void runThisFrameworkTask()
          To be overridden by extending classes.
 
Methods inherited from class edu.memphis.ccrg.lida.workspace.structurebuildingcodelets.StructureBuildingCodeletImpl
getCodeletRunResult, reset, setAssociatedModule
 
Methods inherited from class edu.memphis.ccrg.lida.framework.tasks.CodeletImpl
getSoughtContent, setSoughtContent
 
Methods inherited from class edu.memphis.ccrg.lida.framework.tasks.FrameworkTaskImpl
call, cancel, equals, getControllingTaskSpawner, getNextTicksPerRun, getScheduledTick, getTaskId, getTaskStatus, getTicksPerRun, hashCode, setControllingTaskSpawner, setNextTicksPerRun, setScheduledTick, setTaskStatus, setTicksPerRun, stopRunning, toString
 
Methods inherited from class edu.memphis.ccrg.lida.framework.shared.activation.LearnableImpl
decay, decayBaseLevelActivation, getBaseLevelActivation, getBaseLevelDecayStrategy, getBaseLevelExciteStrategy, getLearnableRemovalThreshold, getTotalActivation, getTotalActivationStrategy, init, isRemovable, reinforceBaseLevelActivation, setBaseLevelActivation, setBaseLevelDecayStrategy, setBaseLevelExciteStrategy, setBaseLevelRemovalThreshold, setTotalActivationStrategy
 
Methods inherited from class edu.memphis.ccrg.lida.framework.shared.activation.ActivatibleImpl
excite, getActivatibleRemovalThreshold, getActivation, getDecayStrategy, getExciteStrategy, setActivatibleRemovalThreshold, setActivation, setDecayStrategy, setExciteStrategy
 
Methods inherited from class edu.memphis.ccrg.lida.framework.initialization.InitializableImpl
containsParameter, getParam, getParameters, init
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.tasks.Codelet
getSoughtContent, setSoughtContent
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.tasks.FrameworkTask
cancel, getControllingTaskSpawner, getNextTicksPerRun, getScheduledTick, getTaskId, getTaskStatus, getTicksPerRun, setControllingTaskSpawner, setNextTicksPerRun, setScheduledTick, setTaskStatus, setTicksPerRun, stopRunning
 
Methods inherited from interface java.util.concurrent.Callable
call
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Learnable
decayBaseLevelActivation, getBaseLevelActivation, getBaseLevelDecayStrategy, getBaseLevelExciteStrategy, getLearnableRemovalThreshold, getTotalActivationStrategy, reinforceBaseLevelActivation, setBaseLevelActivation, setBaseLevelDecayStrategy, setBaseLevelExciteStrategy, setBaseLevelRemovalThreshold, setTotalActivationStrategy
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Activatible
decay, excite, getActivatibleRemovalThreshold, getActivation, getDecayStrategy, getExciteStrategy, getTotalActivation, isRemovable, setActivatibleRemovalThreshold, setActivation, setDecayStrategy, setExciteStrategy
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.initialization.Initializable
containsParameter, getParam, getParameters, init, init
 

Constructor Detail

BasicStructureBuildingCodelet

public BasicStructureBuildingCodelet()
Default constructor

Method Detail

runThisFrameworkTask

protected void runThisFrameworkTask()
Description copied from class: FrameworkTaskImpl
To be overridden by extending classes. Overriding method should execute a handful of statements considered to constitute a single iteration of the task. For example, a codelet might look in a buffer for some content and make a change to it in a single iteration. The overriding method may also change the TaskStatus of a task. For example, if the task should only run once and stop, then the method FrameworkTaskImpl.cancel() may be used to stop the task from further execution (calls of this FrameworkTaskImpl.runThisFrameworkTask() beyond the current one.

Specified by:
runThisFrameworkTask in class StructureBuildingCodeletImpl

retrieveWorkspaceContent

public NodeStructure retrieveWorkspaceContent(WorkspaceBuffer buffer)
Description copied from interface: Codelet
Returns sought content and related content from specified WorkspaceBuffer.

Parameters:
buffer - the buffer
Returns:
the workspace content

bufferContainsSoughtContent

public boolean bufferContainsSoughtContent(WorkspaceBuffer buffer)
Description copied from interface: Codelet
Returns true if specified WorkspaceBuffer contains this codelet's sought content.

Parameters:
buffer - the WorkspaceBuffer to be checked for content
Returns:
true, if successful