summaryrefslogtreecommitdiff
path: root/src/components/application_manager/include/application_manager/event_engine/event.h
blob: cfd6e9569331d6b32d841a79422b62a68043e8ca (plain)
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
/*
 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_EVENT_ENGINE_EVENT_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_ENGINE_EVENT_H_

#include <interfaces/HMI_API.h>
#include <interfaces/MOBILE_API.h>

#include "smart_objects/smart_object.h"
#include "application_manager/smart_object_keys.h"

namespace application_manager {
namespace event_engine {

class EventDispatcher;

class Event {
 public:
  // Typedef for possible Event ID's from mobile_apis functionID enum
  typedef hmi_apis::FunctionID::eType EventID;

  /*
   * @brief Constructor with parameters
   *
   * @param id Event ID. Please see mobile_apis::FunctionID for possible ID's
   */
  explicit Event(const EventID& id);

  /*
   * @brief Destructor
   */
  virtual ~Event();

  /*
   * @brief Sends synchronously event to all subscribers.
   *
   */
  void raise(EventDispatcher& event_dispatcher);

  /*
   * @brief Provides event ID
   */
  inline const EventID& id() const;

  /*
   * @brief Sets event smart object
   *
   * @param so The smart_object received in HMI response
   */
  void set_smart_object(const smart_objects::SmartObject& so);

  /*
   * @brief Retrieves event smart object
   *
   * @return The smart_object received in HMI response
   */
  inline const smart_objects::SmartObject& smart_object() const;

  /*
   * @brief Retrieves smart object request ID
   */
  inline int32_t smart_object_function_id() const;

  /*
   * @brief Retrieves smart object correlation ID
   */
  inline int32_t smart_object_correlation_id() const;

  /*
   * @brief Retrieves smart_object response type
   */
  inline int32_t smart_object_type() const;

 protected:
 private:
  EventID id_;
  smart_objects::SmartObject response_so_;

  /*
   * @brief Default constructor
   *
   * Unimplemented to avoid misusing
   */
  Event();

  DISALLOW_COPY_AND_ASSIGN(Event);
};

const Event::EventID& Event::id() const {
  return id_;
}

const smart_objects::SmartObject& Event::smart_object() const {
  return response_so_;
}

int32_t Event::smart_object_function_id() const {
  return response_so_.getElement(strings::params)
      .getElement(strings::function_id)
      .asInt();
}

int32_t Event::smart_object_correlation_id() const {
  return response_so_.getElement(strings::params)
      .getElement(strings::correlation_id)
      .asInt();
}

int32_t Event::smart_object_type() const {
  return response_so_.getElement(strings::params)
      .getElement(strings::message_type)
      .asInt();
}

class MobileEvent {
 public:
  // Typedef for possible Event ID's from mobile_apis functionID enum
  typedef mobile_apis::FunctionID::eType MobileEventID;

  /*
   * @brief Constructor with parameters
   *
   * @param id Event ID. Please see mobile_apis::FunctionID for possible ID's
   */
  explicit MobileEvent(const MobileEventID& id);

  /*
   * @brief Destructor
   */
  virtual ~MobileEvent();

  /*
   * @brief Sends synchronously event to all subscribers.
   *
   */
  void raise(EventDispatcher& event_dispatcher);

  /*
   * @brief Provides event ID
   */
  inline const MobileEventID& id() const;

  /*
   * @brief Sets event smart object
   *
   * @param so The smart_object received in Mobile response
   */
  void set_smart_object(const smart_objects::SmartObject& so);

  /*
   * @brief Retrieves event smart object
   *
   * @return The smart_object received in Mobile response
   */
  inline const smart_objects::SmartObject& smart_object() const;

  /*
   * @brief Retrieves smart object request ID
   */
  inline int32_t smart_object_function_id() const;

  /*
   * @brief Retrieves smart object correlation ID
   */
  inline int32_t smart_object_correlation_id() const;

  /*
   * @brief Retrieves smart_object response type
   */
  inline int32_t smart_object_type() const;

 protected:
 private:
  MobileEventID id_;
  smart_objects::SmartObject response_so_;

  /*
   * @brief Default constructor
   *
   * Unimplemented to avoid misusing
   */
  MobileEvent();

  DISALLOW_COPY_AND_ASSIGN(MobileEvent);
};

const MobileEvent::MobileEventID& MobileEvent::id() const {
  return id_;
}

const smart_objects::SmartObject& MobileEvent::smart_object() const {
  return response_so_;
}

int32_t MobileEvent::smart_object_function_id() const {
  return response_so_.getElement(strings::params)
      .getElement(strings::function_id)
      .asInt();
}

int32_t MobileEvent::smart_object_correlation_id() const {
  return response_so_.getElement(strings::params)
      .getElement(strings::correlation_id)
      .asInt();
}

int32_t MobileEvent::smart_object_type() const {
  return response_so_.getElement(strings::params)
      .getElement(strings::message_type)
      .asInt();
}

}  // namespace event_engine
}  // namespace application_manager

#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_ENGINE_EVENT_H_