Options class is used to manipulate with basic Navigation settings in ApiOptions#changeApplicationOptions(Options, int) function. More...

Classes
class	LOAD_RESTRICTIONS
	HAZMAT / Load restrictions. More...

Public Member Functions
	Options ()

String	getHomeLocation ()
	Returns name of home position. More...

void	setHomeLocation (String strHomeLocation)
	Sets name of home position. More...

String	getLanguage ()
	Returns a language based on assignment of the form "(language).lang", e.g. More...

void	setLanguage (String strLangFile)
	Sets a language based on assignment of the form "(language).lang", e.g. More...

String	getVoice ()
	Returns a name of voice based on assignment of the voice folder name, e.g. More...

void	setVoice (String strVoiceFolder)
	Sets a name of voice based on assignment of the voice folder name, e.g. More...

String	getVoicePerson ()
	Returns a name of the sound file to play on speed warning. More...

void	setVoicePerson (String strVoicePerson)
	Sets a name of the sound file to play on speed warning. More...

String	getMaxSpeedSound ()
	Return a name of the sound file to play on speed warning. More...

void	setMaxSpeedSound (String strMaxSpeedSound)
	Sets a name of the sound file to play on speed warning. More...

String	toString ()

Static Public Member Functions
static Bundle	writeBundle (Options options)

static Options	readBundle (Bundle b)

Public Attributes
int	bSoundEnabled = -1
	Flag enabling/disabling sounds. More...

int	bOperateRightHanded = -1
	Flag effecting Navigation appearance. More...

int	nVolumeMin = -1
	Represents minimum sound volume. More...

int	nVolumeMax = -1
	Represents maximum sound volume. More...

int	DistanceUnit = -1
	Flag determining distance units. More...

int	ClockFormat = -1
	Flag determining clock format. More...

int	GPSUnits = -1
	Flag determining GPSUnits format. More...

int	KeyboardType = -1
	Flag determining keyboard type. More...

int	nAvoidTollRoads = -1
	Flag determining whether Navigation avoids toll roads when computing route. More...

int	bAvoidUTurns = -1
	Flag determining whether Navigation avoids U-turns when computing route. More...

int	nPlanningSettings = -1
	Flag determining what kind of route Navigation computes. More...

int	nPlanningSettingsLimitedSpeed = -1
	Parameter determinig vehicle speed limit. More...

int	bAvoidFerries = -1
	Flag determining whether Navigation avoids ferries when computing route. More...

int	bDisableMainMenu = -1
	Flag enabling/disabling main menu. More...

int	bDisableRecompute = -1
	Flag enabling/disabling recomputing route when deviating from the route. More...

int	nETAMaximumSpeed = -1
	Estimate time arrival maximum speed. More...

int	nETAPercentageChange = -1
	Estimate time arrival percentage change. More...

int	bRadarsWarnOn = -1
	Enable speed camera warning 1 = enable; 0 = disable; -1 = get value. More...

int	bRadarsVisible = -1
	Radars visible 1 = visible; 0 = invisible; -1 = get value. More...

int	nRadarDistance = -1
	Radars warning distance (range 1..10); -1 = get value; real distance = distance * 100 (m / yd) More...

int	nRadarDistanceInCity = -1
	Radars warning distance in city (range 1..10); -1 = get value; real distance = distance * 100 (m / yd) More...

int	nSkin = -1
	Skin mode 0 = DAY; 1 = NIGHT; 2 = AUTOSKIN. More...

int	nTimeZone = -1
	Time zone in minutes. More...

int	nSpeedExceedInCity = -100
	Speed warning is triggered when the maximum allowed speed in city is exceeded by this value. More...

int	nSpeedExceed = -100
	Speed warning is triggered when the maximum allowed speed outside city is exceeded by this value. More...

int	nView = -1
	View mode 0 = 3D; 1 = 2D; 2 = 2D North up. More...

int	nSignpostDirection = -1
	Displayed signposts: 0=disabled; 1=Preffered direction; 2=All directions; -1=get value. More...

int	nSignpostSize = -1
	Displayed signposts size: 0=single line; 1=simplified; 2=full; -1=get value. More...

int	bSnapToEveryRoad = -1
	Allows position snapping to forbidden roads. More...

