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.
void	setHomeLocation (String strHomeLocation)
	Sets name of home position.
String	getLanguage ()
	Returns a language based on assignment of the form "(language).lang", e.g.
void	setLanguage (String strLangFile)
	Sets a language based on assignment of the form "(language).lang", e.g.
String	getVoice ()
	Returns a name of voice based on assignment of the voice folder name, e.g.
void	setVoice (String strVoiceFolder)
	Sets a name of voice based on assignment of the voice folder name, e.g.
String	getVoicePerson ()
	Returns a name of the sound file to play on speed warning.
void	setVoicePerson (String strVoicePerson)
	Sets a name of the sound file to play on speed warning.
String	getMaxSpeedSound ()
	Return a name of the sound file to play on speed warning.
void	setMaxSpeedSound (String strMaxSpeedSound)
	Sets a name of the sound file to play on speed warning.
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.
int	bOperateRightHanded = -1
	Flag effecting Navigation appearance.
int	nVolumeMin = -1
	Represents minimum sound volume.
int	nVolumeMax = -1
	Represents maximum sound volume.
int	DistanceUnit = -1
	Flag determining distance units.
int	ClockFormat = -1
	Flag determining clock format.
int	GPSUnits = -1
	Flag determining GPSUnits format.
int	KeyboardType = -1
	Flag determining keyboard type.
int	nAvoidTollRoads = -1
	Flag determining whether Navigation avoids toll roads when computing route.
int	bAvoidUTurns = -1
	Flag determining whether Navigation avoids U-turns when computing route.
int	nPlanningSettings = -1
	Flag determining what kind of route Navigation computes.
int	nPlanningSettingsLimitedSpeed = -1
	Parameter determinig vehicle speed limit.
int	bAvoidFerries = -1
	Flag determining whether Navigation avoids ferries when computing route.
int	bDisableMainMenu = -1
	Flag enabling/disabling main menu.
int	bDisableRecompute = -1
	Flag enabling/disabling recomputing route when deviating from the route.
int	nETAMaximumSpeed = -1
	Estimate time arrival maximum speed.
int	nETAPercentageChange = -1
	Estimate time arrival percentage change.
int	bRadarsWarnOn = -1
	Enable speed camera warning 1 = enable; 0 = disable; -1 = get value.
int	bRadarsVisible = -1
	Radars visible 1 = visible; 0 = invisible; -1 = get value.
int	nRadarDistance = -1
	Radars warning distance (range 1..10); -1 = get value; real distance = distance * 100 (m / yd)
int	nRadarDistanceInCity = -1
	Radars warning distance in city (range 1..10); -1 = get value; real distance = distance * 100 (m / yd)
int	nSkin = -1
	Skin mode 0 = DAY; 1 = NIGHT; 2 = AUTOSKIN.
int	nTimeZone = -1
	Time zone in minutes.
int	nSpeedExceedInCity = -100
	Speed warning is triggered when the maximum allowed speed in city is exceeded by this value.
int	nSpeedExceed = -100
	Speed warning is triggered when the maximum allowed speed outside city is exceeded by this value.
int	nView = -1
	View mode 0 = 3D; 1 = 2D; 2 = 2D North up.
int	nSignpostDirection = -1
	Displayed signposts: 0=disabled; 1=Preffered direction; 2=All directions; -1=get value.
int	nSignpostSize = -1
	Displayed signposts size: 0=single line; 1=simplified; 2=full; -1=get value.
int	bSnapToEveryRoad = -1
	Allows position snapping to forbidden roads.
int	bMaxSpeedWarn = -1
	Enable acoustic speed exceeding warning 1 = enable; 0 = disable; -1 = get value.
int	bTTSEnabled = -1
	Selected sound is TTS.
int	nVisiblePointReachDistance = -1
int	nInvisiblePointReachDistance = -1
int	bAllowClosedRoads = -1
int	bTruckInMap = -1
	Flag determining whether a truck attributes are contained in map.
int	bUseTruckAtt = -1
	Use truck attributes.
int	nTruckMaxSpeed = -1
	Truck max speed [km/h].
int	nTruckWeightTotal = -1
	Gross vehicle weight [kg].
