alchemist/it.unibo.alchemist.model.interfaces/EnvironmentWithObstacles

EnvironmentWithObstacles

interface EnvironmentWithObstacles<W : Obstacle<P>, T, P : Position<P>, Vector<P>> : EuclideanEnvironment<T, P>

An environment with Obstacles.

Parameters

W

the type of obstacles.

T

the concentration type.

P

the position and vector type for this environment.

Functions

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

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

abstract fun addObstacle(obstacle: W)

Adds an obstacle to this environment.

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

open fun forEach(p0: Consumer<in Node<T>>)

abstract fun getDimensions(): Int

getDistanceBetweenNodes

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

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

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

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

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

getNeighborhood

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

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

abstract fun getNodeCount(): Int

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

getNodesWithinRange

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

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

abstract fun getOffset(): DoubleArray

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

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

abstract fun getSize(): DoubleArray

getSizeInDistanceUnits

abstract fun getSizeInDistanceUnits(): DoubleArray

intersectsObstacle

abstract fun intersectsObstacle(start: P, end: P): Boolean

Checks whether there is at least an obstacle intersecting the line connecting start and end.

abstract fun isTerminated(): Boolean

abstract operator override fun iterator(): MutableIterator<Node<T>>

abstract fun makePosition(vararg coordinates: Number): P

abstract fun makePosition(vararg coordinates: Double): P

Creates a Position compatible with this environment given its coordinates.

open fun moveNode(node: Node<T>, direction: P)

This method moves a node in the environment toward some direction. If node move is unsupported, it does nothing. Subclasses may override this method if they want to change the way a node moves towards some direction. The current implementation internally calls {@link #moveNodeToPosition(Node, Position2D)}, as such, overriding that method may suffice.

moveNodeToPosition

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

abstract fun next(current: P, desired: P): P

This method must calculate the ABSOLUTE next allowed position given the current position and the position in which the node wants to move. For example, if your node is in position 2,3, wants to move to 3,4 but the next allowed position (because, e.g., of physical obstacles) is 2.5,3.5, the result must be a Position containing coordinates 2.5,3.5.

abstract fun removeNode(node: Node<T>)

abstract fun removeObstacle(obstacle: W): Boolean

Removes an obstacle from this environment.

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

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

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

Properties

abstract val obstacles: List<W>

A list of all the obstacles in this environment.

open val origin: P

Create a position corresponding to the origin of this environment.

Inheritors

Environment2DWithObstacles

EnvironmentWithGraph