FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHxEvent.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_HX_EVENT_H
9 #define K_FIRESYNC_HX_EVENT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 #include <kFireSync/Hardware/kHxEvent.x.h>
13 
21 //typedef kObject kHxEvent; --forward-declared in kFsDef.x.h
22 
23 kInlineFx(kHxNode) kHxEvent_Node(kHxEvent manager)
24 {
25  kObj(kHxEvent, manager);
26 
27  return obj->node;
28 }
29 
30 kInlineFx(kSize) kHxEvent_Index(kHxEvent manager)
31 {
32  kObj(kHxEvent, manager);
33 
34  return obj->index;
35 }
36 
37 kInlineFx(kEventManagerType) kHxEvent_Type(kHxEvent manager)
38 {
39  kObj(kHxEvent, manager);
40 
41  return obj->eventType;
42 }
43 
44 kInlineFx(kStatus) kHxEvent_Enable(kHxEvent manager, kBool enabled)
45 {
46  kObj(kHxEvent, manager);
47 
48  obj->enabled = enabled;
49 
50  return kOK;
51 }
52 
53 kInlineFx(kBool) kHxEvent_IsEnabled(kHxEvent manager)
54 {
55  kObj(kHxEvent, manager);
56 
57  return obj->enabled;
58 }
59 
60 kInlineFx(kStatus) kHxEvent_SetControl(kHxEvent manager, kEventControl type)
61 {
62  kObj(kHxEvent, manager);
63 
64  obj->controlType = type;
65 
66  return kOK;
67 }
68 
69 kInlineFx(kEventControl) kHxEvent_Control(kHxEvent manager)
70 {
71  kObj(kHxEvent, manager);
72 
73  return obj->controlType;
74 }
75 
76 kInlineFx(kStatus) kHxEvent_SetControlId(kHxEvent manager, kSize id)
77 {
78  kObj(kHxEvent, manager);
79 
80  obj->controlId = id;
81 
82  return kOK;
83 }
84 
85 kInlineFx(kSize) kHxEvent_ControlId(kHxEvent manager)
86 {
87  kObj(kHxEvent, manager);
88 
89  return obj->controlId;
90 }
91 
92 kInlineFx(kStatus) kHxEvent_SetDomain(kHxEvent manager, kSyncDomain domain)
93 {
94  kObj(kHxEvent, manager);
95 
96  obj->domain = domain;
97 
98  return kOK;
99 }
100 
101 kInlineFx(kSyncDomain) kHxEvent_Domain(kHxEvent manager)
102 {
103  kObj(kHxEvent, manager);
104 
105  return obj->domain;
106 }
107 
108 kInlineFx(kStatus) kHxEvent_SetEncoderMode(kHxEvent manager, kEventEncoder mode)
109 {
110  kObj(kHxEvent, manager);
111 
112  obj->encoderMode = mode;
113 
114  return kOK;
115 }
116 
117 kInlineFx(kEventEncoder) kHxEvent_EncoderMode(kHxEvent manager)
118 {
119  kObj(kHxEvent, manager);
120 
121  return obj->encoderMode;
122 }
123 
124 kInlineFx(kStatus) kHxEvent_SetOffset(kHxEvent manager, k64u offset)
125 {
126  kObj(kHxEvent, manager);
127 
128  obj->offset = offset;
129 
130  return kOK;
131 }
132 
133 kInlineFx(k64u) kHxEvent_Offset(kHxEvent manager)
134 {
135  kObj(kHxEvent, manager);
136 
137  return obj->offset;
138 }
139 
140 
141 kInlineFx(kStatus) kHxEvent_SetCount(kHxEvent manager, k64u count)
142 {
143  kObj(kHxEvent, manager);
144 
145  obj->count = count;
146 
147  return kOK;
148 }
149 
150 kInlineFx(k64u) kHxEvent_Count(kHxEvent manager)
151 {
152  kObj(kHxEvent, manager);
153 
154  return obj->count;
155 }
156 
157 kInlineFx(kStatus) kHxEvent_SetPeriod(kHxEvent manager, k64u period)
158 {
159  kObj(kHxEvent, manager);
160 
161  obj->period = period;
162 
163  return kOK;
164 }
165 
166 kInlineFx(k64u) kHxEvent_Period(kHxEvent manager)
167 {
168  kObj(kHxEvent, manager);
169 
170  return obj->period;
171 }
172 
173 kInlineFx(kStatus) kHxEvent_EnableGate(kHxEvent manager, kBool enabled)
174 {
175  kObj(kHxEvent, manager);
176 
177  obj->gateEnabled = enabled;
178 
179  return kOK;
180 }
181 
182 kInlineFx(kBool) kHxEvent_GateEnabled(kHxEvent manager)
183 {
184  kObj(kHxEvent, manager);
185 
186  return obj->gateEnabled;
187 }
188 
189 kInlineFx(kStatus) kHxEvent_SetPhase(kHxEvent manager, k32u phase)
190 {
191  kObj(kHxEvent, manager);
192 
193  obj->phase = phase;
194 
195  return kOK;
196 }
197 
198 kInlineFx(k32u) kHxEvent_Phase(kHxEvent manager)
199 {
200  kObj(kHxEvent, manager);
201 
202  return obj->phase;
203 }
204 
205 kInlineFx(kStatus) kHxEvent_Stats(kHxEvent manager, kEventStats* stats)
206 {
207  return xkHxEvent_VTable(manager)->VStats(manager, stats);
208 }
209 
210 kInlineFx(kStatus) kHxEvent_Schedule(kHxEvent manager, k64s target)
211 {
212  return xkHxEvent_VTable(manager)->VSchedule(manager, target);
213 }
214 
215 kInlineFx(kStatus) kHxEvent_Trigger(kHxEvent manager)
216 {
217  return xkHxEvent_VTable(manager)->VTrigger(manager);
218 }
219 
220 kInlineFx(kStatus) kHxEvent_Clear(kHxEvent manager)
221 {
222  return xkHxEvent_VTable(manager)->VClear(manager);
223 }
224 
225 kInlineFx(kStatus) kHxEvent_SetMissStyle(kHxEvent manager, kEventMissStyle missStyle)
226 {
227  kObj(kHxEvent, manager);
228 
229  obj->missStyle = missStyle;
230 
231  return kOK;
232 }
233 
234 kInlineFx(kEventMissStyle) kHxEvent_MissStyle(kHxEvent manager)
235 {
236  kObj(kHxEvent, manager);
237 
238  return obj->missStyle;
239 }
240 
241 kInlineFx(kStatus) kHxEvent_EnableCancellation(kHxEvent manager, kBool enabled)
242 {
243  kObj(kHxEvent, manager);
244 
245  obj->cancellationEnabled = enabled;
246 
247  return kOK;
248 }
249 
250 kInlineFx(kBool) kHxEvent_CancellationEnabled(kHxEvent manager)
251 {
252  kObj(kHxEvent, manager);
253 
254  return obj->cancellationEnabled;
255 }
256 
257 #endif
Represents event manager miss styles.
Represents event manager types.
Represents event manager control modes.
#define kInlineFx(TYPE)
Essential declarations related to FireSync nodes.
Abstract base class for hardware node classes.
#define kObj(TypeName_T, T_object)
Represents event manager encoder mode options.
Represents FireSync synchronization domain options.
Represents event manager run-time statistics.
Definition: kNodeDef.h:152
#define kOK