Codelet (cst 1.2.0 API)

java.lang.Object
- br.unicamp.cst.core.entities.Codelet

All Implemented Interfaces:

MemoryObserver, java.lang.Runnable

Direct Known Subclasses:

ActionSelectionCodelet, Actuator, AffordanceExtractorCodelet, AppraisalCodelet, Behavior, BehaviorsWTA, CountCodelet, EmotionalCodelet, GoalCodelet, LearnerCodelet, MoodCodelet, MotivationalCodelet, Perception, Sensor, SequenceBuilderCodelet, SingleThreadBHCodelet, SpotlightBroadcastController
```
public abstract class Codelet
extends java.lang.Object
implements java.lang.Runnable, MemoryObserver
```
The Codelet class, together with the MemoryObject class and the Mind class is one of the most important classes in the CST toolkit. According to the Baars-Franklin architecture, consciousness is the emergence of a serial stream on top of a parallel set of interacting devices. In the Baars-Franklin architectures, such devices are called "codelets", which are small pieces of code specialized in performing simple tasks. In a CST-built cognitive architecture, everything is either a Codelet or a MemoryObject. Codelets are used to implement every kind of processing in the architecture. Codelets have two kinds of inputs: standard inputs and broadcast inputs. Standard inputs are used to convey access to MemoryObjects. Broadcast inputs come from consciousness, and can also be used. Nevertheless, Standard inputs are usually fixed (but can be changed through learning mechanisms), and Broadcast inputs change all the time, due to the consciousness mechanism. Codelets also have outputs. Outputs are used for the Codelets to write or generate new MemoryObjects. Codelets also have an Activation level, which can be used in some situations.

See Also:

Memory, Mind, Runnable

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`activation` Activation level of the Codelet.
`protected java.util.List<Memory>`	`broadcast` Input memories, the ones that were broadcasted.
`protected java.util.List<Memory>`	`inputs` Input memories, the ones that are read.
`protected boolean`	`isMemoryObserver` defines if codelet is a memory observer (runs when memory input changes)
`java.util.concurrent.locks.Lock`	`lock` This variable is a safe lock for multithread access
`protected boolean`	`loop` defines if proc() should be automatically called in a loop
`protected java.lang.String`	`name` Gives this codelet a name, mainly for debugging purposes
`protected java.util.List<Memory>`	`outputs` Output memories, the ones that are written.
`protected double`	`threshold` Threshold of the codelet, which is used to decide if it runs or not.
`protected long`	`timeStep` If the proc() method is set to be called automatically in a loop, this variable stores the time step for such a loop.

Constructor Summary

Constructors
Constructor and Description

Codelet()

