summaryrefslogtreecommitdiff
path: root/api/franca/navigation/poiservice/POIConfiguration.fidl
blob: 8582be2fa21d92f935a77933c80d4e770045fc3f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
// SPDX-License-Identifier: MPL-2.0
// Copyright (C) 2018, Groupe PSA, XS Embedded GmbH, TomTom International B.V., Continental Automotive GmbH, BMW Car IT GmbH,  Alpine Electronics R&D Europe GmbH, AISIN AW CO., LTD.,  Neusoft Technology Solutions GmbH, Jaguar Land Rover Limited, Visteon Corporation, Elektrobit Automotive GmbH
// This Source Code Form is subject to the terms of the
// Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
// this file, you can obtain one at http://mozilla.org/MPL/2.0/.

package org.genivi.navigation.poiservice

import org.genivi.CommonTypes.* from "../../CommonTypes.fidl"
import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"
import org.genivi.navigation.poiservice.POIServiceTypes.* from "POIServiceTypes.fidl"


<** @description : This interface offers methods that implement the POI configuration functionality of a navigation system.**>
interface POIConfiguration {
	version {
		major 2 
		minor 0
	}
		<**	@description : This method returns the API version .**>
	method getVersion {
		out {
			<** @description: .**>
			Version ^version				
		}	
	}		


    <** @description: Units of measurement**>
    enumeration UnitsOfMeasurementAttribute {
        INVALID 				= 0
        LENGTH 	= 49 //Base 0x0030
    }

	enumeration UnitsOfMeasurementValue {
		METER		= 50
		MILE		= 51
		KM			= 52
		YARD		= 53
		FOOT		= 54
	}

	array UnitsOfMeasurementListValue of UnitsOfMeasurementValue 

	map UnitsOfMeasurement {
		UnitsOfMeasurementAttribute to UnitsOfMeasurementValue
	}

	map UnitsOfMeasurementList {
		UnitsOfMeasurementAttribute to UnitsOfMeasurementListValue
	}
	
	enumeration Units {
		METER		= 50
		MILE		= 51
		KM			= 52
		YARD		= 53
		FOOT		= 54
	}

	enumeration TimeFormat {
		INVALID		= 0
		TWELVEH     = 1
		TWENTYFOURH	= 2
	}

	enumeration CoordinatesFormat {
		INVALID		= 0
		<** @description:DEGREES format = d.dº**>
		DEGREES     = 1
        <** @description:MINUTES format = dºm.m'**>		
		MINUTES		= 2
        <** @description:SECONDS format = dºm's"**>
		SECONDS		= 3
	}
	
	<**	@description : Set the current language set. If the language is not supported, the default details will be returned in the native language.**>
	method setLocale {
		in {
			<** @description : the language to be used. ISO 639-3 language code (lower case)**>
			String languageCode				
			<** @description : the country specific variant for the language to be used. ISO 3166-1 alpha 3 country code (upper case)**>
			String countryCode				
			<** @description : the script specific variant for the language to be used. ISO 15924 alpha 4 script code (upper case)**>
			String scriptCode				
		}	
	}	

	<**	@description : Get the current language set .**>
	method getLocale {
		out {
			<** @description : the language used. ISO 639-3 language code (lower case)**>
			String languageCode				
			<** @description : the country specific variant for the language used. ISO 3166-1 alpha 3 country code (upper case)**>
			String countryCode				
			<** @description : the script specific variant for the language used. ISO 15924 alpha 4 script code (upper case)**>
			String scriptCode				
		}	
	}	

	<**	@description : Get the supported set of locales .**>
	method getSupportedLocales {
		out {
			<** @description : array[struct(languageCode,countryCode,scriptCode)]**>
			Locale[] localeList				
		}	
	}	

	<**	@description : Set the time format.**>
	method setTimeFormat {
		in {
			<** @description : timeFormat = enum(INVALID,12H,24H, ... ). **>
			TimeFormat format				
		}	
	}	

	<**	@description : Get the current time format .**>
	method getTimeFormat {
		out {
			<** @description : timeFormat = enum(INVALID,12H,24H, ... ). **>
			TimeFormat format				
		}	
	}	

	<**	@description : Get the supported set of time format .**>
	method getSupportedTimeFormats {
		out {
			<** @description : timeFormatList = array[timeFormat] .**>
			TimeFormat[] timeFormatList				
		}	
	}	

	<**	@description : Set the coordinates format.**>
	method setCoordinatesFormat {
		in {
			<** @description : coordinatesFormat = enum(INVALID,DEGREES,MINUTES,SECONDS, ... )**>
			CoordinatesFormat coordinatesFormat				
		}	
	}	

	<**	@description : Get the coordinates format .**>
	method getCoordinatesFormat {
		out {
			<** @description : coordinatesFormat = enum(INVALID,DEGREES,MINUTES,SECONDS, ... )**>
			CoordinatesFormat coordinatesFormat				
		}	
	}	

	<**	@description : Get the supported set of coordinates format .**>
	method getSupportedCoordinatesFormat {
		out {
			<** @description : array[struct(languageCode,countryCode,scriptCode)]**>
			CoordinatesFormat[] coordinatesFormatList				
		}	
	}	

	<**	@description : Set the units of measurement .**>
	method setUnitsOfMeasurement {
		in {
			<** @description : unitsOfMeasurementList = array[unitsOfMeasurement]**>
			UnitsOfMeasurement unitsOfMeasurementList				
		}	
	}	

	<**	@description : Get the units of measurement .**>
	method getUnitsOfMeasurement {
		out {
			<** @description : unitsOfMeasurementList = array[unitsOfMeasurement]**>
			UnitsOfMeasurement unitsOfMeasurementList				
		}	
	}	

	<**	@description : Get the supported set of units of measurement .**>
	method getSupportedUnitsOfMeasurement {
		out {
			<** @description : unitsOfMeasurementList = array[unitsOfMeasurement]**>
			UnitsOfMeasurementList unitsOfMeasurementList				
		}	
	}	

	<**
		@description : ConfigurationChanged = This signal is sent to the clients when one or more configuration settings changes
	**>
	broadcast configurationChanged {
		out {

			<**
				@description : changedSettings = array[setting]
			**>
			Settings[] changedSettings
		}
	}
	
}