37.1.1

alchemist/it.unibo.alchemist.model.sapere.conditions/LsaNeighborhoodCondition

LsaNeighborhoodCondition

class LsaNeighborhoodCondition : LsaStandardCondition

Constructors

LsaNeighborhoodCondition

constructor(node: ILsaNode, molecule: ILsaMolecule, environment: Environment<List<ILsaMolecule>, out Any>)

Properties

val node: Node<T>

Functions

abstract fun cloneCondition(node: Node<T>, reaction: Reaction<T>): Condition<T>

open fun cloneCondition(node: Node<T>, reaction: Reaction<T>): Condition<T>

abstract fun cloneCondition(node: Node<List<ILsaMolecule>>, reaction: Reaction<List<ILsaMolecule>>): ILsaCondition

abstract fun cloneCondition(node: Node<List<ILsaMolecule>>, reaction: Reaction<List<ILsaMolecule>>): LsaAbstractCondition

This method allows to clone this action on a new node.

open fun cloneCondition(node: Node<List<ILsaMolecule>>, r: Reaction<List<ILsaMolecule>>): LsaNeighborhoodCondition

How to override: create a new action of your concrete subtype.

abstract fun filter(matches: List<Map<HashString, ITreeNode<out Any>>>, validNodes: List<ILsaNode>, retrieved: List<Map<ILsaNode, List<ILsaMolecule>>>): Boolean

open fun filter(matchesList: List<Map<HashString, ITreeNode<out Any>>>, validNodes: List<ILsaNode>, retrieved: List<Map<ILsaNode, List<ILsaMolecule>>>): Boolean

When this method is called, the condition must filter the current matches and allowed nodes.

open fun getContext(): Context

getInboundDependencies

fun getInboundDependencies(): ListSet<? extends Dependency>

How to override: if you intend your condition to be potentially changed by any change in the context, return null.

fun getNode(): ILsaNode

Override if your Condition can return a more specific type of node.

getPropensityContribution

fun getPropensityContribution(): Double

This method is a support for the propensity calculation inside the Reactions.

fun isValid(): Boolean

open fun reactionReady()

This method is called by the Simulation once the Reaction whose this Condition belongs to is the next one to be executed, and all its conditions passed (namely, the next operation will be the reaction execution).

open fun toString(): String