diff options
Diffstat (limited to 'AudioManagerDaemon/include/CAmRouter.h')
| -rw-r--r-- | AudioManagerDaemon/include/CAmRouter.h | 61 |
1 files changed, 34 insertions, 27 deletions
diff --git a/AudioManagerDaemon/include/CAmRouter.h b/AudioManagerDaemon/include/CAmRouter.h index ba13bf1..9b2b4d2 100644 --- a/AudioManagerDaemon/include/CAmRouter.h +++ b/AudioManagerDaemon/include/CAmRouter.h @@ -1,31 +1,29 @@ /** - * Copyright (C) 2011, BMW AG + * Copyright (C) 2012, GENIVI Alliance, Inc. + * Copyright (C) 2012, BMW AG * - * GeniviAudioMananger AudioManagerDaemon + * This file is part of GENIVI Project AudioManager. * - * \file CAmRouter.h + * 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/. * - * \date 20-Oct-2011 3:42:04 PM - * \author Christian Mueller (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 Mueller Christian.ei.mueller@bmw.de + * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012 * - * 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. + * \file CAmRouter.h + * For further information see http://www.genivi.org/. * */ #ifndef ROUTER_H_ #define ROUTER_H_ -#include <audiomanagertypes.h> +#include "audiomanagertypes.h" namespace am { @@ -33,47 +31,56 @@ namespace am class CAmDatabaseHandler; class CAmControlSender; +/** + * Implements an autorouting algorithm for connecting sinks and sources via different audio domains. + */ class CAmRouter { public: CAmRouter(CAmDatabaseHandler* iDatabaseHandler, CAmControlSender* iSender); - am_Error_e getRoute(const bool onlyfree, const am_sourceID_t sourceID, const am_sinkID_t sinkID, std::vector<am_Route_s>& returnList); ~CAmRouter(); + am_Error_e getRoute(const bool onlyfree, const am_sourceID_t sourceID, const am_sinkID_t sinkID, std::vector<am_Route_s>& returnList); private: am_Error_e findBestWay(am_sinkID_t sinkID, am_sourceID_t sourceID, std::vector<am_RoutingElement_s>& listRoute, std::vector<am_RoutingElement_s>::iterator routeIterator, std::vector<am_gatewayID_t>::iterator gatewayIterator); void listPossibleConnectionFormats(const am_sourceID_t sourceID, const am_sinkID_t sinkID, std::vector<am_ConnectionFormat_e>& listFormats) const; void listRestrictedOutputFormatsGateways(const am_gatewayID_t gatewayID, const am_ConnectionFormat_e sinkConnectionFormat, std::vector<am_ConnectionFormat_e>& listFormats) const; - CAmDatabaseHandler* mDatabaseHandler; - CAmControlSender* mControlSender; + CAmDatabaseHandler* mpDatabaseHandler; //!< pointer to database handler + CAmControlSender* mpControlSender; //!< pointer the controlsender - is used to retrieve information for the optimal route }; +/** + * an item in the routing tree + */ class CAmRoutingTreeItem { public: CAmRoutingTreeItem(const am_domainID_t domainID, const am_gatewayID_t gatewayID = 0, CAmRoutingTreeItem *parent = 0); - void appendChild(CAmRoutingTreeItem *newChild); - void returnChildItems(std::vector<CAmRoutingTreeItem*> listChildItems); - am_domainID_t returnDomainID() const; - am_gatewayID_t returnGatewayID() const; - virtual ~CAmRoutingTreeItem(); - CAmRoutingTreeItem* returnParent() const; + ~CAmRoutingTreeItem(); + void appendChild(CAmRoutingTreeItem *newChild); //!< appends a new child + void returnChildItems(std::vector<CAmRoutingTreeItem*> listChildItems); //!< returns the list of childs + am_domainID_t returnDomainID() const; //!< returns the domainID of the tree + am_gatewayID_t returnGatewayID() const; //!< returns the gatewayID of the tree + CAmRoutingTreeItem* returnParent() const; //!< returns the parent item of the tree private: std::vector<CAmRoutingTreeItem*> mListChildItems; //!< List of all child items am_domainID_t mDomainID; //!< the domain ID of the item am_gatewayID_t mGatewayID; //!< the gateway Id - CAmRoutingTreeItem *mParentItem; //!< pointer to the parent item + CAmRoutingTreeItem *mpParentItem; //!< pointer to the parent item }; +/** + * a routing tree + */ class CAmRoutingTree { public: CAmRoutingTree(const am_domainID_t rootDomainID); + ~CAmRoutingTree(); CAmRoutingTreeItem* insertItem(const am_domainID_t domainID, const am_gatewayID_t gatewayID, CAmRoutingTreeItem *parent); void getRoute(CAmRoutingTreeItem* targetItem, std::vector<am_gatewayID_t>& listGateways); am_domainID_t returnRootDomainID() const; CAmRoutingTreeItem* returnRootItem(); - virtual ~CAmRoutingTree(); private: CAmRoutingTreeItem mRootItem; //!< pointer to root item std::vector<CAmRoutingTreeItem*> mListChild; //!< list of all childs |