Constructors
Constructor and Description
`Codelet()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`accessMemoryObjects()` This method is used in every Codelet to capture input, broadcast and output MemoryObjects which shall be used in the proc() method.
`void`	`addBroadcast(Memory b)` Adds a memory to the broadcast list.
`void`	`addBroadcasts(java.util.List<Memory> broadcast)` Adds a list of memories to the broadcast input list.
`void`	`addInput(Memory input)` Add one memory to the input list.
`void`	`addInputs(java.util.List<Memory> inputs)` Add a list of memories to the input list.
`void`	`addOutput(Memory output)` Add a memory to the output list.
`void`	`addOutputs(java.util.List<Memory> outputs)` Adds a list of memories to the output list.
`abstract void`	`calculateActivation()` This abstract method must be implemented by the user.
`double`	`getActivation()` Gets this Codelet activation.
`java.util.List<Memory>`	`getBroadcast()` Gets the list of broadcast memories.
`Memory`	`getBroadcast(java.lang.String name)` Returns a specific memory (with the given name) from the broadcast list of the Codelet.
`Memory`	`getBroadcast(java.lang.String type, int index)` Return a memory if its name is found at the broadcast list ...
`boolean`	`getEnabled()` Gets the enable status.
`Memory`	`getInput(java.lang.String name)` Gets a certain memory from the input list by its name.
`Memory`	`getInput(java.lang.String type, int index)` This method returns an input memory from its input list.
`java.util.List<Memory>`	`getInputs()` Gets the input memories list.
`java.util.ArrayList<Memory>`	`getInputsOfType(java.lang.String type)` Gets a list of input memories of a certain type.
`java.lang.String`	`getName()` Gets this Codelet name.
`Memory`	`getOutput(java.lang.String name)` Gets a Memory from the output list by its name.
`Memory`	`getOutput(java.lang.String type, int index)` This method returns an output memory from its output list.
`java.util.List<Memory>`	`getOutputs()` Gets the list of output memories.
`java.util.ArrayList<Memory>`	`getOutputsOfType(java.lang.String type)` Gets a list of output memories of a certain type.
`java.lang.String`	`getThreadName()` Gets the Codelet's Java Thread name, for debugging purposes.
`double`	`getThreshold()` Gets the Codelet's threshold.
`long`	`getTimeStep()` Gets the Codelet' s timestep.
`boolean`	`impendingAccess(Codelet accesing)` Safe access to other Codelets through reentrant locks.
`boolean`	`impendingAccessBuffer(MemoryBuffer accesing)` Safe access to MemoryBuffers through reentrant locks
`boolean`	`isLoop()` Gets if this Codelet is looping.
`boolean`	`isProfiling()` Gets if this Codelet is profiling.
`void`	`notifyCodelet()` runs when codelet is a memory observer and memory input changes
`abstract void`	`proc()` Main Codelet function, to be implemented in each subclass.
`void`	`removeFromInput(java.util.List<Memory> inputs)` Removes a given list of memories from the input list.
`void`	`removeFromOutput(java.util.List<Memory> outputs)` Removes a given memory list from the output list.
`void`	`removesInput(Memory input)` Removes a given memory from the input list.
`void`	`removesOutput(Memory output)` Removes a given memory from the output list.
`void`	`run()` When first activated, the thread containing this codelet runs the proc() method
`void`	`setActivation(double activation)` Sets this codelet's activation.
`void`	`setBroadcast(java.util.List<Memory> broadcast)` Sets the list of broadcast memories.
`void`	`setCodeletProfiler(java.lang.String filePath, java.lang.String fileName, java.lang.String mindIdentifier, java.lang.Integer queueSize, java.lang.Long intervalTimeMillis, CodeletsProfiler.FileFormat fileFormat)` Sets Codelet Profiler
`void`	`setEnabled(boolean status)` Set the enable status.
`void`	`setInputs(java.util.List<Memory> inputs)` Sets the input memories list.
`void`	`setIsMemoryObserver(boolean isMemoryObserver)` Sets this Codelet to be a memory observer.
`void`	`setLoop(boolean loop)` Sets this Codelet to loop.
`void`	`setName(java.lang.String name)` Sets this Codelet name.
`void`	`setOutputs(java.util.List<Memory> outputs)` Sets the list of output memories.
`void`	`setProfiling(boolean isProfiling)` Sets if this Codelet is profiling.
`void`	`setThreshold(double threshold)` Sets the Codelet's threshold.
`void`	`setTimeStep(long timeStep)` Sets the Codelet's timestep.
`boolean`	`shouldLoop()` Gets if this Codelet is looping.
`void`	`start()` Starts this codelet execution.
`void`	`stop()` Tells this codelet to stop looping (stops running)
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - activation
```
protected double activation
```
    Activation level of the Codelet. Ranges from 0.0 to 1.0d.
  - threshold
```
protected double threshold
```
    Threshold of the codelet, which is used to decide if it runs or not. If activation is equal or greater than activation, codelet runs proc().Ranges from 0.0 to 1.0d.
  - inputs
```
protected java.util.List<Memory> inputs
```
    Input memories, the ones that are read.
  - outputs
```
protected java.util.List<Memory> outputs
```
    Output memories, the ones that are written.
  - broadcast
```
protected java.util.List<Memory> broadcast
```
    Input memories, the ones that were broadcasted.
  - loop
```
protected boolean loop
```
    defines if proc() should be automatically called in a loop
  - isMemoryObserver
```
protected boolean isMemoryObserver
```
    defines if codelet is a memory observer (runs when memory input changes)
  - timeStep
```
protected long timeStep
```
    If the proc() method is set to be called automatically in a loop, this variable stores the time step for such a loop. A timeStep of value 0 means that the proc() method should be called continuously, without interval.
  - name
```
protected java.lang.String name
```
    Gives this codelet a name, mainly for debugging purposes
  - lock
```
public java.util.concurrent.locks.Lock lock
```
    This variable is a safe lock for multithread access
- Constructor Detail
  - Codelet
```
public Codelet()
```
- Method Detail
  - accessMemoryObjects
```
public abstract void accessMemoryObjects()
```
    This method is used in every Codelet to capture input, broadcast and output MemoryObjects which shall be used in the proc() method. This abstract method must be implemented by the user. Here, the user must get the inputs and outputs it needs to perform proc.
  - calculateActivation
```
public abstract void calculateActivation()
```
    This abstract method must be implemented by the user. Here, the user must calculate the activation of the codelet before it does what it is supposed to do in proc();
  - proc
```
public abstract void proc()
```
    Main Codelet function, to be implemented in each subclass.
  - run
```
public void run()
```
    When first activated, the thread containing this codelet runs the proc() method
    
    Specified by:
    
    run in interface java.lang.Runnable
  - start
```
public void start()
```
    Starts this codelet execution.
  - stop
```
public void stop()
```
    Tells this codelet to stop looping (stops running)
  - impendingAccess
```
public boolean impendingAccess(Codelet accesing)
```
    Safe access to other Codelets through reentrant locks.
    
    Parameters:
    
    accesing - the Codelet accessing.
    
    Returns:
    
    true if is impeding access.
  - impendingAccessBuffer
```
public boolean impendingAccessBuffer(MemoryBuffer accesing)
```
    Safe access to MemoryBuffers through reentrant locks
    
    Parameters:
    
    accesing - the Memory Buffer accessing.
    
    Returns:
    
    true if is impending Access.
  - shouldLoop
```
public boolean shouldLoop()
```
    Gets if this Codelet is looping.
    
    Returns:
    
    the loop
  - setLoop
```
public void setLoop(boolean loop)
```
    Sets this Codelet to loop.
    
    Parameters:
    
    loop - the loop to set
  - getEnabled
```
public boolean getEnabled()
```
    Gets the enable status.
    
    Returns:
    
    the enable state.
  - setEnabled
```
public void setEnabled(boolean status)
```
    Set the enable status.
    
    Parameters:
    
    status - the new enable status
  - getName
```
public java.lang.String getName()
```
    Gets this Codelet name.
    
    Returns:
    
    the name.
  - setName
```
public void setName(java.lang.String name)
```
    Sets this Codelet name.
    
    Parameters:
    
    name - the name to set
  - isLoop
```
public boolean isLoop()
```
    Gets if this Codelet is looping.
    
    Returns:
    
    the loop
  - getActivation
```
public double getActivation()
```
    Gets this Codelet activation.
    
    Returns:
    
    the activation
  - setActivation
```
public void setActivation(double activation)
                   throws CodeletActivationBoundsException
