diff options
Diffstat (limited to 'SDL_Core/src/components/AppMgr/include/AppMgr/Application.h')
| -rw-r--r-- | SDL_Core/src/components/AppMgr/include/AppMgr/Application.h | 356 |
1 files changed, 0 insertions, 356 deletions
diff --git a/SDL_Core/src/components/AppMgr/include/AppMgr/Application.h b/SDL_Core/src/components/AppMgr/include/AppMgr/Application.h deleted file mode 100644 index 9ca9c2a9e..000000000 --- a/SDL_Core/src/components/AppMgr/include/AppMgr/Application.h +++ /dev/null @@ -1,356 +0,0 @@ -// -// Copyright (c) 2013, Ford Motor Company -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are met: -// -// Redistributions of source code must retain the above copyright notice, this -// list of conditions and the following disclaimer. -// -// Redistributions in binary form must reproduce the above copyright notice, -// this list of conditions and the following -// disclaimer in the documentation and/or other materials provided with the -// distribution. -// -// Neither the name of the Ford Motor Company nor the names of its contributors -// may be used to endorse or promote products derived from this software -// without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -// POSSIBILITY OF SUCH DAMAGE. -// - -#ifndef APPLICATION_H_ -#define APPLICATION_H_ - -#include "AppMgr/MenuMapping.h" -#include "AppMgr/CommandMapping.h" -#include "AppMgr/AppMenus.h" -#include "JSONHandler/SDLRPCObjects/V2/AudioStreamingState.h" -#include "JSONHandler/SDLRPCObjects/V2/SystemContext.h" -#include "JSONHandler/SDLRPCObjects/V2/HMILevel.h" -#include "JSONHandler/SDLRPCObjects/V1/AudioStreamingState.h" -#include "JSONHandler/SDLRPCObjects/V1/SystemContext.h" -#include "JSONHandler/SDLRPCObjects/V1/HMILevel.h" -#include <string> -#include <vector> -#include <tuple> -#include <map> -#include <list> -#include <cstddef> - -namespace log4cplus -{ - class Logger; -} - -namespace NsAppManager -{ - /** - * \brief An application unique id - combination of connection id and session id - */ - typedef int ApplicationUniqueID; - - /** - * \brief An application session keys - */ - typedef std::list<int> SessionKeys; - - /** - * \brief class Application acts as a metaphor for every mobile application being registered on HMI - */ - class Application - { - public: - - /** - * \brief Class constructor - * \param name application name - * \param appId application id - * \param protocolVersion protocol version - */ - Application(const std::string& name, int appId, unsigned int protocolVersion); - - /** - * \brief Default class destructor - */ - virtual ~Application( ); - - /** - * \brief operator == - * \param item the item to compare with - * \return comparison result - */ - bool operator==(const Application& item) const; - - /** - * \brief Set application NGN media screen app name - * \param value application NGN media screen app name - */ - void setNgnMediaScreenAppName(const std::string& value); - - /** - * \brief Set application voice recognition synonyms - * \param value application voice recognition synonyms - */ - void setVrSynonyms(const std::vector<std::string>& value); - - /** - * \brief Set if the application is a media application - * \param value is the application a media application - */ - void setIsMediaApplication(bool value); - - /** - * \brief retrieve application NGN media screen application name - * \return application NGN media screen application name - */ - const std::string& getNgnMediaScreenAppName( ) const; - - /** - * \brief retrieve application voice-recognition synonyms - * \return application voice-recognition synonyms - */ - const std::vector<std::string>& getVrSynonyms( ) const; - - /** - * \brief retrieve is the application a media application - * \return is the application a media application - */ - bool getIsMediaApplication( ) const; - - /** - * \brief retrieve application protocol version - * \return application protocol version - */ - const unsigned int& getProtocolVersion() const; - - /** - * \brief retrieve application name - * \return application name - */ - const std::string& getName() const; - - /** - * \brief retrieve application ID - * \return application ID - */ - const int& getAppID( ) const; - - /** - * \brief add a command to a menu - * \param commandId command id - * \param menuId menu id - */ - void addMenuCommand(const unsigned int &commandId, const unsigned int &menuId ); - - /** - * \brief remove a command from a menu(s) - * \param commandId command id - */ - void removeMenuCommand(const unsigned int& commandId); - - /** - * \brief find commands within a menu - * \param menuId menu id - * \return commands residing within the given menu - */ - MenuCommands findMenuCommands(const unsigned int &menuId) const; - - /** - * \brief add a menu item to the application - * \param menuId menu id - * \param menuName menu item name - * \param position menu item position within the parent menu - */ - void addMenu(const unsigned int &menuId, const std::string& menuName, const unsigned int* position=0); - - /** - * \brief remove a menu item from the application - * \param menuId menu id - */ - void removeMenu(const unsigned int& menuId); - - /** - * \brief find a menu item from a mapping - * \param menuId menu id - * \return a menu item from a mapping - */ - const MenuValue* findMenu(const unsigned int& menuId); - - /** - * \brief gets all application menus - * \return application menus - */ - MenuItems getAllMenus() const; - - /** - * \brief get count of items - * \return items count - */ - size_t getMenusCount() const; - - /** - * \brief get count of items - * \return items count - */ - size_t getMenuCommandsCount() const; - - /** - * \brief add a command to an application - * \param commandId command id - * \param type command type - * \param params VR or UI params supplied with the AddCommand request - */ - void addCommand(unsigned int commandId, CommandType type , CommandParams params); - - /** - * \brief remove a command from application - * \param commandId command id - * \param type a type of a command - */ - void removeCommand(unsigned int commandId, CommandType type); - - /** - * \brief finds commands in application - * \param commandId command id - * \return command list - */ - Commands findCommands(unsigned int commandId) const; - - /** - * \brief gets all application commands - * \return application commands - */ - Commands getAllCommands() const; - - /** - * \brief get count of items - * \return items count - */ - size_t getCommandsCount() const; - - /** - * \brief retrieve types associated with command id in current application - * \param commandId command id to search for types - * \return input container of command types to be filled with result - */ - CommandTypes getCommandTypes(unsigned int commandId) const; - - /** - * \brief get count of unresponsed requests associated with the given command id - * \param cmdId id of command we need to count unresponded requests for - * \return unresponded requests count - */ - unsigned int getUnrespondedRequestCount(const unsigned int& cmdId) const; - - /** - * \brief increment count of unresponsed requests associated with the given command id - * \param cmdId id of command we need to increment unresponded request count for - * \return unresponded requests count after the operation - */ - unsigned int incrementUnrespondedRequestCount(const unsigned int& cmdId); - - /** - * \brief decrement count of unresponsed requests associated with the given command id - * \param cmdId id of command we need to decrement unresponded request count for - * \return unresponded requests count after the operation - */ - unsigned int decrementUnrespondedRequestCount(const unsigned int& cmdId); - - /** - * \brief add session key to a list of session keys - * \param sessionKey session key - */ - void addSessionKey(const int& sessionKey); - - /** - * \brief remove session key from a list of session keys - * \param sessionKey session key - */ - void removeSessionKey(const int& sessionKey); - - /** - * \brief set application system context - * \param application system context - */ - virtual void setSystemContext( NsSmartDeviceLinkRPCV2::SystemContext value ); - - /** - * \brief retrieve application system context - * \return application system context - */ - virtual const NsSmartDeviceLinkRPCV2::SystemContext& getSystemContext() const; - - /** - * \brief Set application audio streaming state - * \param streamingState audio streaming state of application - */ - virtual void setApplicationAudioStreamingState( const NsSmartDeviceLinkRPCV2::AudioStreamingState& hmiLevel ); - - /** - * \brief retreive application audio streaming state - * \return application audio streaming state - */ - virtual const NsSmartDeviceLinkRPCV2::AudioStreamingState& getApplicationAudioStreamingState( ) const; - - /** - * \brief Set application HMI status level - * \param hmiLevel HMI status level of application - */ - virtual void setApplicationHMIStatusLevel( const NsSmartDeviceLinkRPCV2::HMILevel::HMILevelInternal& hmiLevel ); - - /** - * \brief retrieve aplication HMI status level - * \return HMI status level of application - */ - virtual const NsSmartDeviceLinkRPCV2::HMILevel::HMILevelInternal& getApplicationHMIStatusLevel( ) const; - - void addPersistentFile(const std::string& file); - void removePersistentFile(const std::string& file); - bool isPersistentFile(const std::string& file); - - int getDeviceHandle() const; - void setDeviceHandle(int deviceHandle); - - - protected: - static log4cplus::Logger mLogger; - - /** - * \brief Copy constructor - */ - Application(const Application& ); - - const std::string mName; - const unsigned int mProtocolVersion; - const int mAppID; - SessionKeys mSessionKeys; - std::string mNgnMediaScreenAppName; - std::vector<std::string> mVrSynonyms; - std::vector<std::string> persistentFiles; - bool m_bIsMediaApplication; - MenuMapping mMenuMapping; - CommandMapping mCommandMapping; - AppMenus mMenus; - - NsSmartDeviceLinkRPCV2::SystemContext mSystemContext; - NsSmartDeviceLinkRPCV2::AudioStreamingState mAudioStreamingState; - NsSmartDeviceLinkRPCV2::HMILevel::HMILevelInternal mHMIStatusLevel; - - int mDeviceHandle; - }; - -} // namespace NsAppManager - -#endif /* APPLICATION_H_ */ |