Neonode zForce(TM) SDK

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