int	nTruckWeightAxle = -1
	Weight per axle [kg].
int	nTruckTandemWeight = -1
	Tandem axle weight [kg].
int	nTruckTridemWeight = -1
	Tridem axle weight [kg].
int	nTruckOtherWeight = -1
	Other weight [kg].
int	nTruckUnladenWeight = -1
	Unladen vehicle weight [kg].
int	nTruckLenght = -1
	Total vehicle length [mm].
int	nTruckAxleLength = -1
	Extreme axle length [mm].
int	nTrailerLength = -1
	Trailer Length [mm].
int	nTractorLength = -1
	Tractor Length [mm].
int	nKingpinLastAxle = -1
	Kingpin to last axle [mm].
int	nKingpinLastTandem = -1
	Kingpin to middle of last tandem [mm].
int	nKingpinEndTrailer = -1
	Kingpin to end of trailer (last trailer if applicable) [mm].
int	nTruckOtherLength = -1
	Other length [mm].
int	nTruckWidth = -1
	Vehicle width [mm].
int	nTruckHeight = -1
	Posted height [mm].
int	nLoadRestrictions = -1
	HAZMAT / Load restrictions.
int	bAllowItineraryEdit = -1
	Flag determining whether the user will be allowed to edit itinerary manually.
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()

Options ( )

Referenced by readBundle(), and writeBundle().

Member Function Documentation

◆ getHomeLocation()

String getHomeLocation ( )

Returns name of home position.

Returns: A new string to name of home position.

Referenced by writeBundle().

◆ getLanguage()

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 writeBundle().

◆ getMaxSpeedSound()

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 writeBundle().

◆ getVoice()

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 writeBundle().

◆ getVoicePerson()

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 writeBundle().

◆ readBundle()

Options readBundle ( Bundle b )

static

References Options(), setHomeLocation(), setLanguage(), setMaxSpeedSound(), setVoice(), and setVoicePerson().

Referenced by ApiOptions.changeApplicationOptions().

◆ setHomeLocation()

void setHomeLocation ( String strHomeLocation )

Sets name of home position.

Parameters

strHomeLocation A string to name of home position.

Referenced by readBundle().

◆ setLanguage()

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 readBundle().

◆ setMaxSpeedSound()

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 readBundle().

◆ setVoice()

void setVoice ( String strVoiceFolder )

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

"english_us".

In case of NonTTS voices set bTTSEnabled to 0 else 1

Parameters

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

Referenced by readBundle().

◆ setVoicePerson()

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 readBundle().

◆ toString()

String toString ( )

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

◆ writeBundle()

Bundle writeBundle ( Options options )

static

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

Referenced by ApiOptions.changeApplicationOptions().

Member Data Documentation

◆ bAllowClosedRoads

int bAllowClosedRoads = -1

Referenced by toString(), and writeBundle().

◆ bAllowItineraryEdit

int bAllowItineraryEdit = -1

Flag determining whether the user will be allowed to edit itinerary manually.

Referenced by toString(), and writeBundle().

◆ bAvoidFerries

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 toString(), and writeBundle().

◆ bAvoidUTurns

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.

Referenced by toString(), and writeBundle().

◆ bDisableMainMenu

int bDisableMainMenu = -1

Flag enabling/disabling main menu.

Notes:
Possible values are:

0 - main menu enabled
1 - main menu disabled.

Referenced by toString(), and writeBundle().

◆ bDisableRecompute

int bDisableRecompute = -1

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

Referenced by toString(), and writeBundle().

◆ bMaxSpeedWarn

int bMaxSpeedWarn = -1

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

Referenced by toString(), and writeBundle().

◆ bOperateRightHanded

int bOperateRightHanded = -1

Flag effecting Navigation appearance.

Notes:
Possible values are:

1 - Righthanded appearance.
0 - Lefthanded appearance.

Referenced by toString(), and writeBundle().

◆ bRadarsVisible

int bRadarsVisible = -1

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

Referenced by toString(), and writeBundle().

◆ bRadarsWarnOn

int bRadarsWarnOn = -1

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

Referenced by toString(), and writeBundle().

◆ bSnapToEveryRoad

int bSnapToEveryRoad = -1

Allows position snapping to forbidden roads.

