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
|
/*
* This file was generated by the CommonAPI Generators.
* Used org.genivi.commonapi.core 2.1.6.v20140519.
* Used org.franca.core 0.8.11.201401091023.
*
* 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/.
*/
/**
* EnhancedPosition = This interface offers functionalities to retrieve the
* enhanced position of the vehicle
*/
#ifndef ORG_GENIVI_ENHANCEDPOSITIONSERVICE_Enhanced_Position_STUB_H_
#define ORG_GENIVI_ENHANCEDPOSITIONSERVICE_Enhanced_Position_STUB_H_
#include <org/genivi/EnhancedPositionService/EnhancedPositionServiceTypes.h>
#include "EnhancedPosition.h"
#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#define COMMONAPI_INTERNAL_COMPILATION
#endif
#include <CommonAPI/InputStream.h>
#include <CommonAPI/OutputStream.h>
#include <CommonAPI/SerializableStruct.h>
#include <cstdint>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
#include <CommonAPI/Stub.h>
#undef COMMONAPI_INTERNAL_COMPILATION
namespace org {
namespace genivi {
namespace EnhancedPositionService {
/**
* Receives messages from remote and handles all dispatching of deserialized calls
* to a stub for the service EnhancedPosition. Also provides means to send broadcasts
* and attribute-changed-notifications of observable attributes as defined by this service.
* An application developer should not need to bother with this class.
*/
class EnhancedPositionStubAdapter: virtual public CommonAPI::StubAdapter, public EnhancedPosition {
public:
/**
* Sends a broadcast event for PositionUpdate. Should not be called directly.
* Instead, the "fire<broadcastName>Event" methods of the stub should be used.
*/
virtual void firePositionUpdateEvent(const EnhancedPositionServiceTypes::Bitmask& changedValues) = 0;
virtual void deactivateManagedInstances() = 0;
protected:
/**
* Defines properties for storing the ClientIds of clients / proxies that have
* subscribed to the selective broadcasts
*/
};
/**
* Defines the necessary callbacks to handle remote set events related to the attributes
* defined in the IDL description for EnhancedPosition.
* For each attribute two callbacks are defined:
* - a verification callback that allows to verify the requested value and to prevent setting
* e.g. an invalid value ("onRemoteSet<AttributeName>").
* - an action callback to do local work after the attribute value has been changed
* ("onRemote<AttributeName>Changed").
*
* This class and the one below are the ones an application developer needs to have
* a look at if he wants to implement a service.
*/
class EnhancedPositionStubRemoteEvent {
public:
virtual ~EnhancedPositionStubRemoteEvent() { }
};
/**
* Defines the interface that must be implemented by any class that should provide
* the service EnhancedPosition to remote clients.
* This class and the one above are the ones an application developer needs to have
* a look at if he wants to implement a service.
*/
class EnhancedPositionStub: public virtual CommonAPI::Stub<EnhancedPositionStubAdapter, EnhancedPositionStubRemoteEvent> {
public:
virtual ~EnhancedPositionStub() { }
virtual const CommonAPI::Version& getInterfaceVersion(std::shared_ptr<CommonAPI::ClientId> clientId) = 0;
/**
* GetVersion = This method returns the API version implemented by the server
* application
*/
/// This is the method that will be called on remote calls on the method GetVersion.
virtual void GetVersion(const std::shared_ptr<CommonAPI::ClientId> clientId, EnhancedPositionServiceTypes::Version& version) = 0;
/**
* 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
*/
/// This is the method that will be called on remote calls on the method GetPositionInfo.
virtual void GetPositionInfo(const std::shared_ptr<CommonAPI::ClientId> clientId, EnhancedPositionServiceTypes::Bitmask valuesToReturn, EnhancedPositionServiceTypes::Timestamp& timestamp, EnhancedPositionServiceTypes::PositionInfo& data) = 0;
/**
* 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
*/
/// This is the method that will be called on remote calls on the method GetSatelliteInfo.
virtual void GetSatelliteInfo(const std::shared_ptr<CommonAPI::ClientId> clientId, EnhancedPositionServiceTypes::Timestamp& timestamp, EnhancedPositionServiceTypes::SatelliteInfo& satelliteInfo) = 0;
/**
* GetTime = This method returns UTC time and date.
Note: If a
* requested value is invalid, it's not returned to the client application
*/
/// This is the method that will be called on remote calls on the method GetTime.
virtual void GetTime(const std::shared_ptr<CommonAPI::ClientId> clientId, EnhancedPositionServiceTypes::Timestamp& timestamp, EnhancedPositionServiceTypes::TimeInfo& time) = 0;
/**
* 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
*/
/// Sends a broadcast event for PositionUpdate.
virtual void firePositionUpdateEvent(const EnhancedPositionServiceTypes::Bitmask& changedValues) = 0;
using CommonAPI::Stub<EnhancedPositionStubAdapter, EnhancedPositionStubRemoteEvent>::initStubAdapter;
typedef CommonAPI::Stub<EnhancedPositionStubAdapter, EnhancedPositionStubRemoteEvent>::StubAdapterType StubAdapterType;
typedef CommonAPI::Stub<EnhancedPositionStubAdapter, EnhancedPositionStubRemoteEvent>::RemoteEventHandlerType RemoteEventHandlerType;
typedef EnhancedPositionStubRemoteEvent RemoteEventType;
typedef EnhancedPosition StubInterface;
};
} // namespace EnhancedPositionService
} // namespace genivi
} // namespace org
#endif // ORG_GENIVI_ENHANCEDPOSITIONSERVICE_Enhanced_Position_STUB_H_
|