int	bMaxSpeedWarn = -1
	Enable acoustic speed exceeding warning 1 = enable; 0 = disable; -1 = get value. More...

int	bTTSEnabled = -1
	Selected sound is TTS. More...

int	nVisiblePointReachDistance = -1

int	nInvisiblePointReachDistance = -1

int	bAllowClosedRoads = -1

int	bHideMenuCursor = -1
	Hide menu cursor in browse map. More...

int	bTruckInMap = -1
	Flag determining whether a truck attributes are contained in map. More...

int	bUseTruckAtt = -1
	Use truck attributes. More...

int	nTruckMaxSpeed = -1
	Truck max speed [km/h]. More...

int	nTruckWeightTotal = -1
	Gross vehicle weight [kg]. More...

int	nTruckWeightAxle = -1
	Weight per axle [kg]. More...

int	nTruckTandemWeight = -1
	Tandem axle weight [kg]. More...

int	nTruckTridemWeight = -1
	Tridem axle weight [kg]. More...

int	nTruckOtherWeight = -1
	Other weight [kg]. More...

int	nTruckUnladenWeight = -1
	Unladen vehicle weight [kg]. More...

int	nTruckLenght = -1
	Total vehicle length [mm]. More...

int	nTruckAxleLength = -1
	Extreme axle length [mm]. More...

int	nTrailerLength = -1
	Trailer Length [mm]. More...

int	nTractorLength = -1
	Tractor Length [mm]. More...

int	nKingpinLastAxle = -1
	Kingpin to last axle [mm]. More...

int	nKingpinLastTandem = -1
	Kingpin to middle of last tandem [mm]. More...

int	nKingpinEndTrailer = -1
	Kingpin to end of trailer (last trailer if applicable) [mm]. More...

int	nTruckOtherLength = -1
	Other length [mm]. More...

int	nTruckWidth = -1
	Vehicle width [mm]. More...

int	nTruckHeight = -1
	Posted height [mm]. More...

int	nLoadRestrictions = -1
	HAZMAT / Load restrictions. More...

Position	HomePosition = new Position(0, 0)

Detailed Description

Options class is used to manipulate with basic Navigation settings in ApiOptions#changeApplicationOptions(Options, int) function.

Constructor & Destructor Documentation

Options ( )

Referenced by Options.readBundle().

Member Function Documentation

String getHomeLocation ( )

Returns name of home position.

Returns: A new string to name of home position.

Referenced by Options.writeBundle().

String getLanguage ( )

Returns a language based on assignment of the form "(language).lang", e.g.

"english.lang".

Returns: A new string to name of lang file.

Referenced by Options.writeBundle().

String getMaxSpeedSound ( )

Return a name of the sound file to play on speed warning.

Returns: A new string to name of the sound file to play on speed warning.

Referenced by Options.writeBundle().

String getVoice ( )

Returns a name of voice based on assignment of the voice folder name, e.g.

"english_us".

Returns: A new string to voice based on assignment of the voice folder name, e.g. "english_us".

Referenced by Options.writeBundle().

String getVoicePerson ( )

Returns a name of the sound file to play on speed warning.

Returns: A new string to name of the sound file to play on speed warning

Referenced by Options.writeBundle().

static Options readBundle ( Bundle b )

static

References Options.bAllowClosedRoads, Options.bAvoidFerries, Options.bDisableMainMenu, Options.bDisableRecompute, Options.bHideMenuCursor, Options.bMaxSpeedWarn, Options.bOperateRightHanded, Options.bRadarsVisible, Options.bRadarsWarnOn, Options.bSnapToEveryRoad, Options.bSoundEnabled, Options.bTruckInMap, Options.bTTSEnabled, Options.bUseTruckAtt, Options.ClockFormat, Options.DistanceUnit, Options.GPSUnits, Options.HomePosition, Options.KeyboardType, Options.nAvoidTollRoads, Options.nETAMaximumSpeed, Options.nETAPercentageChange, Options.nInvisiblePointReachDistance, Options.nKingpinEndTrailer, Options.nKingpinLastAxle, Options.nKingpinLastTandem, Options.nLoadRestrictions, Options.nPlanningSettings, Options.nPlanningSettingsLimitedSpeed, Options.nRadarDistance, Options.nRadarDistanceInCity, Options.nSignpostDirection, Options.nSignpostSize, Options.nSkin, Options.nSpeedExceed, Options.nSpeedExceedInCity, Options.nTimeZone, Options.nTractorLength, Options.nTrailerLength, Options.nTruckAxleLength, Options.nTruckHeight, Options.nTruckLenght, Options.nTruckMaxSpeed, Options.nTruckOtherLength, Options.nTruckOtherWeight, Options.nTruckTandemWeight, Options.nTruckTridemWeight, Options.nTruckUnladenWeight, Options.nTruckWeightAxle, Options.nTruckWeightTotal, Options.nTruckWidth, Options.nView, Options.nVisiblePointReachDistance, Options.nVolumeMax, Options.nVolumeMin, Options.Options(), Options.setHomeLocation(), Options.setLanguage(), Options.setMaxSpeedSound(), Options.setVoice(), and Options.setVoicePerson().

