alchemist/it.unibo.alchemist.model.reactions/AbstractReaction

AbstractReaction

abstract class AbstractReaction<T> : Reaction<T>

The type which describes the concentration of a molecule. This class offers a partial implementation of Reaction. In particular, it allows writing new reaction specifying only which distribution time to adopt

Parameters

<T>

concentration type

Inheritors

Constructors

AbstractReaction

constructor(node: Node<T>, timeDistribution: TimeDistribution<T>)

Builds a new reaction, starting at time t.

Properties

node

@get:Nonnull

val node: Node<T>

timeDistribution

@get:Nonnull

val timeDistribution: TimeDistribution<T>

Functions

canExecute

open fun canExecute(): Boolean

The default implementation verifies if all the conditions are valid.

cloneOnNewNode

abstract fun cloneOnNewNode(node: Node<T>, currentTime: Time): Reaction<T>

This method allows to clone this reaction on a new node. It may result useful to support runtime creation of nodes with the same reaction programming, e.g. for morphogenesis.

compareTo

fun compareTo(o: Actionable<T>): Int

equals

fun equals(o: Any): Boolean

execute

open fun execute()

The default execution iterates all the actions in order and executes them.

getActions

@Nonnull

open fun getActions(): List<Action<T>>

Override only if you need to implement extremely tricky behaviors.

getConditions

@Nonnull

open fun getConditions(): List<Condition<T>>

Override only if you need to implement extremely tricky behaviors.

getInboundDependencies

@Nonnull

fun getInboundDependencies(): ListSet<Dependency>

getInputContext

@Nonnull

fun getInputContext(): Context

The widest Context among Conditions, namely the smallest Context in which the Reaction can read informations.

getNode

abstract fun getNode(): Node<T>

getOutboundDependencies

@Nonnull

fun getOutboundDependencies(): ListSet<Dependency>

getOutputContext

@Nonnull

fun getOutputContext(): Context

The widest Context among Actions, namely the smallest context in which the Reaction can do modifications.

getRate

open fun getRate(): Double

Returns the speed of this Reaction. It is an average number, and can potentially change during the simulation, depending on the implementation.

getTau

@Nonnull

fun getTau(): Time

getTimeDistribution

abstract fun getTimeDistribution(): TimeDistribution<T>

hashCode

fun hashCode(): Int

initializationComplete

open fun initializationComplete(@Nonnull atTime: Time, @Nonnull environment: Environment<T, out Any>)

This method is called when the environment has completed its initialization.

setActions

open fun setActions(@Nonnull actions: List<out Action<T>>)

This should get overridden only if very tricky behaviors are implemented, such that the default Alchemist action addition model is no longer usable.

setConditions

open fun setConditions(@Nonnull conditions: List<out Condition<T>>)

This should get overridden only if very tricky behaviors are implemented, such that the default Alchemist condition addition model is no longer usable.

toGraphQLReactionSurrogate

fun <T> Reaction<T>.toGraphQLReactionSurrogate(): ReactionSurrogate<T>

Converts a Reaction to a ReactionSurrogate.

toString

open fun toString(): String

update

fun update(@Nonnull currentTime: Time, hasBeenExecuted: Boolean, @Nonnull environment: Environment<T, out Any>)

Updates the scheduling of this reaction.