```
    Sets this codelet's activation.
    
    Parameters:
    
    activation - the activation to set
    
    Throws:
    
    CodeletActivationBoundsException - exception triggered if an activation lower than 0 or bigger than 1 is set
  - getInputs
```
public java.util.List<Memory> getInputs()
```
    Gets the input memories list.
    
    Returns:
    
    the inputs.
  - setInputs
```
public void setInputs(java.util.List<Memory> inputs)
```
    Sets the input memories list.
    
    Parameters:
    
    inputs - the inputs to set.
  - addInput
```
public void addInput(Memory input)
```
    Add one memory to the input list.
    
    Parameters:
    
    input - one input to set.
  - addInputs
```
public void addInputs(java.util.List<Memory> inputs)
```
    Add a list of memories to the input list.
    
    Parameters:
    
    inputs - a list of inputs.
  - addOutput
```
public void addOutput(Memory output)
```
    Add a memory to the output list.
    
    Parameters:
    
    output - one output to set.
  - removesOutput
```
public void removesOutput(Memory output)
```
    Removes a given memory from the output list.
    
    Parameters:
    
    output - the memory to be removed from output.
  - removesInput
```
public void removesInput(Memory input)
```
    Removes a given memory from the input list.
    
    Parameters:
    
    input - the memory to be removed from input.
  - removeFromOutput
```
public void removeFromOutput(java.util.List<Memory> outputs)
```
    Removes a given memory list from the output list.
    
    Parameters:
    
    outputs - the list of memories to be removed from output.
  - removeFromInput
```
public void removeFromInput(java.util.List<Memory> inputs)
```
    Removes a given list of memories from the input list.
    
    Parameters:
    
    inputs - the list of memories to be removed from input.
  - addOutputs
```
public void addOutputs(java.util.List<Memory> outputs)
```
    Adds a list of memories to the output list.
    
    Parameters:
    
    outputs - the list of memories to be added to the output.
  - getOutputs
```
public java.util.List<Memory> getOutputs()
```
    Gets the list of output memories.
    
    Returns:
    
    the outputs.
  - getOutputsOfType
```
public java.util.ArrayList<Memory> getOutputsOfType(java.lang.String type)
```
    Gets a list of output memories of a certain type.
    
    Parameters:
    
    type - the type of memories to be fetched from the output.
    
    Returns:
    
    the list of all memory objects in output of a given type.
  - getInputsOfType
```
public java.util.ArrayList<Memory> getInputsOfType(java.lang.String type)
```
    Gets a list of input memories of a certain type.
    
    Parameters:
    
    type - the type of memories to be retrieved.
    
    Returns:
    
    the list of memory objects in input of a given type.
  - setOutputs
```
public void setOutputs(java.util.List<Memory> outputs)
```
    Sets the list of output memories.
    
    Parameters:
    
    outputs - the outputs to set.
  - getBroadcast
```
public java.util.List<Memory> getBroadcast()
```
    Gets the list of broadcast memories.
    
    Returns:
    
    the broadcast.
  - setBroadcast
```
public void setBroadcast(java.util.List<Memory> broadcast)
```
    Sets the list of broadcast memories.
    
    Parameters:
    
    broadcast - the broadcast to set.
  - getBroadcast
```
public Memory getBroadcast(java.lang.String name)
```
    Returns a specific memory (with the given name) from the broadcast list of the Codelet.
    
    Parameters:
    
    name - the name of a memory to be retrieved at the broadcast list.
    
    Returns:
    
    the list of memories in the broadcast list.
  - addBroadcast
```
public void addBroadcast(Memory b)
```
    Adds a memory to the broadcast list.
    
    Parameters:
    
    b - one broadcast input to set.
  - addBroadcasts
```
public void addBroadcasts(java.util.List<Memory> broadcast)
```
    Adds a list of memories to the broadcast input list.
    
    Parameters:
    
    broadcast - one input to set.
  - getThreadName
```
public java.lang.String getThreadName()
```
    Gets the Codelet's Java Thread name, for debugging purposes.
    
    Returns:
    
    The name of the thread running this Codelet.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getInput
```
public Memory getInput(java.lang.String type,
                       int index)
