alchemist/it.unibo.alchemist.model.sapere.nodes/LsaNode

LsaNode

class LsaNode : GenericNode<List<ILsaMolecule>> , ILsaNode

This class realizes a node with LSA concentration.

Constructors

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

Builds a new LsaNode.

Properties

val contents: ObservableMutableMap<Molecule, T>

val environment: Environment<T, out Any>

The environment in which the node is places.

val id: Int

val moleculeCount: Observable<Integer>

val properties: List<Capability<T>>

val reactions: ObservableList<Reaction<T>>

Functions

open fun addLsa(instance: ILsaMolecule)

Adds an instance of ILsaMolecule in the node's LsaSpace.

abstract fun addProperty(capability: Capability<T>)

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>)

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: 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

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>

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

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

abstract fun compareTo(p: T): Int

concentrationOf

@NotNull

open fun concentrationOf(@NotNull molecule: Molecule): Observable<Option<List<ILsaMolecule>>>

Observe the concentration calculated with the given molecule.

abstract fun contains(molecule: Molecule): Boolean

open fun contains(molecule: Molecule): Boolean

Tests whether a node contains a Molecule.

containsMolecule

@NotNull

open fun containsMolecule(@NotNull molecule: Molecule): Observable<Boolean>

Observes whether a node contains a Molecule.

open fun dispose()

abstract fun dispose()

Disposes and releases the resources held by this object.

abstract fun equals(other: Any): Boolean

fun equals(other: Any): Boolean

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

open fun get(molecule: Molecule): Option<T>

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

abstract fun getContents(): ObservableMap<Molecule, T>

getCurrentMoleculeCount

abstract fun getCurrentMoleculeCount(): Int

open fun getCurrentMoleculeCount(): Int

open fun getLsaSpace(): List<ILsaMolecule>

Returns the LSA molecules in this node.

getMoleculeCount

@NotNull

open fun getMoleculeCount(): Observable<Integer>

Observes the count of different molecules in this node.

abstract fun getProperties(): List<Capability<T>>

abstract fun getReactions(): ObservableList<Reaction<T>>

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

abstract fun hashCode(): Int

fun hashCode(): Int

open fun matching(template: ILsaMolecule): List<ILsaMolecule>

Finds the LSA instances in this node that [template] matches.

observeCandidates

@NotNull

open fun observeCandidates(@NotNull template: ILsaMolecule): Observable<List<ILsaMolecule>>

Observes the instances that [template] may match: those sharing its first argument when it is a constant or a number, every instance otherwise.

observeLsaSpace

open fun observeLsaSpace(): ObservableList<ILsaMolecule>

Observes the LSA space of this node.

open fun remove($this$remove: Reaction<T>)

Unregisters this reaction from its host, see removeReaction.

removeAllConcentrationOf

open fun removeAllConcentrationOf(@Nonnull moleculeToRemove: Molecule)

Removes every copy of [moleculeToRemove] from this node.

removeOneMatchedLsa

open fun removeOneMatchedLsa(matchedInstance: ILsaMolecule): Boolean

Deletes an ILsaMolecule from the Node LsaSpace Warning: the method removes only the first matched ILsaMolecule.

abstract fun removeReaction(reaction: Reaction<T>)

fun removeReaction(reaction: Reaction<T>)

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

open fun set(@Nonnull molecule: Molecule, c: List<ILsaMolecule>)

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.

open fun toString(): String