alchemist/it.unibo.alchemist.model/Node

Node

interface Node<T> : Comparable<Node<T>> , Disposable, ReactionHost<T>

Parameters

The type of the concentration

This interface must be implemented in every realization of node

Inheritors

EnvironmentNode

Types

object Companion

Utilities for Nodes.

Properties

abstract val contents: ObservableMap<Molecule, T>

currentMoleculeCount

abstract val currentMoleculeCount: Int

abstract val id: Int

abstract val moleculeCount: Observable<Int>

Observes the count of different molecules in this node.

abstract val properties: List<Capability<T>>

abstract override val reactions: ObservableList<Reaction<T>>

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

Functions

abstract 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.

abstract 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.

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.

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.

abstract 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.

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

concentrationOf

abstract 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.

abstract operator fun contains(molecule: Molecule): Boolean

Tests whether a node contains a Molecule.

containsMolecule

abstract fun containsMolecule(molecule: Molecule): Observable<Boolean>

Observes whether a node contains a Molecule.

abstract fun dispose()

Disposes and releases the resources held by this object.

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

abstract operator fun get(molecule: Molecule): Option<T>

The concentration of a molecule, some if the molecule is present in this node, none otherwise.

abstract override fun hashCode(): Int

open fun Reaction<T>.remove()

Unregisters this reaction from its host, see removeReaction.

removeAllConcentrationOf

abstract fun removeAllConcentrationOf(moleculeToRemove: Molecule)

abstract fun removeReaction(reaction: Reaction<T>)

Unregisters reaction and notifies the running simulation when it was actually present.

abstract operator fun set(molecule: Molecule, concentration: T)

Sets the concentration of mol to c.

infix fun Node<*>.shouldEqual(other: Node<*>)

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.