Referenced by toString(), and writeBundle().

◆ bSoundEnabled

int bSoundEnabled = -1

Flag enabling/disabling sounds.

Notes:
Possible values are:

1 - Sound enabled
0 - Sound disabled.

Referenced by toString(), and writeBundle().

◆ bTruckInMap

int bTruckInMap = -1

Flag determining whether a truck attributes are contained in map.

This flag is readonly

Referenced by toString(), and writeBundle().

◆ bTTSEnabled

int bTTSEnabled = -1

Selected sound is TTS.

Referenced by toString(), and writeBundle().

◆ bUseTruckAtt

int bUseTruckAtt = -1

Use truck attributes.

Referenced by toString(), and writeBundle().

◆ ClockFormat

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 toString(), and writeBundle().

◆ DistanceUnit

int DistanceUnit = -1

Flag determining distance units.

Notes:
Possible values are:

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

Referenced by toString(), and writeBundle().

◆ GPSUnits

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 toString(), and writeBundle().

◆ HomePosition

Position HomePosition = new Position(0, 0)

Referenced by toString(), and writeBundle().

◆ KeyboardType

int KeyboardType = -1

Flag determining keyboard type.

Notes:
Possible values are:

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

Referenced by toString(), and writeBundle().

◆ nAvoidTollRoads

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 toString(), and writeBundle().

◆ nETAMaximumSpeed

int nETAMaximumSpeed = -1

Estimate time arrival maximum speed.

Referenced by toString(), and writeBundle().

◆ nETAPercentageChange

int nETAPercentageChange = -1

Estimate time arrival percentage change.

Referenced by toString(), and writeBundle().

◆ nInvisiblePointReachDistance

int nInvisiblePointReachDistance = -1

Referenced by toString(), and writeBundle().

◆ nKingpinEndTrailer

int nKingpinEndTrailer = -1

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

Referenced by toString(), and writeBundle().

◆ nKingpinLastAxle

int nKingpinLastAxle = -1

Kingpin to last axle [mm].

Referenced by toString(), and writeBundle().

◆ nKingpinLastTandem

int nKingpinLastTandem = -1

Kingpin to middle of last tandem [mm].

Referenced by toString(), and writeBundle().

◆ nLoadRestrictions

int nLoadRestrictions = -1

HAZMAT / Load restrictions.

See also: LOAD_RESTRICTIONS

Referenced by toString(), and writeBundle().

◆ nPlanningSettings

int nPlanningSettings = -1

Flag determining what kind of route Navigation computes.

Notes:
Possible values are:

1 - Navigation computes fastest route.
2 - Navigation computes shortest route.
3 - Navigation computes economical route.

See also: nPlanningSettingsLimitedSpeed

Referenced by toString(), and writeBundle().

◆ nPlanningSettingsLimitedSpeed

int nPlanningSettingsLimitedSpeed = -1

Parameter determinig vehicle speed limit.

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

See also: nPlanningSettingsLimitedSpeed

Referenced by toString(), and writeBundle().

◆ nRadarDistance

int nRadarDistance = -1

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

Referenced by toString(), and writeBundle().

◆ nRadarDistanceInCity

int nRadarDistanceInCity = -1

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

Referenced by toString(), and writeBundle().

◆ nSignpostDirection

int nSignpostDirection = -1

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

Referenced by toString(), and writeBundle().

◆ nSignpostSize

int nSignpostSize = -1

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

Referenced by toString(), and writeBundle().

◆ nSkin

int nSkin = -1

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

Referenced by toString(), and writeBundle().

◆ nSpeedExceed

int nSpeedExceed = -100

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

Referenced by toString(), and writeBundle().

◆ nSpeedExceedInCity

int nSpeedExceedInCity = -100

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

Referenced by toString(), and writeBundle().

◆ nTimeZone

int nTimeZone = -1

Time zone in minutes.

This flag is readonly.

Referenced by toString(), and writeBundle().

◆ nTractorLength

int nTractorLength = -1

Tractor Length [mm].

Referenced by toString(), and writeBundle().

◆ nTrailerLength

int nTrailerLength = -1

Trailer Length [mm].

Referenced by toString(), and writeBundle().

◆ nTruckAxleLength

