Neonode zForce(TM) SDK

- Main Page
- Modules
- Classes
- Files

- File List
- File Members

Message.h
Go to the documentation of this file.
1
9 #ifndef MESSAGE_MESSAGE_H
10 #define MESSAGE_MESSAGE_H
11
12 #ifndef ZFORCECOMMON_H
13 #error Please include "zForceCommon.h" before this file.
14 #endif // ZFORCECOMMON_H
15
21 struct Message
22 {
23 MessageType MessageType;
24 MessageGroup MessageGroup;
25 bool Error;
26 int ErrorCode;
27 uint64_t SerialNumber;
28 void ( * Destructor)(Message * self);
29 };
30
47 DLLEXTERNAL Message * Message_GetInstance (MessageType messageType,
48 MessageGroup messageGroup);
49
60 DLLINTERNAL Message * Message_New (MessageGroup messageGroup, uint32_t size);
61
62 // Barr 4.2d violation and exclusion.
63 #if defined(USE_ENABLEMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
64 #include <EnableMessage.h>
65 #endif
66
67 #if defined(USE_DISABLEMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
68 #include <DisableMessage.h>
69 #endif
70
71 #if defined(USE_OPERATIONMODESMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
72 #include <OperationModesMessage.h>
73 #endif
74
75 #if defined(USE_RESOLUTIONMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
76 #include <ResolutionMessage.h>
77 #endif
78
79 #if defined(USE_TOUCHACTIVEAREAMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
80 #include <TouchActiveAreaMessage.h>
81 #endif
82
83 #if defined(USE_TOUCHMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
84 #include <TouchMessage.h>
85 #endif
86
87 #if defined(USE_NUMBEROFTRACKEDOBJECTSMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
88 #include <NumberOfTrackedObjectsMessage.h>
89 #endif
90
91 #if defined(USE_FINGERFREQUENCYMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
92 #include <FingerFrequencyMessage.h>
93 #endif
94
95 #if defined(USE_IDLEFREQUENCYMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
96 #include <IdleFrequencyMessage.h>
97 #endif
98
99 #if defined(USE_DETECTEDOBJECTSIZERESTRICTIONMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
100 #include <DetectedObjectSizeRestrictionMessage.h>
101 #endif
102
103 #if defined(USE_REVERSETOUCHACTIVEAREAMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
104 #include <ReverseTouchActiveAreaMessage.h>
105 #endif
106
107 #if defined(USE_MCUUNIQUEIDENTIFIERMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
108 #include <McuUniqueIdentifierMessage.h>
109 #endif
110
111 #endif // MESSAGE_MESSAGE_H
112
TouchMessage.h
An TouchMessage contains the Data of a Touch.
McuUniqueIdentifierMessage.h
Brief description of module&#39;s purpose.
DisableMessage.h
A DisableMessage that disables a Device.
FingerFrequencyMessage.h
A FingerFrequencyMessage.
Message::MessageType
MessageType MessageType
The Message Type of the Message.
Definition: Message.h:23
Message_New
DLLINTERNAL Message * Message_New(MessageGroup messageGroup, uint32_t size)
Internal constructor for Message.
Message::SerialNumber
uint64_t SerialNumber
Unique serial number for this message.
Definition: Message.h:27
TouchActiveAreaMessage.h
A TouchActiveAreaMessage contains the Touch Active Area of a Device.
IdleFrequencyMessage.h
An IdleFrequencyMessage.
Message::Error
bool Error
If an error occurred, this is True.
Definition: Message.h:25
OperationModesMessage.h
An OperationModesMessage contains the modes the Device is set to.
Message
The main Message struct.
Definition: Message.h:21
Message::Destructor
void(* Destructor)(Message *self)
Destructor.
Definition: Message.h:28
MessageGroup
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:107
MessageType
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:87
ReverseTouchActiveAreaMessage.h
A ReverseTouchActiveAreaMessage contains the Touch Active Area of a Device.
ResolutionMessage.h
A ResolutionMessage that contains the Resolution a Device is set to.
EnableMessage.h
An EnableMessage that enables a Device.
DetectedObjectSizeRestrictionMessage.h
A DetectedObjectSizeRestrictionMessage contains Detected Object Size Restrictions of a Device...
Message_GetInstance
DLLEXTERNAL Message * Message_GetInstance(MessageType messageType, MessageGroup messageGroup)
Factory creator for Messages.
Message::MessageGroup
MessageGroup MessageGroup
The Message Group of the Message.
Definition: Message.h:24
Message::ErrorCode
int ErrorCode
Error Code, valid when Error == true.
Definition: Message.h:26
NumberOfTrackedObjectsMessage.h
A NumberOfTrackedObjectsMessage.