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

GenericNode

open class GenericNode<T> @JvmOverloads constructor(val environment: Environment<T, *>, val id: Int = idFromEnv(environment), molecules: MutableMap<Molecule, T> = LinkedHashMap(), properties: MutableList<Capability<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

@JvmOverloads

constructor(environment: Environment<T, *>, id: Int = idFromEnv(environment), molecules: MutableMap<Molecule, T> = LinkedHashMap(), properties: MutableList<Capability<T>> = ArrayList())

Properties

contents

open override val contents: ObservableMutableMap<Molecule, T>

currentMoleculeCount

open override val currentMoleculeCount: Int

environment

val environment: Environment<T, *>

The environment in which the node is places.

override val id: Int

moleculeCount

open override val moleculeCount: Observable<Int>

Observes the count of different molecules in this node.

properties

override val properties: List<Capability<T>>

reactions

override val reactions: ObservableList<Reaction<T>>

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

Functions

addProperty

override fun addProperty(capability: Capability<T>)

Adds a capability to the node. Properties are part of the node setup: adding one fails once the node is in an environment, so properties can be read without being observed.

addReaction

override fun addReaction(reaction: Reaction<T>)

Registers reaction and notifies the running simulation when it was not already present. Fails if this is not the Reaction.host of reaction.

asProperty

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

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

returns a Capability of the provided superType.

asProperty

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

Returns the node property of the reified type C.

asPropertyOrNull

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

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

returns a Capability of the provided superType.

asPropertyOrNull

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

Returns the node property of the reified type C, or null if the node does not have a compatible property.

cloneNode

open override fun cloneNode(): 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. Its reactions are cloned through NodeReaction.cloneOnNewNode.

compareTo

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

concentrationOf

open override fun concentrationOf(molecule: Molecule): Observable<Option<T>>

Observe the concentration calculated with the given molecule. The result of this computation is wrapped into an Option and some if the value is present, otherwise none.

contains