summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
author <philippe colliot>2015-02-24 16:49:18 +0100
committer <philippe colliot>2015-02-24 16:49:18 +0100
commitcfa3066da6befc35b9d9b817ec6e9f345cad85e7 (patch)
treea30ee6e93d38b4a5118de872c0c8db04fb36318d /api
parent69776d11b24630fec1f0c0bba77c7d9eb757f51e (diff)
downloadpoi-service-cfa3066da6befc35b9d9b817ec6e9f345cad85e7.tar.gz
[GT-3126] Make franca interfaces compliant to GENIVI guidelines
Diffstat (limited to 'api')
-rw-r--r--api/franca/.gitignore1
-rwxr-xr-xapi/franca/navigation/NavigationTypes.fidl6
-rwxr-xr-xapi/franca/navigation/mapviewer/MapViewerControl.fidl294
-rwxr-xr-xapi/franca/navigation/mapviewer/MapViewerControlTypes.fidl106
-rwxr-xr-xapi/franca/navigation/navigationcore/Guidance.fidl86
-rwxr-xr-xapi/franca/navigation/navigationcore/LocationInput.fidl82
-rwxr-xr-xapi/franca/navigation/navigationcore/LocationInputTypes.fidl15
-rwxr-xr-xapi/franca/navigation/navigationcore/MapMatchedPosition.fidl84
-rwxr-xr-xapi/franca/navigation/navigationcore/Routing.fidl110
-rwxr-xr-xapi/franca/navigation/poiservice/ContentAccessModule.fidl34
-rwxr-xr-xapi/franca/navigation/poiservice/POISearch.fidl112
-rwxr-xr-xapi/franca/navigation/poiservice/POIServiceTypes.fidl235
-rwxr-xr-xapi/franca/navigation/poiservice/ServiceContentAccess.fidl24
13 files changed, 671 insertions, 518 deletions
diff --git a/api/franca/.gitignore b/api/franca/.gitignore
new file mode 100644
index 0000000..6722cd9
--- /dev/null
+++ b/api/franca/.gitignore
@@ -0,0 +1 @@
+*.xml
diff --git a/api/franca/navigation/NavigationTypes.fidl b/api/franca/navigation/NavigationTypes.fidl
index 4154c98..c5d036f 100755
--- a/api/franca/navigation/NavigationTypes.fidl
+++ b/api/franca/navigation/NavigationTypes.fidl
@@ -11,11 +11,11 @@ typeCollection NavigationTypes {
<** @description: version.**>
struct Version {
<** @description : when the major changes, then backward compatibility with previous releases is not granted.**>
- UInt16 ^major
+ UInt16 ^versionMajor
<** @description : when the minor changes, then backward compatibility with previous releases is granted, but something changed in the implementation of the API (e.g. new methods may have been added).**>
- UInt16 ^minor
+ UInt16 ^versionMinor
<** @description : when the micro changes, then backward compatibility with previous releases is granted (bug fixes or documentation modifications).**>
- UInt16 ^micro
+ UInt16 ^versionMicro
<** @description : release date (e.g. 21-06-2011).**>
String date
}
diff --git a/api/franca/navigation/mapviewer/MapViewerControl.fidl b/api/franca/navigation/mapviewer/MapViewerControl.fidl
index 1a8f216..f94d599 100755
--- a/api/franca/navigation/mapviewer/MapViewerControl.fidl
+++ b/api/franca/navigation/mapviewer/MapViewerControl.fidl
@@ -13,25 +13,25 @@ import org.genivi.navigation.navigationcore.MapViewerControlTypes.* from "MapVie
@description : MapViewerControl = This interface offers functions to control the MapViewer
**>
-interface org.genivi.mapviewer.MapViewerControl {
+interface MapViewerControl {
version {
major 0
minor 0
}
<**
- @description : GetVersion = This method returns the API version implemented by the server application
+ @description : getVersion = This method returns the API version implemented by the server application
**>
- method GetVersion {
+ method getVersion {
out {
Version ^version
}
}
<**
- @description : CreateMapViewInstance = This method creates a new map instance
+ @description : createMapViewInstance = This method creates a new map instance
**>
- method CreateMapViewInstance {
+ method createMapViewInstance {
in {
<**
@@ -56,9 +56,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : ReleaseMapViewInstance = This method releases (i.e. destroys) a given map instance. Only invisible map instances can be released
+ @description : releaseMapViewInstance = This method releases (i.e. destroys) a given map instance. Only invisible map instances can be released
**>
- method ReleaseMapViewInstance {
+ method releaseMapViewInstance {
in {
<**
@@ -74,9 +74,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetMapViewType = This method returns the map type of a map instance as it was set using CreateMapViewInstance
+ @description : getMapViewType = This method returns the map type of a map instance as it was set using CreateMapViewInstance
**>
- method GetMapViewType {
+ method getMapViewType {
in {
<**
@@ -94,18 +94,18 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetSupportedMapViewTypes = This method retrieves the supported map view types
+ @description : getSupportedMapViewTypes = This method retrieves the supported map view types
**>
- method GetSupportedMapViewTypes {
+ method getSupportedMapViewTypes {
out {
MapViewType [] mapViewTypeList
}
}
<**
- @description : SetTargetPoint = This method sets the position of the point the camera is always aimed at
+ @description : setTargetPoint = This method sets the position of the point the camera is always aimed at
**>
- method SetTargetPoint {
+ method setTargetPoint {
in {
<**
@@ -123,9 +123,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetTargetPoint = This method retrieves the target point position
+ @description : getTargetPoint = This method retrieves the target point position
**>
- method GetTargetPoint {
+ method getTargetPoint {
in {
<**
@@ -139,9 +139,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetFollowCarMode = This method sets the FollowCar mode
+ @description : setFollowCarMode = This method sets the FollowCar mode
**>
- method SetFollowCarMode {
+ method setFollowCarMode {
in {
<**
@@ -162,9 +162,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetFollowCarMode = This method returns the current FollowCar-mode
+ @description : getFollowCarMode = This method returns the current FollowCar-mode
**>
- method GetFollowCarMode {
+ method getFollowCarMode {
in {
<**
@@ -182,9 +182,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetCameraPosition = This method sets the coordinates of the point at which the camera must be positioned
+ @description : setCameraPosition = This method sets the coordinates of the point at which the camera must be positioned
**>
- method SetCameraPosition {
+ method setCameraPosition {
in {
<**
@@ -202,9 +202,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetCameraPosition = This method returns the coordinates of the point at which the camera is positioned
+ @description : getCameraPosition = This method returns the coordinates of the point at which the camera is positioned
**>
- method GetCameraPosition {
+ method getCameraPosition {
in {
<**
@@ -218,9 +218,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetCameraHeadingAngle = This method sets the map view heading angle
+ @description : setCameraHeadingAngle = This method sets the map view heading angle
**>
- method SetCameraHeadingAngle {
+ method setCameraHeadingAngle {
in {
<**
@@ -241,9 +241,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetCameraHeadingToTarget = This method sets the camera heading in such a way, that the camera always looks at a given target
+ @description : setCameraHeadingToTarget = This method sets the camera heading in such a way, that the camera always looks at a given target
**>
- method SetCameraHeadingToTarget {
+ method setCameraHeadingToTarget {
in {
<**
@@ -261,9 +261,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetCameraHeadingTrackUp = This method sets the camera heading in such a way, that the camera always looks in the direction in which the car is moving
+ @description : setCameraHeadingTrackUp = This method sets the camera heading in such a way, that the camera always looks in the direction in which the car is moving
**>
- method SetCameraHeadingTrackUp {
+ method setCameraHeadingTrackUp {
in {
<**
@@ -279,9 +279,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetCameraHeading = This method returns the current camera heading
+ @description : getCameraHeading = This method returns the current camera heading
**>
- method GetCameraHeading {
+ method getCameraHeading {
in {
<**
@@ -306,9 +306,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetCameraTiltAngle = This method sets the camera tilt angle
+ @description : setCameraTiltAngle = This method sets the camera tilt angle
**>
- method SetCameraTiltAngle {
+ method setCameraTiltAngle {
in {
<**
@@ -329,9 +329,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetMapViewTiltAngle = This method returns the camera tilt angle
+ @description : getMapViewTiltAngle = This method returns the camera tilt angle
**>
- method GetCameraTiltAngle {
+ method getCameraTiltAngle {
in {
<**
@@ -349,9 +349,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetCameraRollAngle = This method sets the camera roll angle
+ @description : setCameraRollAngle = This method sets the camera roll angle
**>
- method SetCameraRollAngle {
+ method setCameraRollAngle {
in {
<**
@@ -372,9 +372,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetCameraRollAngle = This method returns the camera roll angle
+ @description : getCameraRollAngle = This method returns the camera roll angle
**>
- method GetCameraRollAngle {
+ method getCameraRollAngle {
in {
<**
@@ -392,9 +392,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetCameraDistanceFromTargetPoint = This method sets the mode and the camera distance from the target point
+ @description : setCameraDistanceFromTargetPoint = This method sets the mode and the camera distance from the target point
**>
- method SetCameraDistanceFromTargetPoint {
+ method setCameraDistanceFromTargetPoint {
in {
<**
@@ -415,9 +415,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetCameraDistanceFromTargetPoint = This method gets the mode and the camera distance from the target point
+ @description : getCameraDistanceFromTargetPoint = This method gets the mode and the camera distance from the target point
**>
- method GetCameraDistanceFromTargetPoint {
+ method getCameraDistanceFromTargetPoint {
in {
<**
@@ -435,9 +435,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetMapViewScaleMode = This method sets the scaling mode.
+ @description : setMapViewScaleMode = This method sets the scaling mode.
**>
- method SetMapViewScaleMode {
+ method setMapViewScaleMode {
in {
<**
@@ -458,9 +458,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetMapViewScaleMode = This method gets the scaling mode.
+ @description : getMapViewScaleMode = This method gets the scaling mode.
**>
- method GetMapViewScaleMode {
+ method getMapViewScaleMode {
in {
<**
@@ -478,9 +478,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetSupportedMapViewScaleModes = This method gets the supported scaling modes.
+ @description : getSupportedMapViewScaleModes = This method gets the supported scaling modes.
**>
- method GetSupportedMapViewScaleModes {
+ method getSupportedMapViewScaleModes {
in {
<**
@@ -494,21 +494,21 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : AddMapViewScaleChangedListener = This method adds a listener which is notified when map view scale changes.
+ @description : addMapViewScaleChangedListener = This method adds a listener which is notified when map view scale changes.
**>
- method AddMapViewScaleChangedListener {
+ method addMapViewScaleChangedListener {
}
<**
- @description : RemoveMapViewScaleChangedListener = This method removes a listener which is notified when map view scale changes.
+ @description : removeMapViewScaleChangedListener = This method removes a listener which is notified when map view scale changes.
**>
- method RemoveMapViewScaleChangedListener {
+ method removeMapViewScaleChangedListener {
}
<**
- @description : SetCameraHeight = This method sets the camera height
+ @description : setCameraHeight = This method sets the camera height
**>
- method SetCameraHeight {
+ method setCameraHeight {
in {
<**
@@ -529,9 +529,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetCameraHeight = This method gets the camera height
+ @description : getCameraHeight = This method gets the camera height
**>
- method GetCameraHeight {
+ method getCameraHeight {
in {
<**
@@ -549,9 +549,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetMapViewPerspective = This method sets the map perspective
+ @description : setMapViewPerspective = This method sets the map perspective
**>
- method SetMapViewPerspective {
+ method setMapViewPerspective {
in {
<**
@@ -572,9 +572,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetMapViewPerspective = This method returns the current map perspective
+ @description : getMapViewPerspective = This method returns the current map perspective
**>
- method GetMapViewPerspective {
+ method getMapViewPerspective {
in {
<**
@@ -592,18 +592,18 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetSupportedMapViewPerspectives = This method retrieves the supported mapview perspectives
+ @description : getSupportedMapViewPerspectives = This method retrieves the supported mapview perspectives
**>
- method GetSupportedMapViewPerspectives {
+ method getSupportedMapViewPerspectives {
out {
MapPerspective[] perspectiveList
}
}
<**
- @description : SetMapViewObjectVisibility = This method specifies the type of objects to show on the map.
+ @description : setMapViewObjectVisibility = This method specifies the type of objects to show on the map.
**>
- method SetMapViewObjectVisibility {
+ method setMapViewObjectVisibility {
in {
<**
@@ -621,9 +621,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetMapViewObjectVisibility = This method gets the type of objects shown on the map.
+ @description : getMapViewObjectVisibility = This method gets the type of objects shown on the map.
**>
- method GetMapViewObjectVisibility {
+ method getMapViewObjectVisibility {
in {
<**
@@ -637,9 +637,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetSupportedMapViewObjectVisibilities = This method gets the supported object visibilities.
+ @description : getSupportedMapViewObjectVisibilities = This method gets the supported object visibilities.
**>
- method GetSupportedMapViewObjectVisibilities {
+ method getSupportedMapViewObjectVisibilities {
in {
<**
@@ -653,9 +653,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetScaleList = This method returns a list of supported map scales
+ @description : getScaleList = This method returns a list of supported map scales
**>
- method GetScaleList {
+ method getScaleList {
in {
<**
@@ -669,9 +669,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetMapViewScale = This method sets the map scale by specifying a ScaleID
+ @description : setMapViewScale = This method sets the map scale by specifying a ScaleID
**>
- method SetMapViewScale {
+ method setMapViewScale {
in {
<**
@@ -692,9 +692,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetMapViewScaleByDelta = This method sets the map scale by specifying a delta value with respect to the currently set ScaleID
+ @description : setMapViewScaleByDelta = This method sets the map scale by specifying a delta value with respect to the currently set ScaleID
**>
- method SetMapViewScaleByDelta {
+ method setMapViewScaleByDelta {
in {
<**
@@ -715,9 +715,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetMapViewScaleByMetersPerPixel = This method sets the map scale by specifying the number of meters that a pixel represents
+ @description : setMapViewScaleByMetersPerPixel = This method sets the map scale by specifying the number of meters that a pixel represents
**>
- method SetMapViewScaleByMetersPerPixel {
+ method setMapViewScaleByMetersPerPixel {
in {
<**
@@ -738,9 +738,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetMapViewScale = This method returns the currently used map scale
+ @description : getMapViewScale = This method returns the currently used map scale
**>
- method GetMapViewScale {
+ method getMapViewScale {
in {
<**
@@ -763,9 +763,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetMapViewBoundingBox = This method sets the map bounding box
+ @description : setMapViewBoundingBox = This method sets the map bounding box
**>
- method SetMapViewBoundingBox {
+ method setMapViewBoundingBox {
in {
<**
@@ -783,9 +783,9 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : GetMapViewBoundingBox = This method returns the bounding box of a given map instance
+ @description : getMapViewBoundingBox = This method returns the bounding box of a given map instance
**>
- method GetMapViewBoundingBox {
+ method getMapViewBoundingBox {
in {
<**
@@ -799,10 +799,10 @@ interface org.genivi.mapviewer.MapViewerControl {
}
<**
- @description : SetMapViewSaveArea = This methods defines the area that the HMI guarantees not to
+ @description : setMapViewSaveArea = This methods defines the area that the HMI guarantees not to
cover with other windows or user interface elements
**>
- method SetMapViewSaveArea {
+ method setMapViewSaveArea {
in {
<**
@@ -820,10 +820,10 @@ cover with other windows or user interface elements
}
<**
- @description : SetMapViewSaveArea = This methods defines the area that the HMI guarantees not to
+ @description : setMapViewSaveArea = This methods defines the area that the HMI guarantees not to
cover with other windows or user interface elements
**>
- method GetMapViewSaveArea {
+ method getMapViewSaveArea {
in {
<**
@@ -837,9 +837,9 @@ cover with other windows or user interface elements
}
<**
- @description : SetMapViewPan = This method pans a given map instance
+ @description : setMapViewPan = This method pans a given map instance
**>
- method SetMapViewPan {
+ method setMapViewPan {
in {
<**
@@ -862,9 +862,9 @@ cover with other windows or user interface elements
}
<**
- @description : GetMapViewPan
+ @description : getMapViewPan
**>
- method GetMapViewPan {
+ method getMapViewPan {
in {
<**
@@ -882,9 +882,9 @@ cover with other windows or user interface elements
}
<**
- @description : SetMapViewRotation = This method rotates the map
+ @description : setMapViewRotation = This method rotates the map
**>
- method SetMapViewRotation {
+ method setMapViewRotation {
in {
<**
@@ -910,9 +910,9 @@ cover with other windows or user interface elements
}
<**
- @description : GetMapViewRotation = This method is particularly interesting for debugging purposes
+ @description : getMapViewRotation = This method is particularly interesting for debugging purposes
**>
- method GetMapViewRotation {
+ method getMapViewRotation {
in {
<**
@@ -935,9 +935,9 @@ cover with other windows or user interface elements
}
<**
- @description : SetMapViewVisibilityMode = This method sets the current visibility mode
+ @description : setMapViewVisibilityMode = This method sets the current visibility mode
**>
- method SetMapViewVisibilityMode {
+ method setMapViewVisibilityMode {
in {
<**
@@ -958,9 +958,9 @@ cover with other windows or user interface elements
}
<**
- @description : GetMapViewVisibilityMode = This method returns the current visibility mode
+ @description : getMapViewVisibilityMode = This method returns the current visibility mode
**>
- method GetMapViewVisibilityMode {
+ method getMapViewVisibilityMode {
in {
<**
@@ -978,18 +978,18 @@ cover with other windows or user interface elements
}
<**
- @description : GetSupportedMapViewVisibilityModes = This method retrieves the supported mapview visibility modes
+ @description : getSupportedMapViewVisibilityModes = This method retrieves the supported mapview visibility modes
**>
- method GetSupportedMapViewVisibilityModes {
+ method getSupportedMapViewVisibilityModes {
out {
Visibility [] visibilityModeList
}
}
<**
- @description : SetMapViewPerformanceLevel = This method sets the perfomance level of a given map instance
+ @description : setMapViewPerformanceLevel = This method sets the perfomance level of a given map instance
**>
- method SetMapViewPerformanceLevel {
+ method setMapViewPerformanceLevel {
in {
<**
@@ -1010,9 +1010,9 @@ cover with other windows or user interface elements
}
<**
- @description : GetMapViewPerformanceLevel = This method returns the perfomance level of a given map instance
+ @description : getMapViewPerformanceLevel = This method returns the perfomance level of a given map instance
**>
- method GetMapViewPerformanceLevel {
+ method getMapViewPerformanceLevel {
in {
<**
@@ -1030,18 +1030,18 @@ cover with other windows or user interface elements
}
<**
- @description : GetSupportedMapViewPerformanceLevels = This method retrieves the supported perfomance levels
+ @description : getSupportedMapViewPerformanceLevels = This method retrieves the supported perfomance levels
**>
- method GetSupportedMapViewPerformanceLevels {
+ method getSupportedMapViewPerformanceLevels {
out {
Level [] performanceLevelList
}
}
<**
- @description : DisplayRoute = This method visualizes one of the calculated routes
+ @description : displayRoute = This method visualizes one of the calculated routes
**>
- method DisplayRoute {
+ method displayRoute {
in {
<**
@@ -1067,9 +1067,9 @@ cover with other windows or user interface elements
}
<**
- @description : HideRoute = This method hides one of the visible routes
+ @description : hideRoute = This method hides one of the visible routes
**>
- method HideRoute {
+ method hideRoute {
in {
<**
@@ -1090,9 +1090,9 @@ cover with other windows or user interface elements
}
<**
- @description : GetDisplayedRoutes = This method returns a list of displayed routes
+ @description : getDisplayedRoutes = This method returns a list of displayed routes
**>
- method GetDisplayedRoutes {
+ method getDisplayedRoutes {
in {
<**
@@ -1106,9 +1106,9 @@ cover with other windows or user interface elements
}
<**
- @description : GetPoiCategoriesVisible = Get the set of POI categories displayed on the map.
+ @description : getPoiCategoriesVisible = Get the set of POI categories displayed on the map.
**>
- method GetPoiCategoriesVisible {
+ method getPoiCategoriesVisible {
in {
<**
@@ -1122,10 +1122,10 @@ cover with other windows or user interface elements
}
<**
- @description : SetPoiCategoriesVisible = Add POI categories to the set of POI categories displayed on the map.
+ @description : setPoiCategoriesVisible = Add POI categories to the set of POI categories displayed on the map.
Any specified category that until now was displayed with scale limits is now displayed without limits.
**>
- method SetPoiCategoriesVisible {
+ method setPoiCategoriesVisible {
in {
<**
@@ -1142,10 +1142,10 @@ cover with other windows or user interface elements
}
<**
- @description : SetPoiCategoriesVisible = Add POI categories to the set of POI categories displayed on the map, where the POI's are only displayed in a specific range of scales.
+ @description : setPoiCategoriesVisible = Add POI categories to the set of POI categories displayed on the map, where the POI's are only displayed in a specific range of scales.
Any specified category that until now was displayed without scale limits is now displayed with limits.
**>
- method SetPoiCategoriesVisibleWithinLimits {
+ method setPoiCategoriesVisibleWithinLimits {
in {
<**
@@ -1172,9 +1172,9 @@ cover with other windows or user interface elements
}
<**
- @description : SetPoiCategoriesNotVisible = Remove POI categories from the set of POI categories displayed on the map.
+ @description : setPoiCategoriesNotVisible = Remove POI categories from the set of POI categories displayed on the map.
**>
- method SetPoiCategoriesNotVisible {
+ method setPoiCategoriesNotVisible {
in {
<**
@@ -1191,9 +1191,9 @@ cover with other windows or user interface elements
}
<**
- @description : SetTrafficIncidentsVisibility = Set the visibility of Traffic Incidents on the map.
+ @description : setTrafficIncidentsVisibility = Set the visibility of Traffic Incidents on the map.
**>
- method SetTrafficIncidentsVisibility {
+ method setTrafficIncidentsVisibility {
in {
<**
@@ -1214,9 +1214,9 @@ cover with other windows or user interface elements
}
<**
- @description : SetMapViewTheme = This method configures the theme of a given map view instance
+ @description : setMapViewTheme = This method configures the theme of a given map view instance
**>
- method SetMapViewTheme {
+ method setMapViewTheme {
in {
<**
@@ -1237,9 +1237,9 @@ cover with other windows or user interface elements
}
<**
- @description : GetMapViewTheme = This method returns the current theme of a given map view instance
+ @description : getMapViewTheme = This method returns the current theme of a given map view instance
**>
- method GetMapViewTheme {
+ method getMapViewTheme {
in {
<**
@@ -1257,18 +1257,18 @@ cover with other windows or user interface elements
}
<**
- @description : GetSupportedMapViewThemes = This method retrieves the supported mapview themes
+ @description : getSupportedMapViewThemes = This method retrieves the supported mapview themes
**>
- method GetSupportedMapViewThemes {
+ method getSupportedMapViewThemes {
out {
MapTheme [] mapViewThemeList
}
}
<**
- @description : ConvertPixelCoordsToGeoCoords = This method converts pixel coordinates to geographical coordinates
+ @description : convertPixelCoordsToGeoCoords = This method converts pixel coordinates to geographical coordinates
**>
- method ConvertPixelCoordsToGeoCoords {
+ method convertPixelCoordsToGeoCoords {
in {
<**
@@ -1289,9 +1289,9 @@ cover with other windows or user interface elements
}
<**
- @description : ConvertGeoCoordsToPixelCoords = This method converts geographical coordinates into pixel coordinates
+ @description : convertGeoCoordsToPixelCoords = This method converts geographical coordinates into pixel coordinates
**>
- method ConvertGeoCoordsToPixelCoords {
+ method convertGeoCoordsToPixelCoords {
in {
<**
@@ -1314,9 +1314,9 @@ cover with other windows or user interface elements
}
<**
- @description : DisplayCustomElements = This method visualizes a set of custom elements on the map
+ @description : displayCustomElements = This method visualizes a set of custom elements on the map
**>
- method DisplayCustomElements {
+ method displayCustomElements {
in {
<**
@@ -1336,9 +1336,9 @@ cover with other windows or user interface elements
}
<**
- @description : HideCustomElements = This method hides a set of custom elements which were visualized by DisplayCustomElements
+ @description : hideCustomElements = This method hides a set of custom elements which were visualized by DisplayCustomElements
**>
- method HideCustomElements {
+ method hideCustomElements {
in {
<**
@@ -1356,9 +1356,9 @@ cover with other windows or user interface elements
}
<**
- @description : GetDisplayedCustomElements = This method retrieves the visualized custom elements on the map
+ @description : getDisplayedCustomElements = This method retrieves the visualized custom elements on the map
**>
- method GetDisplayedCustomElements {
+ method getDisplayedCustomElements {
in {
<**
@@ -1372,9 +1372,9 @@ cover with other windows or user interface elements
}
<**
- @description : SelectElementsOnMap = This method selects elements on the map view which are at the position specified by user input
+ @description : selectElementsOnMap = This method selects elements on the map view which are at the position specified by user input
**>
- method SelectElementsOnMap {
+ method selectElementsOnMap {
in {
<**
@@ -1397,9 +1397,9 @@ cover with other windows or user interface elements
}
<**
- @description : MapViewScaleChanged = This signal is emitted when the mapview scale changes
+ @description : mapViewScaleChanged = This signal is emitted when the mapview scale changes
**>
- broadcast MapViewScaleChanged {
+ broadcast mapViewScaleChanged {
out {
<**
@@ -1420,9 +1420,9 @@ cover with other windows or user interface elements
}
<**
- @description : MapViewVisibilityChanged = This signal is emitted when the MapView visibility changes
+ @description : mapViewVisibilityChanged = This signal is emitted when the MapView visibility changes
**>
- broadcast MapViewVisibilityChanged {
+ broadcast mapViewVisibilityChanged {
out {
<**
@@ -1438,9 +1438,9 @@ cover with other windows or user interface elements
}
<**
- @description : DisplayedRoutes = This signal is emitted when the list of displayed routes change
+ @description : displayedRoutes = This signal is emitted when the list of displayed routes change
**>
- broadcast DisplayedRoutes {
+ broadcast displayedRoutes {
out {
<**
diff --git a/api/franca/navigation/mapviewer/MapViewerControlTypes.fidl b/api/franca/navigation/mapviewer/MapViewerControlTypes.fidl
index 940000b..ea33b1f 100755
--- a/api/franca/navigation/mapviewer/MapViewerControlTypes.fidl
+++ b/api/franca/navigation/mapviewer/MapViewerControlTypes.fidl
@@ -13,6 +13,8 @@ typeCollection MapViewerControlTypes {
enumeration MapViewType extends BasicEnum {
MAIN_MAP = "0x0010"
SPLIT_SCREEN = "0x0011"
+
+ GUIDING_MAP
}
enumeration MapScaleMode extends BasicEnum {
@@ -27,8 +29,57 @@ typeCollection MapViewerControlTypes {
}
enumeration MapObject extends BasicEnum {
- BUILDINGS = "0x0080"
- TERRAIN = "0x0081"
+ // TODO: Check which elements are really visible
+ DET_POI //Points Of Interest
+ DET_TTI //TTI elements
+ DET_ONE_WAY_STREET_ARROW //Arrows marking one way streets
+ DET_CITY_NAME //City names
+ DET_ROAD_NAME //Road names
+ DET_MOTORWAY_EXIT_MARKER //Motorway exit signs
+ DET_TRAFFIC_LIGHT //Traffic lights
+ DET_TRAFFIC_LIGHTS_ALONG_ROUTE //Traffic lights along the route
+ DET_ROAD_ICON //Road icons
+ DET_DTM //Digital Terrain Model
+ DET_LANDMARKS_3D //3D landmarks
+ DET_FAVORITES //Saved favorite destinations
+ DET_ROUTE_BLOCKING //Highlighting of blocked routes
+ DET_ROAD //Roads
+ DET_POLYGON //Polygons
+ DET_DESTINATION //Destination flag
+ DET_MANOEUVRE_MARKER //Manoeuvre point markers
+ DET_LANE_GUIDANCE_MARKER //Lange guidance point markers
+ DET_ROUTE //Route
+ DET_MANOEUVRE_ARROW //Manoeuvre arrows
+ DET_TREKKING_TOUR //Trekking tours
+ DET_TTI_EDGE_HIGHLIGHTING //TTI highlighted edges
+ DET_CITY_MARKER //City markers
+ DET_VEHICLE //Vehicle
+ DET_POLYGON_NAME //Name of polygons
+ DET_OFF_ROAD_ROUTE //Connection line between end of a route and an off-road destination
+ DET_TTI_ARROW //Direction arrow for TTI messages
+ DET_POI_NAME //Points Of Interest with a label
+ DET_RASTER_MAP //Raster maps
+ DET_BREAD_CRUMB_TRAIL //Line that connects bread crumbs (past positions)
+ DET_EDGE_HIGHLIGHTING //Draw highlighted edges that were selected by MAP_POINT_QUERY0 - MAP_POINT_QUERY4.
+ DET_DIRECTION_ARROW //Draw arrows that indicate driving or walking direction.
+ DET_CITY_BUILDINGS //Render city buildings.
+ DET_FPS_DISPLAY //Measure and display frames per second.
+ DET_CROSSHAIR //Display crosshair.
+ DET_DEVDROP_BANNER //Enables drawing of a banner. The banner indicates that the current version is a developer's version. The banner is rendered across the display.
+ DET_FRAME_AROUND_MAP //a frame is rendered around the map.
+ DET_CORONA //a corona is drawn around the earth.
+ DET_WATEREFFECT //Demo effect for water.
+ DET_TREES //Demo effect for trees.
+ DET_RAIN //Demo effect for rain.
+ DET_CITYMODEL_ROUTE_TRANSPARENCY //Render buildings transparently around route.
+ DET_ROUTE_DESTINATION //Render destination POIs (e.g. destination flags).
+ DET_RANGE_DISPLAY //Display range display.
+ DET_POI_BRANDS //Display branded POIs.
+ DET_WEATHER_MARKER //DrawingElementType_DET_WEATHER_MARKER
+ DET_WEATHER_OVERLAY //Weather map overlay
+ DET_WAYPOINT_ROUTE
+ DET_WAYPOINT_ROUTE_MARKER
+ DET_STENCIL
}
enumeration PanAction extends BasicEnum {
@@ -51,10 +102,36 @@ typeCollection MapViewerControlTypes {
LEVEL_5 = "0x0054"
}
- enumeration MapTheme extends BasicEnum {
- THEME_1 = "0x0060"
- THEME_2 = "0x0061"
- THEME_3 = "0x0062"
+ enumeration MapTheme extends BasicEnum {
+ THEME_BMW_CLASSIC_DAY
+ THEME_BMW_CLASSIC_NIGHT
+ THEME_BMW_CLASSIC_TRAFFIC_DAY
+ THEME_BMW_CLASSIC_TRAFFIC_NIGHT
+ THEME_BMW_ALTERNATIVE_DAY
+ THEME_BMW_ALTERNATIVE_NIGHT
+ THEME_BMW_ALTERNATIVE_TRAFFIC_DAY
+ THEME_BMW_ALTERNATIVE_TRAFFIC_NIGHT
+ THEME_BMW_GUIDING
+
+ THEME_MINI_CLASSIC_DAY
+ THEME_MINI_CLASSIC_NIGHT
+ THEME_MINI_CLASSIC_TRAFFIC_DAY
+ THEME_MINI_CLASSIC_TRAFFIC_NIGHT
+ THEME_MINI_ALTERNATIVE_DAY
+ THEME_MINI_ALTERNATIVE_NIGHT
+ THEME_MINI_ALTERNATIVE_TRAFFIC_DAY
+ THEME_MINI_ALTERNATIVE_TRAFFIC_NIGHT
+ THEME_MINI_GUIDING
+
+ THEME_I_CLASSIC_DAY
+ THEME_I_CLASSIC_NIGHT
+ THEME_I_CLASSIC_TRAFFIC_DAY
+ THEME_I_CLASSIC_TRAFFIC_NIGHT
+ THEME_I_ALTERNATIVE_DAY
+ THEME_I_ALTERNATIVE_NIGHT
+ THEME_I_ALTERNATIVE_TRAFFIC_DAY
+ THEME_I_ALTERNATIVE_TRAFFIC_NIGHT
+ THEME_I_GUIDING
}
<**
@@ -84,6 +161,23 @@ typeCollection MapViewerControlTypes {
}
enumeration SelectableMapType extends BasicEnum {
+ MET_POI = "2" //POI.
+ MET_POLYGON = "3" //Polygons.
+ MET_EDGE = "4" //All edges except roads. E.g. railways rivers ferries.
+ MET_ROAD = "5" //Road edges.
+ MET_ROAD_ICON = "6" //Road icons.
+ MET_TTI_ICON = "7" //TTI icons.
+ MET_TTI_EDGE = "8" //TTI edge [Not yet supported].
+ MET_CITY_MARKER = "9" //City names and city markers.
+ MET_ROUTE = "10" //Tours.
+ MET_TREKKING_ROUTE = "11" //Trekking tours.
+ MET_POSITION = "12" //Position.
+ MET_LANDMARK = "13" //Landmarks.
+ MET_DESTINATION = "14" //Destinations.
+ MET_FAVORITE = "15" //Favorites.
+ MET_PICTURE = "16" //Picture.
+ MET_GENERIC_MARKER = "17" //Generic markers like weather markers.
+
CUSTOM_ELEMENT = "0x0120"
CURRENT_POSITION = "0x0121"
WAYPOINT = "0x0122"
diff --git a/api/franca/navigation/navigationcore/Guidance.fidl b/api/franca/navigation/navigationcore/Guidance.fidl
index 9b1e08f..54044c0 100755
--- a/api/franca/navigation/navigationcore/Guidance.fidl
+++ b/api/franca/navigation/navigationcore/Guidance.fidl
@@ -14,25 +14,25 @@ import org.genivi.navigation.navigationcore.GuidanceTypes.* from "GuidanceTypes.
@description : Guidance = This interface offers functions that implement the route-guidance functionality of a navigation system
**>
-interface org.genivi.navigationcore.Guidance {
+interface Guidance {
version {
major 0
minor 0
}
<**
- @description : GetVersion = This method returns the API version implemented by the server application
+ @description : getVersion = This method returns the API version implemented by the server application
**>
- method GetVersion {
+ method getVersion {
out {
Version ^version
}
}
<**
- @description : StartGuidance = This method starts the guidance for a given route
+ @description : startGuidance = This method starts the guidance for a given route
**>
- method StartGuidance {
+ method startGuidance {
in {
<**
@@ -48,9 +48,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : StopGuidance = This method stops the guidance
+ @description : stopGuidance = This method stops the guidance
**>
- method StopGuidance {
+ method stopGuidance {
in {
<**
@@ -61,9 +61,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : SetVoiceGuidance = This method switch on/off the voice guidance
+ @description : setVoiceGuidance = This method switch on/off the voice guidance
**>
- method SetVoiceGuidance {
+ method setVoiceGuidance {
in {
<**
@@ -79,9 +79,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : GetGuidanceDetails = This method retrieves guidance information
+ @description : getGuidanceDetails = This method retrieves guidance information
**>
- method GetGuidanceDetails {
+ method getGuidanceDetails {
out {
<**
@@ -107,15 +107,15 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : PlayVoiceManeuver = This method plays or repeats the last voice guidance
+ @description : playVoiceManeuver = This method plays or repeats the last voice guidance
**>
- method PlayVoiceManeuver {
+ method playVoiceManeuver {
}
<**
- @description : GetWaypointInformation = This method retrieves the information on the remaining way points of the route. A point can be the final destination as well as a stage defined by the user. The returned waypoints are ordered by their 'number'.
+ @description : getWaypointInformation = This method retrieves the information on the remaining way points of the route. A point can be the final destination as well as a stage defined by the user. The returned waypoints are ordered by their 'number'.
**>
- method GetWaypointInformation {
+ method getWaypointInformation {
in {
<**
@@ -136,7 +136,7 @@ interface org.genivi.navigationcore.Guidance {
<**
@description : This method retrieves the information on the final destination
**>
- method GetDestinationInformation {
+ method getDestinationInformation {
out {
<**
@@ -172,9 +172,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : GetManeuversList = This method retrieves the list of next maneuvers
+ @description : getManeuversList = This method retrieves the list of next maneuvers
**>
- method GetManeuversList {
+ method getManeuversList {
in {
<**
@@ -199,9 +199,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : SetRouteCalculationMode = This method configures the way the navigation application wants the navigation core to behave of reroute trigger
+ @description : setRouteCalculationMode = This method configures the way the navigation application wants the navigation core to behave of reroute trigger
**>
- method SetRouteCalculationMode {
+ method setRouteCalculationMode {
in {
<**
@@ -217,9 +217,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : SkipNextManeuver = This method allows to jump behind the current maneuver
+ @description : skipNextManeuver = This method allows to jump behind the current maneuver
**>
- method SkipNextManeuver {
+ method skipNextManeuver {
in {
<**
@@ -230,9 +230,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : GetGuidanceStatus = This method retrieves the guidance status
+ @description : getGuidanceStatus = This method retrieves the guidance status
**>
- method GetGuidanceStatus {
+ method getGuidanceStatus {
out {
<**
@@ -248,9 +248,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : SetVoiceGuidanceSettings = This method sets the voice guidance settings
+ @description : setVoiceGuidanceSettings = This method sets the voice guidance settings
**>
- method SetVoiceGuidanceSettings {
+ method setVoiceGuidanceSettings {
in {
<**
@@ -261,9 +261,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : GetVoiceGuidanceSettings = This method returns the used voice guidance settings
+ @description : getVoiceGuidanceSettings = This method returns the used voice guidance settings
**>
- method GetVoiceGuidanceSettings {
+ method getVoiceGuidanceSettings {
out {
<**
@@ -274,15 +274,15 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : VehicleLeftTheRoadNetwork = This signal is emitted when the vehicle exits from the road network
+ @description : vehicleLeftTheRoadNetwork = This signal is emitted when the vehicle exits from the road network
**>
- broadcast VehicleLeftTheRoadNetwork {
+ broadcast vehicleLeftTheRoadNetwork {
}
<**
- @description : GuidanceStatusChanged = This signal is emitted when the guidance status changes
+ @description : guidanceStatusChanged = This signal is emitted when the guidance status changes
**>
- broadcast GuidanceStatusChanged {
+ broadcast guidanceStatusChanged {
out {
<**
@@ -298,9 +298,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : WaypointReached = This signal is emitted when the destination is reached
+ @description : waypointReached = This signal is emitted when the destination is reached
**>
- broadcast WaypointReached {
+ broadcast waypointReached {
out {
<**
@@ -313,7 +313,7 @@ interface org.genivi.navigationcore.Guidance {
<**
@description : This signal is emitted each time a maneuver event is going
**>
- broadcast ManeuverChanged {
+ broadcast maneuverChanged {
out {
<**
@@ -324,9 +324,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : PositionOnRouteChanged = This signal is emitted when the position on the route changes
+ @description : positionOnRouteChanged = This signal is emitted when the position on the route changes
**>
- broadcast PositionOnRouteChanged {
+ broadcast positionOnRouteChanged {
out {
<**
@@ -337,15 +337,15 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : VehicleLeftTheRoute = This signal is emitted when the vehicle has left the route
+ @description : vehicleLeftTheRoute = This signal is emitted when the vehicle has left the route
**>
- broadcast VehicleLeftTheRoute {
+ broadcast vehicleLeftTheRoute {
}
<**
- @description : PositionToRouteChanged = This signal is emitted when the vehicle is off-the-road network and either the heading or the distance (or both) to the closest point on the active route changes
+ @description : positionToRouteChanged = This signal is emitted when the vehicle is off-the-road network and either the heading or the distance (or both) to the closest point on the active route changes
**>
- broadcast PositionToRouteChanged {
+ broadcast positionToRouteChanged {
out {
<**
@@ -361,9 +361,9 @@ interface org.genivi.navigationcore.Guidance {
}
<**
- @description : ActiveRouteChanged = This signal is emitted when the active route changes
+ @description : activeRouteChanged = This signal is emitted when the active route changes
**>
- broadcast ActiveRouteChanged {
+ broadcast activeRouteChanged {
out {
<**
diff --git a/api/franca/navigation/navigationcore/LocationInput.fidl b/api/franca/navigation/navigationcore/LocationInput.fidl
index ce4c087..6cd9402 100755
--- a/api/franca/navigation/navigationcore/LocationInput.fidl
+++ b/api/franca/navigation/navigationcore/LocationInput.fidl
@@ -15,25 +15,25 @@ import org.genivi.navigation.navigationcore.LocationInputTypes.* from "LocationI
@description : LocationInput = This interface offers functions that implement the location-input functionality of a navigation system
**>
-interface org.genivi.navigationcore.LocationInput {
+interface LocationInput {
version {
major 3
minor 0
}
<**
- @description : GetVersion = This method returns the API version implemented by the server application
+ @description : getVersion = This method returns the API version implemented by the server application
**>
- method GetVersion {
+ method getVersion {
out {
Version ^version
}
}
<**
- @description : CreateLocationInput = This method creates a new location input and retrieves a handle
+ @description : createLocationInput = This method creates a new location input and retrieves a handle
**>
- method CreateLocationInput {
+ method createLocationInput {
in {
<**
@@ -54,9 +54,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : DeleteLocationInput = This method deletes a location input and its associated resources
+ @description : deleteLocationInput = This method deletes a location input and its associated resources
**>
- method DeleteLocationInput {
+ method deleteLocationInput {
in {
<**
@@ -72,18 +72,18 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : GetSupportedAddressAttributes = This method retrieves the supported address attributes
+ @description : getSupportedAddressAttributes = This method retrieves the supported address attributes
**>
- method GetSupportedAddressAttributes {
+ method getSupportedAddressAttributes {
out {
AddressAttributeList addressAttributesList
}
}
<**
- @description : SetAddress = This method sets the address to start with for the LocationInput identified by the given handle
+ @description : setAddress = This method sets the address to start with for the LocationInput identified by the given handle
**>
- method SetAddress {
+ method setAddress {
in {
<**
@@ -101,9 +101,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : SetSelectionCriterion = This method sets the selection criterion for the current speller, search input and the corresponding result-lists for the current session
+ @description : setSelectionCriterion = This method sets the selection criterion for the current speller, search input and the corresponding result-lists for the current session
**>
- method SetSelectionCriterion {
+ method setSelectionCriterion {
in {
<**
@@ -124,9 +124,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : Spell = This method sends the next spell input for the current session
+ @description : spell = This method sends the next spell input for the current session
**>
- method Spell {
+ method spell {
in {
<**
@@ -152,9 +152,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : Search = This method sends the search input for the current session
+ @description : search = This method sends the search input for the current session
**>
- method Search {
+ method search {
in {
<**
@@ -180,9 +180,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : RequestListUpdate = This method sends a request for more list elements for the current session
+ @description : requestListUpdate = This method sends a request for more list elements for the current session
**>
- method RequestListUpdate {
+ method requestListUpdate {
in {
<**
@@ -208,9 +208,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : SelectEntry = This method triggers selection of a result list entry by index
+ @description : selectEntry = This method triggers selection of a result list entry by index
**>
- method SelectEntry {
+ method selectEntry {
in {
<**
@@ -231,9 +231,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : GetEntry = This method synchronously gets the address for the given result list entry
+ @description : getEntry = This method synchronously gets the address for the given result list entry
**>
- method GetEntry {
+ method getEntry {
in {
<**
@@ -252,9 +252,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : ValidateAddress = This method validates an address from different sources than Navigation
+ @description : validateAddress = This method validates an address from different sources than Navigation
**>
- method ValidateAddress {
+ method validateAddress {
in {
<**
@@ -272,9 +272,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : ReverseGeocode = This method transforms a geocoordinate into an address
+ @description : reverseGeocode = This method transforms a geocoordinate into an address
**>
- method ReverseGeocode {
+ method reverseGeocode {
in {
<**
@@ -292,9 +292,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : CurrentSelectionCriterion = This signal notifies the SelectionCriterion for the current speller input or search.
+ @description : currentSelectionCriterion = This signal notifies the SelectionCriterion for the current speller input or search.
**>
- broadcast CurrentSelectionCriterion {
+ broadcast currentSelectionCriterion {
out {
<**
@@ -310,9 +310,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : SearchStatus = This signal updates the search status of the specified session
+ @description : searchStatus = This signal updates the search status of the specified session
**>
- broadcast SearchStatus {
+ broadcast searchStatus {
out {
<**
@@ -328,9 +328,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : SpellResult = This signal notifies the result of the previous Spell method
+ @description : spellResult = This signal notifies the result of the previous Spell method
**>
- broadcast SpellResult {
+ broadcast spellResult {
out {
<**
@@ -356,9 +356,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : SearchResultList = This signal updates the address result list (e.g. after a Search/Spell/Scroll call)
+ @description : searchResultList = This signal updates the address result list (e.g. after a Search/Spell/Scroll call)
**>
- broadcast SearchResultList {
+ broadcast searchResultList {
out {
<**
@@ -386,9 +386,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : SearchResultListSizeChanged = This signal updates the size of the address result list
+ @description : searchResultListSizeChanged = This signal updates the size of the address result list
**>
- broadcast SearchResultListSizeChanged {
+ broadcast searchResultListSizeChanged {
out {
<**
@@ -404,9 +404,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : ContentUpdated = This signal updates the input content data for the specified session
+ @description : contentUpdated = This signal updates the input content data for the specified session
**>
- broadcast ContentUpdated {
+ broadcast contentUpdated {
out {
<**
@@ -426,9 +426,9 @@ interface org.genivi.navigationcore.LocationInput {
}
<**
- @description : AddressValidationResult = This signal notifies the validation result of a former ValidateAddress call
+ @description : addressValidationResult = This signal notifies the validation result of a former ValidateAddress call
**>
- broadcast AddressValidationResult {
+ broadcast addressValidationResult {
out {
<**
diff --git a/api/franca/navigation/navigationcore/LocationInputTypes.fidl b/api/franca/navigation/navigationcore/LocationInputTypes.fidl
index 3816b6e..4c88bb9 100755
--- a/api/franca/navigation/navigationcore/LocationInputTypes.fidl
+++ b/api/franca/navigation/navigationcore/LocationInputTypes.fidl
@@ -1,6 +1,6 @@
/*
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
+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/.
@@ -27,6 +27,7 @@ typeCollection LocationInputTypes {
PHONENUMBER = "0x00ae"
POINAME = "0x00af"
TOWNCENTER = "0x00b0"
+ INTERNAL_DATA = "0x00FF"
}
enumeration ValidationType extends BasicEnum {
@@ -43,9 +44,13 @@ typeCollection LocationInputTypes {
array AddressAttributeList of AddressAttribute
- union AddressValue {
-
- }
+ union AddressValue {
+ Int32 intValue
+ Double doubleValue
+ String stringValue
+ Coordinate3D coordinateValue
+ ByteBuffer internalData
+ }
map Address {
AddressAttribute to AddressValue
@@ -55,4 +60,4 @@ typeCollection LocationInputTypes {
AddressAttribute to ValidationType
}
-} \ No newline at end of file
+}
diff --git a/api/franca/navigation/navigationcore/MapMatchedPosition.fidl b/api/franca/navigation/navigationcore/MapMatchedPosition.fidl
index 3732ded..c348a0a 100755
--- a/api/franca/navigation/navigationcore/MapMatchedPosition.fidl
+++ b/api/franca/navigation/navigationcore/MapMatchedPosition.fidl
@@ -15,25 +15,25 @@ import org.genivi.navigation.navigationcore.MapMatchedPositionTypes.* from "MapM
@description : MapMatchedPosition = This interface offers functions to retrieve the map matched position and to simulate positioning
**>
-interface org.genivi.navigationcore.MapMatchedPosition {
+interface MapMatchedPosition {
version {
major 0
minor 0
}
<**
- @description : GetVersion = This method returns the API version implemented by the server application
+ @description : getVersion = This method returns the API version implemented by the server application
**>
- method GetVersion {
+ method getVersion {
out {
Version ^version
}
}
<**
- @description : SetSimulationMode = This method activates or deactivates the simulation mode
+ @description : setSimulationMode = This method activates or deactivates the simulation mode
**>
- method SetSimulationMode {
+ method setSimulationMode {
in {
<**
@@ -49,9 +49,9 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : GetSimulationStatus = This method retrieves the simulation status
+ @description : getSimulationStatus = This method retrieves the simulation status
**>
- method GetSimulationStatus {
+ method getSimulationStatus {
out {
<**
@@ -64,19 +64,19 @@ interface org.genivi.navigationcore.MapMatchedPosition {
<**
@description : AddSimulationStatusListener = Add this node as a listener to Simulation Status changes.
**>
- method AddSimulationStatusListener {
+ method addSimulationStatusListener {
}
<**
@description : RemoveSimulationStatusListener = Remove this node as a listener to Simulation Status changes.
**>
- method RemoveSimulationStatusListener {
+ method removeSimulationStatusListener {
}
<**
- @description : SetSimulationSpeed = This method sets the speed factor for the simulation mode
+ @description : setSimulationSpeed = This method sets the speed factor for the simulation mode
**>
- method SetSimulationSpeed {
+ method setSimulationSpeed {
in {
<**
@@ -92,9 +92,9 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : GetSimulationSpeed = returns the speed factor for the simulation mode
+ @description : getSimulationSpeed = returns the speed factor for the simulation mode
**>
- method GetSimulationSpeed {
+ method getSimulationSpeed {
out {
<**
@@ -107,19 +107,19 @@ interface org.genivi.navigationcore.MapMatchedPosition {
<**
@description : AddSimulationSpeedListener = Add this node as a listener to simulation speed factor changes.
**>
- method AddSimulationSpeedListener {
+ method addSimulationSpeedListener {
}
<**
@description : RemoveSimulationSpeedListener = Remove this node as a listener to simulation speed factor changes.
**>
- method RemoveSimulationSpeedListener {
+ method removeSimulationSpeedListener {
}
<**
- @description : StartSimulation = This method starts, or resumes, a Follow Active Route simulation
+ @description : startSimulation = This method starts, or resumes, a Follow Active Route simulation
**>
- method StartSimulation {
+ method startSimulation {
in {
<**
@@ -130,9 +130,9 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : PauseSimulation = This method freezes the current location
+ @description : pauseSimulation = This method freezes the current location
**>
- method PauseSimulation {
+ method pauseSimulation {
in {
<**
@@ -143,9 +143,9 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : GetPosition = This method returns the current position
+ @description : getPosition = This method returns the current position
**>
- method GetPosition {
+ method getPosition {
in {
PositionItemKey[] valuesToReturn
}
@@ -155,9 +155,9 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : SetPosition = This method sets the position to a specific location
+ @description : setPosition = This method sets the position to a specific location
**>
- method SetPosition {
+ method setPosition {
in {
<**
@@ -170,9 +170,9 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : GetAddress = This method returns the current address
+ @description : getAddress = This method returns the current address
**>
- method GetAddress {
+ method getAddress {
in {
AddressItemKey[] valuesToReturn
}
@@ -184,7 +184,7 @@ interface org.genivi.navigationcore.MapMatchedPosition {
<**
@description : positionOnSegment = This method returns the vehicle position on a route segment
**>
- method GetPositionOnSegment {
+ method getPositionOnSegment {
in {
PositionOnSegmentKey [] valuesToReturn
}
@@ -194,9 +194,9 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : GetStatus = This method returns the current status
+ @description : getStatus = This method returns the current status
**>
- method GetStatus {
+ method getStatus {
in {
PositionStatus [] valuesToReturn
}
@@ -206,9 +206,9 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : SimulationStatusChanged = This signal is emitted when the Simulation Status has changed
+ @description : simulationStatusChanged = This signal is emitted when the Simulation Status has changed
**>
- broadcast SimulationStatusChanged {
+ broadcast simulationStatusChanged {
out {
<**
@@ -219,9 +219,9 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : SimulationSpeedChanged = This signal is emitted when the simulation speed factor has changed
+ @description : simulationSpeedChanged = This signal is emitted when the simulation speed factor has changed
**>
- broadcast SimulationSpeedChanged {
+ broadcast simulationSpeedChanged {
out {
<**
@@ -232,45 +232,45 @@ interface org.genivi.navigationcore.MapMatchedPosition {
}
<**
- @description : PositionUpdate = This signal is called to notify a client application of a position change. The update frequency is implementation specific. The maximal allowed frequency is 10Hz
+ @description : positionUpdate = This signal is called to notify a client application of a position change. The update frequency is implementation specific. The maximal allowed frequency is 10Hz
**>
- broadcast PositionUpdate {
+ broadcast positionUpdate {
out {
PositionItemKey [] changedValues
}
}
<**
- @description : AddressUpdate = This signal is called to notify a client application that the current address changed
+ @description : addressUpdate = This signal is called to notify a client application that the current address changed
**>
- broadcast AddressUpdate {
+ broadcast addressUpdate {
out {
AddressItemKey[] changedValues
}
}
<**
- @description : PositionOnSegmentUpdate = This signal is called to notify the client that the vehicle position on the route segment changed
+ @description : positionOnSegmentUpdate = This signal is called to notify the client that the vehicle position on the route segment changed
**>
- broadcast PositionOnSegmentUpdate {
+ broadcast positionOnSegmentUpdate {
out {
PositionOnSegmentKey[] changedValues
}
}
<**
- @description : StatusUpdate = This signal is emitted to notifiy a client application that the current status changed
+ @description : statusUpdate = This signal is emitted to notifiy a client application that the current status changed
**>
- broadcast StatusUpdate {
+ broadcast statusUpdate {
out {
PositionStatus [] changedValues
}
}
<**
- @description : OffroadPositionChanged = This signal is emitted when the heading and the distance to the closest point on the road network changes
+ @description : offroadPositionChanged = This signal is emitted when the heading and the distance to the closest point on the road network changes
**>
- broadcast OffRoadPositionChanged {
+ broadcast offRoadPositionChanged {
out {
<**
diff --git a/api/franca/navigation/navigationcore/Routing.fidl b/api/franca/navigation/navigationcore/Routing.fidl
index 18913dd..19d3918 100755
--- a/api/franca/navigation/navigationcore/Routing.fidl
+++ b/api/franca/navigation/navigationcore/Routing.fidl
@@ -16,7 +16,7 @@ import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"
@description : This interface offers functions that implement the routing functionality of a navigation system
**>
-interface org.genivi.navigationcore.Routing {
+interface Routing {
version {
major 0
minor 0
@@ -25,7 +25,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method returns the API version implemented by the server application
**>
- method GetVersion {
+ method getVersion {
out {
Version ^version
}
@@ -34,7 +34,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method creates a route
**>
- method CreateRoute {
+ method createRoute {
in {
<**
@@ -54,7 +54,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method deletes a route and its associated resources
**>
- method DeleteRoute {
+ method deleteRoute {
in {
<**
@@ -72,7 +72,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method sets the cost model
**>
- method SetCostModel {
+ method setCostModel {
in {
<**
@@ -95,7 +95,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method retrieves the selected cost model
**>
- method GetCostModel {
+ method getCostModel {
in {
<**
@@ -115,7 +115,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method retrieves a list of supported cost models
**>
- method GetSupportedCostModels {
+ method getSupportedCostModels {
out {
CostModel [] costModelsList
}
@@ -124,7 +124,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method sets a list of route preferences
**>
- method SetRoutePreferences {
+ method setRoutePreferences {
in {
<**
@@ -151,7 +151,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method retrieves a list of selected route preferences
**>
- method GetRoutePreferences {
+ method getRoutePreferences {
in {
<**
@@ -173,7 +173,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method retrieves a list of supported route preferences
**>
- method GetSupportedRoutePreferences {
+ method getSupportedRoutePreferences {
out {
RoutePreference[] routePreferencesList
ConiditionPreference[] conditionPreferenceList
@@ -183,7 +183,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method sets the time schedule for the route to be calculated
**>
- method SetRouteSchedule {
+ method setRouteSchedule {
in {
<**
@@ -203,7 +203,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method gets the time schedule for the route to be calculated
**>
- method GetRouteSchedule {
+ method getRouteSchedule {
in {
<**
@@ -222,7 +222,7 @@ interface org.genivi.navigationcore.Routing {
<**
@description : This method sets a list of means of transportation that must be considered when calculating a route
**>
- method SetTransportationMeans {
+ method setTransportationMeans {
in {
<**
@@ -240,9 +240,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : GetTransportationMeans = This method retrieves the selected means of transportation
+ @description : getTransportationMeans = This method retrieves the selected means of transportation
**>
- method GetTransportationMeans {
+ method getTransportationMeans {
in {
<**
@@ -256,18 +256,18 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : GetSupportedTransportationMeans = This method retrieves a list of supported means of transportation
+ @description : getSupportedTransportationMeans = This method retrieves a list of supported means of transportation
**>
- method GetSupportedTransportationMeans {
+ method getSupportedTransportationMeans {
out {
TransportationMeans[] transportationMeansList
}
}
<**
- @description : SetExcludedAreas = This method sets the areas to be excluded when calculating a route
+ @description : setExcludedAreas = This method sets the areas to be excluded when calculating a route
**>
- method SetExcludedAreas {
+ method setExcludedAreas {
in {
<**
@@ -285,9 +285,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : GetExcludedAreas = This method retrieves the areas to be excluded when calculating a route
+ @description : getExcludedAreas = This method retrieves the areas to be excluded when calculating a route
**>
- method GetExcludedAreas {
+ method getExcludedAreas {
in {
<**
@@ -301,9 +301,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : SetWaypoints = This method sets a list of waypoints
+ @description : setWaypoints = This method sets a list of waypoints
**>
- method SetWaypoints {
+ method setWaypoints {
in {
<**
@@ -326,9 +326,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : GetWaypoints = This method retrieves a list of waypoints
+ @description : getWaypoints = This method retrieves a list of waypoints
**>
- method GetWaypoints {
+ method getWaypoints {
in {
<**
@@ -348,9 +348,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : CalculateRoute = This method starts a route calculation
+ @description : calculateRoute = This method starts a route calculation
**>
- method CalculateRoute {
+ method calculateRoute {
in {
<**
@@ -366,9 +366,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : CancelRouteCalculation = This method cancels a route calculation
+ @description : cancelRouteCalculation = This method cancels a route calculation
**>
- method CancelRouteCalculation {
+ method cancelRouteCalculation {
in {
<**
@@ -384,9 +384,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : CalculateRoutes = This method allows a client to calculate alternative routes that differs from a list of already calculated routes
+ @description : calculateRoutes = This method allows a client to calculate alternative routes that differs from a list of already calculated routes
**>
- method CalculateRoutes {
+ method calculateRoutes {
in {
<**
@@ -401,9 +401,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : GetRouteSegments = This method retrieves a list of segments for a given route starting from the one closest to the current position to the one closest to the destination
+ @description : getRouteSegments = This method retrieves a list of segments for a given route starting from the one closest to the current position to the one closest to the destination
**>
- method GetRouteSegments {
+ method getRouteSegments {
in {
<**
@@ -440,9 +440,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : GetRouteOverview = This method retrieves general information about a given route
+ @description : getRouteOverview = This method retrieves general information about a given route
**>
- method GetRouteOverview {
+ method getRouteOverview {
in {
<**
@@ -458,9 +458,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : GetRouteBoundingBox = This method retrieves the bounding box containing a calculated route
+ @description : getRouteBoundingBox = This method retrieves the bounding box containing a calculated route
**>
- method GetRouteBoundingBox {
+ method getRouteBoundingBox {
in {
<**
@@ -474,18 +474,18 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : GetAllRoutes = This method retrieves the handles of all created routes
+ @description : getAllRoutes = This method retrieves the handles of all created routes
**>
- method GetAllRoutes {
+ method getAllRoutes {
out {
Handle [] routesList
}
}
<**
- @description : SetBlockedRouteStretches = This method sets blocked streches on a given route
+ @description : setBlockedRouteStretches = This method sets blocked streches on a given route
**>
- method SetBlockedRouteStretches {
+ method setBlockedRouteStretches {
in {
<**
@@ -503,9 +503,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : GetBlockedRouteStretches = This method retrieves all blocked streches on a given route
+ @description : getBlockedRouteStretches = This method retrieves all blocked streches on a given route
**>
- method GetBlockedRouteStretches {
+ method getBlockedRouteStretches {
in {
<**
@@ -519,9 +519,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : RouteDeleted = This signal is emitted to inform clients that the current route has been deleted
+ @description : routeDeleted = This signal is emitted to inform clients that the current route has been deleted
**>
- broadcast RouteDeleted {
+ broadcast routeDeleted {
out {
<**
@@ -532,9 +532,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : RouteCalculationCancelled = This signal informs a client that a route calculation was cancelled
+ @description : routeCalculationCancelled = This signal informs a client that a route calculation was cancelled
**>
- broadcast RouteCalculationCancelled {
+ broadcast routeCalculationCancelled {
out {
<**
@@ -545,9 +545,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : RouteCalculationSuccessful = This signal informs a client that a route calculation was successful
+ @description : routeCalculationSuccessful = This signal informs a client that a route calculation was successful
**>
- broadcast RouteCalculationSuccessful {
+ broadcast routeCalculationSuccessful {
out {
<**
@@ -560,9 +560,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : RouteCalculationFailed = This signal informs a client that a route calculation failed
+ @description : routeCalculationFailed = This signal informs a client that a route calculation failed
**>
- broadcast RouteCalculationFailed {
+ broadcast routeCalculationFailed {
out {
<**
@@ -580,9 +580,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : RouteCalculationProgressUpdate = This signal informs a client about a route calculation progress
+ @description : routeCalculationProgressUpdate = This signal informs a client about a route calculation progress
**>
- broadcast RouteCalculationProgressUpdate {
+ broadcast routeCalculationProgressUpdate {
out {
<**
@@ -603,9 +603,9 @@ interface org.genivi.navigationcore.Routing {
}
<**
- @description : AlternativeRoutesAvailable = This signal is emitted when alternative routes have been computed in the background and are available for guidance.
+ @description : alternativeRoutesAvailable = This signal is emitted when alternative routes have been computed in the background and are available for guidance.
**>
- broadcast AlternativeRoutesAvailable {
+ broadcast alternativeRoutesAvailable {
out {
Handle[] routeHandlesList
}
diff --git a/api/franca/navigation/poiservice/ContentAccessModule.fidl b/api/franca/navigation/poiservice/ContentAccessModule.fidl
index bca32ff..6407743 100755
--- a/api/franca/navigation/poiservice/ContentAccessModule.fidl
+++ b/api/franca/navigation/poiservice/ContentAccessModule.fidl
@@ -1,6 +1,6 @@
/*
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
+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/.
@@ -20,7 +20,7 @@ interface POIContentAccessModule {
}
<** @description : This method returns the API version implemented by the content access module.**>
- method GetVersion {
+ method getVersion {
out {
<** @description: .**>
Version ^version
@@ -29,29 +29,29 @@ interface POIContentAccessModule {
<** @description : Set the current language set for the search by poi provider module.
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 {
+ method setLanguage {
in {
- <** @description : The language to be used.**>
+ <** @description : the language to be used.**>
String languageCode
- <** @description : The country specific variant for the language to be used.**>
+ <** @description : the country specific variant for the language to be used.**>
String countryCode
}
}
<** @description : This method is sent by the POI service component to inform all the CAM that a new POI search was started.
It provides all the relevant search parameters. Of course the CAM will only be aware of the search if it registers one of the search categories.**>
- method PoiSearchStarted {
+ method poiSearchStarted {
in {
<** @description : poi search unique handle. It must be used by the CAM to send the list of results to the component.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : max size of the results list.**>
UInt16 maxSize
<** @description: struct(lat,lon,alt).**>
Coordinate3D location
<** @description: array[struct(id,radius)].**>
- categoryRadius_t[] poiCategories
+ CategoryAndRadius[] poiCategories
<** @description : array[struct(name, poiCategory, type, value, operator, mandatory)].**>
- attributeDetails_t[] poiAttributes
+ AttributeDetails[] poiAttributes
<** @description : contains the name of the poi that is searched. It could be a partial name or an empty string.**>
String inputString
<** @description : enum(SORT_DEFAULT,SORT_BY_DISTANCE,SORT_BY_TIME,ATTRIBUTE_CUSTOM, ... )
@@ -61,21 +61,21 @@ interface POIContentAccessModule {
}
<** @description : This method cancels the search for the current id.**>
- method PoiSearchCanceled {
+ method poiSearchCanceled {
in {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
}
}
<** @description : This method provides the poi results list found by the CAM.
As the POI unique id is managed by the POI component, the CAM only provides the POI name, the category and coordinates as well as all the relevant detailed information.**>
- method ResultListRequested {
+ method resultListRequested {
in {
<** @description : Content access module unique id as known by the POI service component.**>
UInt8 camId
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : List of attributes name to retrieve. This is optional and the list could be empty.**>
String[] attributes
}
@@ -85,20 +85,20 @@ interface POIContentAccessModule {
<** @description : Number of items of the results list.**>
UInt16 resultListSize
<** @description : array[struct(source_id, name, category, location, distance, attributes)].**>
- poiCAMDetails_t[] resultList
+ PoiCAMDetails[] resultList
}
}
<** @description : This method retrieves the details associated to one or more POI.
It contains the name, the parent categories, the list of attributes, the icons, ... .**>
- method PoiDetailsRequested {
+ method poiDetailsRequested {
in {
<** @description : array[unique_poi_id].**>
- UInt32[] source_id
+ POI_ID[] source_id
}
out {
<** @description : array[(details, categories, attributes)] .**>
- searchResultDetails_t[] results
+ SearchResultDetails[] results
}
}
diff --git a/api/franca/navigation/poiservice/POISearch.fidl b/api/franca/navigation/poiservice/POISearch.fidl
index 66fc351..699add3 100755
--- a/api/franca/navigation/poiservice/POISearch.fidl
+++ b/api/franca/navigation/poiservice/POISearch.fidl
@@ -1,6 +1,6 @@
/*
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
+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/.
@@ -19,7 +19,7 @@ interface POISearch {
minor 0
}
<** @description : This method returns the API version implemented by the content access module.**>
- method GetVersion {
+ method getVersion {
out {
<** @description: .**>
Version ^version
@@ -28,7 +28,7 @@ interface POISearch {
<** @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 {
+ method getLanguage {
out {
<** @description : The language.**>
String languageCode
@@ -39,7 +39,7 @@ interface POISearch {
<** @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 {
+ method setLanguage {
in {
<** @description : The language to be used.**>
String languageCode
@@ -49,94 +49,94 @@ interface POISearch {
}
<** @description : This method allows the application to validate that POI categories are supported by the POI component and the Content access modules.**>
- method ValidateCategories {
+ method validateCategories {
in {
<** @description : list of categories enum(INVALID,ALL_CATEGORIES,AIRPORT,RESTAURANT,HOTEL,GAZ_STATION,CAR_PARK, ...)
Note: A POI category is a unique ID. It could be a predifined category or a custom one defined by a POI plug-in.**>
- UInt16[] categories
+ CategoryID[] categories
}
out {
<** @description : List of status for all the POI categories.**>
- poiCategoryAndStatus_t[] results
+ CategoryAndStatus[] results
}
}
<** @description : This method retrieves the list od POI categories available (pre-defined and custom).**>
- method GetAvailableCategories {
+ method getAvailableCategories {
out {
<** @description : List of categories (id, name and top_level).**>
- poiCategoryAndName_t[] categories
+ CategoryAndName[] categories
}
}
<** @description : Get the root category id. That would be ALL_CATEGORIES.**>
- method GetRootCategory {
+ method getRootCategory {
out {
<** @description : The root category is a top level one by design.**>
- UInt16 category
+ CategoryID category
}
}
<** @description : Get the children categories id and type (top level) from the a parent unique id.**>
- method GetChildrenCategories {
+ method getChildrenCategories {
in {
<** @description : unique category id.**>
- UInt16 category
+ CategoryID category
}
out {
<** @description : List of categories (id and top_level).**>
- poiCategoryAndLevel_t[] categories
+ CategoryAndLevel[] categories
}
}
<** @description : Get the parent categories id and type (top level) from the a unique id.**>
- method GetParentCategories {
+ method getParentCategories {
in {
<** @description : unique category id.**>
- UInt16 category
+ CategoryID category
}
out {
<** @description : List of categories (id and top_level).**>
- poiCategoryAndLevel_t[] categories
+ CategoryAndLevel[] categories
}
}
<** @description : GetCategoriesDetails = 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 {
+ method getCategoriesDetails {
in {
<** @description : list of categories enum(INVALID,ALL_CATEGORIES,AIRPORT,RESTAURANT,HOTEL,GAZ_STATION,CAR_PARK, ...)
Note: A POI category is a unique ID. It could be a predefined category or a custom one defined by a POI plug-in. **>
- UInt16[] categories
+ CategoryID[] categories
}
out {
<** @description : List of details for all the POI categories.**>
- category_t[] results
+ Category[] results
}
}
<** @description : This method creates a new search input and retrieves a handle .**>
- method CreatePoiSearchHandle {
+ method createPoiSearchHandle {
out {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
}
}
<** @description : This method deletes a search input and its associated resources.**>
- method DeletePoiSearchHandle {
+ method deletePoiSearchHandle {
in {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
}
}
<** @description : This method sets the location to start the search around.
If a route handle was defined before, it will be replaced by this location.**>
- method SetCenter {
+ method setCenter {
in {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : location of the center.**>
Coordinate3D location
}
@@ -145,48 +145,48 @@ interface POISearch {
<** @description : This method allows to start a POI search along a guided route.
The route handle must be valid or the POI search will failed.
If a search location was defined before, it will be replaced by the route.**>
- method SetRouteHandle {
+ method setRouteHandle {
in {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : session handle.**>
- UInt8 sessionHandle
+ Handle sessionHandle
<** @description : route handle.**>
- UInt8 routeHandle
+ Handle routeHandle
<** @description : (optional) Distance from vehicle (in meters) from where to start the search along. 0 or invalid distance means start from vehicle.**>
- UInt16 startSearchOffset
+ UInt32 startSearchOffset
<** @description : (optional) Length of the route (in meters) from where to start the search along. 0 or invalid lenght means end is the destination.**>
- UInt16 endSearchOffset
+ UInt32 endSearchOffset
}
}
<** @description : This method sets the POI categories for the current search input and the corresponding result-lists for the current session .**>
- method SetCategories {
+ method setCategories {
in {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description: array[struct(id,radius)].**>
- categoryRadius_t[] poiCategories
+ CategoryAndRadius[] poiCategories
}
}
<** @description : This method set POI attributes (optional) for the current search input and the corresponding result-lists for the current session
An attribute is attached to a category.**>
- method SetAttributes {
+ method setAttributes {
in {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : array[struct(name, poiCategory, type, value, operator, mandatory)].**>
- attributeDetails_t[] poiAttributes
+ AttributeDetails[] poiAttributes
}
}
<** @description : This method sends the search input for the search handle.
The search will start with the either the location or the route handle.
If no positon or route handle were configured, the search will use the vehicle position are center location.**>
- method StartPoiSearch {
+ method startPoiSearch {
in {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : contains the name of the poi that is searched. It could be a partial name or an empty string.**>
String inputString
<** @description : enum(SORT_DEFAULT,SORT_BY_DISTANCE,SORT_BY_TIME,ATTRIBUTE_CUSTOM, ... )
@@ -196,20 +196,20 @@ interface POISearch {
}
<** @description : This method cancels the search for the current session.**>
- method CancelPoiSearch {
+ method cancelPoiSearch {
in {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
}
}
<** @description : This method starts to check for POI aound vehicle according to the criteria defined with the unique handle.
By default, it will search for POI around vehicle position with default radius defined for each categories.
If a route handle was defined, it will search along the route with default categorie's radius.**>
- method StartPoiProximityAlert {
+ method startPoiProximityAlert {
in {
<** @description : poi alert unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : contains the name of the poi that is searched. It could be a partial name or an empty string.**>
String inputString
<** @description : enum(SORT_DEFAULT,SORT_BY_DISTANCE,SORT_BY_TIME,ATTRIBUTE_CUSTOM, ... )
@@ -219,18 +219,18 @@ interface POISearch {
}
<** @description : This method cancels the search for the current session.**>
- method CancelPoiProximityAlert {
+ method cancelPoiProximityAlert {
in {
<** @description : poi alert unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
}
}
<** @description : This method gets the poi result list (e.g. after a Search/Scroll call) .**>
- method RequestResultList {
+ method requestResultList {
in {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : starting offset of the newly requested list elements. If invalid (more that total list for instance) it starts from the begining.**>
UInt16 offset
<** @description : maximum number of elements that should be returned as result.**>
@@ -244,20 +244,20 @@ interface POISearch {
<** @description : Number of items of the results list.**>
UInt16 resultListSize
<** @description : array[unique_id, distance, route_status, attributes].**>
- searchResult_t[] resultListWindow
+ SearchResult[] resultListWindow
}
}
<** @description : This method retrieves the details associated to one or more POI.
It contains the name, the parent categories, the list of attributes, the icons, ... ..**>
- method GetPoiDetails {
+ method getPoiDetails {
in {
<** @description : list of poi.**>
- UInt32[] id
+ POI_ID[] id
}
out {
<** @description : array[details, categories, attributes].**>
- searchResultDetails_t[] results
+ SearchResultDetails[] results
}
}
@@ -265,7 +265,7 @@ interface POISearch {
broadcast CategoriesUpdated {
out {
<** @description : List of POI categories modified or added.**>
- poiCategoryAndReason_t[] poiCategories
+ CategoryAndReason[] poiCategories
}
}
@@ -273,9 +273,9 @@ interface POISearch {
broadcast PoiStatus {
out {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : enum(INVALID,NOT_STARTED,SEARCHING,FINISHED, ... ).**>
- UInt16 statusValue
+ SearchStatusState statusValue
}
}
@@ -283,7 +283,7 @@ interface POISearch {
broadcast ResultListChanged {
out {
<** @description : poi search unique handle.**>
- UInt8 poiSearchHandle
+ Handle poiSearchHandle
<** @description : Number of items of the results list.**>
UInt16 resultListSize
}
diff --git a/api/franca/navigation/poiservice/POIServiceTypes.fidl b/api/franca/navigation/poiservice/POIServiceTypes.fidl
index d24e0d3..fb80f9e 100755
--- a/api/franca/navigation/poiservice/POIServiceTypes.fidl
+++ b/api/franca/navigation/poiservice/POIServiceTypes.fidl
@@ -1,6 +1,6 @@
/*
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
+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/.
@@ -16,257 +16,310 @@ typeCollection POIServiceTypes {
minor 1
}
- <** @description: TODO replace this workaround as soon as possible!!**>
- union variant_t {
-
- }
+ <** @description:Unique ID for a POI results**>
+ typedef POI_ID is UInt32
+
+ <** @description:Unique ID for a POI Categories**>
+ typedef CategoryID is UInt32
+
+ <** @description:Unique ID for a POI Icon Resource**>
+ typedef ResourceID is UInt32
+
+ typedef AttributeID is UInt32
+
+ <** @description: Current state of the search**>
+ enumeration SearchStatusState {
+ INVALID
+ NOT_STARTED
+ SEARCHING
+ FINISHED
+ }
+
+ <** @description: Type of Attribute**>
+ enumeration AttributeType {
+ INTEGER
+ BOOLEAN
+ COORDINATE
+ }
+
+ <** @description: Type of Operator**>
+ enumeration OperatorType {
+ INVALID
+ MORE_THAN
+ LESS_THAN
+ EQUAL
+ }
+
+ <** @description: Reason of update**>
+ enumeration UpdateReason {
+ ADDED
+ REMOVED
+ ATTR_ADDED
+ ATTR_MODIFIED
+ ATTR_REMOVED
+ }
+
+ <** @description: Different types of resources for icons**>
+ union Icon {
+ ResourceID[] id
+ String url
+ }
+
+ <** @description: Differtent type of media**>
+ union Media {
+ ResourceID[] id
+ String url
+ }
+
+
+ <** @description: values for attributes. **>
+ union AttributeValue {
+ Int32[] intListValue
+ String[] stringListValue
+ Boolean[] boolListValue
+ Coordinate2D[] coordinateListValue
+ }
+
<** @description:**>
- struct details_t {
+ struct Details {
<** @description : list of parent categories unique id.**>
- UInt16[] parents_id
+ CategoryID[] parentsId
<** @description : visual icons set.**>
- variant_t icons
+ Icon icons
<** @description : name.**>
String name
<** @description : short category description (optional).**>
- String short_desc
+ String shortDesc
<** @description : media associated (html web site, audio, video, ...) (optional).**>
- variant_t media
+ Media media
}
<** @description:**>
- struct operator_t {
+ struct Operator {
<** @description : enum(INVALID,MORE_THAN,LESS_THAN,EQUAL, ....).**>
- UInt16 operator_id
+ UInt16 operatorId
<** @description : attribute operator name.**>
- String operator_name
+ String operatorName
}
- <** @description:**>
- struct categoryAttribute_t {
+ <** @description: Describes an attribte which is associcated to an category. Use more than one operator to specify choice options i.e. differtent accpeted credid cards
+ used in categor details and update category**>
+ struct CategoryAttribute {
<** @description : attribute unique name.**>
String name
<** @description : enum(INVALID,STRING,INTEGER,COORDINATES ...).**>
UInt16 type
<** @description:**>
- operator_t[] operators
+ Operator[] operators
}
<** @description:**>
- struct categorySortOption_t {
+ struct CategorySortOption {
<** @description : enum(SORT_DEFAULT,SORT_BY_DISTANCE,SORT_BY_TIME,ATTRIBUTE_CUSTOM, ... ).**>
- UInt16 id
- <** @description : name to be displayed by application.**>
+ CategoryID id
+ <** @description : localized name to be displayed by application.**>
String name
}
<** @description:**>
- struct CAMCategory_t {
+ struct CAMCategory {
<** @description : struct(list of parents_id, icons, name, short_desc, media).**>
- details_t details
+ Details details
<** @description : array[struct(name, type, array[struct(operator_id, operator_name)])].**>
- categoryAttribute_t[] attributes
+ CategoryAttribute[] attributes
<** @description : array[struct(id, name)].**>
- categorySortOption_t[] sortOptions
+ CategorySortOption[] sortOptions
}
<** @description:**>
- struct CAMCategoryUpdate_t {
+ struct CAMCategoryUpdate {
<** @description : enum(INVALID,ALL_CATEGORIES,AIRPORT,RESTAURANT,HOTEL,GAZ_STATION,CAR_PARK, ...). Note: A POI category is a unique ID. It could be a predefined category or a custom one defined by a POI plug-in **>
- UInt16 id
+ CategoryID id
<** @description : array[struct(name, type, array[struct(operator_id, operator_name)])].**>
- categoryAttribute_t[] attributes
+ CategoryAttribute[] attributes
<** @description : array[struct(id, name)].**>
- categorySortOption_t[] sortOptions
+ CategorySortOption[] sortOptions
}
- <** @description:**>
- struct poiAttribute_t
+ <** @description: Attribute associcated to an POI used in addPOI and POI Search Result(both CAM and Service)**>
+ struct PoiAttribute
{
<** @description:attribute unique name (see data model)**>
String name
<** @description:enum(INVALID,STRING,INTEGER,COORDINATES ...)**>
UInt16 type
<** @description:The value depends on the attribute specifications and type**>
- variant_t value
+ AttributeValue value
}
<** @description:**>
- struct categoryRadius_t
+ struct CategoryAndRadius
{
<** @description : enum(INVALID,ALL_CATEGORIES,AIRPORT,RESTAURANT,HOTEL,GAZ_STATION,CAR_PARK, ...). Note: A POI category is a unique ID. It could be a predefined category or a custom one defined by a POI plug-in **>
- UInt16 id
+ CategoryID id
<** @description : activation or search radius around the position (in 10 meters) for the category. If value is 0 (zero), the default radius (defined for a category) is applied.**>
UInt32 radius
}
<** @description:**>
- struct poiDetails_t
+ struct PoiDetails
{
<** @description:POI id**>
- UInt32 id
+ POI_ID id
<** @description:POI name**>
String name
- <** @description:latitude of a vertex of the polygon in format %3.6f. Range [-90:+90]. Example: 48.053250**>
- Double latitude
- <** @description:longitude of a vertex of the polygon in format %3.6f. Range [-180:+180]. Example: 48.053250**>
- Double longitude
- <** @description:altitude above the sea level of the current position in meters**>
- Int32 altitude
+ <** @description:POI location.**>
+ Coordinate3D location
}
<** @description:**>
- struct searchResultDetails_t
+ struct SearchResultDetails
{
<** @description: struct(id,name,latitude,longitude,altitude).**>
- poiDetails_t details
+ PoiDetails details
<** @description: array[unique_id].**>
- UInt16[] categories
+ CategoryID[] categories
<** @description: array[struct(name,type,value)].**>
- poiAttribute_t[] attributes
+ PoiAttribute[] attributes
}
<** @description:**>
- struct searchResult_t
+ struct SearchResult
{
<** @description:POI id**>
- UInt32 id
+ POI_ID id
<** @description:distance in meters to poi from center of the search or from vehicle if search along**>
UInt32 distance
<** @description:enum(OFF_ROUTE,ON_ROUTE,INSIDE_CORRIDOR, ... )**>
- UInt16 route_status
+ UInt16 routeStatus
<** @description:List of attributes requested. It could be empty**>
- poiAttribute_t[] attributes
+ PoiAttribute[] attributes
}
<** @description:**>
- struct poiCAMDetails_t
+ struct PoiCAMDetails
{
<** @description:POI unique id as known by the content access module. This id will be used by POI service to request POI details.**>
- UInt32 source_id
+ POI_ID sourceId
<** @description:POI name.**>
String name
<** @description:POI category unique id.**>
- UInt16 category
+ CategoryID category
<** @description:POI location.**>
Coordinate3D location
<** @description:distance in meters to poi from center of the search.**>
UInt16 distance
<** @description:List of attributes requested. It could be empty.**>
- poiAttribute_t[] attributes
+ PoiAttribute[] attributes
}
- <** @description:**>
- struct attributeDetails_t
+ <** @description: used in setAttrbutes and CAM startPOISearch**>
+ struct AttributeDetails
{
<** @description : attribute unique name (see data model).**>
String name
<** @description : enum(INVALID,ALL_CATEGORIES,AIRPORT,RESTAURANT,HOTEL,GAZ_STATION,CAR_PARK, ...). Note: A POI category is a unique ID. It could be a predefined category or a custom one defined by a POI plug-in **>
- UInt16 poiCategory
+ CategoryID poiCategory
<** @description : enum(INVALID,STRING,INTEGER,COORDINATES ...).**>
UInt16 type
<** @description : value or partial value. The value depends on the attribute specifications and type.**>
- variant_t value
+ AttributeValue value
<** @description : enum(INVALID,MORE_THAN,LESS_THAN,EQUAL, ....).**>
UInt16 oper
<** @description : true if the attribute is mandatory for the search and false for optional.**>
Boolean mandatory
}
- <** @description:**>
- struct categoryDetails_t
+ <** @description: Detailed descripton of a category**>
+ struct CategoryDetails
{
<** @description : Category unique id.**>
- UInt16 unique_id
+ CategoryID uniqueId
<** @description : list of parent categories unique id.**>
- UInt16[] parents_id
+ CategoryID[] parentsId
<** @description : visual icons set.**>
- variant_t icons
+ Icon icons
<** @description : name.**>
String name
<** @description : true if the category is a pre-defined one (top level), false for customized categories created by plug-in.**>
- Boolean top_level
+ Boolean topLevel
<** @description : short category description (optional).**>
String description
<** @description : media associated (html web site, audio, video, ...) (optional).**>
- variant_t media
+ Media media
}
- <** @description:**>
- struct category_t
+ <** @description: Detailed description of a category including attributes and sort options**>
+ struct Category
{
<** @description : struct(unique_id, list of parents_id, icons, name, top_level, short_desc, media).**>
- categoryDetails_t details
+ CategoryDetails details
<** @description : array[struct(name, type, array[struct(operator_id, operator_name)].**>
- categoryAttribute_t[] attributes
+ CategoryAttribute[] attributes
<** @description : array[struct(id, name)].**>
- categorySortOption_t[] sortOptions
+ CategorySortOption[] sortOptions
}
- <** @description:**>
- struct poiCategoryAndLevel_t
+ <** @description: Pair of catgory and description of level**>
+ struct CategoryAndLevel
{
<** @description : Category unique id.**>
- UInt16 unique_id
+ CategoryID uniqueId
<** @description : true if the category is a pre-defined one (top level), false for customized categories created by plug-in.**>
- Boolean top_level
+ Boolean topLevel
}
- <** @description:**>
- struct poiCategoryAndName_t
+ <** @description: pair of category and name **>
+ struct CategoryAndName
{
<** @description : Category unique id.**>
- UInt16 unique_id
+ CategoryID uniqueId
<** @description : name.**>
String name
<** @description : true if the category is a pre-defined one (top level), false for customized categories created by plug-in.**>
- Boolean top_level
+ Boolean topLevel
}
- <** @description:**>
- struct poiCategoryAndReason_t
+ <** @description: pair of category and reson for update**>
+ struct CategoryAndReason
{
<** @description : Category unique id.**>
- UInt16 unique_id
+ CategoryID unique_id
<** @description : enum(ADDED,REMOVED,ATTR_ADDED,ATTR_MODIFIED,ATTR_REMOVED, ... ) .**>
UInt16 reason
}
- <** @description:**>
- struct poiCategoryAndStatus_t
+ <** @description: pair of category and the this category is available**>
+ struct CategoryAndStatus
{
<** @description : Category unique id.**>
- UInt16 unique_id
+ CategoryID uniqueId
<** @description : true if the category is available .**>
- UInt16 status
+ Boolean status
}
<** @description:**>
- struct poiAddedDetails_t
+ struct PoiAddedDetails
{
<** @description:POI name**>
String name
- <** @description:latitude of a vertex of the polygon in format %3.6f. Range [-90:+90]. Example: 48.053250**>
- Double latitude
- <** @description:longitude of a vertex of the polygon in format %3.6f. Range [-180:+180]. Example: 48.053250**>
- Double longitude
- <** @description:altitude above the sea level of the current position in meters**>
- Int32 altitude
+ <** @description:POI location.**>
+ Coordinate3D location
<** @description: array[struct(name,type,value)].**>
- poiAttribute_t[] attributes
+ PoiAttribute[] attributes
}
}
diff --git a/api/franca/navigation/poiservice/ServiceContentAccess.fidl b/api/franca/navigation/poiservice/ServiceContentAccess.fidl
index 2797588..04b17bb 100755
--- a/api/franca/navigation/poiservice/ServiceContentAccess.fidl
+++ b/api/franca/navigation/poiservice/ServiceContentAccess.fidl
@@ -1,6 +1,6 @@
/*
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
+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/.
@@ -20,7 +20,7 @@ interface POIContentAccess {
<** @description : Register to the POI provider module
When the CAM registers, it provides a name and then get a unique id. This id must be used everytime the CAM communicates with the POI service component.
After the registration is done, the CAM can start to update POI categories and POI attributes as well as registers POI categories to search for.**>
- method RegisterContentAccessModule {
+ method registerContentAccessModule {
in {
<** @description : The name of the CAM.**>
String moduleName
@@ -33,7 +33,7 @@ interface POIContentAccess {
}
<** @description : Remove CAM from POI provider module.**>
- method UnRegisterContentAccessModule {
+ method unRegisterContentAccessModule {
in {
<** @description : Content access module unique id as known by the POI service component.**>
UInt8 camId
@@ -41,7 +41,7 @@ interface POIContentAccess {
}
<** @description : Register to the POI provider module the categories you can search for POI.
The categories could be predifined one or customized ones. In order to register a customized category, you might need to create it before and add it to the POI service component.**>
- method RegisterPoiCategories {
+ method registerPoiCategories {
in {
<** @description : Content access module unique id as known by the POI service component.**>
UInt8 camId
@@ -49,46 +49,46 @@ interface POIContentAccess {
List of POI categories to register.
unique_id = Unique category id.
**>
- UInt16[] poiCategories
+ CategoryID[] poiCategories
}
}
<** @description : Update categories in the POI service component. It could be a predifined or a customed one.
The CAM provides for each categories the list of attributes (mandatories like name or optional) it wants to update.
Depending on the local database write policy, the CAM might only be able to update customized attributes for a category and not the predefined ones so some update could be rejected.**>
- method UpdateCategories {
+ method updateCategories {
in {
<** @description : Content access module unique id as known by the POI service component.**>
UInt8 camId
<** @description : array[unique_id, attributes, sortOptions].**>
- CAMCategoryUpdate_t[] poiCategories
+ CAMCategoryUpdate[] poiCategories
}
}
<** @description : Add new categories to the POI service component.
The CAM provides for each categories the name, the parent categories, the top level attribute, the list of attributes, the icons, ... .**>
- method AddCategories {
+ method addCategories {
in {
<** @description : Content access module unique id as known by the POI service component.**>
UInt8 camId
<** @description : List of details for all the POI categories.**>
- CAMCategory_t[] poiCategories
+ CAMCategory[] poiCategories
}
out {
<**
@description : array of unique POI categories as registered by the POI service component.
Note: A POI category is a unique ID
**>
- UInt16[] poiCategoriesId
+ CategoryID[] poiCategoriesId
}
}
<** @description : Remove categories from the POI service component. It could be a predifined or a customed one.
Depending on the local database write policy, the CAM might only not be able to remove some categories.**>
- method RemoveCategories {
+ method removeCategories {
in {
<** @description : Content access module unique id as known by the POI service component.**>
UInt8 camId
<** @description : array[unique_id].
List of POI categories to remove.**>
- UInt16[] poiCategories
+ CategoryID[] poiCategories
}
}
} \ No newline at end of file