com.bmwcarit.barefoot.roadmap

Class RoadMap

java.lang.Object

com.bmwcarit.barefoot.topology.Graph<Road>

com.bmwcarit.barefoot.roadmap.RoadMap

All Implemented Interfaces:

Serializable

public class RoadMap
extends Graph<Road>
implements Serializable

Implementation of a road map with (directed) roads, i.e. Road objects. It provides a road network for routing that is derived from Graph and spatial search of roads with a SpatialIndex.

Note: Since Road objects are directed representations of BaseRoad objects, identifiers have a special mapping, see Road.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.bmwcarit.barefoot.topology.Graph

edges

Constructor Summary

Constructors

Constructor and Description
RoadMap()

Method Summary

Modifier and Type	Method and Description
RoadMap	construct() Constructs road network topology and spatial index.
void	deconstruct() Destroys road network topology and spatial index.
static RoadMap	Load(RoadReader reader) Loads and creates a RoadMap object from BaseRoad objects loaded with a RoadReader.
RoadReader	reader() Gets RoadReader of roads in this RoadMap.
SpatialIndex<RoadPoint>	spatial() Returns instance of SpatialIndex for spatial search of Road objects.

Methods inherited from class com.bmwcarit.barefoot.topology.Graph

add, components, edges, get, remove, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoadMap

public RoadMap()

Method Detail

Load

public static RoadMap Load(RoadReader reader)
                    throws SourceException

Loads and creates a RoadMap object from BaseRoad objects loaded with a RoadReader.

Parameters:

reader - RoadReader to load BaseRoad objects.

Returns:

RoadMap object.

Throws:

SourceException - thrown if error occurs while loading roads.

construct

public RoadMap construct()

Constructs road network topology and spatial index.

Overrides:

construct in class Graph<Road>

Returns:

Returns a self reference to this graph.

deconstruct

public void deconstruct()

Destroys road network topology and spatial index. (Necessary if roads have been added and road network topology and spatial index must be reconstructed.)

Overrides:

deconstruct in class Graph<Road>

spatial

public SpatialIndex<RoadPoint> spatial()

Returns instance of SpatialIndex for spatial search of Road objects.

Returns:

Instance of SpatialIndex or null, if the map hasn't been constructed ( construct()) or has been deconstructed ( deconstruct()).

reader

public RoadReader reader()

Gets RoadReader of roads in this RoadMap.

Returns:

RoadReader object.