add error messages to Franca files

12 files changed, 154 insertions, 17 deletions

diff --git a/api/franca/hmi/speechservice/SpeechOutput.fidl b/api/franca/hmi/speechservice/SpeechOutput.fidl
index fbd4a50..1cac5ef 100644
--- a/api/franca/hmi/speechservice/SpeechOutput.fidl
+++ b/api/franca/hmi/speechservice/SpeechOutput.fidl
@@ -20,7 +20,7 @@ interface SpeechOutput {
 		minor 0
 	}
 	
-	<**	@description : This method returns the API version implemented by the content access module.**>
+	<**	@description : This method returns the API version implemented by the SpeechOutput.**>
 	method getVersion {
 		out {
 			<** @description: .**>
diff --git a/api/franca/navigation/NavigationTypes.fidl b/api/franca/navigation/NavigationTypes.fidl
index 23f76c3..856cdc2 100755
--- a/api/franca/navigation/NavigationTypes.fidl
+++ b/api/franca/navigation/NavigationTypes.fidl
@@ -100,4 +100,9 @@ typeCollection NavigationTypes {
 		<** @description : the script specific variant for the language used. ISO 15924 alpha 4 script code (upper case)**>

 		String scriptCode						

 	}

+	

+	enumeration NotificationNavigation {

+		SESSION_ERROR_NOMORESESSIONHANDLES

+		SESSION_ERROR_SESSIONNOTAVAILABLE

+	}

 }
\ No newline at end of file
diff --git a/api/franca/navigation/mapviewer/MapViewerControl.fidl b/api/franca/navigation/mapviewer/MapViewerControl.fidl
index 5b0595c..2749ccb 100755
--- a/api/franca/navigation/mapviewer/MapViewerControl.fidl
+++ b/api/franca/navigation/mapviewer/MapViewerControl.fidl
@@ -8,6 +8,7 @@ package org.genivi.navigation.mapviewer
 
 import org.genivi.CommonTypes.* from "../../CommonTypes.fidl"
 import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"
+import org.genivi.navigation.mapviewer.MapViewerTypes.* from "./MapViewerTypes.fidl"
 
 <**
 	@description : MapViewerControl = This interface offers functions to control the MapViewer
@@ -294,6 +295,7 @@ interface MapViewerControl {
 
 	<**
 		@description : createMapViewInstance = This method creates a new map instance
+		notify(MAPVIEWERCONTROL_ERROR_NOMOREMAPVIEWINSTANCEHANDLES) is emitted if no more map view instance handles are available
 	**>
 	method createMapViewInstance {
 		in {
@@ -321,6 +323,7 @@ interface MapViewerControl {
 
 	<**
 		@description : releaseMapViewInstance = This method releases (i.e. destroys) a given map instance. Only invisible map instances can be released
+		notify(MAPVIEWERCONTROL_ERROR_MAPVIEWINSTANCENOTAVAILABLE) is emitted if an application tries to delete a map view instance handle that is not available
 	**>
 	method releaseMapViewInstance {
 		in {
@@ -1956,4 +1959,13 @@ interface MapViewerControl {
 		}
 	}
 
+	<**
+		@description : notify = This signal is emitted when something wrong occured when invoking the API 
+	**>
+	broadcast notify {
+		out {
+			Notification notification
+		}
+	}
+
 }
\ No newline at end of file
diff --git a/api/franca/navigation/mapviewer/MapViewerTypes.fidl b/api/franca/navigation/mapviewer/MapViewerTypes.fidl
new file mode 100644
index 0000000..2e2613d
--- /dev/null
+++ b/api/franca/navigation/mapviewer/MapViewerTypes.fidl
@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: MPL-2.0
+// Copyright (C) 2014, PCA Peugeot Citro�n, XS Embedded GmbH, TomTom International B.V., Continental Automotive GmbH, BMW Car IT GmbH,  Alpine Electronics R&D Europe GmbH, AISIN AW CO., LTD.,  Neusoft Technology Solutions GmbH, Jaguar Land Rover Limited, Visteon Corporation, Elektrobit Automotive GmbH
+// This Source Code Form is subject to the terms of the
+// Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
+// this file, you can obtain one at http://mozilla.org/MPL/2.0/.
+
+package org.genivi.navigation.mapviewer
+import org.genivi.CommonTypes.* from "../../CommonTypes.fidl"
+import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"
+
+typeCollection MapViewerTypes {
+	version {
+		major 4 
+		minor 0
+	}
+	enumeration Notification extends NotificationNavigation{
+		MAPVIEWERCONTROL_ERROR_NOMOREMAPVIEWINSTANCEHANDLES
+		MAPVIEWERCONTROL_ERROR_MAPVIEWINSTANCENOTAVAILABLE	
+	}
+}
diff --git a/api/franca/navigation/mapviewer/Session.fidl b/api/franca/navigation/mapviewer/Session.fidl
index 23828ee..9fbe92e 100644
--- a/api/franca/navigation/mapviewer/Session.fidl
+++ b/api/franca/navigation/mapviewer/Session.fidl
@@ -8,6 +8,7 @@ package org.genivi.navigation.mapviewer
 
 import org.genivi.CommonTypes.* from "../../CommonTypes.fidl"
 import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"
+import org.genivi.navigation.mapviewer.MapViewerTypes.* from "./MapViewerTypes.fidl"
 
 
 <** @description : This interface offers methods that implement the navigation core session functionality of a navigation system.**>
@@ -25,7 +26,9 @@ interface Session {
 		}	
 	}	
 
-	<** @description : createSession = This method creates a new session and retrieves a handle .**>
+	<** @description : createSession = This method creates a new session and retrieves a handle .
+		notify(SESSION_ERROR_NOMORESESSIONHANDLES) is emitted if no more session handles are available
+	**>
 	method createSession {
 		in {
 			<**
@@ -42,7 +45,9 @@ interface Session {
 		}
 	}
 
-	<** @description : deleteSession = This method deletes a session and its associated resources .**>
+	<** @description : deleteSession = This method deletes a session and its associated resources .
+		notify(SESSION_ERROR_SESSIONNOTAVAILABLE) is emitted if an application tries to delete a session handle that is not available
+	**>
 	method deleteSession {
 		in {
 			<**	@description : sessionHandle **>
@@ -78,5 +83,14 @@ interface Session {
 			Handle sessionHandle			
 		}
 	}
+
+	<**
+		@description : notify = This signal is emitted when something wrong occured when invoking the API 
+	**>
+	broadcast notify {
+		out {
+			Notification notification
+		}
+	}
 	
 }
diff --git a/api/franca/navigation/navigationcore/Configuration.fidl b/api/franca/navigation/navigationcore/Configuration.fidl
index 1aa15d0..8ca3258 100644
--- a/api/franca/navigation/navigationcore/Configuration.fidl
+++ b/api/franca/navigation/navigationcore/Configuration.fidl
@@ -16,13 +16,7 @@ interface Configuration {
 		major 4 
 		minor 0
 	}
-		<**	@description : This method returns the API version .**>
-	method getVersion {
-		out {
-			<** @description: .**>
-			Version ^version				
-		}	
-	}		
+	
     <** @description: Settings**>
     enumeration Settings {
         INVALID 				= 0
@@ -66,6 +60,14 @@ interface Configuration {
 		SECONDS		= 3
 	}
 	
+	<**	@description : This method returns the API version .**>
+	method getVersion {
+		out {
+			<** @description: .**>
+			Version ^version				
+		}	
+	}		
+
 	<**	@description : Set the current language set. If the language is not supported, the default details will be returned in the native language.**>
 	method setLocale {
 		in {
diff --git a/api/franca/navigation/navigationcore/Guidance.fidl b/api/franca/navigation/navigationcore/Guidance.fidl
index d33256d..e4c4f18 100644
--- a/api/franca/navigation/navigationcore/Guidance.fidl
+++ b/api/franca/navigation/navigationcore/Guidance.fidl
@@ -8,6 +8,7 @@ package org.genivi.navigation.navigationcore
 	

 import org.genivi.CommonTypes.* from "../../CommonTypes.fidl"

 import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"

+import org.genivi.navigation.navigationcore.NavigationCoreTypes.* from "./NavigationCoreTypes.fidl"

 

 <**

 	@description : Guidance = This interface offers functions that implement the route-guidance functionality of a navigation system

@@ -266,6 +267,7 @@ interface Guidance {
 

 	<**

 		@description : playVoiceManeuver = This method plays or repeats the last voice guidance

+		notify(GUIDANCE_ERROR_VOICENOTALLOWED) is emitted if the voice generation is inactive

 	**>

 	method playVoiceManeuver {

 	}

@@ -331,6 +333,7 @@ interface Guidance {
 

 	<**

 		@description : getManeuversList = This method retrieves the list of next maneuvers

+		notify(GUIDANCE_ERROR_NOMANEUVER) is emitted in case there's no maneuver until the destination

 	**>

 	method getManeuversList {

 		in {

@@ -376,6 +379,7 @@ interface Guidance {
 

 	<**

 		@description : skipNextManeuver = This method allows to jump behind the current maneuver

+		notify(GUIDANCE_ERROR_NOMANEUVER) is emitted in case there's no maneuver until the destination

 	**>

 	method skipNextManeuver {

 		in {

@@ -407,6 +411,7 @@ interface Guidance {
 

 	<**

 		@description : setVoiceGuidanceSettings = This method sets the voice guidance settings

+		notify(GUIDANCE_ERROR_VOICENOTALLOWED) is emitted if the voice generation is inactive

 	**>

 	method setVoiceGuidanceSettings {

 		in {

@@ -531,5 +536,12 @@ interface Guidance {
 		}

 	}

 

-

+	<**

+		@description : notify = This signal is emitted when something wrong occured when invoking the API 

+	**>

+	broadcast notify {

+		out {

+			Notification notification

+		}

+	}

 }
\ No newline at end of file
diff --git a/api/franca/navigation/navigationcore/LocationInput.fidl b/api/franca/navigation/navigationcore/LocationInput.fidl
index c4d372e..14f714d 100644
--- a/api/franca/navigation/navigationcore/LocationInput.fidl
+++ b/api/franca/navigation/navigationcore/LocationInput.fidl
@@ -80,6 +80,7 @@ interface LocationInput {
 

 	<**

 		@description : createLocationInput = This method creates a new location input and retrieves a handle

+		notify(LOCATIONINPUT_ERROR_NOMORELOCATIONINPUTHANDLES) is emitted if no more location input handles are available

 	**>

 	method createLocationInput {

 		in {

@@ -100,6 +101,7 @@ interface LocationInput {
 

 	<**

 		@description : deleteLocationInput = This method deletes a location input and its associated resources

+		notify(LOCATIONINPUT_ERROR_LOCATIONINPUTNOTAVAILABLE) is emitted if an application tries to delete a location input handle that is not available

 	**>

 	method deleteLocationInput {

 		in {

@@ -487,4 +489,12 @@ interface LocationInput {
 		}

 	}

 

+	<**

+		@description : notify = This signal is emitted when something wrong occured when invoking the API 

+	**>

+	broadcast notify {

+		out {

+			Notification notification

+		}

+	}

 }
\ No newline at end of file
diff --git a/api/franca/navigation/navigationcore/MapMatchedPosition.fidl b/api/franca/navigation/navigationcore/MapMatchedPosition.fidl
index 437dfca..cd56c8d 100644
--- a/api/franca/navigation/navigationcore/MapMatchedPosition.fidl
+++ b/api/franca/navigation/navigationcore/MapMatchedPosition.fidl
@@ -250,6 +250,7 @@ interface MapMatchedPosition {
 

 	<**

 		@description : getPosition = This method returns the current position

+		notify(MAPMATCHEDPOSITION_ERROR_NOPOSITION) is emitted if no position is available

 	**>

 	method getPosition {

 		in {

@@ -276,7 +277,9 @@ interface MapMatchedPosition {
 	}

 

 	<**

-		@description : getAddress = This method returns the current address

+		@description : getCurrentAddress = This method returns the current address

+		notify(MAPMATCHEDPOSITION_ERROR_NOMAP) is emitted if no map is available

+		notify(MAPMATCHEDPOSITION_ERROR_OUTOFKNOWNMAP) is emitted if the vehicle is located in a position outside of the known map

 	**>

 	method getCurrentAddress {

 		in {

@@ -391,7 +394,12 @@ interface MapMatchedPosition {
 		}

 	}

 

-

-

-

+	<**

+		@description : notify = This signal is emitted when something wrong occured when invoking the API 

+	**>

+	broadcast notify {

+		out {

+			Notification notification

+		}

+	}

 }
\ No newline at end of file
diff --git a/api/franca/navigation/navigationcore/NavigationCoreTypes.fidl b/api/franca/navigation/navigationcore/NavigationCoreTypes.fidl
index 636d526..98ae3f4 100644
--- a/api/franca/navigation/navigationcore/NavigationCoreTypes.fidl
+++ b/api/franca/navigation/navigationcore/NavigationCoreTypes.fidl
@@ -23,4 +23,23 @@ typeCollection NavigationCoreTypes {
 		LONGITUDE	= 161
 		ALTITUDE	= 162
 	}	
+	
+	enumeration Notification {
+		GUIDANCE_ERROR_NOMANEUVER = 0
+		GUIDANCE_ERROR_VOICENOTALLOWED
+		LOCATIONINPUT_ERROR_NOMORELOCATIONINPUTHANDLES
+		LOCATIONINPUT_ERROR_LOCATIONINPUTNOTAVAILABLE
+		MAPMATCHEDPOSITION_ERROR_NOPOSITION
+		MAPMATCHEDPOSITION_ERROR_NOMAP
+		MAPMATCHEDPOSITION_ERROR_OUTOFKNOWNMAP
+		ROUTING_ERROR_NOMOREROUTEHANDLES
+		ROUTING_ERROR_ROUTENOTAVAILABLE
+		ROUTING_ERROR_OPERATIONNOTALLOWED
+		ROUTING_ERROR_ROUTEPREFERENCENOTSUPPORTED
+		ROUTING_ERROR_WAYPOINTCANNOTBECHANGED
+		ROUTING_ERROR_TOOMANYWAYPOINTS
+		SESSION_ERROR_NOMORESESSIONHANDLES
+		SESSION_ERROR_SESSIONNOTAVAILABLE
+	}
+	
 }
diff --git a/api/franca/navigation/navigationcore/Routing.fidl b/api/franca/navigation/navigationcore/Routing.fidl
index 246f748..03a741c 100644
--- a/api/franca/navigation/navigationcore/Routing.fidl
+++ b/api/franca/navigation/navigationcore/Routing.fidl
@@ -205,6 +205,7 @@ interface Routing {
 

 	<**

 		@description : This method creates a route

+		notify(ROUTING_ERROR_NOMOREROUTEHANDLES) is emitted if no more routing handles are available

 	**>

 	method createRoute {

 		in {

@@ -225,6 +226,8 @@ interface Routing {
 

 	<**

 		@description : This method deletes a route and its associated resources

+		notify(ROUTING_ERROR_ROUTENOTAVAILABLE) is emitted if an application tries to delete a route handle that is not available

+		notify(ROUTING_ERROR_OPERATIONNOTALLOWED) is emitted if an application tries to delete a route which is not created manually (e.g. an alternative route calculated in the background)

 	**>

 	method deleteRoute {

 		in {

@@ -243,6 +246,7 @@ interface Routing {
 

 	<**

 		@description : This method sets the cost model

+		notify(ROUTING_ERROR_OPERATIONNOTALLOWED) is emitted if an application tries to set a cost model for a route which is not created manually (e.g. an alternative route calculated in the background)

 	**>

 	method setCostModel {

 		in {

@@ -295,6 +299,8 @@ interface Routing {
 

 	<**

 		@description : This method sets a list of route preferences

+		notify(ROUTING_ERROR_OPERATIONNOTALLOWED) is emitted if an application tries to set route preferences for a route which is not created manually (e.g. an alternative route calculated in the background)

+		notify(ROUTING_ERROR_ROUTEPREFERENCENOTSUPPORTED) is emitted if an application tries to set a route preference which is not supported (e.g. (USE,CRIME_AREA)). The preferences which are not supported are product dependent.

 	**>

 	method setRoutePreferences {

 		in {

@@ -393,6 +399,7 @@ interface Routing {
 

 	<**

 		@description : This method sets a list of means of transportation that must be considered when calculating a route

+		notify(ROUTING_ERROR_OPERATIONNOTALLOWED) is emitted if an application tries to set transportation means for a route which is not created manually (e.g. an alternative route calculated in the background)

 	**>

 	method setTransportationMeans {

 		in {

@@ -438,6 +445,7 @@ interface Routing {
 

 	<**

 		@description : setExcludedAreas = This method sets the areas to be excluded when calculating a route

+		notify(ROUTING_ERROR_OPERATIONNOTALLOWED) is emitted if an application tries to set excluded areas for a route which is not created manually (e.g. an alternative route calculated in the background)

 	**>

 	method setExcludedAreas {

 		in {

@@ -474,6 +482,9 @@ interface Routing {
 

 	<**

 		@description : setWaypoints = This method sets a list of waypoints

+		notify(ROUTING_ERROR_WAYPOINTCANNOTBECHANGED) is emitted when a client application tries to change the waypoints while the route guidance is active

+		notify(ROUTING_ERROR_TOOMANYWAYPOINTS) is emitted when a client application tries to set a number of waypoints that exceeds the system capabilities

+		notify(ROUTING_ERROR_OPERATIONNOTALLOWED) is emitted if an application tries to set waypoints for a route which is not created manually (e.g. an alternative route calculated in the background)

 	**>

 	method setWaypoints {

 		in {

@@ -521,6 +532,7 @@ interface Routing {
 

 	<**

 		@description : calculateRoute = This method starts a route calculation

+		notify(ROUTING_ERROR_OPERATIONNOTALLOWED) is emitted if an application tries to calculate a route which is not created manually (e.g. an alternative route calculated in the background)

 	**>

 	method calculateRoute {

 		in {

@@ -557,6 +569,7 @@ interface Routing {
 

 	<**

 		@description : calculateRoutes = This method allows a client to calculate alternative routes that differs from a list of already calculated routes

+		notify(ROUTING_ERROR_OPERATIONNOTALLOWED) is emitted if an application tries to calculate an alternative to a route which is not created manually (e.g. an alternative route calculated in the background)

 	**>

 	method calculateRoutes {

 		in {

@@ -783,5 +796,13 @@ interface Routing {
 		}

 	}

 

+	<**

+		@description : notify = This signal is emitted when something wrong occured when invoking the API 

+	**>

+	broadcast notify {

+		out {

+			Notification notification

+		}

+	}

 

 }
\ No newline at end of file
diff --git a/api/franca/navigation/navigationcore/Session.fidl b/api/franca/navigation/navigationcore/Session.fidl
index c136000..9da1b40 100644
--- a/api/franca/navigation/navigationcore/Session.fidl
+++ b/api/franca/navigation/navigationcore/Session.fidl
@@ -8,6 +8,7 @@ package org.genivi.navigation.navigationcore
 
 import org.genivi.CommonTypes.* from "../../CommonTypes.fidl"
 import org.genivi.navigation.NavigationTypes.* from "../NavigationTypes.fidl"
+import org.genivi.navigation.navigationcore.NavigationCoreTypes.* from "NavigationCoreTypes.fidl"
 
 
 <** @description : This interface offers methods that implement the navigation core session functionality of a navigation system.**>
@@ -25,7 +26,9 @@ interface Session {
 		}	
 	}	
 
-	<** @description : createSession = This method creates a new session and retrieves a handle .**>
+	<** @description : createSession = This method creates a new session and retrieves a handle .
+		notify(SESSION_ERROR_NOMORESESSIONHANDLES) is emitted if no more session handles are available
+	**>
 	method createSession {
 		in {
 			<**
@@ -42,7 +45,9 @@ interface Session {
 		}
 	}
 
-	<** @description : deleteSession = This method deletes a session and its associated resources .**>
+	<** @description : deleteSession = This method deletes a session and its associated resources .
+		notify(SESSION_ERROR_SESSIONNOTAVAILABLE) is emitted if an application tries to delete a session handle that is not available
+	**>
 	method deleteSession {
 		in {
 			<**	@description : sessionHandle **>
@@ -78,5 +83,14 @@ interface Session {
 			Handle sessionHandle			
 		}
 	}
+
+	<**
+		@description : notify = This signal is emitted when something wrong occured when invoking the API 
+	**>
+	broadcast notify {
+		out {
+			Notification notification
+		}
+	}
 	
 }