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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/*
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 SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_PERFORM_INTERACTION_REQUEST_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_PERFORM_INTERACTION_REQUEST_H_
#include "application_manager/commands/command_request_impl.h"
#include "application_manager/application.h"
#include "utils/timer_thread.h"
#include "utils/macro.h"
namespace application_manager {
class Application;
namespace commands {
/**
* @brief PerformInteractionRequest command class
**/
class PerformInteractionRequest : public CommandRequestImpl {
public:
/**
* @brief PerformInteractionRequest class constructor
*
* @param message Incoming SmartObject message
**/
explicit PerformInteractionRequest(const MessageSharedPtr& message);
/**
* @brief PerformInteractionRequest class destructor
**/
virtual ~PerformInteractionRequest();
/**
* @brief Initialize request params
**/
virtual bool Init();
/**
* @brief Execute command
**/
virtual void Run();
/**
* @brief Interface method that is called whenever new event received
*
* @param event The received event
*/
virtual void on_event(const event_engine::Event& event);
/**
* @brief Timer callback function
*
*/
void onTimer();
private:
/*
* @brief Function is called by RequestController when request execution time
* has exceed it's limit
*
*/
virtual void onTimeOut();
/*
* @brief Function will be called when VR_OnCommand event
* comes
*
* @param message which should send to mobile side
*
*/
void ProcessVRResponse(const smart_objects::SmartObject& message);
/*
* @brief Sends PerformInteraction response to mobile side
*
* @param message which should send to mobile side
*
*/
void ProcessPerformInteractionResponse
(const smart_objects::SmartObject& message);
/*
* @brief Sends UI PerformInteraction request to HMI
*
* @param app_id Application ID
*
*/
void SendUIPerformInteractionRequest(
application_manager::ApplicationSharedPtr const app);
/*
* @brief Sends TTS PerformInteraction request to HMI
*
* @param app_id Application ID
*
*/
void SendVRPerformInteractionRequest(
application_manager::ApplicationSharedPtr const app);
/*
* @brief Sends UI Show VR help request to HMI
*
* @param app_id Application ID
*/
void SendUIShowVRHelpRequest(ApplicationSharedPtr const app);
/**
* @brief Creates and Sends Perform interaction to UI.
*/
void CreateUIPerformInteraction(const smart_objects::SmartObject& msg_params,
application_manager::ApplicationSharedPtr const app);
/*
* @brief Checks if incoming choice set doesn't has similar menu names.
*
* @param app_id Application ID
*
* return Return TRUE if there are no similar menu names in choice set,
* otherwise FALSE
*/
bool CheckChoiceSetMenuNames(application_manager::ApplicationSharedPtr const app);
/*
* @brief Checks if incoming choice set doesn't has similar VR synonyms.
*
* @param app_id Application ID
*
* return Return TRUE if there are no similar VR synonyms in choice set,
* otherwise FALSE
*/
bool CheckChoiceSetVRSynonyms(application_manager::ApplicationSharedPtr const app);
/*
* @brief Checks if request with non-sequential positions of vrHelpItems
* SDLAQ-CRS-466
*
* @param app_id Application ID
*
* @return TRUE if vrHelpItems positions are sequential,
* otherwise FALSE
*/
bool CheckVrHelpItemPositions(application_manager::ApplicationSharedPtr const app);
/*
* @brief Disable PerformInteraction state in application and
* delete VR commands from HMI
*/
void DisablePerformInteraction();
/**
* @brief Checks perform interaction params(initialText, initialPrompt, ...).
* When type is String there is a check on the contents \t\n \\t \\n
* @return if perform interaction contains \t\n \\t \\n return TRUE,
* FALSE otherwise
*/
bool IsWhiteSpaceExist();
/**
* @brief Send HMI close PopUp and call DisablePerformInteraction
*/
void TerminatePerformInteraction();
/**
* @brief Checks parameter ChoiceID from response.
* @param app contains pointer to application
* @param choice_id contains ChoiceID from response.
* @return if ChoiceID from response is correct method returns TRUE
* otherwise returns FALSE.
*/
bool CheckChoiceIDFromResponse(ApplicationSharedPtr app, int32_t choice_id);
// members
timer::TimerThread<PerformInteractionRequest> timer_;
DISALLOW_COPY_AND_ASSIGN(PerformInteractionRequest);
mobile_apis::Result::eType vr_perform_interaction_code_;
mobile_apis::InteractionMode::eType interaction_mode_;
bool ui_response_recived;
bool vr_response_recived;
};
} // namespace commands
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_PERFORM_INTERACTION_REQUEST_H_
|
