summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author <philippe colliot>2015-12-15 12:13:36 +0100
committer <philippe colliot>2015-12-15 12:13:36 +0100
commitbc339c3e5cec7da6568afd331227d3263d918b26 (patch)
treed84db1f9fb9c9f10d4e72063e7c9fdd44326c1ad
parent4ffde4fb9eab651f5cc99882c586db992b5b4d8b (diff)
downloadpoi-service-bc339c3e5cec7da6568afd331227d3263d918b26.tar.gz
Add missing fidl configuration files
-rw-r--r--api/franca/navigation/mapviewer/MapViewerConfiguration.fidl191
-rw-r--r--api/franca/navigation/navigationcore/NavigationCoreConfiguration.fidl191
-rw-r--r--api/franca/navigation/poiservice/POIConfiguration.fidl192
-rw-r--r--api/franca/navigation/poiservice/POISearch.fidl24
4 files changed, 575 insertions, 23 deletions
diff --git a/api/franca/navigation/mapviewer/MapViewerConfiguration.fidl b/api/franca/navigation/mapviewer/MapViewerConfiguration.fidl
new file mode 100644
index 0000000..0e8a0c7
--- /dev/null
+++ b/api/franca/navigation/mapviewer/MapViewerConfiguration.fidl
@@ -0,0 +1,191 @@
+// SPDX-License-Identifier: MPL-2.0
+// Copyright (C) 2014, PCA Peugeot Citro�n, 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.navigationcore
+
+import org.genivi.CommonTypes.* from "../../CommonTypes.fidl"
+import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"
+
+
+<** @description : This interface offers methods that implement the map viewer configuration functionality of a navigation system.**>
+interface MapViewerConfiguration {
+ version {
+ major 0
+ minor 1
+ }
+ <** @description : This method returns the API version .**>
+ method getVersion {
+ out {
+ <** @description: .**>
+ Version ^version
+ }
+ }
+ <** @description: Settings**>
+ enumeration Settings {
+ INVALID = 0
+ UNITS_OF_MEASUREMENT = 48 //Base 0x0030
+ LOCALE = 37
+ TIME_FORMAT = 3
+ COORDINATES_FORMAT = 6
+ }
+
+ <** @description: Units of measurement**>
+ enumeration UnitsOfMeasurementAttribute {
+ INVALID = 0
+ LENGTH = 49 //Base 0x0030
+ }
+
+ union UnitsOfMeasurementValue {
+ Int32 intValue
+ Double doubleValue
+ }
+
+ map UnitsOfMeasurement {
+ UnitsOfMeasurementAttribute to UnitsOfMeasurementValue
+ }
+
+ 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]**>
+ UnitsOfMeasurement 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
+ }
+ }
+
+} \ No newline at end of file
diff --git a/api/franca/navigation/navigationcore/NavigationCoreConfiguration.fidl b/api/franca/navigation/navigationcore/NavigationCoreConfiguration.fidl
new file mode 100644
index 0000000..21221dd
--- /dev/null
+++ b/api/franca/navigation/navigationcore/NavigationCoreConfiguration.fidl
@@ -0,0 +1,191 @@
+// SPDX-License-Identifier: MPL-2.0
+// Copyright (C) 2014, PCA Peugeot Citro�n, 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.navigationcore
+
+import org.genivi.CommonTypes.* from "../../CommonTypes.fidl"
+import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"
+
+
+<** @description : This interface offers methods that implement the navigation core configuration functionality of a navigation system.**>
+interface NavigationCoreConfiguration {
+ version {
+ major 0
+ minor 1
+ }
+ <** @description : This method returns the API version .**>
+ method getVersion {
+ out {
+ <** @description: .**>
+ Version ^version
+ }
+ }
+ <** @description: Settings**>
+ enumeration Settings {
+ INVALID = 0
+ UNITS_OF_MEASUREMENT = 48 //Base 0x0030
+ LOCALE = 37
+ TIME_FORMAT = 3
+ COORDINATES_FORMAT = 6
+ }
+
+ <** @description: Units of measurement**>
+ enumeration UnitsOfMeasurementAttribute {
+ INVALID = 0
+ LENGTH = 49 //Base 0x0030
+ }
+
+ union UnitsOfMeasurementValue {
+ Int32 intValue
+ Double doubleValue
+ }
+
+ map UnitsOfMeasurement {
+ UnitsOfMeasurementAttribute to UnitsOfMeasurementValue
+ }
+
+ 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]**>
+ UnitsOfMeasurement 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
+ }
+ }
+
+} \ No newline at end of file
diff --git a/api/franca/navigation/poiservice/POIConfiguration.fidl b/api/franca/navigation/poiservice/POIConfiguration.fidl
new file mode 100644
index 0000000..acbe5b9
--- /dev/null
+++ b/api/franca/navigation/poiservice/POIConfiguration.fidl
@@ -0,0 +1,192 @@
+// SPDX-License-Identifier: MPL-2.0
+// Copyright (C) 2014, PCA Peugeot Citro�n, 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 0
+ minor 1
+ }
+ <** @description : This method returns the API version .**>
+ method getVersion {
+ out {
+ <** @description: .**>
+ Version ^version
+ }
+ }
+ <** @description: Settings**>
+ enumeration Settings {
+ INVALID = 0
+ UNITS_OF_MEASUREMENT = 48 //Base 0x0030
+ LOCALE = 37
+ TIME_FORMAT = 3
+ COORDINATES_FORMAT = 6
+ }
+
+ <** @description: Units of measurement**>
+ enumeration UnitsOfMeasurementAttribute {
+ INVALID = 0
+ LENGTH = 49 //Base 0x0030
+ }
+
+ union UnitsOfMeasurementValue {
+ Int32 intValue
+ Double doubleValue
+ }
+
+ map UnitsOfMeasurement {
+ UnitsOfMeasurementAttribute to UnitsOfMeasurementValue
+ }
+
+ 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]**>
+ UnitsOfMeasurement 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
+ }
+ }
+
+} \ No newline at end of file
diff --git a/api/franca/navigation/poiservice/POISearch.fidl b/api/franca/navigation/poiservice/POISearch.fidl
index 11dbe2b..e7ecbdf 100644
--- a/api/franca/navigation/poiservice/POISearch.fidl
+++ b/api/franca/navigation/poiservice/POISearch.fidl
@@ -24,29 +24,7 @@ interface POISearch {
Version ^version
}
}
-
- <** @description : Get the current language set for the search.
- The language defines the poi and categories name and details language. If the language is not supported, the default details will be returned in the native language. **>
- method getLanguage {
- out {
- <** @description : The language.**>
- String languageCode
- <** @description : The country specific variant for the language.**>
- String countryCode
- }
- }
-
- <** @description : Set the language.
- The language defines the poi and categories name and details language. If the language is not supported, the default details will be returned in the native language.**>
- method setLanguage {
- in {
- <** @description : The language to be used.**>
- String languageCode
- <** @description : The country specific variant for the language to be used.**>
- String countryCode
- }
- }
-
+
<** @description : This method allows the application to validate that POI categories are supported by the POI component and the Content access modules.**>
method validateCategories {
in {