summaryrefslogtreecommitdiff
path: root/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.h
blob: 0909211384b09ed8393330dde94301f3644dab08 (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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
/*
* This file was generated by the CommonAPI Generators.
* Used org.genivi.commonapi.core 2.1.6.v20150127.
* Used org.franca.core 0.8.10.201309262002.
*
* 
*/
/**
 * The interface towards the Controlling Instance (e.g HMI). It handles the
 *  communication towards the HMI and other system components who need to interact
 *  with the audiomanagement.
There are two rules that have to be kept in mind
 *  when implementing against this interface:
 * @author Christian Mueller
 */
#ifndef ORG_GENIVI_AM_Command_Control_DBUS_STUB_ADAPTER_H_
#define ORG_GENIVI_AM_Command_Control_DBUS_STUB_ADAPTER_H_

#include <org/genivi/am/CommandControlStub.h>

#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#define COMMONAPI_INTERNAL_COMPILATION
#endif

#include <CommonAPI/DBus/DBusStubAdapterHelper.h>
#include <CommonAPI/DBus/DBusStubAdapter.h>
#include <CommonAPI/DBus/DBusFactory.h>
#include <CommonAPI/DBus/DBusServicePublisher.h>

#undef COMMONAPI_INTERNAL_COMPILATION

namespace org {
namespace genivi {
namespace am {

typedef CommonAPI::DBus::DBusStubAdapterHelper<CommandControlStub> CommandControlDBusStubAdapterHelper;

class CommandControlDBusStubAdapterInternal: public virtual CommandControlStubAdapter, public CommandControlDBusStubAdapterHelper {
 public:
    CommandControlDBusStubAdapterInternal(
            const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory,
            const std::string& commonApiAddress,
            const std::string& dbusInterfaceName,
            const std::string& dbusBusName,
            const std::string& dbusObjectPath,
            const std::shared_ptr<CommonAPI::DBus::DBusProxyConnection>& dbusConnection,
            const std::shared_ptr<CommonAPI::StubBase>& stub);

    ~CommandControlDBusStubAdapterInternal();

    virtual const bool hasFreedesktopProperties();


    /**
     * Callback that is called when the number of connections change
     */
    void fireNewMainConnectionEvent(const am_MainConnectionType_s& mainConnection);
    /**
     * Callback that is called when the number of connections change
     */
    void fireRemovedMainConnectionEvent(const am_mainConnectionID_t& mainConnection);
    /**
     * Callback that is called when the number of sinks change
     */
    void fireNewSinkEvent(const am_SinkType_s& sink);
    /**
     * Callback that is called when the number of sinks change
     */
    void fireRemovedSinkEvent(const am_sinkID_t& sinkID);
    /**
     * Callback that is called when the number of sources change
     */
    void fireNewSourceEvent(const am_SourceType_s& source);
    /**
     * Callback that is called when the number of sources change
     */
    void fireRemovedSourceEvent(const am_sourceID_t& source);
    /**
     * this callback is fired if the number of sink classes changed
     */
    void fireNumberOfSinkClassesChangedEvent();
    /**
     * this callback is fired if the number of source classes changed
     */
    void fireNumberOfSourceClassesChangedEvent();
    /**
     * This callback is called when the ConnectionState of a connection changed.
     */
    void fireMainConnectionStateChangedEvent(const am_mainConnectionID_t& connectionID, const am_ConnectionState_e& connectionState);
    /**
     * this callback indicates that a sinkSoundProperty has changed.
     */
    void fireMainSinkSoundPropertyChangedEvent(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty);
    /**
     * this callback indicates that a sourceSoundProperty has changed.
     */
    void fireMainSourceSoundPropertyChangedEvent(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty);
    /**
     * this callback is called when the availability of a sink has changed
     */
    void fireSinkAvailabilityChangedEvent(const am_sinkID_t& sinkID, const am_Availability_s& availability);
    /**
     * this callback is called when the availability of source has changed.
     */
    void fireSourceAvailabilityChangedEvent(const am_sourceID_t& sourceID, const am_Availability_s& availability);
    /**
     * this callback indicates a volume change on the indicated sink
     */
    void fireVolumeChangedEvent(const am_sinkID_t& sinkID, const am_mainVolume_t& volume);
    /**
     * this callback indicates a mute state change on a sink.
     */
    void fireSinkMuteStateChangedEvent(const am_sinkID_t& sinkID, const am_MuteState_e& muteState);
    /**
     * is fired if a systemProperty changed
     */
    void fireSystemPropertyChangedEvent(const am_SystemProperty_s& systemProperty);
    /**
     * This callback is fired if the timinginformation for a mainConnectionID changed
     */
    void fireTimingInformationChangedEvent(const am_mainConnectionID_t& mainConnectionID, const am_timeSync_t& time);
    /**
     * This callback is called when a sink is updated.
     */
    void fireSinkUpdatedEvent(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_MainSoundProperty_L& listMainSoundProperties);
    /**
     * This callback is called when a source is updated.
     */
    void fireSourceUpdatedEvent(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_MainSoundProperty_L& listMainSoundProperties);
    /**
     * This callback is called when a notificated value of a sink changes.
     */
    void fireSinkNotificationEvent(const am_sinkID_t& sinkID, const am_NotificationPayload_s& notification);
    /**
     * This callback is called when a notifcated value of a source changes.
     */
    void fireSourceNotificationEvent(const am_sourceID_t& sourceID, const am_NotificationPayload_s& notification);
    /**
     * This callback is triggered when a mainNotificationConfiguration is changed.
     */
    void fireMainSinkNotificationConfigurationChangedEvent(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration);
    /**
     * This callback is triggered when a mainNotificationConfiguration is changed.
     */
    void fireMainSourceNotificationConfigurationChangedEvent(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration);


    const CommandControlDBusStubAdapterHelper::StubDispatcherTable& getStubDispatcherTable();
    const CommonAPI::DBus::StubAttributeTable& getStubAttributeTable();

    void deactivateManagedInstances();


static CommonAPI::DBus::DBusGetAttributeStubDispatcher<
        CommandControlStub,
        CommonAPI::Version
        > getCommandControlInterfaceVersionStubDispatcher;



/**
 * connects a source to sink
(at)return E_OK on success, E_NOT_POSSIBLE on
 *  failure, E_ALREADY_EXISTS if the connection does already exists
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sourceID_t, am_sinkID_t>,
    std::tuple<am_mainConnectionID_t, am_Error_e>
    > connectStubDispatcher;
/**
 * disconnects a mainConnection
(at)return E_OK on successes, E_NON_EXISTENT if
 *  the connection does not exist, E_NOT_POSSIBLE on error.
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_mainConnectionID_t>,
    std::tuple<am_Error_e>
    > disconnectStubDispatcher;
/**
 * sets the volume for a sink
(at)return E_OK on success, E_UNKOWN on error,
 *  E_OUT_OF_RANGE in case the value is out of range
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sinkID_t, am_mainVolume_t>,
    std::tuple<am_Error_e>
    > setVolumeStubDispatcher;
/**
 * This function is used to increment or decrement the current volume for a
 *  sink.
(at)return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the
 *  value is not in the given volume range.
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sinkID_t, int16_t>,
    std::tuple<am_Error_e>
    > volumeStepStubDispatcher;
/**
 * sets the mute state of a sink
(at)return E_OK on success, E_UNKNOWN on error.
 *  If the mute state is already the desired one, the Daemon will return E_OK.
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sinkID_t, am_MuteState_e>,
    std::tuple<am_Error_e>
    > setSinkMuteStateStubDispatcher;
/**
 * This method is used to set sound properties, e.g. Equalizer Values. Since the
 *  capabilities of the system can differ, the exact key value pairs can be
 *  extended in each product
(at)return E_OK on success, E_OUT_OF_RANGE if value
 *  exceeds range, E_UNKNOWN in case of an error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sinkID_t, am_MainSoundProperty_s>,
    std::tuple<am_Error_e>
    > setMainSinkSoundPropertyStubDispatcher;
/**
 * This method is used to set sound properties, e.g. Equalizer Values. Since the
 *  capabilities of the system can differ, the exact key value pairs can be
 *  extended in each product
(at)return E_OK on success, E_OUT_OF_RANGE if value
 *  exceeds range, E_UNKNOWN in case of an error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sourceID_t, am_MainSoundProperty_s>,
    std::tuple<am_Error_e>
    > setMainSourceSoundPropertyStubDispatcher;
/**
 * is used to set a specific system property.
(at)return E_OK on success,
 *  E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_SystemProperty_s>,
    std::tuple<am_Error_e>
    > setSystemPropertyStubDispatcher;
/**
 * returns the actual list of MainConnections
(at)return E_OK on success,
 *  E_DATABASE_ERROR on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<>,
    std::tuple<am_MainConnection_L, am_Error_e>
    > getListMainConnectionsStubDispatcher;
/**
 * returns the actual list of Sinks
(at)return E_OK on success, E_DATABASE_ERROR
 *  on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<>,
    std::tuple<am_SinkType_L, am_Error_e>
    > getListMainSinksStubDispatcher;
/**
 * returns the actual list of Sources
(at)return E_OK on success, E_DATABASE_ERROR
 *  on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<>,
    std::tuple<am_SourceType_L, am_Error_e>
    > getListMainSourcesStubDispatcher;
/**
 * This is used to retrieve all source sound properties related to a source.
 *  Returns a vector of the sound properties and values as pair
(at)return E_OK on
 *  success, E_DATABASE_ERROR on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sinkID_t>,
    std::tuple<am_MainSoundProperty_L, am_Error_e>
    > getListMainSinkSoundPropertiesStubDispatcher;
/**
 * This is used to retrieve all source sound properties related to a
 *  source.
(at)return E_OK on success, E_DATABASE_ERROR on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sourceID_t>,
    std::tuple<am_MainSoundProperty_L, am_Error_e>
    > getListMainSourceSoundPropertiesStubDispatcher;
/**
 * This is used to retrieve SourceClass Information of all source classes
 *  
(at)return E_OK on success, E_DATABASE_ERROR on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<>,
    std::tuple<am_SourceClass_L, am_Error_e>
    > getListSourceClassesStubDispatcher;
/**
 * This is used to retrieve SinkClass Information of all sink classes 
(at)return
 *  E_OK on success, E_DATABASE_ERROR on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<>,
    std::tuple<am_SinkClass_L, am_Error_e>
    > getListSinkClassesStubDispatcher;
/**
 * Retrieves a complete list of all systemProperties.
(at)return E_OK on success,
 *  E_DATABASE_ERROR on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<>,
    std::tuple<am_SystemProperty_L, am_Error_e>
    > getListSystemPropertiesStubDispatcher;
/**
 * returns the delay in ms that the audiopath for the given mainConnection
 *  has
(at)return E_OK on success, E_NOT_POSSIBLE if timing information is not
 *  yet retrieved, E_DATABASE_ERROR on read error on the database
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_mainConnectionID_t>,
    std::tuple<am_timeSync_t, am_Error_e>
    > getTimingInformationStubDispatcher;
/**
 * Retrieves the list of MainNotifications for a sink. Does not return the
 *  possible ones.
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sinkID_t>,
    std::tuple<am_NotificationConfiguration_L, am_Error_e>
    > getListMainSinkNotificationConfigurationsStubDispatcher;
/**
 * Retrieves the list of MainNotifications for a source. Does not return the
 *  possible ones.
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sourceID_t>,
    std::tuple<am_NotificationConfiguration_L, am_Error_e>
    > getListMainSourceNotificationConfigurationsStubDispatcher;
/**
 * sets a MainNotificationConfiuration. This can be used to turn on an off
 *  notifications an to change the mode of the configuration.
(at)return E_OK on
 *  success, E_NON_EXISTENT if sinkID does not exists, E_DATABASE_ERROR on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sinkID_t, am_NotificationConfiguration_s>,
    std::tuple<am_Error_e>
    > setMainSinkNotificationConfigurationStubDispatcher;
/**
 * sets a MainNotificationConfiuration. This can be used to turn on an off
 *  notifications an to change the mode of the configuration.
(at)return E_OK on
 *  success, E_NON_EXISTENT if sourceID does not exists, E_DATABASE_ERROR on error
 */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
    CommandControlStub,
    std::tuple<am_sourceID_t, am_NotificationConfiguration_s>,
    std::tuple<am_Error_e>
    > setMainSourceNotificationConfigurationStubDispatcher;




 protected:
    virtual const char* getMethodsDBusIntrospectionXmlData() const;

 private:
    CommandControlDBusStubAdapterHelper::StubDispatcherTable stubDispatcherTable_;
    CommonAPI::DBus::StubAttributeTable stubAttributeTable_;
};

class CommandControlDBusStubAdapter: public CommandControlDBusStubAdapterInternal, public std::enable_shared_from_this<CommandControlDBusStubAdapter> {
public:
    CommandControlDBusStubAdapter(
                         const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory,
                         const std::string& commonApiAddress,
                         const std::string& dbusInterfaceName,
                         const std::string& dbusBusName,
                         const std::string& dbusObjectPath,
                         const std::shared_ptr<CommonAPI::DBus::DBusProxyConnection>& dbusConnection,
                         const std::shared_ptr<CommonAPI::StubBase>& stub) :
            CommonAPI::DBus::DBusStubAdapter(
                            factory,
                            commonApiAddress,
                            dbusInterfaceName,
                            dbusBusName,
                            dbusObjectPath,
                            dbusConnection,
                            false),
            CommandControlDBusStubAdapterInternal(
                            factory,
                            commonApiAddress,
                            dbusInterfaceName,
                            dbusBusName,
                            dbusObjectPath,
                            dbusConnection,
                            stub) { }
};

} // namespace am
} // namespace genivi
} // namespace org

#endif // ORG_GENIVI_AM_Command_Control_DBUS_STUB_ADAPTER_H_