* fix [GAM-28] problems in routingsender.cpp

* [GAM-27] major refactoring: bringing everything to standardized names
* Enhancement of CAmSerializer.h
* improvement of documentation
* adoption & regeneration of inerfaces

5 files changed, 236 insertions, 90 deletions

diff --git a/PluginCommandInterfaceDbus/include/DBusCommandSender.h b/PluginCommandInterfaceDbus/include/CAmCommandSenderDbus.h
index e64e6f6..ad625dc 100644
--- a/PluginCommandInterfaceDbus/include/DBusCommandSender.h
+++ b/PluginCommandInterfaceDbus/include/CAmCommandSenderDbus.h
@@ -26,16 +26,18 @@
 #ifndef DBUSCOMMANDSENDER_H_
 #define DBUSCOMMANDSENDER_H_
 
+#include <dbus/dbus.h>
+#include <map>
+#include "shared/CAmDbusWrapper.h"
+#include "CAmDbusMessageHandler.h"
+#include "IAmCommandReceiverShadow.h"
+#include "command/IAmCommandSend.h"
+
 #ifdef UNIT_TEST
-#include  "../test/DbusCommandInterfaceBackdoor.h"
+#include  "../test/CAmCommandSenderDbusBackdoor.h"
 #endif
 
-#include <command/CommandSendInterface.h>
-#include <dbus/dbus.h>
-#include <dbus/DBusWrapper.h>
-#include <map>
-#include "DBusMessageHandler.h"
-#include "CommandReceiverShadow.h"
+
 
 namespace am
 {
@@ -45,43 +47,42 @@ const char MY_NODE[] = "CommandInterface";
 /**
  * Dbus Implementation of CommandSendInterface
  */
-class DbusCommandSender: public CommandSendInterface
+class CAmCommandSenderDbus: public IAmCommandSend
 {
 public:
-    DbusCommandSender();
-    virtual ~DbusCommandSender();
-    am_Error_e startupInterface(CommandReceiveInterface* commandreceiveinterface) ;
-    void setCommandReady(const uint16_t handle) ;
-    void setCommandRundown(const uint16_t handle) ;
-    void cbNewMainConnection(const am_MainConnectionType_s mainConnection) ;
-    void cbRemovedMainConnection(const am_mainConnectionID_t mainConnection) ;
-    void cbNewSink(const am_SinkType_s& sink) ;
-    void cbRemovedSink(const am_sinkID_t sinkID) ;
-    void cbNewSource(const am_SourceType_s& source) ;
-    void cbRemovedSource(const am_sourceID_t source) ;
-    void cbNumberOfSinkClassesChanged() ;
-    void cbNumberOfSourceClassesChanged() ;
-    void cbMainConnectionStateChanged(const am_mainConnectionID_t connectionID, const am_ConnectionState_e connectionState) ;
-    void cbMainSinkSoundPropertyChanged(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty) ;
-    void cbMainSourceSoundPropertyChanged(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty) ;
-    void cbSinkAvailabilityChanged(const am_sinkID_t sinkID, const am_Availability_s& availability) ;
-    void cbSourceAvailabilityChanged(const am_sourceID_t sourceID, const am_Availability_s& availability) ;
-    void cbVolumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume) ;
-    void cbSinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState) ;
-    void cbSystemPropertyChanged(const am_SystemProperty_s& systemProperty) ;
-    void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) ;
-    void getInterfaceVersion(std::string& version) const ;
+    CAmCommandSenderDbus();
+    virtual ~CAmCommandSenderDbus();
+    am_Error_e startupInterface(IAmCommandReceive* commandreceiveinterface);
+    void setCommandReady(const uint16_t handle);
+    void setCommandRundown(const uint16_t handle);
+    void cbNewMainConnection(const am_MainConnectionType_s mainConnection);
+    void cbRemovedMainConnection(const am_mainConnectionID_t mainConnection);
+    void cbNewSink(const am_SinkType_s& sink);
+    void cbRemovedSink(const am_sinkID_t sinkID);
+    void cbNewSource(const am_SourceType_s& source);
+    void cbRemovedSource(const am_sourceID_t source);
+    void cbNumberOfSinkClassesChanged();
+    void cbNumberOfSourceClassesChanged();
+    void cbMainConnectionStateChanged(const am_mainConnectionID_t connectionID, const am_ConnectionState_e connectionState);
+    void cbMainSinkSoundPropertyChanged(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty);
+    void cbMainSourceSoundPropertyChanged(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty);
+    void cbSinkAvailabilityChanged(const am_sinkID_t sinkID, const am_Availability_s& availability);
+    void cbSourceAvailabilityChanged(const am_sourceID_t sourceID, const am_Availability_s& availability);
+    void cbVolumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume);
+    void cbSinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState);
+    void cbSystemPropertyChanged(const am_SystemProperty_s& systemProperty);
+    void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time);
+    void getInterfaceVersion(std::string& version) const;
 
 #ifdef UNIT_TEST
