alchemist-api/it.unibo.alchemist.model.interfaces/Environment

Environment

interface Environment<T, P : Position<out P>?> : Serializable, Iterable<T>

Interface for an environment. Every environment must implement this specification.

Parameters

<P>

Concentration type

<T>

Position type

Functions

addGlobalReaction

abstract fun addGlobalReaction(reaction: GlobalReaction<T>)

Add a Actionable to the Environment.

addLayer

abstract fun addLayer(m: Molecule, l: Layer<T, P>)

Add a Layer to the Environment.

addNode

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

This method allows to add a new node to this environment.

addTerminator

abstract fun addTerminator(terminator: Predicate<Environment<T, P>>)

forEach

open fun forEach(action: Consumer<out Any>)

getDimensions

abstract fun getDimensions(): Int

The number of dimensions of this environment.

getDistanceBetweenNodes

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

Measures the distance between two nodes in the environment.

getGlobalReactions

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

Get the Environment's Actionables.

getIncarnation

@Nonnull

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

getLayer

abstract fun getLayer(m: Molecule): Optional<Layer<T, P>>

Get the layer associate to the given molecule.

getLayers

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

Return all the Layers in this Environment.

getLinkingRule

abstract fun getLinkingRule(): LinkingRule<T, P>

getNeighborhood

abstract fun getNeighborhood(center: Node<T>): Neighborhood<T>

Given a node, this method returns its neighborhood.

getNodeByID

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

Allows to access a node known its id.

getNodeCount

abstract fun getNodeCount(): Int

getNodes

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

All the nodes that exist in current environment.

getNodesWithinRange

abstract fun getNodesWithinRange(center: P, range: Double): ListSet<Node<T>>

Given a Position(center) this method returns a list of all the surroundings nodes within the given range.

abstract fun getNodesWithinRange(center: Node<T>, range: Double): ListSet<Node<T>>

Given a node (center) this method returns a list of all the surroundings nodes within the given range.

getOffset

abstract fun getOffset(): Array<Double>

This method allows to know which are the smallest coordinates represented.

getPosition

@Nonnull

abstract fun getPosition(node: Node<T>): P

Calculates the position of a node.

getSimulation

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

getSize

abstract fun getSize(): Array<Double>

This method returns the size of the environment as an array of length getDimensions.

getSizeInDistanceUnits

abstract fun getSizeInDistanceUnits(): Array<Double>

This method returns the size of the environment as an array of length getDimensions.

isTerminated

abstract fun isTerminated(): Boolean

iterator

abstract fun iterator(): Iterator<T>

makePosition

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

moveNodeToPosition

@Nonnull

abstract fun moveNodeToPosition(@Nonnull node: Node<T>, @Nonnull position: P)

This method moves a node in the environment to some position.

removeNode

abstract fun removeNode(node: Node<T>)

This method allows to remove a node.

setLinkingRule

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

setSimulation

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

spliterator

open fun spliterator(): Spliterator<T>

Inheritors

BenchmarkableEnvironment

EuclideanEnvironment