alchemist/it.unibo.alchemist.model.nodes/GenericNode

GenericNode

open class GenericNode<T>(val incarnation: Incarnation<T, *>, val environment: Environment<T, *>, val id: Int = idFromEnv(environment), val reactions: MutableList<Reaction<T>> = ArrayList(), val molecules: MutableMap<Molecule, T> = LinkedHashMap(), val properties: MutableList<NodeProperty<T>> = ArrayList()) : Node<T>

This class realizes an abstract node. You may extend it to realize your own nodes.

Parameters

concentration type

Inheritors

EnvironmentNodeImpl

LsaNode

Constructors

GenericNode

constructor(environment: Environment<T, *>)

constructor(incarnation: Incarnation<T, *>, environment: Environment<T, *>, id: Int = idFromEnv(environment), reactions: MutableList<Reaction<T>> = ArrayList(), molecules: MutableMap<Molecule, T> = LinkedHashMap(), properties: MutableList<NodeProperty<T>> = ArrayList())

Properties

contents

open override val contents: Map<Molecule, T>

environment

val environment: Environment<T, *>

The environment in which the node is places.

override val id: Int

incarnation

val incarnation: Incarnation<T, *>

simulation incarnation.

moleculeCount

open override val moleculeCount: Int

molecules

val molecules: MutableMap<Molecule, T>

The node's molecules.

properties

override val properties: MutableList<NodeProperty<T>>

reactions

override val reactions: MutableList<Reaction<T>>

This method allows to access all the reaction of the node.

Functions

addProperty

override fun addProperty(nodeProperty: NodeProperty<T>)

Adds a capability to the node.

addReaction

override fun addReaction(reactionToAdd: Reaction<T>)

Adds a reaction to this node. The reaction is added only in the node, but not in the it.unibo.alchemist.core.Simulation scheduler, so it will never be executed. To add the reaction also in the scheduler (and start to execute it), you have to call also the method it.unibo.alchemist.core.Simulation.reactionAdded.

asProperty

open fun <C : NodeProperty<T>> asProperty(superType: Class<C>): C

open fun <C : NodeProperty<T>> asProperty(superType: KClass<C>): C

returns a NodeProperty of the provided superType.

asProperty

inline fun <T, C : NodeProperty<T>> Node<T>.asProperty(): C

returns a NodeProperty of the provided type C.

asPropertyOrNull

open fun <C : NodeProperty<T>> asPropertyOrNull(superType: Class<in C>): C?

open fun <C : NodeProperty<T>> asPropertyOrNull(superType: KClass<in C>): C?

returns a NodeProperty of the provided superType.

asPropertyOrNull

inline fun <T, C : NodeProperty<T>> Node<T>.asPropertyOrNull(): C?

returns a NodeProperty of the provided type C or null if the node does not have a compatible property.

cloneNode

open override fun cloneNode(currentTime: Time): Node<T>

Creates a new Node which is a clone of the current Node. The new Node will have all the current Node's properties, such as reactions and molecules, but it will also have a different ID.

compareTo

operator override fun compareTo(other: Node<T>): Int

contains

open operator override fun contains(molecule: Molecule): Boolean

Tests whether a node contains a Molecule.

equals

operator override fun equals(other: Any?): Boolean

forEach

override fun forEach(action: Consumer<in Reaction<T>>)

Performs an action for every reaction.

getConcentration

open override fun getConcentration(molecule: Molecule): T

Calculates the concentration of a molecule.

hashCode

override fun hashCode(): Int

iterator

operator override fun iterator(): Iterator<Reaction<T>>

randomElement

fun <R> Iterable<R>.randomElement(randomGenerator: <Error class: unknown class>): R

Returns a random element of the Iterable using the provided randomGenerator.

removeConcentration

override fun removeConcentration(moleculeToRemove: Molecule)

removeReaction

override fun removeReaction(reactionToRemove: Reaction<T>)

Removes a reaction from this node. The reaction is removed only in the node, but not in the it.unibo.alchemist.core.Simulation scheduler, so the scheduler will continue to execute the reaction. To remove the reaction also in the scheduler (and stop to execute it), you have to call also the method it.unibo.alchemist.core.Simulation.reactionRemoved.

setConcentration

open override fun setConcentration(molecule: Molecule, concentration: T)

Sets the concentration of mol to c.

shuffled

fun <R> Iterable<R>.shuffled(randomGenerator: <Error class: unknown class>): Iterable<R>

Fisher–Yates shuffle algorithm using a RandomGenerator. More information on Wikipedia.

spliterator

override fun spliterator(): Spliterator<Reaction<T>>

Returns the reactions.

toGraphQLNodeSurrogate

fun <T> Node<T>.toGraphQLNodeSurrogate(): NodeSurrogate<T>

Converts a Node to a NodeSurrogate.

toNodeSurrogate

fun <T, P : Position<out P>, TS : Any, PS : PositionSurrogate> Node<T>.toNodeSurrogate(environment: Environment<T, P>, toConcentrationSurrogate: (T) -> TS, toPositionSurrogate: (P) -> PS): NodeSurrogate<TS, PS>

A function that maps a it.unibo.alchemist.model.Node to its surrogate class it.unibo.alchemist.boundary.webui.common.model.surrogate.NodeSurrogate.

toString

open override fun toString(): String