diff options
Diffstat (limited to 'enhanced-position-service/api/franca/EnhancedPosition.fidl')
| -rwxr-xr-x | enhanced-position-service/api/franca/EnhancedPosition.fidl | 175 |
1 files changed, 51 insertions, 124 deletions
diff --git a/enhanced-position-service/api/franca/EnhancedPosition.fidl b/enhanced-position-service/api/franca/EnhancedPosition.fidl index 5f47b07..8b7bdba 100755 --- a/enhanced-position-service/api/franca/EnhancedPosition.fidl +++ b/enhanced-position-service/api/franca/EnhancedPosition.fidl @@ -12,140 +12,67 @@ package org.genivi.EnhancedPositionService import org.genivi.EnhancedPositionService.EnhancedPositionServiceTypes.* from "EnhancedPositionServiceTypes.fidl"
-<**
- @description : EnhancedPosition = This interface offers functionalities to retrieve the enhanced position of the vehicle
-**>
+<** @description : EnhancedPosition = This interface offers functionalities to retrieve the enhanced position of the vehicle **>
interface EnhancedPosition {
- version {
- major 0
- minor 0
- }
+ 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 {
- out {
- Version ^version
- }
- }
-
- <**
- @description : GetData = This method returns a given set of positioning data (e.g. Position, Course, Accuracy, Status, ... )
- Note: If a requested value is invalid, it's not returned to the client application
- **>
- method GetData {
- in {
- PositionDataKey[] valuesToReturn
- }
- out {
- PositionData data
- }
- }
-
- <**
- @description : GetPosition = This method returns the current position
- Note: If a requested value is invalid, it's not returned to the client application
- **>
- method GetPosition {
- out {
- PositionInfo position
- }
- }
+ out {
+ Version ^version
+ }
+ }
- <**
- @description : GetRotationRate = This method returns the rotation rate
- Note: If a requested value is invalid, it's not returned to the client application
- **>
- method GetRotationRate {
- out {
- RotationRate rotationRate
- }
- }
-
- <**
- @description : GetAccuracy = This method returns the accuracy
- Note: If a requested value is invalid, it's not returned to the client application
+ <** @description : GetPositionInfo = This method returns a given set of positioning data (e.g. Position, Course, Accuracy, Status, ... )
+ Note: If a requested value is invalid, it's not returned to the client application
**>
- method GetAccuracy {
- out {
- AccuracyInfo accuracy
- }
- }
-
+ method GetPositionInfo {
+ in {
+ <** @description : valuesToReturn = Bitmask obtained as result of a bitwise OR operation on the keys corresponding to the values to be returned **>
+ Bitmask valuesToReturn
+ }
+ out {
+ <** @description : timestamp = Timestamp of the acquisition of the position data [ms] **>
+ Timestamp timestamp
+ <** @description : data = Position data **>
+ PositionInfo[] data
+ }
+ }
+
<**
@description : GetSatelliteInfo = This method returns information about the current satellite constellation
Note: If a requested value is invalid, it's not returned to the client application
**>
- method GetSatelliteInfo {
- out {
- SatelliteInfo satelliteInfo
- }
- }
-
- <**
- @description : GetStatus = This method returns the status of this service
- Note: If a requested value is invalid, it's not returned to the client application
- **>
- method GetStatus {
- out {
- StatusInfo status
- }
- }
-
- <**
- @description : GetTime = This method returns UTC time and date
- Note: If a requested value is invalid, it's not returned to the client application
- **>
- method GetTime {
- out {
- TimeInfo time
- }
- }
-
- <**
- @description : PositionUpdate = This signal is called to notifiy a client application of a position change. The update frequency is implementation specific. The maximal allowed frequency is 10Hz
+ method GetSatelliteInfo {
+ out {
+ <** @description : timestamp = Timestamp of the acquisition of the satellite detail data [ms] **>
+ Timestamp timestamp
+ <** @description : satelliteInfo = satellite information **>
+ SatelliteInfo[] satelliteInfo
+ }
+ }
+
+ <** @description : GetTime = This method returns UTC time and date.
+ Note: If a requested value is invalid, it's not returned to the client application
**>
+ method GetTime {
+ out {
+ <** @description : timestamp = Timestamp of the acquisition of the UTC date/time [ms] **>
+ Timestamp timestamp
+ <** @description : time = UTC date/time **>
+ TimeInfo time
+ }
+ }
+
+ <** @description : PositionUpdate = This signal is called to notifiy a client application of a position change. The update frequency is implementation specific. The maximal allowed frequency is 10Hz **>
broadcast PositionUpdate {
- out {
- PositionDataKey[] changedValues
- }
- }
-
- <**
- @description : RotationRateUpdated = This signal is emitted when the rotation rate changes
- **>
- broadcast RotationRateUpdate {
- out {
- RotationRateKey[] changedValues
- }
- }
-
- <**
- @description : AccuracyUpdated = This signal is emitted when the accuracy changes
- **>
- broadcast AccuracyUpdate {
- out {
- AccuracyInfoKey[] changedValues
- }
- }
-
- <**
- @description : SatelliteInfoUpdate = This signal is emitted when information about the current satellite information is updated
- **>
- broadcast SatelliteInfoUpdate {
- out {
- SatelliteInfoKey[] changedValues
- }
- }
-
- <**
- @description : StatusUpdate = This signal is emitted when the status of this service changes
- **>
- broadcast StatusUpdate {
- out {
- StatusInfoKey[] changedValues
- }
- }
+ out {
+ <** @description : valuesToReturn = Bitmask obtained as result of a bitwise OR operation on the keys corresponding to the values that changed **>
+ Bitmask changedValues
+ }
+ }
}
|