DefaultProceduralModule6

java.lang.Object
- org.jactr.core.utils.DefaultAdaptable
- - org.jactr.core.module.AbstractModule
  - - org.jactr.core.module.procedural.six.DefaultProceduralModule6

All Implemented Interfaces:

IModule, IProceduralModule, IProceduralModule6, IAdaptable, IInitializable, IInstallable, IParameterized

Direct Known Subclasses:

DefaultThreadedProceduralModule6
```
public class DefaultProceduralModule6
extends AbstractModule
implements IProceduralModule6, IParameterized
```
default procedural module. It provides extensibility by using IProductionInstantiator, IProductionSelector, and IConflictSetAssembler strict harvesting is implemented by addProductionInternal(IProduction). The IProduction's IConditions are checked. If they are IBufferCondition, it checks to see if IActivationBuffer.isStrictHarvestingEnabled() and if so, ensures that there is an IBufferAction for that buffer as well, if not, an RemoveAction is added (and therefore the production explicitly removes the chunk).

Author:

harrison

See Also:

http://jactr.org/node/132

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,IProduction>`	`_allProductionsByName`
`protected boolean`	`_breakExpectedUtilityTiesRandomly`
`protected ProductionUtilityComparator`	`_comparator`
`protected double`	`_expectedUtilityNoise`
`protected double`	`_productionFiringTime`
`protected long`	`_productionsFired`
`protected IRandomModule`	`_randomModule`
`protected java.util.concurrent.locks.ReentrantReadWriteLock`	`_readWriteLock`
`static java.lang.String`	`ENABLE_PARALLEL_INSTANTIATIONS_PARAM`
`static org.apache.commons.logging.Log`	`LOGGER` logger definition

Fields inherited from interface org.jactr.core.module.procedural.six.IProceduralModule6
EXPECTED_UTILITY_NOISE

Fields inherited from interface org.jactr.core.module.procedural.IProceduralModule
DEFAULT_PRODUCTION_FIRING_TIME, NUMBER_OF_PRODUCTIONS_FIRED

Constructor Summary

Constructors
Constructor and Description

DefaultProceduralModule6()

Constructors
Constructor and Description
`DefaultProceduralModule6()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(IProceduralModuleListener listener, java.util.concurrent.Executor executor)`
`java.util.concurrent.CompletableFuture<IProduction>`	`addProduction(IProduction production)` add this production to procedural memory and check for duplicates
`protected IProduction`	`addProductionInternal(IProduction production)`
`protected java.util.Collection<IInstantiation>`	`createAndSortInstantiations(java.util.Collection<IProduction> productions)` iterates over productions, attempting to instantiate each.
`java.util.concurrent.CompletableFuture<IProduction>`	`createProduction(java.lang.String name)` create a production, likely backed by the factory
`protected IProduction`	`createProductionInternal(java.lang.String name)`
`void`	`dispose()` release any resources.
`protected void`	`fireConflictSetAssembled(java.util.Collection<IInstantiation> instances)`
`java.util.concurrent.CompletableFuture<java.lang.Double>`	`fireProduction(IInstantiation instantiation, double firingTime)` actually executed the production returning the amount of time it took to fire this production and fire notification events.
`protected void`	`fireProductionAdded(IProduction production)`
`protected void`	`fireProductionCreated(IProduction production)`
`protected void`	`fireProductionFired(IInstantiation instantiation)`
`protected java.lang.Double`	`fireProductionInternal(IInstantiation instantiation, double firingTime)`
`protected void`	`fireProductionsMerged(IProduction original, IProduction duplicate)`
`protected void`	`fireProductionWillFire(IInstantiation instantiation)`
`java.util.concurrent.CompletableFuture<java.util.Collection<IInstantiation>>`	`getConflictSet(java.util.Collection<IActivationBuffer> buffers)` find the set of production instantiations that can fire based on the state of the buffers and fire the notification events
`IConflictSetAssembler`	`getConflictSetAssembler()`
`protected java.util.Collection<IInstantiation>`	`getConflictSetInternal(java.util.Collection<IActivationBuffer> buffers)`
`double`	`getDefaultProductionFiringTime()` the default production firing time, aka default action time
`double`	`getExpectedUtilityNoise()`
`long`	`getNumberOfProductionsFired()`
`java.lang.String`	`getParameter(java.lang.String key)` return parameter value - null if not defined.
`java.util.Collection<java.lang.String>`	`getPossibleParameters()` Return all parameters that can be read
`java.util.concurrent.CompletableFuture<IProduction>`	`getProduction(java.lang.String name)` return the named production
`IProductionInstantiator`	`getProductionInstantiator()`
`protected IProduction`	`getProductionInternal(java.lang.String name)`
`java.util.concurrent.CompletableFuture<java.util.Collection<IProduction>>`	`getProductions()` return all the productions
`IProductionSelector`	`getProductionSelector()`
`protected java.util.Collection<IProduction>`	`getProductionsInternal()`
`java.util.Collection<java.lang.String>`	`getSetableParameters()` Return list of all parameters that can be set.
`void`	`initialize()` this will be called after all the modules have been installed permitting the module to attach listeners to other modules.
`boolean`	`isParallelInstantiationsEnabled()`
`void`	`removeListener(IProceduralModuleListener listener)`
`java.util.concurrent.Future<IProduction>`	`removeProduction(IProduction production)`
`protected IProduction`	`removeProductionInternal(IProduction production)`
`void`	`reset()` reset the module.
`java.util.concurrent.CompletableFuture<IInstantiation>`	`selectInstantiation(java.util.Collection<IInstantiation> instantiations)`
`protected IInstantiation`	`selectInstantiationInternal(java.util.Collection<IInstantiation> instantiations)`
`void`	`setConflictSetAssembler(IConflictSetAssembler assembler)`
`void`	`setDefaultProductionFiringTime(double firingTime)`
`void`	`setExpectedUtilityNoise(double noise)`
`void`	`setNumberOfProductionsFired(long fired)`
`void`	`setParallelInstantiationsEnabled(boolean enable)`
`void`	`setParameter(java.lang.String key, java.lang.String value)` Set the named parameter
`void`	`setProductionInstantiator(IProductionInstantiator instantiator)`
`void`	`setProductionSelector(IProductionSelector selector)`

Methods inherited from class org.jactr.core.module.AbstractModule
createBuffers, delayedFuture, delayedFuture, getExecutor, getModel, getName, getSafeName, immediateFuture, immediateReturn, install, setExecutor, uninstall

Methods inherited from class org.jactr.core.utils.DefaultAdaptable
addAdapterFactory, getAdapter, removeAdapterFactory

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

Methods inherited from interface org.jactr.core.module.IModule
getModel, getName, install

Methods inherited from interface org.jactr.core.utils.IInstallable
uninstall

Methods inherited from interface org.jactr.core.utils.IAdaptable
getAdapter

- Field Detail
  - LOGGER
```
public static final org.apache.commons.logging.Log LOGGER
```
    logger definition
  - _allProductionsByName
```
protected java.util.Map<java.lang.String,IProduction> _allProductionsByName
```
  - _readWriteLock
```
protected java.util.concurrent.locks.ReentrantReadWriteLock _readWriteLock
```
  - _productionFiringTime
```
protected double _productionFiringTime
```
  - _productionsFired
```
protected long _productionsFired
```
  - _breakExpectedUtilityTiesRandomly
```
protected boolean _breakExpectedUtilityTiesRandomly
```
  - _expectedUtilityNoise
```
protected double _expectedUtilityNoise
```
  - _comparator
```
protected ProductionUtilityComparator _comparator
```
  - _randomModule
```
protected IRandomModule _randomModule
```
  - ENABLE_PARALLEL_INSTANTIATIONS_PARAM
```
public static final java.lang.String ENABLE_PARALLEL_INSTANTIATIONS_PARAM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DefaultProceduralModule6
```
public DefaultProceduralModule6()
```
- Method Detail
  - setProductionSelector
