1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/*
Copyright (c) 2018, 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 SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_REQUEST_TO_HMI_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_REQUEST_TO_HMI_H_
#include "application_manager/application_manager.h"
#include "application_manager/commands/command_impl.h"
#include "application_manager/commands/command_request_impl.h"
namespace application_manager {
namespace commands {
/**
* @brief Check if HMI's interface is available.
* @param application_manager contains application manager component
* @param interface contains name of HMI's interface
* @return true if interface is available otherwise return fasle.
*/
bool CheckAvailabilityHMIInterfaces(ApplicationManager& application_manager,
HmiInterfaces::InterfaceID interface);
/**
* @brief Change interface state
* @param application_manager contains ApplicationManager instance
* @param response_from_hmi contains response from HMI
* @param interface contanins InterfaceID whose state is changed.
* @return true if field available exist and contains true in response params
* otherwise return false.
*/
bool ChangeInterfaceState(ApplicationManager& application_manager,
const smart_objects::SmartObject& response_from_hmi,
HmiInterfaces::InterfaceID interface);
class RequestToHMI : public CommandRequestImpl {
public:
RequestToHMI(const MessageSharedPtr& message,
ApplicationManager& application_manager,
rpc_service::RPCService& rpc_service,
HMICapabilities& hmi_capabilities,
policy::PolicyHandlerInterface& policy_handler);
virtual ~RequestToHMI();
virtual bool Init();
virtual bool CleanUp();
virtual void Run();
void SendRequest();
/**
* @brief Updates required requests that should be send to the HMI to get
* required HMI capabilities
* @param interface_name Interface name (e.g. UI, TTS, VR, RC or VehicleInfo)
*/
void UpdateRequiredInterfaceCapabilitiesRequests(
const std::string& interface_name);
/**
* @brief According to the specified interface sends appropriate requests to
* HMI for fetching of capabilities
* @param interface_name Interface name (e.g. UI, TTS, VR, RC or VehicleInfo)
*/
void RequestInterfaceCapabilities(const char* interface_name);
/*
* @brief Retrieves application ID
*/
inline uint32_t application_id() const {
return (*message_)[strings::msg_params][strings::app_id].asUInt();
}
private:
DISALLOW_COPY_AND_ASSIGN(RequestToHMI);
/**
* @brief Updates required requests that should be send to
* the HMI to get required HMI capabilities according to the passed function
* ids
* @param requests_to_send_to_hmi Collection of the function ids
*/
void UpdateRequestsRequiredForCapabilities(
const std::set<hmi_apis::FunctionID::eType>& requests_to_send_to_hmi);
/**
* @brief Sends request to HMI for fetching of capabilities according to the
* passed function ids
*/
void RequestCapabilities(
const std::set<hmi_apis::FunctionID::eType>& requests_to_send_to_hmi);
};
} // namespace commands
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_HMI_REQUEST_TO_HMI_H_
|
