diff options
author | Aleksandar Donchev <aleksander.donchev@partner.bmw.de> | 2013-06-21 16:38:56 +0200 |
---|---|---|
committer | Christian Linke <christian.linke@bmw.de> | 2013-06-26 17:46:18 +0200 |
commit | 721aed89269292b07bdd21361828612c34640bde (patch) | |
tree | 72b1f66168bd1cee24bd0eae7932e7e6c46a4ad6 /AudioManagerDaemon/include/CAmMapHandler.h | |
parent | 0ba29aa3f94b9231f6876f3c0023db68e45a93d7 (diff) | |
download | audiomanager-721aed89269292b07bdd21361828612c34640bde.tar.gz |
First version Map implementation of database handler with unit tests ( ticket 38 )
Signed-off-by: Christian Linke <christian.linke@bmw.de>
Diffstat (limited to 'AudioManagerDaemon/include/CAmMapHandler.h')
-rw-r--r-- | AudioManagerDaemon/include/CAmMapHandler.h | 394 |
1 files changed, 394 insertions, 0 deletions
diff --git a/AudioManagerDaemon/include/CAmMapHandler.h b/AudioManagerDaemon/include/CAmMapHandler.h new file mode 100644 index 0000000..984fbe1 --- /dev/null +++ b/AudioManagerDaemon/include/CAmMapHandler.h @@ -0,0 +1,394 @@ +/** + * Copyright (C) 2012, BMW AG + * + * This file is part of GENIVI Project AudioManager. + * + * Contributions are licensed to the GENIVI Alliance under one or more + * Contribution License Agreements. + * + * \copyright + * 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/. + * + * +* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013 + * + * \file CAmDatabaseHandler.h + * For further information see http://www.genivi.org/. + * + */ + +#ifndef MAPHANDLER_H_ +#define MAPHANDLER_H_ + +#include "CAmDatabaseHandlerInterface.h" +#include <unordered_map> +#include <map> +#include <stdint.h> +#include <limits.h> + + +namespace am +{ +//todo: check the enum values before entering & changing in the database. +//todo: change asserts for dynamic boundary checks into failure answers.# +//todo: check autoincrement boundary and set to 16bit limits +//todo: If the sink is part of a gateway, the listconnectionFormats is copied to the gatewayInformation. Check this statement for sinks & sources +//todo: exchange last_insert_row id to be more safe +//todo: create test to ensure uniqueness of names throughout the database +//todo: enforce the uniqueness of names + +/** + * The following structures extend the base structures with the field 'reserved'. + */ + +struct am_Sink_Database_s : public am_Sink_s +{ + bool reserved; + am_Sink_Database_s():am_Sink_s(), reserved(false) + {}; + void getSinkType(am_SinkType_s & sinkType) const + { + sinkType.name = name; + sinkType.sinkID = sinkID; + sinkType.availability = available; + sinkType.muteState = muteState; + sinkType.volume = mainVolume; + sinkType.sinkClassID = sinkClassID; + }; + am_Sink_Database_s & operator=(const am_Sink_Database_s & anObject) + { + if (this != &anObject) + { + am_Sink_s::operator=(anObject); + reserved = anObject.reserved; + } + return *this; + }; + am_Sink_Database_s & operator=(const am_Sink_s & anObject) + { + if (this != &anObject) + am_Sink_s::operator=(anObject); + return *this; + }; + void print() const + { + printf("\n Sink(%s) id(%d)\n", name.c_str() ,sinkID); + printf("\t availability(%d) availabilityReason(%d) sinkClassID(%d) domainID(%d) visible(%d) volume(%d) mainVolume(%d) muteState(%d) reserved(%d)\n", + available.availability, available.availabilityReason, sinkClassID, domainID, visible, volume, mainVolume, muteState,reserved); + }; +}; + +struct am_Source_Database_s : public am_Source_s +{ + bool reserved; + am_Source_Database_s():am_Source_s(), reserved(false) + {}; + void getSourceType(am_SourceType_s & sourceType) const + { + sourceType.name = name; + sourceType.sourceClassID = sourceClassID; + sourceType.availability = available; + sourceType.sourceID = sourceID; + }; + am_Source_Database_s & operator=(const am_Source_Database_s & anObject) + { + if (this != &anObject) + { + am_Source_s::operator=(anObject); + reserved = anObject.reserved; + } + return *this; + }; + am_Source_Database_s & operator=(const am_Source_s & anObject) + { + if (this != &anObject) + { + am_Source_s::operator=(anObject); + } + return *this; + }; + void print() const + { + printf("\n Source(%s) id(%d)\n", name.c_str() ,sourceID); + printf("\t availability(%d) availabilityReason(%d) sourceClassID(%d) domainID(%d) visible(%d) volume(%d) interruptState(%d) sourceState(%d) reserved(%d)\n", + available.availability, available.availabilityReason, sourceClassID, domainID, visible, volume, interruptState, sourceState,reserved); + }; +}; + +struct am_Connection_Database_s : public am_Connection_s +{ + bool reserved; + am_Connection_Database_s():am_Connection_s(), reserved(true) + {}; + am_Connection_Database_s & operator=(const am_Connection_Database_s & anObject) + { + if (this != &anObject) + { + am_Connection_s::operator=(anObject); + reserved = anObject.reserved; + } + return *this; + }; + am_Connection_Database_s & operator=(const am_Connection_s & anObject) + { + if (this != &anObject) + am_Connection_s::operator=(anObject); + return *this; + }; +}; + +struct am_Domain_Database_s : public am_Domain_s +{ + bool reserved; + am_Domain_Database_s():am_Domain_s(), reserved(false) + {}; + am_Domain_Database_s & operator=(const am_Domain_Database_s & anObject) + { + if (this != &anObject) + { + am_Domain_s::operator=(anObject); + reserved = anObject.reserved; + } + return *this; + }; + am_Domain_Database_s & operator=(const am_Domain_s & anObject) + { + if (this != &anObject) + am_Domain_s::operator=(anObject); + return *this; + }; +}; + +struct am_MainConnection_Database_s : public am_MainConnection_s +{ + am_MainConnection_Database_s():am_MainConnection_s() + {}; + void getMainConnectionType(am_MainConnectionType_s & connectionType) const + { + connectionType.mainConnectionID = mainConnectionID; + connectionType.sourceID = sourceID; + connectionType.sinkID = sinkID; + connectionType.connectionState = connectionState; + connectionType.delay = delay; + }; + am_MainConnection_Database_s & operator=(const am_MainConnection_Database_s & anObject) + { + am_MainConnection_s::operator=(anObject); + return *this; + }; + am_MainConnection_Database_s & operator=(const am_MainConnection_s & anObject) + { + am_MainConnection_s::operator=(anObject); + return *this; + }; +}; + +/** + * This class handles and abstracts the database + */ +class CAmMapHandler : public CAmDatabaseHandlerInterface +{ +public: + CAmMapHandler(); + ~CAmMapHandler(); + am_Error_e enterDomainDB(const am_Domain_s& domainData, am_domainID_t& domainID); + am_Error_e enterMainConnectionDB(const am_MainConnection_s& mainConnectionData, am_mainConnectionID_t& connectionID); + am_Error_e enterSinkDB(const am_Sink_s& sinkData, am_sinkID_t& sinkID); + am_Error_e enterCrossfaderDB(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID); + am_Error_e enterGatewayDB(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID); + am_Error_e enterSourceDB(const am_Source_s& sourceData, am_sourceID_t& sourceID); + am_Error_e enterConnectionDB(const am_Connection_s& connection, am_connectionID_t& connectionID); + am_Error_e enterSinkClassDB(const am_SinkClass_s& sinkClass, am_sinkClass_t& sinkClassID); + am_Error_e enterSourceClassDB(am_sourceClass_t& sourceClassID, const am_SourceClass_s& sourceClass); + am_Error_e enterSystemProperties(const std::vector<am_SystemProperty_s>& listSystemProperties); + am_Error_e changeMainConnectionRouteDB(const am_mainConnectionID_t mainconnectionID, const std::vector<am_connectionID_t>& listConnectionID); + am_Error_e changeMainConnectionStateDB(const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState); + am_Error_e changeSinkMainVolumeDB(const am_mainVolume_t mainVolume, const am_sinkID_t sinkID); + am_Error_e changeSinkAvailabilityDB(const am_Availability_s& availability, const am_sinkID_t sinkID); + am_Error_e changDomainStateDB(const am_DomainState_e domainState, const am_domainID_t domainID); + am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID); + am_Error_e changeMainSinkSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID); + am_Error_e changeMainSourceSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID); + am_Error_e changeSourceSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sourceID_t sourceID); + am_Error_e changeSinkSoundPropertyDB(const am_SoundProperty_s& soundProperty, const am_sinkID_t sinkID); + am_Error_e changeSourceAvailabilityDB(const am_Availability_s& availability, const am_sourceID_t sourceID); + am_Error_e changeSystemPropertyDB(const am_SystemProperty_s& property); + am_Error_e changeDelayMainConnection(const am_timeSync_t & delay, const am_mainConnectionID_t & connectionID); + am_Error_e changeSinkClassInfoDB(const am_SinkClass_s& sinkClass); + am_Error_e changeSourceClassInfoDB(const am_SourceClass_s& sourceClass); + am_Error_e changeConnectionTimingInformation(const am_connectionID_t connectionID, const am_timeSync_t delay); + am_Error_e changeConnectionFinal(const am_connectionID_t connectionID); + am_Error_e changeSourceState(const am_sourceID_t sourceID, const am_SourceState_e sourceState); + am_Error_e changeSinkVolume(const am_sinkID_t sinkID, const am_volume_t volume); + am_Error_e changeSourceVolume(const am_sourceID_t sourceID, const am_volume_t volume); + am_Error_e changeCrossFaderHotSink(const am_crossfaderID_t crossfaderID, const am_HotSink_e hotsink); + am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID); + am_Error_e removeSinkDB(const am_sinkID_t sinkID); + am_Error_e removeSourceDB(const am_sourceID_t sourceID); + am_Error_e removeGatewayDB(const am_gatewayID_t gatewayID); + am_Error_e removeCrossfaderDB(const am_crossfaderID_t crossfaderID); + am_Error_e removeDomainDB(const am_domainID_t domainID); + am_Error_e removeSinkClassDB(const am_sinkClass_t sinkClassID); + am_Error_e removeSourceClassDB(const am_sourceClass_t sourceClassID); + am_Error_e removeConnection(const am_connectionID_t connectionID); + am_Error_e getSourceClassInfoDB(const am_sourceID_t sourceID, am_SourceClass_s& classInfo) const; + am_Error_e getSinkClassInfoDB(const am_sinkID_t sinkID, am_SinkClass_s& sinkClass) const; + am_Error_e getGatewayInfoDB(const am_gatewayID_t gatewayID, am_Gateway_s& gatewayData) const; + am_Error_e getSinkInfoDB(const am_sinkID_t sinkID, am_Sink_s& sinkData) const; + am_Error_e getSourceInfoDB(const am_sourceID_t sourceID, am_Source_s& sourceData) const; + am_Error_e getCrossfaderInfoDB(const am_crossfaderID_t crossfaderID, am_Crossfader_s& crossfaderData) const; + am_Error_e getMainConnectionInfoDB(const am_mainConnectionID_t mainConnectionID, am_MainConnection_s& mainConnectionData) const; + am_Error_e getSinkVolume(const am_sinkID_t sinkID, am_volume_t& volume) const; + am_Error_e getSourceVolume(const am_sourceID_t sourceID, am_volume_t& volume) const; + am_Error_e getSinkSoundPropertyValue(const am_sinkID_t sinkID, const am_SoundPropertyType_e propertyType, int16_t& value) const; + am_Error_e getSourceSoundPropertyValue(const am_sourceID_t sourceID, const am_SoundPropertyType_e propertyType, int16_t& value) const; + am_Error_e getListSinksOfDomain(const am_domainID_t domainID, std::vector<am_sinkID_t>& listSinkID) const; + am_Error_e getListSourcesOfDomain(const am_domainID_t domainID, std::vector<am_sourceID_t>& listSourceID) const; + am_Error_e getListCrossfadersOfDomain(const am_domainID_t domainID, std::vector<am_crossfaderID_t>& listGatewaysID) const; + am_Error_e getListGatewaysOfDomain(const am_domainID_t domainID, std::vector<am_gatewayID_t>& listGatewaysID) const; + am_Error_e getListMainConnections(std::vector<am_MainConnection_s>& listMainConnections) const; + am_Error_e getListDomains(std::vector<am_Domain_s>& listDomains) const; + am_Error_e getListConnections(std::vector<am_Connection_s>& listConnections) const; + am_Error_e getListSinks(std::vector<am_Sink_s>& listSinks) const; + am_Error_e getListSources(std::vector<am_Source_s>& lisSources) const; + am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const; + am_Error_e getListCrossfaders(std::vector<am_Crossfader_s>& listCrossfaders) const; + am_Error_e getListGateways(std::vector<am_Gateway_s>& listGateways) const; + am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const; + am_Error_e getListVisibleMainConnections(std::vector<am_MainConnectionType_s>& listConnections) const; + am_Error_e getListMainSinks(std::vector<am_SinkType_s>& listMainSinks) const; + am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const; + am_Error_e getListMainSinkSoundProperties(const am_sinkID_t sinkID, std::vector<am_MainSoundProperty_s>& listSoundProperties) const; + am_Error_e getListMainSourceSoundProperties(const am_sourceID_t sourceID, std::vector<am_MainSoundProperty_s>& listSourceProperties) const; + am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const; + am_Error_e getListSinkConnectionFormats(const am_sinkID_t sinkID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const; + am_Error_e getListSourceConnectionFormats(const am_sourceID_t sourceID, std::vector<am_ConnectionFormat_e> & listConnectionFormats) const; + am_Error_e getListGatewayConnectionFormats(const am_gatewayID_t gatewayID, std::vector<bool> & listConnectionFormat) const; + am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const; + am_Error_e getDomainOfSource(const am_sourceID_t sourceID, am_domainID_t& domainID) const; + am_Error_e getDomainOfSink(const am_sinkID_t sinkID, am_domainID_t& domainID) const; + am_Error_e getSoureState(const am_sourceID_t sourceID, am_SourceState_e& sourceState) const; + am_Error_e getDomainState(const am_domainID_t domainID, am_DomainState_e& state) const; + am_Error_e getRoutingTree(bool onlyfree, CAmRoutingTree& tree, std::vector<CAmRoutingTreeItem*>& flatTree); + am_Error_e peekDomain(const std::string& name, am_domainID_t& domainID); + am_Error_e peekSink(const std::string& name, am_sinkID_t& sinkID); + am_Error_e peekSource(const std::string& name, am_sourceID_t& sourceID); + am_Error_e peekSinkClassID(const std::string& name, am_sinkClass_t& sinkClassID); + am_Error_e peekSourceClassID(const std::string& name, am_sourceClass_t& sourceClassID); + am_Error_e changeSourceDB(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_SoundProperty_s>& listSoundProperties, const std::vector<am_ConnectionFormat_e>& listConnectionFormats, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties); + am_Error_e changeSinkDB(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_SoundProperty_s>& listSoundProperties, const std::vector<am_ConnectionFormat_e>& listConnectionFormats, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties); + am_Error_e getListMainSinkNotificationConfigurations(const am_sinkID_t sinkID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations); + am_Error_e getListMainSourceNotificationConfigurations(const am_sourceID_t sourceID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations); + am_Error_e changeMainSinkNotificationConfigurationDB(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration); + am_Error_e changeMainSourceNotificationConfigurationDB(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration); + am_Error_e changeGatewayDB(const am_gatewayID_t gatewayID, const std::vector<am_ConnectionFormat_e>& listSourceConnectionFormats, const std::vector<am_ConnectionFormat_e>& listSinkConnectionFormats, const std::vector<bool>& convertionMatrix); + am_Error_e changeSinkNotificationConfigurationDB(const am_sinkID_t sinkID,const am_NotificationConfiguration_s notificationConfiguration); + am_Error_e changeSourceNotificationConfigurationDB(const am_sourceID_t sourceID,const am_NotificationConfiguration_s notificationConfiguration); + + bool existMainConnection(const am_mainConnectionID_t mainConnectionID) const; + bool existcrossFader(const am_crossfaderID_t crossfaderID) const; + bool existConnection(const am_Connection_s & connection) const; + bool existConnectionID(const am_connectionID_t connectionID) const; + bool existSource(const am_sourceID_t sourceID) const; + bool existSourceNameOrID(const am_sourceID_t sourceID, const std::string& name) const; + bool existSourceName(const std::string& name) const; + bool existSink(const am_sinkID_t sinkID) const; + bool existSinkNameOrID(const am_sinkID_t sinkID, const std::string& name) const; + bool existSinkName(const std::string& name) const; + bool existDomain(const am_domainID_t domainID) const; + bool existGateway(const am_gatewayID_t gatewayID) const; + bool existSinkClass(const am_sinkClass_t sinkClassID) const; + bool existSourceClass(const am_sourceClass_t sourceClassID) const; + void registerObserver(CAmDatabaseObserver *iObserver); + bool sourceVisible(const am_sourceID_t sourceID) const; + bool sinkVisible(const am_sinkID_t sinkID) const; + + void printSources(); + void printSinks(); + void printSinkClasses(); + void printSourceClasses(); +private: + + typedef std::map<am_domainID_t, am_Domain_Database_s> CAmMapDomain; + typedef std::map<am_sourceClass_t, am_SourceClass_s> CAmMapSourceClass; + typedef std::map<am_sinkClass_t, am_SinkClass_s> CAmMapSinkClass; + typedef std::map<am_sinkID_t, am_Sink_Database_s> CAmMapSink; + typedef std::map<am_sourceID_t, am_Source_Database_s> CAmMapSource; + typedef std::map<am_gatewayID_t, am_Gateway_s> CAmMapGateway; + typedef std::map<am_crossfaderID_t, am_Crossfader_s> CAmMapCrossfader; + typedef std::map<am_connectionID_t, am_Connection_Database_s> CAmMapConnection; + typedef std::map<am_mainConnectionID_t, am_MainConnection_Database_s> CAmMapMainConnection; + typedef std::vector<am_SystemProperty_s> CAmVectorSystemProperties; + typedef struct CAmMappedData + { + int16_t mCurrentDomainID; + int16_t mCurrentSourceClassesID; + int16_t mCurrentSinkClassesID; + int16_t mCurrentSinkID; + int16_t mCurrentSourceID; + int16_t mCurrentGatewayID; + int16_t mCurrentCrossfaderID; + int16_t mCurrentConnectionID; + int16_t mCurrentMainConnectionID; + int16_t mDefaultIDLimit; + + CAmVectorSystemProperties mSystemProperties; + CAmMapDomain mDomainMap; + CAmMapSourceClass mSourceClassesMap; + CAmMapSinkClass mSinkClassesMap; + CAmMapSink mSinkMap; + CAmMapSource mSourceMap; + CAmMapGateway mGatewayMap; + CAmMapCrossfader mCrossfaderMap; + CAmMapConnection mConnectionMap; + CAmMapMainConnection mMainConnectionMap; + + CAmMappedData(): //For Domain, MainConnections, Connections we don't have static IDs. + mCurrentDomainID(1), mCurrentSourceClassesID(DYNAMIC_ID_BOUNDARY), mCurrentSinkClassesID(DYNAMIC_ID_BOUNDARY), + mCurrentSinkID(DYNAMIC_ID_BOUNDARY), mCurrentSourceID(DYNAMIC_ID_BOUNDARY), mCurrentGatewayID(DYNAMIC_ID_BOUNDARY), + mCurrentCrossfaderID(DYNAMIC_ID_BOUNDARY), mCurrentConnectionID(1), mCurrentMainConnectionID(1), + mDefaultIDLimit(SHRT_MAX), + + mSystemProperties(), + mDomainMap(),mSourceClassesMap(), mSinkClassesMap(), mSinkMap(), mSourceMap(), + mGatewayMap(), mCrossfaderMap(), mConnectionMap(), mMainConnectionMap() + {}; + + bool increaseID(int16_t * resultID, int16_t * sourceID, int16_t const desiredStaticID = 0, int16_t const preferedStaticIDBoundary = DYNAMIC_ID_BOUNDARY) + { + if( desiredStaticID > 0 && desiredStaticID < preferedStaticIDBoundary ) + { + *resultID = desiredStaticID; + return true; + } + else if( *sourceID < mDefaultIDLimit-1 ) //SHRT_MAX or the max limit is reserved and not used!!! + { + *resultID = (*sourceID)++; + return true; + } + else + { + *resultID = -1; + return false; + } + }; + } CAmMappedData; + + + CAmMappedData mMappedData; + + am_timeSync_t calculateMainConnectionDelay(const am_mainConnectionID_t mainConnectionID) const; //!< calculates a new main connection delay + int16_t calculateDelayForRoute(const std::vector<am_connectionID_t>& listConnectionID); + bool insertSinkDB(const am_Sink_s & sinkData, am_sinkID_t & sinkID); + bool insertCrossfaderDB(const am_Crossfader_s & crossfaderData, am_crossfaderID_t & crossfaderID); + bool insertGatewayDB(const am_Gateway_s & gatewayData, am_gatewayID_t & gatewayID); + bool insertSourceDB(const am_Source_s & sourceData, am_sourceID_t & sourceID); + bool insertSinkClassDB(const am_SinkClass_s & sinkClass, am_sinkClass_t & sinkClassID); + bool insertSourceClassDB(am_sourceClass_t & sourceClassID, const am_SourceClass_s & sourceClass); +}; + +} + +#endif /* MAPHANDLER_H_ */ |