-    friend class DbusCommandInterfaceBackdoor;
+    friend class CAmCommandSenderDbusBackdoor;
 #endif
 private:
-    DBusMessageHandler mDBUSMessageHandler;
-    CommandReceiverShadow mCommandReceiverShadow;
-    DBusWrapper* mDBusWrapper;
-    CommandReceiveInterface* mCommandReceiveInterface;
-    bool mReady;        ///< ! if false, calls shall be ignored.
-
+    CAmDbusMessageHandler mCAmDbusMessageHandler; ///< ! instance of message handler
+    IAmCommandReceiverShadow mIAmCommandReceiverShadow; ///< ! instance of shadow
+    CAmDbusWrapper* mpCAmDbusWrapper; ///< ! pointer to dbus wrapper
+    IAmCommandReceive* mpIAmCommandReceive; ///< ! pointer to commandReceive Interface
+    bool mReady; ///< ! if false, calls shall be ignored.
 
     /**
      * list of sinks, needed to send out only deltas
diff --git a/PluginCommandInterfaceDbus/include/DBusMessageHandler.h b/PluginCommandInterfaceDbus/include/CAmDbusMessageHandler.h
index 71a4078..5431e2b 100644
--- a/PluginCommandInterfaceDbus/include/DBusMessageHandler.h
+++ b/PluginCommandInterfaceDbus/include/CAmDbusMessageHandler.h
@@ -26,12 +26,13 @@
 #ifndef _DBUSMESSAGEHANDLER_H_
 #define _DBUSMESSAGEHANDLER_H_
 
-#include <audiomanagertypes.h>
 #include <dbus/dbus.h>
 #include <vector>
 #include <sstream>
 #include <string>
 #include <list>
+#include "audiomanagertypes.h"
+
 
 namespace am
 {
@@ -39,11 +40,11 @@ namespace am
 /**
  * handles DBus Messages, is used to extract & append parameters and send messages
  */
