summaryrefslogtreecommitdiff
path: root/api/navigation-core/genivi-navigationcore-configuration.xml
blob: b121f60469631b44040b915679e0988a9fa84b9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="introspect.xsl"?>
<!-- SPDX-License-Identifier: MPL-2.0
     Copyright (C) 2014, BMW Car IT GmbH, Continental Automotive GmbH, PCA Peugeot Citroën, XS Embedded GmbH,   TomTom International B.V., Alpine Electronics R&D Europe GmbH, AISIN AW CO., LTD.,  Neusoft Technology Solutions GmbH, Jaguar Land Rover Limited, Visteon Corporation
     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/.
-->
<node xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="/org/genivi/navigationcore" xsi:noNamespaceSchemaLocation="introspect.xsd">
  <interface name="org.genivi.navigation.navigationcore.Configuration">
    <version>3.0.0 (21-01-2014)</version>
    <doc>
      <line>Configuration = This interface offers functions to set and retrieve configuration parameters</line>
    </doc>
    <method name="GetVersion">
      <doc>
        <line>GetVersion = This method returns the API version implemented by the server application</line>
      </doc>
      <arg name="version" type="(qqqs)" direction="out">
        <doc>
          <line>version = struct(major,minor,micro,date)</line>
          <line>major = when the major changes, then backward compatibility with previous releases is not granted</line>
          <line>minor = 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)</line>
          <line>micro = when the micro changes, then backward compatibility with previous releases is granted (bug fixes or documentation modifications)</line>
          <line>date = release date (e.g. 21-06-2011)</line>
        </doc>
      </arg>
    </method>
    <method name="SetUnitsOfMeasurement">
      <doc>
        <line>SetUnitsOfMeasurement = This method sets the units of measurement</line>
      </doc>
      <arg name="unitsOfMeasurement" type="a{ii}" direction="in">
        <doc>
          <line>unitsOfMeasurementList = array[unitsOfMeasurement]</line>
          <line>unitsOfMeasurement = tuple (key,value)</line>
          <line>key = enum(INVALID,LENGTH, ... )</line>
          <line>key = LENGTH, value = value of type 'i', that represents an enum(INVALID,METER,MILE, ... )</line>
        </doc>
      </arg>
    </method>
    <method name="GetUnitsOfMeasurement">
      <doc>
        <line>GetUnitsOfMeasurement = This method retrieves the units of measurement</line>
      </doc>
      <arg name="unitsOfMeasurement" type="a{ii}" direction="out">
        <doc>
          <line>unitsOfMeasurementList = array[unitsOfMeasurement]</line>
          <line>unitsOfMeasurement = tuple (key,value)</line>
          <line>key = enum(INVALID,LENGTH, ... )</line>
          <line>key = LENGTH, value = value of type 'i', that represents an enum(INVALID,METER,MILE, ... )</line>
        </doc>
      </arg>
    </method>
    <method name="GetSupportedUnitsOfMeasurement">
      <doc>
        <line>GetSupportedUnitsOfMeasurement = This method retrieves the supported units of measurement</line>
      </doc>
      <arg name="unitsOfMeasurementList" type="a{iai}" direction="out">
        <doc>
          <line>unitsOfMeasurementList = array[unitsOfMeasurement]</line>
          <line>unitsOfMeasurement = dictionary[key,value]</line>
          <line>dictionary = array of tuples (key,value)</line>
          <line>key = enum(INVALID,LENGTH, ... )</line>
          <line>key = LENGTH, value = value of type 'ai'; 'i' is an enum(INVALID,METER,MILE, ... )</line>
        </doc>
      </arg>
    </method>
    <method name="SetTimeFormat">
      <doc>
        <line>SetTimeFormat = This method sets the time format</line>
      </doc>
      <arg name="timeFormat" type="i" direction="in">
        <doc>
          <line>timeFormat = enum(INVALID,12H,24H, ... )</line>
        </doc>
      </arg>
    </method>
    <method name="GetTimeFormat">
      <doc>
        <line>GetTimeFormat = This method retrieves the time format</line>
      </doc>
      <arg name="timeFormat" type="i" direction="out">
        <doc>
          <line>timeFormat = enum(INVALID,12H,24H, ... )</line>
        </doc>
      </arg>
    </method>
    <method name="GetSupportedTimeFormats">
      <doc>
        <line>GetSupportedTimeFormats = This method retrieves the supported time formats</line>
      </doc>
      <arg name="timeFormatList" type="ai" direction="out">
        <doc>
          <line>timeFormatList = array[timeFormat]</line>
          <line>timeFormat = enum(INVALID,12H,24H, ... )</line>
        </doc>
      </arg>
    </method>
    <method name="SetCoordinatesFormat">
      <doc>
        <line>SetCoordinatesFormat = This method sets the coordinates format</line>
      </doc>
      <arg name="coordinatesFormat" type="i" direction="in">
        <doc>
          <line>coordinatesFormat = enum(INVALID,DEGREES,MINUTES,SECONDS, ... )</line>
          <line>DEGREES format = d.dº</line>
          <line>MINUTES format = dºm.m'</line>
          <line>SECONDS format = dºm's"</line>
        </doc>
      </arg>
    </method>
    <method name="GetCoordinatesFormat">
      <doc>
        <line>GetCoordinatesFormat = This method retrieves the coordinates format</line>
      </doc>
      <arg name="coordinatesFormat" type="i" direction="out">
        <doc>
          <line>coordinatesFormat = enum(INVALID,DEGREES,MINUTES,SECONDS, ... )</line>
          <line>DEGREES format = d.dº</line>
          <line>MINUTES format = dºm.m'</line>
          <line>SECONDS format = dºm's"</line>
        </doc>
      </arg>
    </method>
    <method name="GetSupportedCoordinatesFormats">
      <doc>
        <line>GetSupportedCoordinatesFormats = This method retrieves the supported coordinates formats</line>
      </doc>
      <arg name="coordinatesFormatList" type="ai" direction="out">
        <doc>
          <line>coordinatesFormatList = array[coordinatesFormat]</line>
          <line>coordinatesFormat = enum(INVALID,DEGREES,MINUTES,SECONDS, ... )</line>
          <line>DEGREES format = d.dº</line>
          <line>MINUTES format = dºm.m'</line>
          <line>SECONDS format = dºm's"</line>
        </doc>
      </arg>
    </method>
    <method name="SetLocale">
      <doc>
        <line>SetLocale = This method sets the current language and country</line>
      </doc>
      <arg name="languageCode" type="s" direction="in">
        <doc>
          <line>languageCode = ISO 639‐3 language code (lower case)</line>
        </doc>
      </arg>
      <arg name="countryCode" type="s" direction="in">
        <doc>
          <line>countryCode = ISO 3166‐1 alpha 3 country code (upper case)</line>
        </doc>
      </arg>
      <arg name="scriptCode" type="s" direction="in">
        <doc>
          <line>scriptCode= ISO 15924 alpha 4 script code (upper case)</line>
        </doc>
      </arg>
    </method>
    <method name="GetLocale">
      <doc>
        <line>GetLocale = This method retrieves the current language and country</line>
      </doc>
      <arg name="languageCode" type="s" direction="out">
        <doc>
          <line>languageCode = ISO 639‐3 language code (lower case)</line>
        </doc>
      </arg>
      <arg name="countryCode" type="s" direction="out">
        <doc>
          <line>countryCode = ISO 3166‐1 alpha 3 country code (upper case)</line>
        </doc>
      </arg>
      <arg name="scriptCode" type="s" direction="out">
        <doc>
          <line>scriptCode= ISO 15924 alpha 4 script code (upper case)</line>
        </doc>
      </arg>
    </method>
    <method name="GetSupportedLocales">
      <doc>
        <line>GetSupportedLocales = This method retrieves the supported languages and countries</line>
      </doc>
      <arg name="localeList" type="a(sss)" direction="out">
        <doc>
          <line>localeList = array[struct(languageCode,countryCode)]</line>
          <line>languageCode = ISO 639-3 language code (lower case)</line>
          <line>countryCode = ISO 3166-1 alpha 3 country code (upper case)</line>
          <line>scriptCode = ISO 15924 alpha 4 script code (upper case)</line>
        </doc>
      </arg>
    </method>
    <signal name="ConfigurationChanged">
      <doc>
        <line>ConfigurationChanged = This signal is sent to the clients when one or more configuration settings changes</line>
      </doc>
      <arg name="changedSettings" type="ai">
        <doc>
          <line>changedSettings = array[setting]</line>
          <line>setting = enum(INVALID,UNITS_OF_MEASUREMENT,LOCALE,TIME_FORMAT,COORDINATES_FORMAT, ... )</line>
        </doc>
      </arg>
    </signal>
  </interface>
</node>