int nTruckAxleLength = -1

Extreme axle length [mm].

Referenced by toString(), and writeBundle().

◆ nTruckHeight

int nTruckHeight = -1

Posted height [mm].

Referenced by toString(), and writeBundle().

◆ nTruckLenght

int nTruckLenght = -1

Total vehicle length [mm].

Referenced by toString(), and writeBundle().

◆ nTruckMaxSpeed

int nTruckMaxSpeed = -1

Truck max speed [km/h].

Referenced by toString(), and writeBundle().

◆ nTruckOtherLength

int nTruckOtherLength = -1

Other length [mm].

Referenced by toString(), and writeBundle().

◆ nTruckOtherWeight

int nTruckOtherWeight = -1

Other weight [kg].

Referenced by toString(), and writeBundle().

◆ nTruckTandemWeight

int nTruckTandemWeight = -1

Tandem axle weight [kg].

Referenced by toString(), and writeBundle().

◆ nTruckTridemWeight

int nTruckTridemWeight = -1

Tridem axle weight [kg].

Referenced by toString(), and writeBundle().

◆ nTruckUnladenWeight

int nTruckUnladenWeight = -1

Unladen vehicle weight [kg].

Referenced by toString(), and writeBundle().

◆ nTruckWeightAxle

int nTruckWeightAxle = -1

Weight per axle [kg].

Referenced by toString(), and writeBundle().

◆ nTruckWeightTotal

int nTruckWeightTotal = -1

Gross vehicle weight [kg].

Referenced by toString(), and writeBundle().

◆ nTruckWidth

int nTruckWidth = -1

Vehicle width [mm].

Referenced by toString(), and writeBundle().

◆ nView

int nView = -1

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

Referenced by toString(), and writeBundle().

◆ nVisiblePointReachDistance

int nVisiblePointReachDistance = -1

Referenced by toString(), and writeBundle().

◆ nVolumeMax

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 toString(), and writeBundle().

◆ nVolumeMin

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 toString(), and writeBundle().

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Options()

Member Function Documentation

◆ getHomeLocation()

◆ getLanguage()

◆ getMaxSpeedSound()

◆ getVoice()

◆ getVoicePerson()

◆ readBundle()

◆ setHomeLocation()

◆ setLanguage()

◆ setMaxSpeedSound()

◆ setVoice()

◆ setVoicePerson()

◆ toString()

◆ writeBundle()

Member Data Documentation

◆ bAllowClosedRoads

◆ bAllowItineraryEdit

◆ bAvoidFerries

◆ bAvoidUTurns

◆ bDisableMainMenu

◆ bDisableRecompute

◆ bMaxSpeedWarn

◆ bOperateRightHanded

◆ bRadarsVisible

◆ bRadarsWarnOn

◆ bSnapToEveryRoad

◆ bSoundEnabled

◆ bTruckInMap

◆ bTTSEnabled

◆ bUseTruckAtt

◆ ClockFormat

◆ DistanceUnit

◆ GPSUnits

◆ HomePosition

◆ KeyboardType

◆ nAvoidTollRoads

◆ nETAMaximumSpeed

◆ nETAPercentageChange

◆ nInvisiblePointReachDistance

◆ nKingpinEndTrailer

◆ nKingpinLastAxle

◆ nKingpinLastTandem

◆ nLoadRestrictions

◆ nPlanningSettings

◆ nPlanningSettingsLimitedSpeed

◆ nRadarDistance

◆ nRadarDistanceInCity

◆ nSignpostDirection

◆ nSignpostSize

◆ nSkin

◆ nSpeedExceed

◆ nSpeedExceedInCity

◆ nTimeZone

◆ nTractorLength

◆ nTrailerLength

◆ nTruckAxleLength

◆ nTruckHeight

◆ nTruckLenght

◆ nTruckMaxSpeed

◆ nTruckOtherLength

◆ nTruckOtherWeight

◆ nTruckTandemWeight

◆ nTruckTridemWeight

◆ nTruckUnladenWeight

◆ nTruckWeightAxle

◆ nTruckWeightTotal

◆ nTruckWidth

◆ nView

◆ nVisiblePointReachDistance

◆ nVolumeMax

◆ nVolumeMin