-class DBusMessageHandler
+class CAmDbusMessageHandler
 {
 public:
-    DBusMessageHandler();
-    ~DBusMessageHandler();
+    CAmDbusMessageHandler();
+    ~CAmDbusMessageHandler();
 
     /**
      * sets the DBus Connection
@@ -116,9 +117,9 @@ private:
     dbus_uint32_t mSerial;
     std::string mErrorName;
     std::string mErrorMsg;
-    DBusMessage* mDbusMessage;
-    DBusMessage* mReveiveMessage;
-    DBusConnection* mDBusConnection;
+    DBusMessage* mpDBusMessage;
+    DBusMessage* mpReveiveMessage;
+    DBusConnection* mpDBusConnection;
 };
 
 }
diff --git a/PluginCommandInterfaceDbus/include/CommandInterface.xml b/PluginCommandInterfaceDbus/include/CommandInterface.xml
new file mode 100644
index 0000000..f6f07a0
--- /dev/null
+++ b/PluginCommandInterfaceDbus/include/CommandInterface.xml
@@ -0,0 +1,174 @@
+<?xml version="1.0" encoding="UTF-8" ?>

+<!DOCTYPE node PUBLIC

+  "-//freedesktop//DTD D-Bus Object Introspection 1.0//EN"

+  "http://standards.freedesktop.org/dbus/1.0/introspect.dtd">

+

+<node>

+     <interface name="org.genivi.audiomanager.CommandInterface">

+

+        <method name="Connect">

+            <arg type="q" name="sourceID" direction="in"/>

+            <arg type="q" name="sinkID" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="q" name="mainConnectionID" direction="out"/>

+        </method>

+

+        <method name="Disconnect">

+            <arg type="q" name="mainConnectionID" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+        </method>

+

+        <method name="SetVolume">

+            <arg type="q" name="sinkID" direction="in"/>

+            <arg type="n" name="volume" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+        </method>

+

+        <method name="VolumeStep">

+            <arg type="q" name="sinkID" direction="in"/>

+            <arg type="n" name="volumeStep" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+        </method>

+

+        <method name="SetSinkMuteState">

+            <arg type="q" name="sinkID" direction="in"/>

+            <arg type="n" name="muteState" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+        </method>

+

+        <method name="SetMainSinkSoundProperty">

+            <arg type="q" name="sinkID" direction="in"/>

+            <arg type="(nn)" name="soundProperty" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+        </method>

+

+        <method name="SetMainSourceSoundProperty">

+            <arg type="q" name="sourceID" direction="in"/>

+            <arg type="(nn)" name="soundProperty" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+        </method>

+

+        <method name="SetSystemProperty">

+            <arg type="(nn)" name="property" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+        </method>

+

+        <method name="GetListMainConnections">

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="a(qqqnn)" name="listConnections" direction="out"/> <!-- am_mainConnectionID_t mainConnectionID; am_sourceID_t sourceID; am_sinkID_t sinkID; am_timeSync_t delay; am_ConnectionState_e connectionState; -->

+        </method>

+

+        <method name="GetListMainSinks">

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="a(qs(nn)nnq)" name="listMainSinks" direction="out"/> <!-- am_sinkID_t sinkID; std::string name; am_Availability_s availability; am_mainVolume_t volume; am_MuteState_e muteState; am_sinkClass_t sinkClassID; -->

+        </method>

+

+        <method name="GetListMainSources">

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="a(qs(nn)q)" name="listMainSources" direction="out"/> <!-- am_sourceID_t sourceID; std::string name; am_Availability_s availability; am_sourceClass_t sourceClassID; -->

+        </method>

+

+        <method name="GetListMainSinkSoundProperties">

+            <arg type="q" name="sinkID" direction="in"/> 

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="a(nn)" name="listSoundProperties" direction="out"/> <!-- am_MainSoundPropertyType_e type; int16_t value; -->

+        </method>

+

+        <method name="GetListMainSourceSoundProperties">

+            <arg type="q" name="sourceID" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="a(nn)" name="listSourceProperties" direction="out"/> <!-- am_MainSoundPropertyType_e type; int16_t value; -->

+        </method>

+

+        <method name="GetListSourceClasses">

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="a(qsa(nn))" name="listSourceClasses" direction="out"/> <!-- am_sourceClass_t SourceClassID; std::string name; std::vector<am_ClassProperty_s> listClassProperties; -->

+        </method>

+

+        <method name="GetListSinkClasses">

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="a(qsa(nn))" name="listSinkClasses" direction="out"/> <!-- am_sourceClass_t SinkClassID; std::string name; std::vector<am_ClassProperty_s> listClassProperties; -->

+        </method>

+

+        <method name="GetListSystemProperties">

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="a(nn)" name="listSystemProperties" direction="in"/> <!-- am_SystemProperty_e type; int16_t value; -->

+        </method>

+

+        <method name="GetTimingInformation">

+            <arg type="q" name="mainConnectionID" direction="in"/>

+            <arg type="n" name="result" direction="out"/> <!-- method return code (am_Error_e) -->

+            <arg type="n" name="delay" direction="out"/>

+        </method>

+

+        <signal name="NumberOfMainConnectionsChanged">

+        </signal>

+

+	<signal name="SinkAdded">

+            	<arg type="(qs(nn)nnq)" name="newSink" direction="out"/><!-- am_sinkID_t sinkID; std::string name; am_Availability_s availability; am_mainVolume_t volume; am_MuteState_e muteState; am_sinkClass_t sinkClassID; -->

+        </signal>

+		

+	<signal name="SinkRemoved">

+		<arg type="q" name="removedSinkID" direction="out"/>

+        </signal>

+

+	<signal name="SourceAdded">

+            	<arg type="(qs(nn)q)" name="newSource" direction="out"/><!-- am_sourceID_t sourceID; std::string name; 	am_Availability_s availability; am_sourceClass_t sourceClassID; -->

+        </signal>

+		

+	<signal name="SourceRemoved">

+		<arg type="q" name="removedSourceID" direction="out"/>

+        </signal>

+

+        <signal name="NumberOfSinkClassesChanged">

+        </signal>

+

+        <signal name="NumberOfSourceClassesChanged">

+        </signal>

+

+        <signal name="MainConnectionStateChanged">

+            <arg type="q" name="connectionID" direction="out"/>

+            <arg type="n" name="connectionState" direction="out"/>

+        </signal>

+

+        <signal name="MainSinkSoundPropertyChanged">

+            <arg type="q" name="sinkID" direction="out"/>

+            <arg type="(nn)" name="SoundProperty" direction="out"/>

+        </signal>

+

+        <signal name="MainSourceSoundPropertyChanged">

+            <arg type="q" name="sourceID" direction="out"/>

+            <arg type="(nn)" name="SoundProperty" direction="out"/>

+        </signal>

+

+        <signal name="SinkAvailabilityChanged">

+            <arg type="q" name="sinkID" direction="out"/>

+            <arg type="(nn)" name="availability" direction="out"/>

+        </signal>

+

+        <signal name="SourceAvailabilityChanged">

+            <arg type="q" name="sourceID" direction="out"/>

+            <arg type="(nn)" name="availability" direction="out"/>

+        </signal>

+

+        <signal name="VolumeChanged">

+            <arg type="q" name="sinkID" direction="out"/>

+            <arg type="n" name="volume" direction="out"/>

+        </signal>

+

+        <signal name="SinkMuteStateChanged">

+            <arg type="q" name="sinkID" direction="out"/>

+            <arg type="n" name="muteState" direction="out"/>

+        </signal>

+

+            <signal name="SystemPropertyChanged">

+            <arg type="(nn)" name="SystemProperty" direction="out"/>

+        </signal>

+

+        <signal name="TimingInformationChanged">

+            <arg type="q" name="mainConnection" direction="out"/>

+            <arg type="n" name="time" direction="out"/>

+        </signal>

+

+    </interface>

+</node>

diff --git a/PluginCommandInterfaceDbus/include/CommandReceiverShadow.h b/PluginCommandInterfaceDbus/include/IAmCommandReceiverShadow.h
index d2c63cb..dd5a23d 100644
--- a/PluginCommandInterfaceDbus/include/CommandReceiverShadow.h
+++ b/PluginCommandInterfaceDbus/include/IAmCommandReceiverShadow.h
@@ -26,28 +26,30 @@
 #ifndef COMMANDRECEIVERSHADOW_H_
 #define COMMANDRECEIVERSHADOW_H_
 
-#include <config.h>
-#include <command/CommandReceiveInterface.h>
-#include <dbus/DBusWrapper.h>
+
+
 #include <dbus/dbus.h>
 #include <map>
-#include "DBusMessageHandler.h"
+#include "config.h"
+#include "command/IAmCommandReceive.h"
+#include "CAmDbusMessageHandler.h"
+#include "shared/CAmDbusWrapper.h"
 
 namespace am
 {
 
-class CommandReceiverShadow;
+class IAmCommandReceiverShadow;
 
-typedef void (CommandReceiverShadow::*CallBackMethod)(DBusConnection *connection, DBusMessage *message);
+typedef void (IAmCommandReceiverShadow::*CallBackMethod)(DBusConnection *connection, DBusMessage *message);
 
 /**
  * receives the DBus Callbacks, marhsalls and demarshalls the parameters and calls CommandReceive
  */
-class CommandReceiverShadow
+class IAmCommandReceiverShadow
 {
 public:
-    CommandReceiverShadow();
-    virtual ~CommandReceiverShadow();
+    IAmCommandReceiverShadow();
+    virtual ~IAmCommandReceiverShadow();
     void connect(DBusConnection *conn, DBusMessage *msg);
     void disconnect(DBusConnection *conn, DBusMessage *msg);
     void setVolume(DBusConnection *conn, DBusMessage *msg);
@@ -70,13 +72,13 @@ public:
      * sets the pointer to the CommandReceiveInterface and registers Callback
      * @param receiver
      */
-    void setCommandReceiver(CommandReceiveInterface*& receiver);
+    void setCommandReceiver(IAmCommandReceive*& receiver);
 private:
-    CommandReceiveInterface* mCommandReceiveInterface;
-    DBusWrapper* mDBusWrapper;
     typedef std::map<std::string, CallBackMethod> functionMap_t;
     functionMap_t mFunctionMap;
-    DBusMessageHandler mDBUSMessageHandler;
+    CAmDbusMessageHandler mDBUSMessageHandler;
+    IAmCommandReceive* mpIAmCommandReceive;
+    CAmDbusWrapper* mpCAmDbusWrapper;
 
     /**
      * receives a callback whenever the path of the plugin is called
diff --git a/PluginCommandInterfaceDbus/include/mainpage.h b/PluginCommandInterfaceDbus/include/mainpage.h
deleted file mode 100644
index 8a2848c..0000000
--- a/PluginCommandInterfaceDbus/include/mainpage.h
+++ /dev/null
@@ -1,32 +0,0 @@
-/**
- * \mainpage
- * \image html "Bild1.png"
- * Copyright Copyright (C) 2011, BMW AG
- *
- * \date 22.06.2011
- * \author Christian Müller (christian.ei.mueller@bmw.de)
- *
- * \section License
- * GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
- * Copyright (C) 2011, BMW AG – Christian Müller  Christian.ei.mueller@bmw.de
- *
- * 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.
- * 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.
- * 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>.
- * 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.
- * 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.
- * 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.
- * 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.
- *
- * \section About About PluginInterfaceDBus
- * This plugin for the Genivi AudioManager serves as interface for DBus.
- *
- * \section Info More information
- * can be found at <https://collab.genivi.org/wiki/display/genivi/GENIVI+Home>
- *
- */
-
-#ifndef MAINPAGE_H_
-#define MAINPAGE_H_
-
-#endif /* MAINPAGE_H_ */