Referenced by ApiOptions.changeApplicationOptions().

void setHomeLocation ( String strHomeLocation )

Sets name of home position.

Parameters

strHomeLocation A string to name of home position.

Referenced by Options.readBundle().

void setLanguage ( String strLangFile )

Sets a language based on assignment of the form "(language).lang", e.g.

"english.lang".

Parameters

strLangFile A string to name of lang file.

Referenced by Options.readBundle().

void setMaxSpeedSound ( String strMaxSpeedSound )

Sets a name of the sound file to play on speed warning.

Parameters

strMaxSpeedSound A string to name of the sound file to play on speed warning.

Referenced by Options.readBundle().

void setVoice ( String strVoiceFolder )

Sets a name of voice based on assignment of the voice folder name, e.g.

"english_us".

Parameters

strVoiceFolder A string to voice based on assignment of the voice folder name, e.g. "english_us".

Referenced by Options.readBundle().

void setVoicePerson ( String strVoicePerson )

Sets a name of the sound file to play on speed warning.

Parameters

strVoicePerson A string to name of the sound file to play on speed warning

Referenced by Options.readBundle().

String toString ( )

static Bundle writeBundle ( Options options )

static

References Options.bAllowClosedRoads, Options.bAvoidFerries, Options.bDisableMainMenu, Options.bDisableRecompute, Options.bHideMenuCursor, Options.bMaxSpeedWarn, Options.bOperateRightHanded, Options.bRadarsVisible, Options.bRadarsWarnOn, Options.bSnapToEveryRoad, Options.bSoundEnabled, Options.bTruckInMap, Options.bTTSEnabled, Options.bUseTruckAtt, Options.ClockFormat, Options.DistanceUnit, Options.getHomeLocation(), Options.getLanguage(), Options.getMaxSpeedSound(), Options.getVoice(), Options.getVoicePerson(), Position.getX(), Position.getY(), Options.GPSUnits, Options.HomePosition, Options.KeyboardType, Options.nAvoidTollRoads, Options.nETAMaximumSpeed, Options.nETAPercentageChange, Options.nInvisiblePointReachDistance, Options.nKingpinEndTrailer, Options.nKingpinLastAxle, Options.nKingpinLastTandem, Options.nLoadRestrictions, Options.nPlanningSettings, Options.nPlanningSettingsLimitedSpeed, Options.nRadarDistance, Options.nRadarDistanceInCity, Options.nSignpostDirection, Options.nSignpostSize, Options.nSkin, Options.nSpeedExceed, Options.nSpeedExceedInCity, Options.nTimeZone, Options.nTractorLength, Options.nTrailerLength, Options.nTruckAxleLength, Options.nTruckHeight, Options.nTruckLenght, Options.nTruckMaxSpeed, Options.nTruckOtherLength, Options.nTruckOtherWeight, Options.nTruckTandemWeight, Options.nTruckTridemWeight, Options.nTruckUnladenWeight, Options.nTruckWeightAxle, Options.nTruckWeightTotal, Options.nTruckWidth, Options.nView, Options.nVisiblePointReachDistance, Options.nVolumeMax, and Options.nVolumeMin.

Referenced by ApiOptions.changeApplicationOptions().

Member Data Documentation

int bAllowClosedRoads = -1

Referenced by Options.readBundle(), and Options.writeBundle().

int bAvoidFerries = -1

Flag determining whether Navigation avoids ferries when computing route.

