alchemist-maps/it.unibo.alchemist.model.maps.environments/OSMEnvironment

OSMEnvironment

class OSMEnvironment<T> : Abstract2DEnvironment<T, GeoPosition> , MapEnvironment<T, GraphHopperOptions, GraphHopperRoutingService> (source)

This class serves as a template for more specific implementations of environments using a map. It encloses the navigation logic but leaves the subclasses to decide how to provide map data (e.g., loading from disk or relying on online services). The data is then stored in-memory for performance reasons.

Parameters

<T>

concentration type

Constructors

constructor(incarnation: Incarnation<T, GeoPosition>)

Builds a new OSMEnvironment without an actual backing map.

constructor(incarnation: Incarnation<T, GeoPosition>, file: String)

Builds a new OSMEnvironment, with nodes not forced on streets.

constructor(incarnation: Incarnation<T, GeoPosition>, file: String, onStreets: Boolean)

constructor(incarnation: Incarnation<T, GeoPosition>, file: String, onStreets: Boolean, onlyOnStreets: Boolean)

constructor(incarnation: Incarnation<T, GeoPosition>, file: String, approximation: Int)

constructor(incarnation: Incarnation<T, GeoPosition>, file: String, approximation: Int, onStreets: Boolean, onlyOnStreets: Boolean)

Properties

DEFAULT_APPROXIMATION

val DEFAULT_APPROXIMATION: Int = 0

The default value for approximating the position comparison.

DEFAULT_FORCE_STREETS

val DEFAULT_FORCE_STREETS: Boolean = false

The default value for the discard of nodes too far from streets.

DEFAULT_ON_STREETS

val DEFAULT_ON_STREETS: Boolean = true

The default value for the force nodes on streets option.

val dimensions: Int

val incarnation: Incarnation<T, P>

open var networkModel: NetworkModel<T>

simulationOrNull

open val simulationOrNull: Simulation<T, P>

Functions

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

open fun addNode(node: Node<T>, position: P): Boolean

open fun addReaction(reaction: Reaction<T>)

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

open fun computeRoute(p1: GeoPosition, p2: GeoPosition): Route<GeoPosition>

open fun computeRoute(node: Node<T>, coord: GeoPosition): Route<GeoPosition>

open fun computeRoute(node: Node<T>, node2: Node<T>): Route<GeoPosition>

open fun computeRoute(from: GeoPosition, to: GeoPosition, options: GraphHopperOptions): Route<GeoPosition>

open fun computeRoute(node: Node<T>, coord: GeoPosition, options: GraphHopperOptions): Route<GeoPosition>

This method relies on the map data and computes a route towards some absolute coordinate solving a TSP problem.

open fun contains(node: Node<T>): Boolean

currentPositionOf

open fun currentPositionOf(node: Node<T>): P

distanceBetween

open fun distanceBetween(n1: Node<T>, n2: Node<T>): Double

open fun distanceTo($this$distanceTo: Node<T>, other: Node<T>): Double

farthestReachablePosition

open fun farthestReachablePosition(node: Node<T>, desired: P): P

getCurrentPosition

open fun getCurrentPosition($this$currentPosition: Node<T>): P

fun getLayers(): Map<Molecule, Layer<T, P>>

getNeighborhood

open fun getNeighborhood($this$neighborhood: Node<T>): Observable<Neighborhood<T>>

fun getNodeCount(): Observable<Integer>

open fun getNodes(): ObservableList<Node<T>>

fun getOffset(): Array<Double>

open fun getPosition($this$position: Node<T>): Observable<P>

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

getRoutingService

open fun getRoutingService(): GraphHopperRoutingService

Returns the routing service of this environment.

fun getSimulation(): Simulation<T, P>

fun getSize(): Array<Double>

getSizeInDistanceUnits

open fun getSizeInDistanceUnits(): Array<Double>

open fun isTerminated(): Boolean

open fun layerFor(molecule: Molecule): Layer<T, P>

open fun makePosition(coordinates: List<out Number>): P

@NotNull

open fun makePosition(@NotNull coordinates: Array<Double>): GeoPosition

open fun makePosition(coordinates: Array<Number>): GeoPosition

open fun moveNodeTo(node: Node<T>, position: P)

open fun moveTo($this$moveTo: Node<T>, position: P)

open fun neighborhoodOf(node: Node<T>): Observable<Neighborhood<T>>

open fun nodesAround(node: Node<T>, range: Double): List<Node<T>>

open fun nodesInRange($this$nodesInRange: Node<T>, range: Double): List<Node<T>>

open fun nodeWithId(id: Int): Node<T>

observeLayerValue

open fun observeLayerValue(molecule: Molecule, node: Node<T>): Observable<T>

observeNodesAround

open fun observeNodesAround(node: Node<T>, range: Double): ObservableSet<Node<T>>

observeNodesInRange

open fun observeNodesInRange($this$observeNodesInRange: Node<T>, range: Double): ObservableSet<Node<T>>

open fun positionOf(node: Node<T>): Observable<P>

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

open fun removeNode(node: Node<T>)

open fun removeReaction(reaction: Reaction<T>)

fun setSimulation(value: Simulation<T, P>)

open fun toPosition($this$toPosition: Array<Double>): P

open fun toString(): String