```
    This method returns an input memory from its input list. If it couldn't find the given M, it sets this codelet as not able to perform proc(), and keeps trying to find it.
    
    Parameters:
    
    type - type of memory it needs.
    
    index - position of memory in the sublist.
    
    Returns:
    
    memory of type at position.
  - getInput
```
public Memory getInput(java.lang.String name)
```
    Gets a certain memory from the input list by its name.
    
    Parameters:
    
    name - the name of the memory being searched.
    
    Returns:
    
    the memory searched by name or null if not found.
  - getOutput
```
public Memory getOutput(java.lang.String type,
                        int index)
```
    This method returns an output memory from its output list. If it couldn't find the given M, it sets this codelet as not able to perform proc(), and keeps trying to find it.
    
    Parameters:
    
    type - type of memory it needs.
    
    index - position of memory in the sublist.
    
    Returns:
    
    memory of type at position.
  - getOutput
```
public Memory getOutput(java.lang.String name)
```
    Gets a Memory from the output list by its name.
    
    Parameters:
    
    name - the name of the memory.
    
    Returns:
    
    the memory with the name searched or null if not found.
  - getBroadcast
```
public Memory getBroadcast(java.lang.String type,
                           int index)
```
    Return a memory if its name is found at the broadcast list ... if more than one memory with the same name, it return the one at the index position.
    
    Parameters:
    
    type - the name of the memory to be retrieved in the broadcast list.
    
    index - the index to be considered while multiple equal names are found within the broadcast list.
    
    Returns:
    
    the memory.
  - getThreshold
```
public double getThreshold()
```
    Gets the Codelet's threshold.
    
    Returns:
    
    the threshold.
  - setThreshold
```
public void setThreshold(double threshold)
                  throws CodeletThresholdBoundsException
