PluginCommandInterfaceDbus/include/CAmCommandSenderDbus.h

   1 /**
   2  * Copyright (C) 2011, BMW AG
   3  *
   4  * GeniviAudioMananger DbusPlugin
   5  *
   6  * \file CommandSender.h
   7  *
   8  * \date 20-Oct-2011 3:42:04 PM
   9  * \author Christian Mueller (christian.ei.mueller@bmw.de)
  10  *
  11  * \section License
  12  * GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
  13  * Copyright (C) 2011, BMW AG Christian Mueller  Christian.ei.mueller@bmw.de
  14  *
  15  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
  16  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License, version 2.1, for more details.
  17  * You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
  18  * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.
  19  * Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.
  20  * As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.
  21  * Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.
  22  *
  23  * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
  24  */
  25
  26 #ifndef DBUSCOMMANDSENDER_H_
  27 #define DBUSCOMMANDSENDER_H_
  28
  29 #include <dbus/dbus.h>
  30 #include <map>
  31 #include "shared/CAmDbusWrapper.h"
  32 #include "CAmDbusMessageHandler.h"
  33 #include "IAmCommandReceiverShadow.h"
  34 #include "command/IAmCommandSend.h"
  35
  36 #ifdef UNIT_TEST
  37 #include  "../test/CAmCommandSenderDbusBackdoor.h"
  38 #endif
  39
  40
  41
  42 namespace am
  43 {
  44
  45 const char MY_NODE[] = "CommandInterface";
  46
  47 /**
  48  * Dbus Implementation of CommandSendInterface
  49  */
  50 class CAmCommandSenderDbus: public IAmCommandSend
  51 {
  52 public:
  53     CAmCommandSenderDbus();
  54     virtual ~CAmCommandSenderDbus();
  55     am_Error_e startupInterface(IAmCommandReceive* commandreceiveinterface);
  56     void setCommandReady(const uint16_t handle);
  57     void setCommandRundown(const uint16_t handle);
  58     void cbNewMainConnection(const am_MainConnectionType_s mainConnection);
  59     void cbRemovedMainConnection(const am_mainConnectionID_t mainConnection);
  60     void cbNewSink(const am_SinkType_s& sink);
  61     void cbRemovedSink(const am_sinkID_t sinkID);
  62     void cbNewSource(const am_SourceType_s& source);
  63     void cbRemovedSource(const am_sourceID_t source);
  64     void cbNumberOfSinkClassesChanged();
  65     void cbNumberOfSourceClassesChanged();
  66     void cbMainConnectionStateChanged(const am_mainConnectionID_t connectionID, const am_ConnectionState_e connectionState);
  67     void cbMainSinkSoundPropertyChanged(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty);
  68     void cbMainSourceSoundPropertyChanged(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty);
  69     void cbSinkAvailabilityChanged(const am_sinkID_t sinkID, const am_Availability_s& availability);
  70     void cbSourceAvailabilityChanged(const am_sourceID_t sourceID, const am_Availability_s& availability);
  71     void cbVolumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume);
  72     void cbSinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState);
  73     void cbSystemPropertyChanged(const am_SystemProperty_s& systemProperty);
  74     void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time);
  75     void getInterfaceVersion(std::string& version) const;
  76
  77 #ifdef UNIT_TEST
  78     friend class CAmCommandSenderDbusBackdoor;
  79 #endif
  80 private:
  81     CAmDbusMessageHandler mCAmDbusMessageHandler; ///< ! instance of message handler
  82     IAmCommandReceiverShadow mIAmCommandReceiverShadow; ///< ! instance of shadow
  83     CAmDbusWrapper* mpCAmDbusWrapper; ///< ! pointer to dbus wrapper
  84     IAmCommandReceive* mpIAmCommandReceive; ///< ! pointer to commandReceive Interface
  85     bool mReady; ///< ! if false, calls shall be ignored.
  86
  87     /**
  88      * list of sinks, needed to send out only deltas
  89      */
  90     std::vector<am_SinkType_s> mlistSinks;
  91
  92     /**
  93      * list of sources, needed to send out only deltas
  94      */
  95     std::vector<am_SourceType_s> mlistSources;
  96
  97     /**
  98      * used as comparison function for am_SinkType_s
  99      */
 100     struct sortBySinkID
 101     {
 102         bool operator()(const am_SinkType_s & a, const am_SinkType_s & b)
 103         {
 104             return (a.sinkID < b.sinkID);
 105         }
 106     };
 107
 108     /**
 109      * used as comparison function for am_SourceType_s
 110      */
 111     struct sortBySourceID
 112     {
 113         bool operator()(const am_SourceType_s & a, const am_SourceType_s & b)
 114         {
 115             return (a.sourceID < b.sourceID);
 116         }
 117     };
 118
 119 };
 120
 121 }
 122
 123 #endif /* DBUSCOMMANDSENDER_H_ */