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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
/**
* @file
* @author 2012-2013 Stefan Radomski (stefan.radomski@cs.tu-darmstadt.de)
* @copyright Simplified BSD
*
* @cond
* This program is free software: you can redistribute it and/or modify
* it under the terms of the FreeBSD license as published by the FreeBSD
* project.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of the FreeBSD license along with this
* program. If not, see <http://www.opensource.org/licenses/bsd-license>.
* @endcond
*/
#ifndef MMIEVENT_H_OS0SE7H5
#define MMIEVENT_H_OS0SE7H5
#define MMI_WITH_OPERATOR_EVENT 1
#include <DOM/Node.hpp>
#include <DOM/Document.hpp>
#include <uscxml/Interpreter.h>
namespace uscxml {
class MMIEvent {
public:
enum Type {
NEWCONTEXTREQUEST,
NEWCONTEXTRESPONSE,
PREPAREREQUEST,
PREPARERESPONSE,
STARTREQUEST,
STARTRESPONSE,
DONENOTIFICATION,
CANCELREQUEST,
CANCELRESPONSE,
PAUSEREQUEST,
PAUSERESPONSE,
RESUMEREQUEST,
RESUMERESPONSE,
EXTENSIONNOTIFICATION,
CLEARCONTEXTREQUEST,
CLEARCONTEXTRESPONSE,
STATUSREQUEST,
STATUSRESPONSE,
INVALID
};
enum RepresentationType {
MMI_AS_DATA,
MMI_AS_XML
};
static Type getType(Arabica::DOM::Node<std::string> node);
virtual Arabica::DOM::Document<std::string> toXML(bool encapsulateInMMI = true) const;
static MMIEvent fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
// conversion operator
operator Event() const;
#endif
std::string source;
std::string target;
std::string data;
Arabica::DOM::Node<std::string> dataDOM;
std::string requestId;
std::string tagName;
Type type;
RepresentationType representation;
static std::string nameSpace;
protected:
MMIEvent() : representation(MMI_AS_DATA) {}
};
class NewContextRequest : public MMIEvent {
public:
NewContextRequest() {
tagName = "NewContextRequest";
type = NEWCONTEXTREQUEST;
}
NewContextRequest(const MMIEvent& father) : MMIEvent(father) {}
static NewContextRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
std::string token; ///< special token for server-less modality components
};
class ContextualizedRequest : public MMIEvent {
public:
virtual Arabica::DOM::Document<std::string> toXML(bool encapsulateInMMI = true) const;
static ContextualizedRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
std::string context;
protected:
ContextualizedRequest() {}
ContextualizedRequest(const MMIEvent& father) : MMIEvent(father) {}
};
class PauseRequest : public ContextualizedRequest {
public:
PauseRequest() {
tagName = "PauseRequest";
type = PAUSEREQUEST;
}
PauseRequest(const ContextualizedRequest& father) : ContextualizedRequest(father) {}
static PauseRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class ResumeRequest : public ContextualizedRequest {
public:
ResumeRequest() {
tagName = "ResumeRequest";
type = RESUMEREQUEST;
}
ResumeRequest(const ContextualizedRequest& father) : ContextualizedRequest(father) {}
static ResumeRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class CancelRequest : public ContextualizedRequest {
public:
CancelRequest() {
tagName = "CancelRequest";
type = CANCELREQUEST;
}
CancelRequest(const ContextualizedRequest& father) : ContextualizedRequest(father) {}
static CancelRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class ClearContextRequest : public ContextualizedRequest {
public:
ClearContextRequest() {
tagName = "ClearContextRequest";
type = CLEARCONTEXTREQUEST;
}
ClearContextRequest(const ContextualizedRequest& father) : ContextualizedRequest(father) {}
static ClearContextRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class StatusRequest : public ContextualizedRequest {
public:
StatusRequest() {
tagName = "StatusRequest";
type = STARTREQUEST;
}
virtual Arabica::DOM::Document<std::string> toXML(bool encapsulateInMMI = true) const;
static StatusRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
bool automaticUpdate;
protected:
StatusRequest(const ContextualizedRequest& father) : ContextualizedRequest(father) {}
};
class ContentRequest : public ContextualizedRequest {
public:
struct ContentURL {
std::string href;
std::string maxAge;
std::string fetchTimeout;
};
virtual Arabica::DOM::Document<std::string> toXML(bool encapsulateInMMI = true) const;
static ContentRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
std::string content;
Arabica::DOM::Node<std::string> contentDOM;
ContentURL contentURL;
protected:
ContentRequest() {}
ContentRequest(const ContextualizedRequest& father) : ContextualizedRequest(father) {}
};
class PrepareRequest : public ContentRequest {
public:
PrepareRequest() {
tagName = "PrepareRequest";
type = PREPAREREQUEST;
}
PrepareRequest(const ContentRequest& father) : ContentRequest(father) {}
static PrepareRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class StartRequest : public ContentRequest {
public:
StartRequest() {
tagName = "StartRequest";
type = STARTREQUEST;
}
StartRequest(const ContentRequest& father) : ContentRequest(father) {}
static StartRequest fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class ExtensionNotification : public ContextualizedRequest {
public:
ExtensionNotification() {
tagName = "ExtensionNotification";
type = EXTENSIONNOTIFICATION;
}
virtual Arabica::DOM::Document<std::string> toXML(bool encapsulateInMMI = true) const;
static ExtensionNotification fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
std::string name;
protected:
ExtensionNotification(const ContextualizedRequest& father) : ContextualizedRequest(father) {}
};
class StatusResponse : public ContextualizedRequest {
public:
enum Status {
INVALID = 0,
ALIVE = 1,
DEAD = 2,
SUCCESS = 3,
FAILURE = 4
};
StatusResponse() {
tagName = "StatusResponse";
type = STATUSRESPONSE;
status = INVALID;
}
virtual Arabica::DOM::Document<std::string> toXML(bool encapsulateInMMI = true) const;
static StatusResponse fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
Status status;
protected:
StatusResponse(const ContextualizedRequest& father) : ContextualizedRequest(father) {}
};
class StatusInfoResponse : public StatusResponse {
public:
virtual Arabica::DOM::Document<std::string> toXML(bool encapsulateInMMI = true) const;
StatusInfoResponse(const StatusResponse& father) : StatusResponse(father) {}
static StatusInfoResponse fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
std::string statusInfo;
protected:
StatusInfoResponse() {}
};
class PrepareResponse : public StatusInfoResponse {
public:
PrepareResponse() {
tagName = "PrepareResponse";
type = PREPARERESPONSE;
}
PrepareResponse(const StatusInfoResponse& father) : StatusInfoResponse(father) {}
static PrepareResponse fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class StartResponse : public StatusInfoResponse {
public:
StartResponse() {
tagName = "StartResponse";
type = STARTRESPONSE;
}
StartResponse(const StatusInfoResponse& father) : StatusInfoResponse(father) {}
static StartResponse fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class CancelResponse : public StatusInfoResponse {
public:
CancelResponse() {
tagName = "CancelResponse";
type = CANCELRESPONSE;
}
CancelResponse(const StatusInfoResponse& father) : StatusInfoResponse(father) {}
static CancelResponse fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class PauseResponse : public StatusInfoResponse {
public:
PauseResponse() {
tagName = "PauseResponse";
type = PAUSERESPONSE;
}
PauseResponse(const StatusInfoResponse& father) : StatusInfoResponse(father) {}
static PauseResponse fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class ResumeResponse : public StatusInfoResponse {
public:
ResumeResponse() {
tagName = "ResumeResponse";
type = RESUMERESPONSE;
}
ResumeResponse(const StatusInfoResponse& father) : StatusInfoResponse(father) {}
static ResumeResponse fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class ClearContextResponse : public StatusInfoResponse {
public:
ClearContextResponse() {
tagName = "ClearContextResponse";
type = CLEARCONTEXTRESPONSE;
}
ClearContextResponse(const StatusInfoResponse& father) : StatusInfoResponse(father) {}
static ClearContextResponse fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class NewContextResponse : public StatusInfoResponse {
public:
NewContextResponse() {
tagName = "NewContextResponse";
type = NEWCONTEXTRESPONSE;
}
NewContextResponse(const StatusInfoResponse& father) : StatusInfoResponse(father) {}
static NewContextResponse fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
class DoneNotification : public StatusInfoResponse {
public:
DoneNotification() {
tagName = "DoneNotification";
type = DONENOTIFICATION;
}
DoneNotification(const StatusInfoResponse& father) : StatusInfoResponse(father) {}
static DoneNotification fromXML(Arabica::DOM::Node<std::string> node, InterpreterImpl* interpreter = NULL);
#ifdef MMI_WITH_OPERATOR_EVENT
operator Event() const;
#endif
};
}
#endif /* end of include guard: MMIEVENT_H_OS0SE7H5 */
|
