edu.memphis.ccrg.lida.framework.shared.activation
Interface Activatible

All Superinterfaces:
Initializable
All Known Subinterfaces:
AttentionCodelet, Behavior, Coalition, Codelet, Condition, DetectionAlgorithm, FrameworkTask, Learnable, Link, Linkable, Node, PamLink, PamLinkable, PamNode, ProceduralUnit, RootableNode, Scheme, StructureBuildingCodelet
All Known Implementing Classes:
ActivatibleImpl, AddLinkToPerceptTask, AddNodeStructureToPerceptTask, AddNodeToPerceptTask, AttentionCodeletImpl, BasicAttentionCodelet, BasicDetectionAlgorithm, BasicStructureBuildingCodelet, BehaviorImpl, CoalitionImpl, CodeletImpl, CueBackgroundTask, DefaultAttentionCodelet, ExcitationTask, FrameworkTaskImpl, LearnableImpl, LinkImpl, MultipleDetectionAlgorithm, NeighborhoodAttentionCodelet, NodeImpl, PamLinkImpl, PamNodeImpl, PropagationTask, RootableNodeImpl, SchemeImpl, SensoryMemoryBackgroundTask, StructureBuildingCodeletImpl, TriggerTask, UpdateCsmBackgroundTask

public interface Activatible
extends Initializable

An object with activation, has strategies to both excite and decay this activation

Author:
Ryan J. McCall

Field Summary
static double DEFAULT_ACTIVATIBLE_REMOVAL_THRESHOLD
          Default removal threshold for Activatible
static double DEFAULT_ACTIVATION
          Default activation for Activatible
 
Method Summary
 void decay(long ticks)
          decay the current activation using the decay strategy.
 void excite(double amount)
          The current activation of this node is increased using the excitation value as a parameter for the ExciteStrategy
 double getActivatibleRemovalThreshold()
          Gets activatibleRemovalThreshold
 double getActivation()
          Returns the current activation of this activatible
 DecayStrategy getDecayStrategy()
          Gets the decay strategy
 ExciteStrategy getExciteStrategy()
          Gets the excite strategy
 double getTotalActivation()
          Returns the total activation of this activatible
 boolean isRemovable()
          Returns true if this Activatible is removable
 void setActivatibleRemovalThreshold(double threshold)
          Sets activatibleRemovalThreshold
 void setActivation(double activation)
          Set the current activation.
 void setDecayStrategy(DecayStrategy strategy)
          Sets the decay strategy
 void setExciteStrategy(ExciteStrategy strategy)
          Sets the excite strategy
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.initialization.Initializable
containsParameter, getParam, getParameters, init, init
 

Field Detail

DEFAULT_ACTIVATIBLE_REMOVAL_THRESHOLD

static final double DEFAULT_ACTIVATIBLE_REMOVAL_THRESHOLD
Default removal threshold for Activatible

See Also:
Constant Field Values

DEFAULT_ACTIVATION

static final double DEFAULT_ACTIVATION
Default activation for Activatible

See Also:
Constant Field Values
Method Detail

getActivation

double getActivation()
Returns the current activation of this activatible

Returns:
the current activation.

setActivation

void setActivation(double activation)
Set the current activation. Used for initialization, not during regular execution, use excite instead.

Parameters:
activation - new activation

getTotalActivation

double getTotalActivation()
Returns the total activation of this activatible

Returns:
The total activation. It should return the current activation if no base activation is used.

excite

void excite(double amount)
The current activation of this node is increased using the excitation value as a parameter for the ExciteStrategy

Parameters:
amount - the value to be used to increase the current activation of this node

setExciteStrategy

void setExciteStrategy(ExciteStrategy strategy)
Sets the excite strategy

Parameters:
strategy - the Excite strategy for the current activation.

getExciteStrategy

ExciteStrategy getExciteStrategy()
Gets the excite strategy

Returns:
the excite strategy

decay

void decay(long ticks)
decay the current activation using the decay strategy. The decay depends on the time since the last decaying. It is indicated by the parameter ticks.

Parameters:
ticks - the number of ticks to decay

setDecayStrategy

void setDecayStrategy(DecayStrategy strategy)
Sets the decay strategy

Parameters:
strategy - the decay strategy for the current activation.

getDecayStrategy

DecayStrategy getDecayStrategy()
Gets the decay strategy

Returns:
the decay strategy.

setActivatibleRemovalThreshold

void setActivatibleRemovalThreshold(double threshold)
Sets activatibleRemovalThreshold

Parameters:
threshold - threshold for removal of this activatible

getActivatibleRemovalThreshold

double getActivatibleRemovalThreshold()
Gets activatibleRemovalThreshold

Returns:
threshold for removal of this activatible

isRemovable

boolean isRemovable()
Returns true if this Activatible is removable

Returns:
true if activation is less than activatibleRemovalThreshold