```
    Sets the Codelet's threshold.
    
    Parameters:
    
    threshold - the threshold to be set.
    
    Throws:
    
    CodeletThresholdBoundsException - the exception thrown if the threshold value is less than zero or greater than 1.
  - getTimeStep
```
public long getTimeStep()
```
    Gets the Codelet' s timestep.
    
    Returns:
    
    the timeStep.
  - setTimeStep
```
public void setTimeStep(long timeStep)
```
    Sets the Codelet's timestep.
    
    Parameters:
    
    timeStep - the timeStep to set.
  - isProfiling
```
public boolean isProfiling()
```
    Gets if this Codelet is profiling.
    
    Returns:
    
    the isProfiling.
  - setProfiling
```
public void setProfiling(boolean isProfiling)
```
    Sets if this Codelet is profiling.
    
    Parameters:
    
    isProfiling - the isProfiling to set
  - setIsMemoryObserver
```
public void setIsMemoryObserver(boolean isMemoryObserver)
```
    Sets this Codelet to be a memory observer.
    
    Parameters:
    
    isMemoryObserver - the isMemoryObserver to set
  - setCodeletProfiler
```
public void setCodeletProfiler(java.lang.String filePath,
                               java.lang.String fileName,
                               java.lang.String mindIdentifier,
                               java.lang.Integer queueSize,
                               java.lang.Long intervalTimeMillis,
                               CodeletsProfiler.FileFormat fileFormat)
```
    Sets Codelet Profiler
    
    Parameters:
    
    filePath - path to create file
    
    fileName - name file
    
    mindIdentifier - mind identifier in file
    
    queueSize - max queue size which a write in file must be done
    
    intervalTimeMillis - max interval in millis which a write in file must be done
    
    fileFormat - desired file format CSV or JSON
  - notifyCodelet
```
public void notifyCodelet()
```
    runs when codelet is a memory observer and memory input changes
    
    Specified by:
    
    notifyCodelet in interface MemoryObserver

Class Codelet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

activation

threshold

inputs

outputs

broadcast

loop

isMemoryObserver

timeStep

name

lock

Constructor Detail

Codelet

Method Detail

accessMemoryObjects

calculateActivation

proc

run

start

stop

impendingAccess

impendingAccessBuffer

shouldLoop

setLoop

getEnabled

setEnabled

getName

setName

isLoop

getActivation

setActivation

getInputs

setInputs

addInput

addInputs

addOutput

removesOutput

removesInput

removeFromOutput

removeFromInput

addOutputs

getOutputs

getOutputsOfType

getInputsOfType

setOutputs

getBroadcast

setBroadcast

getBroadcast

addBroadcast

addBroadcasts

getThreadName

toString

getInput

getInput

getOutput

getOutput

getBroadcast

getThreshold

setThreshold

getTimeStep

setTimeStep

isProfiling

setProfiling

setIsMemoryObserver

setCodeletProfiler

notifyCodelet