```
public void setProductionSelector(IProductionSelector selector)
```
    Specified by:
    
    setProductionSelector in interface IProceduralModule
  - getProductionSelector
```
public IProductionSelector getProductionSelector()
```
    Specified by:
    
    getProductionSelector in interface IProceduralModule
  - setProductionInstantiator
```
public void setProductionInstantiator(IProductionInstantiator instantiator)
```
    Specified by:
    
    setProductionInstantiator in interface IProceduralModule
  - getProductionInstantiator
```
public IProductionInstantiator getProductionInstantiator()
```
    Specified by:
    
    getProductionInstantiator in interface IProceduralModule
  - setConflictSetAssembler
```
public void setConflictSetAssembler(IConflictSetAssembler assembler)
```
    Specified by:
    
    setConflictSetAssembler in interface IProceduralModule
  - getConflictSetAssembler
```
public IConflictSetAssembler getConflictSetAssembler()
```
    Specified by:
    
    getConflictSetAssembler in interface IProceduralModule
  - addListener
```
public void addListener(IProceduralModuleListener listener,
                        java.util.concurrent.Executor executor)
```
    Specified by:
    
    addListener in interface IProceduralModule
  - removeListener
```
public void removeListener(IProceduralModuleListener listener)
```
    Specified by:
    
    removeListener in interface IProceduralModule
  - dispose