Notes:
Possible values are:

1 - Ask to avoid ferries.
2 - Always avoid ferries.
3 - Never avoid ferries.

Referenced by Options.readBundle(), and Options.writeBundle().

int bAvoidUTurns = -1

Flag determining whether Navigation avoids U-turns when computing route.

Notes:
Possible values are:

1 - Ask to avoid U-turns.
2 - Always avoid U-turns.
3 - Never avoid U-turns.

int bDisableMainMenu = -1

Flag enabling/disabling main menu.

Notes:
Possible values are:

0 - main menu enabled
1 - main menu disabled.

Referenced by Options.readBundle(), and Options.writeBundle().

int bDisableRecompute = -1

Flag enabling/disabling recomputing route when deviating from the route.

Referenced by Options.readBundle(), and Options.writeBundle().

int bHideMenuCursor = -1

Hide menu cursor in browse map.

Referenced by Options.readBundle(), and Options.writeBundle().

int bMaxSpeedWarn = -1

Enable acoustic speed exceeding warning 1 = enable; 0 = disable; -1 = get value.

Referenced by Options.readBundle(), and Options.writeBundle().

int bOperateRightHanded = -1

Flag effecting Navigation appearance.

Notes:
Possible values are:

1 - Righthanded appearance.
0 - Lefthanded appearance.

Referenced by Options.readBundle(), and Options.writeBundle().

int bRadarsVisible = -1

Radars visible 1 = visible; 0 = invisible; -1 = get value.

Referenced by Options.readBundle(), and Options.writeBundle().

int bRadarsWarnOn = -1

Enable speed camera warning 1 = enable; 0 = disable; -1 = get value.

Referenced by Options.readBundle(), and Options.writeBundle().

int bSnapToEveryRoad = -1

Allows position snapping to forbidden roads.

Referenced by Options.readBundle(), and Options.writeBundle().

int bSoundEnabled = -1

Flag enabling/disabling sounds.

Notes:
Possible values are:

1 - Sound enabled 0 - Sound disabled.

Referenced by Options.readBundle(), and Options.writeBundle().

int bTruckInMap = -1

Flag determining whether a truck attributes are contained in map.

This flag is readonly

Referenced by Options.readBundle(), and Options.writeBundle().

int bTTSEnabled = -1

Selected sound is TTS.

Referenced by Options.readBundle(), and Options.writeBundle().

int bUseTruckAtt = -1

Use truck attributes.

Referenced by Options.readBundle(), and Options.writeBundle().

int ClockFormat = -1

Flag determining clock format.

Notes:
Possible values are:

0 - Europe (14:00)
1 - US (2:00)
2 - UK (2:00 PM)

Referenced by Options.readBundle(), and Options.writeBundle().

int DistanceUnit = -1

Flag determining distance units.

Notes:
Possible values are:

0 - Miles(yards)
1 - Kilometers
2 - Miles(feet)

Referenced by Options.readBundle(), and Options.writeBundle().

int GPSUnits = -1

Flag determining GPSUnits format.

Notes:
Possible values are:

