clarion.system
Class ExternalAction

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap<K,V>
          extended by java.util.LinkedHashMap<java.lang.Object,Dimension>
              extended by clarion.system.DimensionValueCollection
                  extended by clarion.system.AbstractChunk
                      extended by clarion.system.AbstractOutputChunk
                          extended by clarion.system.AbstractAction
                              extended by clarion.system.ExternalAction
All Implemented Interfaces:
InterfaceStochasticallySelectable, InterfaceTracksTime, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,Dimension>

public class ExternalAction
extends AbstractAction

This class implements an external action within CLARION. It extends the AbstractAction class.

Usage:

An external action is an action that is performed externally. External actions are delivered to a task environment (or a module outside of the CLARION Library that acts as a another part of the agent's body) that is capable of implementing the action's directives.

An action chunk is attached to the output layer of the bottom level implicit modules in the ACS as well as to rules on the top level. Actions are not required to have dimension-value pairs, but it is advised they be provided as they act as the "instructions" that dictate how an action is to be performed.

Activated values within the action chunk indicate the parts of the action that should be performed. Non-activated values in the action chunk are used to specify those components that should NOT be performed. Therefore, both activation and non-activation of values provide important information for how to handle the action.

Version:
6.0.4
Author:
Nick Wilson
See Also:
Serialized Form

Field Summary
private  int hash
          The hash for this object.
private static long serialVersionUID
           
 
Fields inherited from class clarion.system.AbstractOutputChunk
C, D, FULL_ACTIVATION_LEVEL, GLOBAL_C, GLOBAL_D, GLOBAL_FULL_ACTIVATION_LEVEL, GLOBAL_INITIAL_BLA, GLOBAL_MINIMUM_ACTIVATION_THRESHOLD, GLOBAL_PERSISTENCE, INITIAL_BLA, MINIMUM_ACTIVATION_THRESHOLD, PERSISTENCE
 
Constructor Summary
ExternalAction(java.lang.Object id)
          Initializes the external action with the ID specified.
ExternalAction(java.lang.Object id, java.util.Collection<? extends Dimension> dims)
          Initializes the external action with the specified ID and dimensions.
ExternalAction(java.lang.Object id, java.util.Map<? extends java.lang.Object,? extends Dimension> dims)
          Initializes the external action with the specified ID and map of dimensions.
 
Method Summary
 ExternalAction clone()
          Clones the external action (including all of it's dimensions).
 int hashCode()
           
 
Methods inherited from class clarion.system.AbstractAction
put, putAll
 
Methods inherited from class clarion.system.AbstractOutputChunk
addTimeStamp, adjustSelectionMeasure, getActivation, getBLA, getBLSelectionMeasure, getFinalSelectionMeasure, getTLSelectionMeasure, resetActivation, setActivation, setBLSelectionMeasure, setFinalSelectionMeasure, setTLSelectionMeasure
 
Methods inherited from class clarion.system.AbstractChunk
equals, equalsID, getID, toString
 
Methods inherited from class clarion.system.DimensionValueCollection
containsKeys, getNumDVPairs, getValueCollection, size
 
Methods inherited from class java.util.LinkedHashMap
clear, containsValue, get, removeEldestEntry
 
Methods inherited from class java.util.HashMap
containsKey, entrySet, isEmpty, keySet, remove, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
containsKey, entrySet, isEmpty, keySet, remove, values
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

hash

private int hash
The hash for this object. When this item is cloned, so is this hash.

Constructor Detail

ExternalAction

public ExternalAction(java.lang.Object id)
Initializes the external action with the ID specified.

Parameters:
id - The ID of the external action.

ExternalAction

public ExternalAction(java.lang.Object id,
                      java.util.Collection<? extends Dimension> dims)
Initializes the external action with the specified ID and dimensions.

Parameters:
id - The ID of the external action.
dims - The dimensions for the external action.

ExternalAction

public ExternalAction(java.lang.Object id,
                      java.util.Map<? extends java.lang.Object,? extends Dimension> dims)
Initializes the external action with the specified ID and map of dimensions.

Parameters:
id - The ID of the external action.
dims - The map of dimensions for the external action.
Method Detail

hashCode

public int hashCode()
Specified by:
hashCode in interface java.util.Map<java.lang.Object,Dimension>
Overrides:
hashCode in class DimensionValueCollection

clone

public ExternalAction clone()
Clones the external action (including all of it's dimensions).

Specified by:
clone in class AbstractAction
Returns:
A copy of the external action.