Neonode zForce(TM) SDK
Message.h
Go to the documentation of this file.
1 
9 #if !defined(MESSAGE_MESSAGE_H) && !defined(CONTAINS_MESSAGE)
10 
11 #ifndef ZFORCECOMMON_H
12  #error Please include "zForceCommon.h" before this file.
13 #endif // ZFORCECOMMON_H
14 
20 struct Message
21 {
22 #endif // !defined(MESSAGE_MESSAGE_H) && !defined(CONTAINS_MESSAGE)
23 #if !defined(MESSAGE_MESSAGE_H) || defined(CONTAINS_MESSAGE)
26  bool Error;
27  int ErrorCode;
28  uint64_t SerialNumber;
29  void ( * Destructor)(Message * self);
30 #endif // !defined(MESSAGE_MESSAGE_H) || defined(CONTAINS_MESSAGE)
31 #if !defined(MESSAGE_MESSAGE_H) && !defined(CONTAINS_MESSAGE)
32 };
33 
34 #ifdef __cplusplus
35 extern "C"
36 {
37 #endif // __cplusplus
38 
55 DLLEXTERNAL Message * Message_GetInstance (MessageType messageType, MessageGroup messageGroup);
56 
67 DLLINTERNAL Message * Message_New (MessageGroup messageGroup, uint32_t size);
68 
69 #ifdef __cplusplus
70 }
71 #endif // __cplusplus
72 
73 // Barr 4.2d violation and exclusion.
74 #if defined(USE_ENABLEMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
75  #include <EnableMessage.h>
76 #endif // defined(USE_ENABLEMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
77 
78 #if defined(USE_DISABLEMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
79  #include <DisableMessage.h>
80 #endif // defined(USE_DISABLEMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
81 
82 #if defined(USE_OPERATIONMODESMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
83  #include <OperationModesMessage.h>
84 #endif // defined(USE_OPERATIONMODESMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
85 
86 #if defined(USE_RESOLUTIONMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
87  #include <ResolutionMessage.h>
88 #endif // defined(USE_RESOLUTIONMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
89 
90 #if defined(USE_TOUCHACTIVEAREAMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
91  #include <TouchActiveAreaMessage.h>
92 #endif // defined(USE_TOUCHACTIVEAREAMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
93 
94 #if defined(USE_TOUCHMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
95  #include <TouchMessage.h>
96 #endif // defined(USE_TOUCHMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
97 
98 #if defined(USE_NUMBEROFTRACKEDOBJECTSMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
100 #endif // defined(USE_NUMBEROFTRACKEDOBJECTSMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
101 
102 #if defined(USE_FINGERFREQUENCYMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
103  #include <FingerFrequencyMessage.h>
104 #endif // defined(USE_FINGERFREQUENCYMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
105 
106 #if defined(USE_IDLEFREQUENCYMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
107  #include <IdleFrequencyMessage.h>
108 #endif // defined(USE_IDLEFREQUENCYMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
109 
110 #if defined(USE_DETECTEDOBJECTSIZERESTRICTIONMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
112 #endif // defined(USE_DETECTEDOBJECTSIZERESTRICTIONMESSAGE) || !defined(COMPILING_ZFORCE_SDK)
113 
114 #if defined(USE_REVERSETOUCHACTIVEAREAMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
116 #endif // defined(USE_REVERSETOUCHACTIVEAREAMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
117 
118 #if defined(USE_MCUUNIQUEIDENTIFIERMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
120 #endif // defined(USE_MCUUNIQUEIDENTIFIERMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
121 
122 #if defined(USE_OFFSETMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
123  #include <OffsetMessage.h>
124 #endif // defined(USE_OFFSETMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
125 
126 #if defined(USE_HIDDISPLAYSIZEMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
127  #include <HidDisplaySizeMessage.h>
128 #endif // defined(USE_HIDDISPLAYSIZEMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
129 
130 #if defined(USE_FLIPXYMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
131  #include <FlipXYMessage.h>
132 #endif // defined(USE_FLIPXYMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
133 
134 #if defined(USE_REFLECTIVEEDGEFILTERMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
136 #endif // defined(USE_REFLECTIVEEDGEFILTERMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
137 
138 #if defined(USE_MERGETOUCHESMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
139  #include <MergeTouchesMessage.h>
140 #endif // defined(USE_MERGETOUCHESMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
141 
142 #if defined(USE_TOUCHMODEMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
143  #include <TouchModeMessage.h>
144 #endif // defined(USE_TOUCHMODEMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
145 
146 #if defined(USE_FLOATINGPROTECTIONMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
147  #include <FloatingProtectionMessage.h>
148 #endif // defined(USE_FLOATINGPROTECTIONMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
149 
150 #define MESSAGE_MESSAGE_H
151 #endif // !defined(MESSAGE_MESSAGE_H) && !defined(CONTAINS_MESSAGE)
152 
A HidDisplaySizeMessage that contains the Hid Display Size.
An TouchMessage contains the Data of a Touch.
A MergeTouchesMessage sets the mode for the device to handle all simultaneous touching objects as one...
Brief description of module&#39;s purpose.
A DisableMessage that disables a Device.
A FingerFrequencyMessage.
MessageType MessageType
The Message Type of the Message.
Definition: Message.h:24
DLLINTERNAL Message * Message_New(MessageGroup messageGroup, uint32_t size)
Internal constructor for Message.
uint64_t SerialNumber
Unique serial number for this message.
Definition: Message.h:28
A TouchActiveAreaMessage contains the Touch Active Area of a Device.
An IdleFrequencyMessage.
bool Error
If an error occurred, this is True.
Definition: Message.h:26
A FloatingProtectionMessage configures the floating protection for the device.
An OperationModesMessage contains the modes the Device is set to.
The main Message struct.
Definition: Message.h:20
void(* Destructor)(Message *self)
Destructor.
Definition: Message.h:29
A ReflectiveEdgeFilterMessage contains the modes the Device is set to.
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:128
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:100
A ReverseTouchActiveAreaMessage contains the Touch Active Area of a Device.
A TouchModeMessage sets the touch mode for the device.
A FlipXYMessage that contains a bool for wether the axes are flipped or not.
An OffsetMessage that contains the Offset a Device is set to.
A ResolutionMessage that contains the Resolution a Device is set to.
An EnableMessage that enables a Device.
A DetectedObjectSizeRestrictionMessage contains Detected Object Size Restrictions of a Device...
DLLEXTERNAL Message * Message_GetInstance(MessageType messageType, MessageGroup messageGroup)
Factory creator for Messages.
MessageGroup MessageGroup
The Message Group of the Message.
Definition: Message.h:25
int ErrorCode
Error Code, valid when Error == true.
Definition: Message.h:27
A NumberOfTrackedObjectsMessage.