0 - Degrees (0.0°)
1 - Degrees; minutes (0°0.0')
2 - Degrees; minutes; seconds (0°0'00")

Referenced by Options.readBundle(), and Options.writeBundle().

Position HomePosition = new Position(0, 0)

Referenced by Options.readBundle(), and Options.writeBundle().

int KeyboardType = -1

Flag determining keyboard type.

Notes:
Possible values are:

1 - ABCD
2 - QWERTY
3 - AZERTY
4 - DVORAK

Referenced by Options.readBundle(), and Options.writeBundle().

int nAvoidTollRoads = -1

Flag determining whether Navigation avoids toll roads when computing route.

Notes:
Possible values are:

1 - Ask to avoid toll roads.
2 - Always avoid toll roads.
3 - Never avoid toll roads.

Referenced by Options.readBundle(), and Options.writeBundle().

int nETAMaximumSpeed = -1

Estimate time arrival maximum speed.

Referenced by Options.readBundle(), and Options.writeBundle().

int nETAPercentageChange = -1

Estimate time arrival percentage change.

Referenced by Options.readBundle(), and Options.writeBundle().

int nInvisiblePointReachDistance = -1

Referenced by Options.readBundle(), and Options.writeBundle().

int nKingpinEndTrailer = -1

Kingpin to end of trailer (last trailer if applicable) [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nKingpinLastAxle = -1

Kingpin to last axle [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nKingpinLastTandem = -1

Kingpin to middle of last tandem [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nLoadRestrictions = -1

HAZMAT / Load restrictions.

See also: LOAD_RESTRICTIONS

Referenced by Options.readBundle(), and Options.writeBundle().

int nPlanningSettings = -1

Flag determining what kind of route Navigation computes.

Notes:
Possible values are:

1 - Navigation asks to kind of route.
2 - Navigation computes fastest route.
3 - Navigation computes shortest route.
4 - Navigation avoid motorways.
5 - Navigation computes route for walking.
6 - Navigation computes route for bicycles.
7 - Navigation computes route for vehicles with limited speed. Speed limit is set in.

See also: nPlanningSettingsLimitedSpeed

Referenced by Options.readBundle(), and Options.writeBundle().

int nPlanningSettingsLimitedSpeed = -1

Parameter determinig vehicle speed limit.

Used only if route is computed for vehicles with limited speed.

See also: nPlanningSettingsLimitedSpeed

Referenced by Options.readBundle(), and Options.writeBundle().

int nRadarDistance = -1

Radars warning distance (range 1..10); -1 = get value; real distance = distance * 100 (m / yd)

Referenced by Options.readBundle(), and Options.writeBundle().

int nRadarDistanceInCity = -1

Radars warning distance in city (range 1..10); -1 = get value; real distance = distance * 100 (m / yd)

Referenced by Options.readBundle(), and Options.writeBundle().

int nSignpostDirection = -1

Displayed signposts: 0=disabled; 1=Preffered direction; 2=All directions; -1=get value.

Referenced by Options.readBundle(), and Options.writeBundle().

int nSignpostSize = -1

Displayed signposts size: 0=single line; 1=simplified; 2=full; -1=get value.

Referenced by Options.readBundle(), and Options.writeBundle().

int nSkin = -1

Skin mode 0 = DAY; 1 = NIGHT; 2 = AUTOSKIN.

Referenced by Options.readBundle(), and Options.writeBundle().

int nSpeedExceed = -100

Speed warning is triggered when the maximum allowed speed outside city is exceeded by this value.

Referenced by Options.readBundle(), and Options.writeBundle().

int nSpeedExceedInCity = -100

Speed warning is triggered when the maximum allowed speed in city is exceeded by this value.

Referenced by Options.readBundle(), and Options.writeBundle().

int nTimeZone = -1

Time zone in minutes.

This flag is readonly.

Referenced by Options.readBundle(), and Options.writeBundle().

int nTractorLength = -1

Tractor Length [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTrailerLength = -1

Trailer Length [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckAxleLength = -1

Extreme axle length [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckHeight = -1

Posted height [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckLenght = -1

Total vehicle length [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckMaxSpeed = -1

Truck max speed [km/h].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckOtherLength = -1

Other length [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckOtherWeight = -1

Other weight [kg].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckTandemWeight = -1

Tandem axle weight [kg].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckTridemWeight = -1

Tridem axle weight [kg].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckUnladenWeight = -1

Unladen vehicle weight [kg].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckWeightAxle = -1

Weight per axle [kg].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckWeightTotal = -1

Gross vehicle weight [kg].

Referenced by Options.readBundle(), and Options.writeBundle().

int nTruckWidth = -1

Vehicle width [mm].

Referenced by Options.readBundle(), and Options.writeBundle().

int nView = -1

View mode 0 = 3D; 1 = 2D; 2 = 2D North up.

Referenced by Options.readBundle(), and Options.writeBundle().

int nVisiblePointReachDistance = -1

Referenced by Options.readBundle(), and Options.writeBundle().

int nVolumeMax = -1

Represents maximum sound volume.

(0-10)

Sound volume changes with changing vehicle speed. It is sound volume used with high vehicle speed.

Referenced by Options.readBundle(), and Options.writeBundle().

int nVolumeMin = -1

Represents minimum sound volume.

(0-10)

Sound volume changes with changing vehicle speed. It is sound volume used with low vehicle speed.

Referenced by Options.readBundle(), and Options.writeBundle().

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation