RoadInfo Class Reference

RoadInfo class is providing information about road type. More...

Classes
class	RoadClass
	Enum of the road class as it is used for computing. More...

Public Member Functions
	RoadInfo ()
	Class constructor. More...
	RoadInfo (int roadOffset, int roadFlags, String isoCode)
	RoadInfo (int roadOffset, int roadFlags, String isoCode, String openLRString)
String	getIsoCode ()
	Iso code string of the map, where the road is located. More...
int	getRoadOffset ()
String	getOpenLRString ()
boolean	isFerry ()
boolean	isProhibited ()
	True if the road is prohibited to drive on. More...
int	roadClass ()
	Returns the road class. More...
byte	speedCategory ()
	Returns the speed category of the road. More...
boolean	isTollRoad ()
	True if it is a toll road. More...
boolean	isPaved ()
	True if the road is paved. More...
boolean	isCongestionCharge ()
	True if it is a road with congestion charge. More...
boolean	isUrban ()
	True if the road is in urban area. More...
boolean	isTunnel ()
	True if the road is tunnel. More...
int	speedRestriction ()
	Returns the speed restriction for that road. More...
String	toString ()

Static Public Member Functions
static Bundle	writeBundle (RoadInfo info)
static RoadInfo	readBundle (Bundle b)

Detailed Description

RoadInfo class is providing information about road type.

This is retrieved from the ApiLocation#getLocationRoadInfo(Position, int) function.

Constructor & Destructor Documentation

RoadInfo() [1/3]

RoadInfo

(

)

Class constructor.

Referenced by RoadInfo.readBundle().

RoadInfo() [2/3]

RoadInfo	(	int	roadOffset,
		int	roadFlags,
		String	isoCode
	)

RoadInfo() [3/3]

RoadInfo	(	int	roadOffset,
		int	roadFlags,
		String	isoCode,
		String	openLRString
	)

Member Function Documentation

getIsoCode()

String getIsoCode

(

)

Iso code string of the map, where the road is located.

Returns

Referenced by RoadInfo.writeBundle().

getOpenLRString()

String getOpenLRString

(

)

Returns

OpenLR string if available, empty string otherwise

Referenced by RoadInfo.writeBundle().

getRoadOffset()

int getRoadOffset

(

)

Returns

A unique identifier of the road in map. This identifier is used for special routing.

Referenced by RoadInfo.writeBundle().

isCongestionCharge()

boolean isCongestionCharge

(

)

True if it is a road with congestion charge.

Returns

Referenced by RoadInfo.isTollRoad().

isFerry()

boolean isFerry

(

)

Returns

True if the road is ferry.

isPaved()

boolean isPaved

(

)

True if the road is paved.

Returns

isProhibited()

boolean isProhibited

(

)

True if the road is prohibited to drive on.

Returns

isTollRoad()

boolean isTollRoad

(

)

True if it is a toll road.

Returns

References RoadInfo.isCongestionCharge(), RoadInfo.RoadClass.RC1, and RoadInfo.roadClass().

isTunnel()

boolean isTunnel

(

)

True if the road is tunnel.

Returns

isUrban()

boolean isUrban

(

)

True if the road is in urban area.

Returns

readBundle()

static RoadInfo readBundle ( Bundle  b )

static

References RoadInfo.RoadInfo().

Referenced by ApiLocation.getLocationRoadInfo().

roadClass()

int roadClass

(

)

Returns the road class.

Returns

Referenced by RoadInfo.isTollRoad().

speedCategory()

byte speedCategory

(

)

Returns the speed category of the road.

Returns

speedRestriction()

int speedRestriction

(

)

Returns the speed restriction for that road.

Returns

toString()

String toString

(

)

writeBundle()

static Bundle writeBundle ( RoadInfo  info )

static

References RoadInfo.getIsoCode(), RoadInfo.getOpenLRString(), and RoadInfo.getRoadOffset().