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

OSMEnvironment

class OSMEnvironment<T> @JvmOverloads constructor(incarnation: Incarnation<T, GeoPosition>, file: String? = null, onStreets: Boolean = file != null, onlyOnStreets: Boolean = DEFAULT_FORCE_STREETS, approximation: Int = DEFAULT_APPROXIMATION) : Abstract2DEnvironment<T, GeoPosition> , MapEnvironment<T, GraphHopperOptions, GraphHopperRoutingService> (source)

An environment backed by an OpenStreetMap extract stored in file. It encloses the navigation logic, loading the map lazily the first time navigation is required. Routes are cached in memory for performance reasons.

Parameters

incarnation

the incarnation to be used.

file

the file path where the map data is stored. Accepts OSM maps of any format (xml, osm, pbf). The map will be processed, optimized and stored for future use. If null, navigation is unavailable.

onStreets

if true, the nodes will be placed on the street nearest to the desired position. Defaults to true when a file is provided, to false otherwise.

onlyOnStreets

if true, the nodes which are too far from a street will be simply discarded. If false, they will be placed anyway, in the original position.

approximation

the symbols of IEEE 754-encoded position that may be discarded when comparing two positions, allowing quicker retrieval of the route between two positions via cache.

Type Parameters

concentration type

Constructors

OSMEnvironment

@JvmOverloads

constructor(incarnation: Incarnation<T, GeoPosition>, file: String? = null, onStreets: Boolean = file != null, onlyOnStreets: Boolean = DEFAULT_FORCE_STREETS, approximation: Int = DEFAULT_APPROXIMATION)

Types

Companion

object Companion

Default values for the OSMEnvironment options.

Properties

attachedSimulation

override val attachedSimulation: Observable<Simulation<T, GeoPosition>?>

currentPosition

open val Node<T>.currentPosition: GeoPosition

dimensions

override val dimensions: Int

incarnation

override val incarnation: Incarnation<T, GeoPosition>

isTerminated

open override val isTerminated: Boolean

layers

override val layers: Map<Molecule, Layer<T, GeoPosition>>

neighborhood

open val Node<T>.neighborhood: Observable<Neighborhood<T>>

networkModel

override var networkModel: NetworkModel<T>

nodeCount

override val nodeCount: Observable<Int>

nodes

open override val nodes: ObservableList<Node<T>>

offset

override val offset: DoubleArray

position

open val Node<T>.position: Observable<GeoPosition>

reactions

open override val reactions: ObservableList<Reaction<T>>

routingService

open override val routingService: GraphHopperRoutingService

simulation

override var simulation: Simulation<T, GeoPosition>

simulationOrNull

override val simulationOrNull: Simulation<T, GeoPosition>?

size

override val size: DoubleArray

sizeInDistanceUnits

open override val sizeInDistanceUnits: DoubleArray

Functions

addLayer

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

addNode

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

addReaction

open override fun addReaction(reaction: Reaction<T>)

addTerminator

open fun addTerminator(terminator: (Environment<T, GeoPosition>) -> Boolean)

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

computeRoute

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

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

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

open override 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. It's up to the specific it.unibo.alchemist.model.Action calling this method to effectively move nodes along the path.