Gocator API

GoReplayCondition.h
Go to the documentation of this file.
1
2 /**
3 * @file GoReplayCondition.h
4 * @brief Declares the GoReplayCondition classes.
5 *
6 * @internal
7 * Copyright (C) 2016-2020 by LMI Technologies Inc.
8 * Licensed under the MIT License.
9 * Redistributed files must retain the above copyright notice.
10 */
11 #ifndef GO_REPLAY_CONDITION_H
12 #define GO_REPLAY_CONDITION_H
13
14 #include <GoSdk/GoSdkDef.h>
15
16 kBeginHeader()
17
18 /**
19 * @class GoReplayCondition
20 * @extends kObject
21 * @ingroup GoSdk-Replay
22 * @brief Represents the base replay condition class.
23 */
24 typedef kObject GoReplayCondition;
25
26 /**
27 * Gets the enabled state of a replay condition.
28 *
29 * @public @memberof GoReplayCondition
30 * @version Introduced in firmware 4.5.3.57
31 * @param condition GoReplayCondition object.
32 * @return kTRUE if enabled and kFALSE if disabled.
33 */
34 GoFx(kBool) GoReplayCondition_Enabled(GoReplayCondition condition);
35
36 /**
37 * Sets the enabled state of a replay condition.
38 *
39 * @public @memberof GoReplayCondition
40 * @version Introduced in firmware 4.5.3.57
41 * @param condition GoReplayCondition object.
42 * @param enable kTRUE to enable the replay condition and kFALSE to disable it.
43 * @return Operation status.
44 */
45 GoFx(kStatus) GoReplayCondition_Enable(GoReplayCondition condition, kBool enable);
46
47 /**
48 * @class GoReplayAnyMeasurement
49 * @extends GoReplayCondition
50 * @ingroup GoSdk-Replay
51 * @brief Represents the Any Measurement condition.
52 */
53 typedef GoReplayCondition GoReplayAnyMeasurement;
54
55 /**
56 * Sets the required measurement result.
57 *
58 * @public @memberof GoReplayAnyMeasurement
59 * @version Introduced in firmware 4.5.3.57
60 * @param condition GoReplayAnyMeasurement object.
61 * @param result The required measurement result.
62 * @return Operation status.
63 */
64 GoFx(kStatus) GoReplayAnyMeasurement_SetResult(GoReplayAnyMeasurement condition, GoReplayMeasurementResult result);
65
66 /**
67 * Gets the required measurement result.
68 *
69 * @public @memberof GoReplayAnyMeasurement
70 * @version Introduced in firmware 4.5.3.57
71 * @param condition GoReplayAnyMeasurement object.
72 * @return The required measurement result.
73 */
74 GoFx(GoReplayMeasurementResult) GoReplayAnyMeasurement_Result(GoReplayAnyMeasurement condition);
75
76 /**
77 * @class GoReplayAnyData
78 * @extends GoReplayCondition
79 * @ingroup GoSdk-Replay
80 * @brief Represents the Any Data condition.
81 */
82 typedef GoReplayCondition GoReplayAnyData;
83
84 /**
85 * Sets the required range count case.
86 *
87 * @public @memberof GoReplayAnyData
88 * @version Introduced in firmware 4.5.3.57
89 * @param condition GoReplayAnyData object.
90 * @param rangeCase The required range count case.
91 * @return Operation status.
92 */
93 GoFx(kStatus) GoReplayAnyData_SetRangeCountCase(GoReplayAnyData condition, GoReplayRangeCountCase rangeCase);
94
95 /**
96 * Gets the required range count case.
97 *
98 * @public @memberof GoReplayAnyData
99 * @version Introduced in firmware 4.5.3.57
100 * @param condition GoReplayAnyData object.
101 * @return The required range count case.
102 */
103 GoFx(GoReplayRangeCountCase) GoReplayAnyData_RangeCountCase(GoReplayAnyData condition);
104
105 /**
106 * Sets the required range count threshold.
107 *
108 * @public @memberof GoReplayAnyData
109 * @version Introduced in firmware 4.5.3.57
110 * @param condition GoReplayAnyData object.
111 * @param threshold The required range count threshold.
112 * @return Operation status.
113 */
114 GoFx(kStatus) GoReplayAnyData_SetRangeCountThreshold(GoReplayAnyData condition, k32u threshold);
115
116 /**
117 * Gets the required range count threshold.
118 *
119 * @public @memberof GoReplayAnyData
120 * @version Introduced in firmware 4.5.3.57
121 * @param condition GoReplayAnyData object.
122 * @return The required range count threshold.
123 */
124 GoFx(k32u) GoReplayAnyData_RangeCountThreshold(GoReplayAnyData condition);
125
126 /**
127 * @class GoReplayMeasurement
128 * @extends GoReplayCondition
129 * @ingroup GoSdk-Replay
130 * @brief Represents the Measurement condition.
131 */
132 typedef GoReplayCondition GoReplayMeasurement;
133
134 /**
135 * Sets the required measurement result.
136 *
137 * @public @memberof GoReplayAnyData
138 * @version Introduced in firmware 4.5.3.57
139 * @param condition GoReplayAnyData object.
140 * @param result The required measurement result.
141 * @return Operation status.
142 */
143 GoFx(kStatus) GoReplayMeasurement_SetResult(GoReplayAnyData condition, GoReplayMeasurementResult result);
144
145 /**
146 * Gets the required measurement result.
147 *
148 * @public @memberof GoReplayMeasurement
149 * @version Introduced in firmware 4.5.3.57
150 * @param condition GoReplayMeasurement object.
151 * @return The required measurement result.
152 */
153 GoFx(GoReplayMeasurementResult) GoReplayMeasurement_Result(GoReplayMeasurement condition);
154
155 /**
156 * Gets the ID count.
157 *
158 * @public @memberof GoReplayMeasurement
159 * @version Introduced in firmware 4.5.3.57
160 * @param condition GoReplayMeasurement object.
161 * @return The ID count.
162 */
163 GoFx(kSize) GoReplayMeasurement_IdCount(GoReplayMeasurement condition);
164
165 /**
166 * Gets the ID at the specified index.
167 *
168 * @public @memberof GoReplayMeasurement
169 * @version Introduced in firmware 4.5.3.57
170 * @param condition GoReplayMeasurement object.
171 * @param index The index of the ID.
172 * @return The ID at the specified index.
173 */
174 GoFx(k32u) GoReplayMeasurement_IdAt(GoReplayMeasurement condition, kSize index);
175
176 /**
177 * Sets the ID at the specified index.
178 *
179 * @public @memberof GoReplayAnyData
180 * @version Introduced in firmware 4.5.3.57
181 * @param condition GoReplayAnyData object.
182 * @param index The index of the ID.
183 * @param id The ID.
184 * @return Operation status.
185 */
186 GoFx(kStatus) GoReplayMeasurement_SetIdAt(GoReplayMeasurement condition, kSize index, k32u id);
187
188 kEndHeader()
189 #include <GoSdk/GoReplayCondition.x.h>
190
191 #endif
k32u
GoReplayAnyData::GoReplayAnyData_SetRangeCountCase
kStatus GoReplayAnyData_SetRangeCountCase(GoReplayAnyData condition, GoReplayRangeCountCase rangeCase)
Sets the required range count case.
GoReplayAnyData::GoReplayAnyData_RangeCountCase
GoReplayRangeCountCase GoReplayAnyData_RangeCountCase(GoReplayAnyData condition)
Gets the required range count case.
GoReplayMeasurement::GoReplayMeasurement_Result
GoReplayMeasurementResult GoReplayMeasurement_Result(GoReplayMeasurement condition)
Gets the required measurement result.
GoReplayMeasurement
Represents the Measurement condition.
kSize
GoReplayMeasurementResult
Represents a replay measurement result.
GoReplayMeasurement::GoReplayMeasurement_IdCount
kSize GoReplayMeasurement_IdCount(GoReplayMeasurement condition)
Gets the ID count.
GoSdkDef.h
Essential SDK declarations.
GoReplayAnyData::GoReplayMeasurement_SetIdAt
kStatus GoReplayMeasurement_SetIdAt(GoReplayMeasurement condition, kSize index, k32u id)
Sets the ID at the specified index.
GoReplayAnyData::GoReplayAnyData_RangeCountThreshold
k32u GoReplayAnyData_RangeCountThreshold(GoReplayAnyData condition)
Gets the required range count threshold.
GoReplayMeasurement::GoReplayMeasurement_IdAt
k32u GoReplayMeasurement_IdAt(GoReplayMeasurement condition, kSize index)
Gets the ID at the specified index.
GoReplayRangeCountCase
Represents a replay range count case.
GoReplayCondition
Represents the base replay condition class.
GoReplayAnyMeasurement::GoReplayAnyMeasurement_SetResult
kStatus GoReplayAnyMeasurement_SetResult(GoReplayAnyMeasurement condition, GoReplayMeasurementResult result)
Sets the required measurement result.
GoReplayAnyData::GoReplayAnyData_SetRangeCountThreshold
kStatus GoReplayAnyData_SetRangeCountThreshold(GoReplayAnyData condition, k32u threshold)
Sets the required range count threshold.
GoReplayAnyData
Represents the Any Data condition.
GoReplayAnyMeasurement::GoReplayAnyMeasurement_Result
GoReplayMeasurementResult GoReplayAnyMeasurement_Result(GoReplayAnyMeasurement condition)
Gets the required measurement result.
GoReplayCondition::GoReplayCondition_Enable
kStatus GoReplayCondition_Enable(GoReplayCondition condition, kBool enable)
Sets the enabled state of a replay condition.
kObject
kStatus
GoReplayAnyMeasurement
Represents the Any Measurement condition.
GoReplayAnyData::GoReplayMeasurement_SetResult
kStatus GoReplayMeasurement_SetResult(GoReplayAnyData condition, GoReplayMeasurementResult result)
Sets the required measurement result.
GoReplayCondition::GoReplayCondition_Enabled
kBool GoReplayCondition_Enabled(GoReplayCondition condition)
Gets the enabled state of a replay condition.
kBool