```
public void dispose()
```
    Description copied from interface: IModule
    
    release any resources. this should only be called by the model during its own dispose method (assuming that this module is still installed) and should not result in the propogation of ANY events. The module should dispose of all its resources, including buffers
    
    Specified by:
    
    dispose in interface IModule
    
    Overrides:
    
    dispose in class AbstractModule
  - fireProductionCreated
```
protected void fireProductionCreated(IProduction production)
```
  - fireProductionAdded
```
protected void fireProductionAdded(IProduction production)
```
  - fireProductionWillFire
```
protected void fireProductionWillFire(IInstantiation instantiation)
```
  - fireProductionFired
```
protected void fireProductionFired(IInstantiation instantiation)
```
  - fireProductionsMerged
```
protected void fireProductionsMerged(IProduction original,
                                     IProduction duplicate)
```
  - fireConflictSetAssembled
```
protected void fireConflictSetAssembled(java.util.Collection<IInstantiation> instances)
```
  - setParallelInstantiationsEnabled
```
public void setParallelInstantiationsEnabled(boolean enable)
```
  - isParallelInstantiationsEnabled
```
public boolean isParallelInstantiationsEnabled()
```
  - addProductionInternal
```
protected IProduction addProductionInternal(IProduction production)
```
  - addProduction
```
public java.util.concurrent.CompletableFuture<IProduction> addProduction(IProduction production)
```
    Description copied from interface: IProceduralModule
    
    add this production to procedural memory and check for duplicates
    
    Specified by:
    
    addProduction in interface IProceduralModule
    
    Returns:
  - removeProductionInternal
```
protected IProduction removeProductionInternal(IProduction production)
```
  - removeProduction
```
public java.util.concurrent.Future<IProduction> removeProduction(IProduction production)
```
  - createProductionInternal
```
protected IProduction createProductionInternal(java.lang.String name)
```
  - createProduction
```
public java.util.concurrent.CompletableFuture<IProduction> createProduction(java.lang.String name)
```
    Description copied from interface: IProceduralModule
    
    create a production, likely backed by the factory
    
    Specified by:
    
    createProduction in interface IProceduralModule
    
    Returns:
  - getConflictSetInternal
```
protected java.util.Collection<IInstantiation> getConflictSetInternal(java.util.Collection<IActivationBuffer> buffers)
```
  - createAndSortInstantiations
