com.cartotype.LocationRef Class Reference

Public Attributes
int	type
String	id
Geometry	geometry
double	radiusInMeters
int	sideOfRoad
int	roadOrientation

Static Public Attributes
static final int	LOCATION_REF_LINE = 0
static final int	LOCATION_REF_GEO_COORDINATE = 1
static final int	LOCATION_REF_POINT_ALONG_LINE = 2
static final int	LOCATION_REF_POINT_WITH_ACCESS_POINT = 3
static final int	LOCATION_REF_CIRCLE = 4
static final int	LOCATION_REF_RECTANGLE = 5
static final int	LOCATION_REF_POLYGON = 6
static final int	LOCATION_REF_CLOSED_LINE = 7
static final int	SIDE_OF_ROAD_NONE = 0
static final int	SIDE_OF_ROAD_RIGHT = 1
static final int	SIDE_OF_ROAD_LEFT = 2
static final int	SIDE_OF_ROAD_BOTH = 3
static final int	ROAD_ORIENTATION_NONE = 0
static final int	ROAD_ORIENTATION_FORWARDS = 1
static final int	ROAD_ORIENTATION_BACKWARDS = 2
static final int	ROAD_ORIENTATION_BOTH = 3

Detailed Description

Parameters used for a location reference in traffic information.

Member Data Documentation

geometry

Geometry com.cartotype.LocationRef.geometry

The point or points.

id

String com.cartotype.LocationRef.id

The arbitrary ID of the location reference.

LOCATION_REF_CIRCLE

final int com.cartotype.LocationRef.LOCATION_REF_CIRCLE = 4

static

A location reference type: a circle defined as a point and a radius.

LOCATION_REF_CLOSED_LINE

final int com.cartotype.LocationRef.LOCATION_REF_CLOSED_LINE = 7

static

A location reference type: a closed line in the route network.

LOCATION_REF_GEO_COORDINATE

final int com.cartotype.LocationRef.LOCATION_REF_GEO_COORDINATE = 1

static

A location reference type: a point on the earth's surface.

LOCATION_REF_LINE

final int com.cartotype.LocationRef.LOCATION_REF_LINE = 0

static

A location reference type: a line in the route network.

LOCATION_REF_POINT_ALONG_LINE

final int com.cartotype.LocationRef.LOCATION_REF_POINT_ALONG_LINE = 2

static

A location reference type: a point on a line in the route network.

LOCATION_REF_POINT_WITH_ACCESS_POINT

final int com.cartotype.LocationRef.LOCATION_REF_POINT_WITH_ACCESS_POINT = 3

static

A location reference type: a point on the route network providing access to a nearby POI: the first point is the point on the line, the second is the POI.

LOCATION_REF_POLYGON

final int com.cartotype.LocationRef.LOCATION_REF_POLYGON = 6

static

A location reference type: a polygon defined using a set of points.

LOCATION_REF_RECTANGLE

final int com.cartotype.LocationRef.LOCATION_REF_RECTANGLE = 5

static

A location reference type: a rectangle aligned to the grid of latitude and longitude: it is defined using two points at opposite corners.

radiusInMeters

double com.cartotype.LocationRef.radiusInMeters

The radius, if this is a circle.

ROAD_ORIENTATION_BACKWARDS

final int com.cartotype.LocationRef.ROAD_ORIENTATION_BACKWARDS = 2

static

The orientation of the path along the road is backwards.

ROAD_ORIENTATION_BOTH

final int com.cartotype.LocationRef.ROAD_ORIENTATION_BOTH = 3

static

The orientation of the path along the road is both ways: forwards and backwards.

ROAD_ORIENTATION_FORWARDS

final int com.cartotype.LocationRef.ROAD_ORIENTATION_FORWARDS = 1

static

The orientation of the path along the road is forwards.

ROAD_ORIENTATION_NONE

final int com.cartotype.LocationRef.ROAD_ORIENTATION_NONE = 0

static

The orientation of the path along the road is not specified.

roadOrientation

int com.cartotype.LocationRef.roadOrientation

The road orientation, if relevant: one of the ROAD_ORIENTATION_* constants.

SIDE_OF_ROAD_BOTH

final int com.cartotype.LocationRef.SIDE_OF_ROAD_BOTH = 3

static

A side-of-road type: both sides.

SIDE_OF_ROAD_LEFT

final int com.cartotype.LocationRef.SIDE_OF_ROAD_LEFT = 2

static

A side-of-road type: the left side.

SIDE_OF_ROAD_NONE

final int com.cartotype.LocationRef.SIDE_OF_ROAD_NONE = 0

static

A side-of-road type: the side is not specified.

SIDE_OF_ROAD_RIGHT

final int com.cartotype.LocationRef.SIDE_OF_ROAD_RIGHT = 1

static

A side-of-road type: the right side.

sideOfRoad

int com.cartotype.LocationRef.sideOfRoad

The side of the road, if relevant: one of the SIDE_OF_ROAD_* constants.

type

int com.cartotype.LocationRef.type

The type of this location reference: one of the LOCATION_REF_* constants.

---

The documentation for this class was generated from the following file:

• src/com/cartotype/LocationRef.java