summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
author <philippe colliot>2015-11-23 10:40:12 +0100
committer <philippe colliot>2015-11-23 10:40:12 +0100
commitd67268f037737e63a831419290f51505f39dfdfb (patch)
treed545bbc3bfa0412c5291cd72d923e3c26f30a500 /api
parent79c9942e550e855b810f9128520c4f2571f6f44d (diff)
downloadpoi-service-d67268f037737e63a831419290f51505f39dfdfb.tar.gz
some improvements of the build scripts
Diffstat (limited to 'api')
-rw-r--r--api/franca/navigation/NavigationSettings.fidl110
-rw-r--r--[-rwxr-xr-x]api/franca/navigation/NavigationTypes.fidl76
-rw-r--r--[-rwxr-xr-x]api/franca/navigation/navigationcore/LocationInput.fidl43
-rw-r--r--[-rwxr-xr-x]api/franca/navigation/poiservice/POISearch.fidl2
-rw-r--r--[-rwxr-xr-x]api/franca/navigation/poiservice/POIServiceTypes.fidl11
5 files changed, 197 insertions, 45 deletions
diff --git a/api/franca/navigation/NavigationSettings.fidl b/api/franca/navigation/NavigationSettings.fidl
new file mode 100644
index 0000000..287a9e0
--- /dev/null
+++ b/api/franca/navigation/NavigationSettings.fidl
@@ -0,0 +1,110 @@
+/*
+SPDX-License-Identifier: MPL-2.0
+Copyright (C) 2015-2016, 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, Harman-Becker 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
+
+import org.genivi.navigation.NavigationTypes.* from "NavigationTypes.fidl"
+
+
+<** @description : This interface offers methods that implement the configuration of the navigation core.**>
+interface NavigationSettings {
+ version {
+ major 0
+ minor 1
+ }
+
+ <** @description : This method returns the API version .**>
+ method getVersion {
+ out {
+ <** @description: .**>
+ Version ^version
+ }
+ }
+
+ <** @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)]**>
+ Locales[] 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
+ }
+ }
+
+/* to do: add units of measurements */
+} \ No newline at end of file
diff --git a/api/franca/navigation/NavigationTypes.fidl b/api/franca/navigation/NavigationTypes.fidl
index 0b3e176..7332a93 100755..100644
--- a/api/franca/navigation/NavigationTypes.fidl
+++ b/api/franca/navigation/NavigationTypes.fidl
@@ -22,6 +22,18 @@ typeCollection NavigationTypes {
typedef Handle is UInt32
+ typedef Timestamp is UInt64
+
+ typedef LinkId is ByteBuffer
+
+ <** @description: Handle to a location.
+ Range[0:0x7fffffff]
+ **>
+ typedef LocationHandle is Handle
+
+
+/* geometric types */
+
struct Coordinate2D {
Double latitude
Double longitude
@@ -31,16 +43,40 @@ typeCollection NavigationTypes {
Int32 altitude
}
+ struct Rectangle {
+ Coordinate2D topLeft
+ Coordinate2D bottomRight
+ }
+
array Polygon of Coordinate2D
typedef Area is Polygon
- struct Rectangle {
- Coordinate2D topLeft
- Coordinate2D bottomRight
+ <** @description: Kind of shapes. **>
+ enumeration ShapeType {
+ CIRCLE
+ RECTANGLE
+ POLYGON
+ }
+
+ <** @description: A radius in meters.
+ Range[0x0:0xffffffff]
+ **>
+ typedef Radius is UInt32
+
+ <** @description: A circle given as center and radius. **>
+ struct Circle {
+ <** @description : The center of the circle.**>
+ Coordinate2D center
+ <** @description : The radius of the circle.**>
+ Radius radius
}
-// for the time being, no use of extends for the enum, to be implemented later
+ typedef Distance is Double
+
+/* enumerations */
+
+// for the time being, no use of inheritance (extends) for the enumerations, to be implemented later
enumeration BasicEnum {
INVALID = 0
}
@@ -75,11 +111,29 @@ typeCollection NavigationTypes {
FOOT = 54
}
- typedef Timestamp is UInt64
-
- typedef Distance is Double
-
- typedef LinkId is ByteBuffer
-
- typedef Radius is UInt32
+ 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
+ }
+
+ struct Locales
+ {
+ <** @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
+ }
} \ No newline at end of file
diff --git a/api/franca/navigation/navigationcore/LocationInput.fidl b/api/franca/navigation/navigationcore/LocationInput.fidl
index 6cd9402..926f98e 100755..100644
--- a/api/franca/navigation/navigationcore/LocationInput.fidl
+++ b/api/franca/navigation/navigationcore/LocationInput.fidl
@@ -1,6 +1,6 @@
/*
SPDX-License-Identifier: MPL-2.0
-Copyright (C) 2014, PCA Peugeot Citron, 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
+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/.
@@ -46,10 +46,10 @@ interface LocationInput {
<**
@description : Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
}
error {
- NoMoreLocationInpuHandles
+ NoMoreLocationInputHandles
}
}
@@ -67,7 +67,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
}
}
@@ -94,7 +94,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
Address address
}
@@ -114,7 +114,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : selectionCriterion = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,ZIPCODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... )
@@ -137,7 +137,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : inputString = last input character (UTF-8) (0x08(Backspace) for delete last character, 0x0D(Carriage Return) for delete entire input)
@@ -165,7 +165,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : inputString = contains the String, that is searched
@@ -193,7 +193,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : offset = starting offset of the newly requested list elements
@@ -221,7 +221,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : index = absolute list index of the entry to be selected
@@ -239,7 +239,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : index = list index of the entry to be returned
@@ -265,7 +265,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
Address inputAddress
}
@@ -285,7 +285,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
Coordinate2D coordinate
}
@@ -300,7 +300,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : selectionCriterion = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,ZIPCODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... )
@@ -318,7 +318,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : statusValue = enum(INVALID,NOT_STARTED,SEARCHING,FINISHED, ... )
@@ -336,7 +336,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : uniqueString = unique string derived from spell input (i.e. including auto-completion if applicable)
@@ -364,7 +364,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : totalSize = total size of the result list
@@ -394,7 +394,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : totalSize = total size of the result list
@@ -412,7 +412,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
<**
@description : guidable = flag indicating whether the current address is guidable
@@ -434,7 +434,7 @@ interface LocationInput {
<**
@description : locationInpuHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value
**>
- Handle locationInpuHandle
+ LocationHandle locationInputHandle
Address [] validatedAddressList
@@ -442,7 +442,4 @@ interface LocationInput {
}
}
-
-
-
} \ No newline at end of file
diff --git a/api/franca/navigation/poiservice/POISearch.fidl b/api/franca/navigation/poiservice/POISearch.fidl
index a3fc54f..5566862 100755..100644
--- a/api/franca/navigation/poiservice/POISearch.fidl
+++ b/api/franca/navigation/poiservice/POISearch.fidl
@@ -101,7 +101,7 @@ interface POISearch {
}
}
- <** @description : GetCategoriesDetails = This method retrieves the details associated to one or more POI categories.
+ <** @description : This method retrieves the details associated to one or more POI categories.
It contains the name, the parent categories, the top level attribute, the list of attributes, the icons, ... .**>
method getCategoriesDetails {
in {
diff --git a/api/franca/navigation/poiservice/POIServiceTypes.fidl b/api/franca/navigation/poiservice/POIServiceTypes.fidl
index 01003c1..7968b58 100755..100644
--- a/api/franca/navigation/poiservice/POIServiceTypes.fidl
+++ b/api/franca/navigation/poiservice/POIServiceTypes.fidl
@@ -25,6 +25,7 @@ typeCollection POIServiceTypes {
<** @description:Unique ID for a POI Icon Resource**>
typedef ResourceID is UInt32
+ <** @description:Unique ID for an attribute**>
typedef AttributeID is UInt32
typedef ContentAccessModuleID is UInt8
@@ -373,14 +374,4 @@ typeCollection POIServiceTypes {
<** @description: array[struct(id,type,value)].**>
PoiAttribute[] attributes
}
-
- struct Locales
- {
- <** @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
- }
}