```
protected java.util.Collection<IInstantiation> createAndSortInstantiations(java.util.Collection<IProduction> productions)
```
    iterates over productions, attempting to instantiate each. Those that can be instantiated will be sorted by utility and returned. If
    
    Parameters:
    
    productions -
    
    Returns:
  - getConflictSet
```
public java.util.concurrent.CompletableFuture<java.util.Collection<IInstantiation>> getConflictSet(java.util.Collection<IActivationBuffer> buffers)
```
    Description copied from interface: IProceduralModule
    
    find the set of production instantiations that can fire based on the state of the buffers and fire the notification events
    
    Specified by:
    
    getConflictSet in interface IProceduralModule
    
    Returns:
  - getProductionInternal
```
protected IProduction getProductionInternal(java.lang.String name)
```
  - getProduction
```
public java.util.concurrent.CompletableFuture<IProduction> getProduction(java.lang.String name)
```
    Description copied from interface: IProceduralModule
    
    return the named production
    
    Specified by:
    
    getProduction in interface IProceduralModule
    
    Returns:
  - selectInstantiationInternal
```
protected IInstantiation selectInstantiationInternal(java.util.Collection<IInstantiation> instantiations)
```
  - selectInstantiation
```
public java.util.concurrent.CompletableFuture<IInstantiation> selectInstantiation(java.util.Collection<IInstantiation> instantiations)
```
    Specified by:
    
    selectInstantiation in interface IProceduralModule
  - fireProductionInternal
```
protected java.lang.Double fireProductionInternal(IInstantiation instantiation,
                                                  double firingTime)
```
  - fireProduction
```
public java.util.concurrent.CompletableFuture<java.lang.Double> fireProduction(IInstantiation instantiation,
                                                                               double firingTime)
```
    Description copied from interface: IProceduralModule
    
    actually executed the production returning the amount of time it took to fire this production and fire notification events. This should catch and ModelTerminatedException and return Double.NaN if it catches it
    
    Specified by:
    
    fireProduction in interface IProceduralModule
    
    firingTime - TODO
    
    Returns:
  - getDefaultProductionFiringTime
```
public double getDefaultProductionFiringTime()
```
    Description copied from interface: IProceduralModule
    
    the default production firing time, aka default action time
    
    Specified by:
    
    getDefaultProductionFiringTime in interface IProceduralModule
    
    Returns:
  - setDefaultProductionFiringTime
```
public void setDefaultProductionFiringTime(double firingTime)
```
    Specified by:
    
    setDefaultProductionFiringTime in interface IProceduralModule
  - initialize
```
public void initialize()
```
    Description copied from interface: IModule
    
    this will be called after all the modules have been installed permitting the module to attach listeners to other modules. if you want to get access to chunks,types, or productions before the model runs, attach a model listener and do that during the modelStarted call
    
    Specified by:
    
    initialize in interface IModule
    
    Specified by:
    
    initialize in interface IInitializable
    
    Specified by:
    
    initialize in class AbstractModule
  - getExpectedUtilityNoise
```
public double getExpectedUtilityNoise()
```
    Specified by:
    
    getExpectedUtilityNoise in interface IProceduralModule6
  - getNumberOfProductionsFired
```
public long getNumberOfProductionsFired()
```
    Specified by:
    
    getNumberOfProductionsFired in interface IProceduralModule
    
    Returns:
  - setExpectedUtilityNoise
```
public void setExpectedUtilityNoise(double noise)
```
    Specified by:
    
    setExpectedUtilityNoise in interface IProceduralModule6
  - setNumberOfProductionsFired
```
public void setNumberOfProductionsFired(long fired)
```
    Specified by:
    
    setNumberOfProductionsFired in interface IProceduralModule
  - getProductionsInternal
```
protected java.util.Collection<IProduction> getProductionsInternal()
```
  - getProductions
