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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
/*
* Copyright (c) 2016, 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_INCLUDE_APPLICATION_MANAGER_STATE_CONTROLLER_H_
#define SRC_COMPONENTS_INCLUDE_APPLICATION_MANAGER_STATE_CONTROLLER_H_
#include "application_manager/application.h"
#include "application_manager/application_manager.h"
#include "application_manager/postponed_activation_controller.h"
#include "application_manager/request_controller_settings.h"
#include "stdint.h"
class PostponedActivationController;
namespace application_manager {
class StateController {
public:
/**
* @brief SetRegularState setup regular hmi state, that will appear if
* no specific events are active
* @param app appication to setup regular State
* @param window_id id of applicaion's window to apply HMI state
* @param state state of new regular state
* @param request_hmi_state_change: if true, ActivateAppRequest or
* CloseApplication will be sent to HMI dependent on hmi level of resolved hmi
* state
*/
virtual void SetRegularState(ApplicationSharedPtr app,
const WindowID window_id,
HmiStatePtr state,
const bool request_hmi_state_change) = 0;
/**
* @brief SetRegularState Change regular hmi level and audio state
* @param app appication to setup regular State
* @param window_id id of applicaion's window to apply HMI state
* @param hmi_level of new regular state
* @param audio_state of new regular state
* @paran video_state of new regular state
* @param request_hmi_state_change: if true, ActivateAppRequest or
* CloseApplication will be sent to HMI dependent on hmi level of resolved hmi
* state
*/
virtual void SetRegularState(
ApplicationSharedPtr app,
const WindowID window_id,
const mobile_apis::HMILevel::eType hmi_level,
const mobile_apis::AudioStreamingState::eType audio_state,
const mobile_apis::VideoStreamingState::eType video_state,
const bool request_hmi_state_change) = 0;
/**
* @brief SetRegularState Change regular hmi level
* @param app appication to setup regular State
* @param window_id id of applicaion's window to apply HMI state
* @param hmi_level of new regular state
* @param request_hmi_state_change: if true, ActivateAppRequest or
* CloseApplication will be sent to HMI dependent on hmi level of resolved hmi
* state
*/
virtual void SetRegularState(ApplicationSharedPtr app,
const WindowID window_id,
const mobile_apis::HMILevel::eType hmi_level,
const bool request_hmi_state_change) = 0;
/**
* @brief SetRegularState Change regular hmi level, audio state and system
* context
* @param app appication to setup regular State
* @param window_id id of applicaion's window to apply HMI state
* @param hmi_level of new regular state
* @param audio_state of new regular state
* @param video_state of new regular state
* @param system_context of new regular state
* @param request_hmi_state_change: if true, ActivateAppRequest or
* CloseApplication will be sent to HMI dependent on hmi level of resolved hmi
* state
*/
virtual void SetRegularState(
ApplicationSharedPtr app,
const WindowID window_id,
const mobile_apis::HMILevel::eType hmi_level,
const mobile_apis::AudioStreamingState::eType audio_state,
const mobile_apis::VideoStreamingState::eType video_state,
const mobile_apis::SystemContext::eType system_context,
const bool request_hmi_state_change) = 0;
/**
* @brief SetRegularState Sets regular state with new hmi level
* to application
* @param app appication to setup regular state
* @param window_id id of applicaion's window to apply HMI state
* @param hmi_level new hmi level for application
*/
virtual void SetRegularState(
ApplicationSharedPtr app,
const WindowID window_id,
const mobile_apis::HMILevel::eType hmi_level) = 0;
/**
* @brief SetRegularState Change regular audio state
* @param app appication to setup regular State
* @param window_id id of applicaion's window to apply HMI state
* @param audio_state of new regular state
* @param video_state of new regular state
*/
virtual void SetRegularState(
ApplicationSharedPtr app,
const WindowID window_id,
const mobile_apis::AudioStreamingState::eType audio_state,
const mobile_apis::VideoStreamingState::eType video_state) = 0;
/**
* @brief SetRegularState Change regular system context
* @param app appication to setup regular State
* @param window_id id of applicaion's window to apply HMI state
* @param system_context of new regular state
*/
virtual void SetRegularState(
ApplicationSharedPtr app,
const WindowID window_id,
const mobile_apis::SystemContext::eType system_context) = 0;
/**
* @brief SetRegularState Sets new regular state to application
* @param app appication to setup regular state
* @param window_id id of applicaion's window to apply HMI state
* @param state new hmi state for application
*/
virtual void SetRegularState(ApplicationSharedPtr app,
const WindowID window_id,
HmiStatePtr state) = 0;
/**
* @brief Sets default application state and apply currently active HMI states
* on application registration
* @param app application to apply states
* @param default_level default HMI level
*/
virtual void OnApplicationRegistered(
ApplicationSharedPtr app,
const mobile_apis::HMILevel::eType default_level) = 0;
/**
* @brief OnAppWidgetAdded Sets default state for widget and apply currently
* active HMI states
* @param app application to apply states
* @param window_id id of window to add
* @param default_level default HMI level
*/
virtual void OnAppWindowAdded(
ApplicationSharedPtr app,
const WindowID window_id,
const mobile_apis::WindowType::eType window_type,
const mobile_apis::HMILevel::eType default_level) = 0;
/**
* @brief OnVideoStreamingStarted process video streaming started
* @param app projection or navigation application starting streaming
*/
virtual void OnVideoStreamingStarted(ApplicationConstSharedPtr app) = 0;
/**
* @brief OnVideoStreamingStopped process video streaming stopped
* @param app projection or navigation application stopping streaming
*/
virtual void OnVideoStreamingStopped(ApplicationConstSharedPtr app) = 0;
/**
* @brief OnStateChanged send HMIStatusNotification if needed
* @param app application
* @param window_id id of applicaion's window to apply HMI state
* @param old_state state before change
* @param new_state state after change
*/
virtual void OnStateChanged(ApplicationSharedPtr app,
const WindowID window_id,
HmiStatePtr old_state,
HmiStatePtr new_state) = 0;
/**
* @brief Checks activity of Deactivate HMI state.
* @return Returns TRUE if deactivate HMI state is active, otherwise returns
* FALSE.
*/
virtual bool IsStateActive(HmiState::StateID state_id) const = 0;
/**
* @brief ActivateDefaultWindow performs set of actions required for a proper
* application activation (i.e. main window activation)
* @param app pointer to application to be activated
*/
virtual void ActivateDefaultWindow(ApplicationSharedPtr app) = 0;
/**
* @brief ExitDefaultWindow performs set of action required for a proper
* application exiting (i.e. main window exit)
* @param app pointer to application to be exited
*/
virtual void ExitDefaultWindow(ApplicationSharedPtr app) = 0;
/**
* @brief Sets BACKGROUND or LIMITED hmi level to application
* depends on application type
* @param window_id ID of app window to deactivate
* @param app Application to deactivate
*/
virtual void DeactivateApp(ApplicationSharedPtr app,
const WindowID window_id) = 0;
/**
* @brief ResumePostponedWindows resumes adding of all postponed windows for a
* specified application, if exists
* @param app_id id of application to check
*/
virtual void ResumePostponedWindows(const uint32_t app_id) = 0;
/**
* @brief DropPostponedWindows drops all postponed windows for a specified
* application, if exists
* @param app_id id of application to check
*/
virtual void DropPostponedWindows(const uint32_t app_id) = 0;
virtual PostponedActivationController& GetPostponedActivationController() = 0;
};
} // namespace application_manager
#endif // SRC_COMPONENTS_INCLUDE_APPLICATION_MANAGER_STATE_CONTROLLER_H_
|
