Neonode zForce(TM) SDK
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 {
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)
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)
101 #endif
102 
103 #if defined(USE_REVERSETOUCHACTIVEAREAMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
105 #endif
106 
107 #if defined(USE_MCUUNIQUEIDENTIFIERMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
109 #endif
110 
111 #if defined(USE_OFFSETMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
112  #include <OffsetMessage.h>
113 #endif
114 
115 #if defined(USE_HIDDISPLAYSIZEMESSAGE) || !defined (COMPILING_ZFORCE_SDK)
116  #include <HidDisplaySizeMessage.h>
117 #endif
118 
119 #endif // MESSAGE_MESSAGE_H
120 
A HidDisplaySizeMessage that contains the Hid Display Size.
An TouchMessage contains the Data of a Touch.
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:23
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:27
A TouchActiveAreaMessage contains the Touch Active Area of a Device.
An IdleFrequencyMessage.
bool Error
If an error occurred, this is True.
Definition: Message.h:25
An OperationModesMessage contains the modes the Device is set to.
The main Message struct.
Definition: Message.h:21
void(* Destructor)(Message *self)
Destructor.
Definition: Message.h:28
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:113
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:91
A ReverseTouchActiveAreaMessage contains the Touch Active Area of a Device.
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:24
int ErrorCode
Error Code, valid when Error == true.
Definition: Message.h:26
A NumberOfTrackedObjectsMessage.