alchemist-implementationbase/it.unibo.alchemist.model.environments/AbstractEnvironment

AbstractEnvironment

abstract class AbstractEnvironment<T, P : Position<P>?> : Environment<T, P> (source)

Very generic and basic implementation for an environment. Basically, only manages an internal set of nodes and their position.

Parameters

<T>

concentration type

<P>

Position type

Inheritors

Abstract2DEnvironment

Properties

globalReactions

@get:Nonnull

val globalReactions: ListSet<GlobalReaction<T>>

incarnation

@get:Nonnull

open val incarnation: Incarnation<T, P>

nodes

@get:Nonnull

val nodes: ListSet<Node<T>>

simulation

@Nullable

@get:Nonnull

open var simulation: Simulation<T, P>

Functions

addGlobalReaction

open fun addGlobalReaction(@Nonnull reaction: GlobalReaction<T>)

addLayer

fun addLayer(@Nonnull molecule: Molecule, @Nonnull layer: Layer<T, P>)

addNode

fun addNode(@Nonnull node: Node<T>, @Nonnull p: P): Boolean

addTerminator

open fun addTerminator(@NotNull terminator: TerminationPredicate<T, P>)

Adds to the simulation a predicate that determines whether a simulation should be terminated.

forEach

fun forEach(action: Consumer<in Node<T>>)

getDimensions

abstract fun getDimensions(): Int

getDistanceBetweenNodes

fun getDistanceBetweenNodes(@Nonnull n1: Node<T>, @Nonnull n2: Node<T>): Double

getGlobalReactions

abstract fun getGlobalReactions(): ListSet<GlobalReaction<T>>

getIncarnation

abstract fun getIncarnation(): Incarnation<T, P>

getLayer

@Nullable

fun getLayer(@Nonnull molecule: Molecule): Layer<T, P>

getLayers

@Nonnull

fun getLayers(): ListSet<Layer<T, P>>

getLinkingRule

@Nonnull

fun getLinkingRule(): LinkingRule<T, P>

getNeighborhood

@Nonnull

fun getNeighborhood(@Nonnull node: Node<T>): Neighborhood<T>

getNodeByID

@Nonnull

fun getNodeByID(id: Int): Node<T>

getNodeCount

fun getNodeCount(): Int

getNodes

abstract fun getNodes(): ListSet<Node<T>>

getNodesWithinRange

@Nonnull

fun getNodesWithinRange(@Nonnull position: P, range: Double): ListSet<Node<T>>

@Nonnull

fun getNodesWithinRange(@Nonnull node: Node<T>, range: Double): ListSet<Node<T>>

getOffset

abstract fun getOffset(): Array<Double>

getPosition

@Nonnull

fun getPosition(@Nonnull node: Node<T>): P

getSimulation

abstract fun getSimulation(): Simulation<T, P>

getSimulationOrNull

@Nullable

open fun getSimulationOrNull(): Simulation<T, P>

getSize

abstract fun getSize(): Array<Double>

getSizeInDistanceUnits

@Nonnull

open fun getSizeInDistanceUnits(): Array<Double>

Override this method if units measuring distance do not match with units used for coordinates.

isTerminated

fun isTerminated(): Boolean

iterator

@Nonnull

fun iterator(): Iterator<Node<T>>

makePosition

abstract fun makePosition(p: Array<Number>): P

moveNodeToPosition

abstract fun moveNodeToPosition(p: Node<T>, p1: P)

removeGlobalReaction

open fun removeGlobalReaction(@Nonnull reaction: GlobalReaction<T>)

removeNode

fun removeNode(@Nonnull node: Node<T>)

setLinkingRule

fun setLinkingRule(@Nonnull rule: LinkingRule<T, P>)

setSimulation

abstract fun setSimulation(p: Simulation<T, P>)

spliterator

fun spliterator(): Spliterator<Node<T>>

toString

open fun toString(): String

Not used internally.