```
public java.util.concurrent.CompletableFuture<java.util.Collection<IProduction>> getProductions()
```
    Description copied from interface: IProceduralModule
    
    return all the productions
    
    Specified by:
    
    getProductions in interface IProceduralModule
    
    Returns:
  - getParameter
```
public java.lang.String getParameter(java.lang.String key)
```
    Description copied from interface: IParameterized
    
    return parameter value - null if not defined.
    
    Specified by:
    
    getParameter in interface IParameterized
    
    Parameters:
    
    key - Description of the Parameter
    
    Returns:
    
    The parameter value
    
    See Also:
    
    IParameterized.getParameter(java.lang.String)
  - getPossibleParameters
```
public java.util.Collection<java.lang.String> getPossibleParameters()
```
    Description copied from interface: IParameterized
    
    Return all parameters that can be read
    
    Specified by:
    
    getPossibleParameters in interface IParameterized
    
    Returns:
    
    The possibleParameters value
    
    See Also:
    
    IParameterized.getPossibleParameters()
  - getSetableParameters
```
public java.util.Collection<java.lang.String> getSetableParameters()
```
    Description copied from interface: IParameterized
    
    Return list of all parameters that can be set.
    
    Specified by:
    
    getSetableParameters in interface IParameterized
    
    Returns:
    
    The setableParameters value
    
    See Also:
    
    IParameterized.getSetableParameters()
  - setParameter
```
public void setParameter(java.lang.String key,
                         java.lang.String value)
```
    Description copied from interface: IParameterized
    
    Set the named parameter
    
    Specified by:
    
    setParameter in interface IParameterized
    
    See Also:
    
    IParameterized.setParameter(java.lang.String, java.lang.String)
  - reset
```
public void reset()
```
    Description copied from interface: IModule
    
    reset the module. This will typically clear the owned buffers and abort any module specific operations
    
    Specified by:
    
    reset in interface IModule

Class DefaultProceduralModule6

Field Summary

Fields inherited from interface org.jactr.core.module.procedural.six.IProceduralModule6

Fields inherited from interface org.jactr.core.module.procedural.IProceduralModule

Constructor Summary

Method Summary

Methods inherited from class org.jactr.core.module.AbstractModule

Methods inherited from class org.jactr.core.utils.DefaultAdaptable

Methods inherited from class java.lang.Object

Methods inherited from interface org.jactr.core.module.IModule

Methods inherited from interface org.jactr.core.utils.IInstallable

Methods inherited from interface org.jactr.core.utils.IAdaptable

Field Detail

LOGGER

_allProductionsByName

_readWriteLock

_productionFiringTime

_productionsFired

_breakExpectedUtilityTiesRandomly

_expectedUtilityNoise

_comparator

_randomModule

ENABLE_PARALLEL_INSTANTIATIONS_PARAM

Constructor Detail

DefaultProceduralModule6

Method Detail

setProductionSelector

getProductionSelector

setProductionInstantiator

getProductionInstantiator

setConflictSetAssembler

getConflictSetAssembler

addListener

removeListener

dispose

fireProductionCreated

fireProductionAdded

fireProductionWillFire

fireProductionFired

fireProductionsMerged

fireConflictSetAssembled

setParallelInstantiationsEnabled

isParallelInstantiationsEnabled

addProductionInternal

addProduction

removeProductionInternal

removeProduction

createProductionInternal

createProduction

getConflictSetInternal

createAndSortInstantiations

getConflictSet

getProductionInternal

getProduction

selectInstantiationInternal

selectInstantiation

fireProductionInternal

fireProduction

getDefaultProductionFiringTime

setDefaultProductionFiringTime

initialize

getExpectedUtilityNoise

getNumberOfProductionsFired

setExpectedUtilityNoise

setNumberOfProductionsFired

getProductionsInternal

getProductions

getParameter

getPossibleParameters

getSetableParameters

setParameter

reset