summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorasanoaozora <fifitaneki@hotmail.com>2018-01-03 17:21:59 +0100
committerasanoaozora <fifitaneki@hotmail.com>2018-01-03 17:21:59 +0100
commit03a340b57c464301689f39e7d11e7833a9c4d87d (patch)
tree83bca506d4bf820fb4ec8f866f95c1b660cb0dae /api
parenta3a65e6d544d0af6ee4e1dbbc5414d38fb04be15 (diff)
downloadpoi-service-03a340b57c464301689f39e7d11e7833a9c4d87d.tar.gz
POI ID format updated to uint64 to be compliant with OSM ID
Diffstat (limited to 'api')
-rw-r--r--api/franca/navigation/poiservice/POIServiceTypes.fidl2
-rw-r--r--api/poi-service/genivi-poiservice-contentaccessmodule.xml14
-rw-r--r--api/poi-service/genivi-poiservice-poisearch.xml11
3 files changed, 14 insertions, 13 deletions
diff --git a/api/franca/navigation/poiservice/POIServiceTypes.fidl b/api/franca/navigation/poiservice/POIServiceTypes.fidl
index 01fc3ba..454a9dd 100644
--- a/api/franca/navigation/poiservice/POIServiceTypes.fidl
+++ b/api/franca/navigation/poiservice/POIServiceTypes.fidl
@@ -16,7 +16,7 @@ typeCollection POIServiceTypes {
}
<** @description:Unique ID for a POI results**>
- typedef POI_ID is UInt32
+ typedef POI_ID is UInt64
<** @description:Unique ID for a POI Icon Resource**>
typedef ResourceID is UInt32
diff --git a/api/poi-service/genivi-poiservice-contentaccessmodule.xml b/api/poi-service/genivi-poiservice-contentaccessmodule.xml
index 1d4a321..b6af984 100644
--- a/api/poi-service/genivi-poiservice-contentaccessmodule.xml
+++ b/api/poi-service/genivi-poiservice-contentaccessmodule.xml
@@ -203,7 +203,7 @@
<doc>
<line>removePOIs = Removes a list of POIs to a category. Because of required time to remove it from the database, a signal is emitted when the update is done.</line>
</doc>
- <arg direction="in" name="ids" type="au">
+ <arg direction="in" name="ids" type="at">
<doc>
<line>ids (of type POI_ID) = List of unique ids of POIs to remove.</line>
<line>lineComment to be defined</line>
@@ -304,7 +304,7 @@
<line>resultListSize = Number of items of the results list</line>
</doc>
</arg>
- <arg name="resultList" type="a(usu(ddd)qa(ui(yv)))" direction="out">
+ <arg name="resultList" type="a(tsu(ddd)qa(ui(yv)))" direction="out">
<doc>
<line>resultList = array[source_id,name, category, location, distance, attributeList]</line>
<line>source_id = POI unique id as known by the content access module. This id will be used by POI service to request POI details.</line>
@@ -344,12 +344,12 @@
<line>PoiDetailsRequested = This method retrieves the details associated to one or more POI.</line>
<line>It contains the name, the parent categories, the list of attributes, the icons, ... .</line>
</doc>
- <arg name="source_id" type="au" direction="in">
+ <arg name="source_id" type="at" direction="in">
<doc>
<line>list of poi = Unique source poi id</line>
</doc>
</arg>
- <arg name="results" type="a((us(ddd))aua(ui(yv)))" direction="out">
+ <arg name="results" type="a((ts(ddd))aua(ui(yv)))" direction="out">
<doc>
<line>results = array[details, categories, attributeList]</line>
<line>results = List of details for all the POI.</line>
@@ -406,7 +406,7 @@
<doc>
<line>POIAdded = POIAdded = This signal is emitted when a list of POIs and associated content has been added to the database. It returns the ids.</line>
</doc>
- <arg direction="out" name="pois" type="au">
+ <arg direction="out" name="pois" type="at">
<doc>
<line>pois (of type POI_ID) = List of unique ids of POIs added. The order is the same as the order in the AddPOIs method.</line>
<line>lineComment to be defined</line>
@@ -417,7 +417,7 @@
<doc>
<line>POIRemoved = POIRemoved = This signal is emitted when a list of POIs and associated content has been removed from the database.</line>
</doc>
- <arg direction="out" name="pois" type="au">
+ <arg direction="out" name="pois" type="at">
<doc>
<line>pois (of type POI_ID) = List of unique ids of POIs removed.</line>
<line>lineComment to be defined</line>
@@ -440,7 +440,7 @@
<line>enum[INVALID (org.franca.core.franca.impl.FIntegerConstantImpl@12babf4 (val: 0)), NOT_STARTED (org.franca.core.franca.impl.FIntegerConstantImpl@1a3c8e3 (val: 1296)), SEARCHING (org.franca.core.franca.impl.FIntegerConstantImpl@1f53788 (val: 1297)), FINISHED (org.franca.core.franca.impl.FIntegerConstantImpl@bdae21 (val: 1298))]</line>
</doc>
</arg>
- <arg direction="out" name="pois" type="au">
+ <arg direction="out" name="pois" type="at">
<doc>
<line>pois (of type POI_ID) = List of pois that match the search (only valid if status is set to SEARCHING or FINISHED, by default empty list).</line>
<line>lineComment to be defined</line>
diff --git a/api/poi-service/genivi-poiservice-poisearch.xml b/api/poi-service/genivi-poiservice-poisearch.xml
index 3fc44be..3ad3575 100644
--- a/api/poi-service/genivi-poiservice-poisearch.xml
+++ b/api/poi-service/genivi-poiservice-poisearch.xml
@@ -532,7 +532,7 @@
<line>resultListSize = Number of items of the results list</line>
</doc>
</arg>
- <arg name="resultListWindow" type="a(uuia(ui(yv)))" direction="out">
+ <arg name="resultListWindow" type="a(tuia(ui(yv)))" direction="out">
<doc>
<line>resultListWindow = array[unique_id, distance, route_status, attributeList]</line>
<line>unique_id = POI unique id</line>
@@ -561,17 +561,18 @@
<line>GetPoiDetails = This method retrieves the details associated to one or more POI.</line>
<line>It contains the name, the parent categories, the list of attributes, the icons, ... .</line>
</doc>
- <arg name="id" type="au" direction="in">
+ <arg name="id" type="at" direction="in">
<doc>
- <line>list of poi = Unique poi id</line>
+ <line>list of poi[unique_id]</line>
+ <line>unique_id = POI unique id</line>
</doc>
</arg>
- <arg name="results" type="a((us(ddd))aua(ui(yv)))" direction="out">
+ <arg name="results" type="a((ts(ddd))aua(ui(yv)))" direction="out">
<doc>
<line>results = array[details, categories, attributeList]</line>
<line>results = List of details for all the POI.</line>
<line>details = struct(unique id, name, location)</line>
- <line>unique id = POI id</line>
+ <line>unique_id = POI unique id</line>
<line>name = POI name</line>
<line>location = struct(lat,lon,alt)</line>
<line>lat = latitude of a vertex of the polygon in format %3.6f. Range [-90:+90]. Example: 48.053250</line>