Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
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-2022 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 /**
17 * @class GoReplayCondition
18 * @extends kObject
19 * @ingroup GoSdk-Replay
20 * @brief Represents the base replay condition class.
21 */
22 typedef kObject GoReplayCondition;
23
24 /**
25 * Gets the enabled state of a replay condition.
26 *
27 * @public @memberof GoReplayCondition
28 * @version Introduced in firmware 4.5.3.57
29 * @param condition GoReplayCondition object.
30 * @return kTRUE if enabled and kFALSE if disabled.
31 */
32 GoFx(kBool) GoReplayCondition_Enabled(GoReplayCondition condition);
33
34 /**
35 * Sets the enabled state of a replay condition.
36 *
37 * @public @memberof GoReplayCondition
38 * @version Introduced in firmware 4.5.3.57
39 * @param condition GoReplayCondition object.
40 * @param enable kTRUE to enable the replay condition and kFALSE to disable it.
41 * @return Operation status.
42 */
43 GoFx(kStatus) GoReplayCondition_Enable(GoReplayCondition condition, kBool enable);
44
45 /**
46 * @class GoReplayAnyMeasurement
47 * @extends GoReplayCondition
48 * @ingroup GoSdk-Replay
49 * @brief Represents the Any Measurement condition.
50 */
51 typedef GoReplayCondition GoReplayAnyMeasurement;
52
53 /**
54 * Sets the required measurement result.
55 *
56 * @public @memberof GoReplayAnyMeasurement
57 * @version Introduced in firmware 4.5.3.57
58 * @param condition GoReplayAnyMeasurement object.
59 * @param result The required measurement result.
60 * @return Operation status.
61 */
62 GoFx(kStatus) GoReplayAnyMeasurement_SetResult(GoReplayAnyMeasurement condition, GoReplayMeasurementResult result);
63
64 /**
65 * Gets the required measurement result.
66 *
67 * @public @memberof GoReplayAnyMeasurement
68 * @version Introduced in firmware 4.5.3.57
69 * @param condition GoReplayAnyMeasurement object.
70 * @return The required measurement result.
71 */
72 GoFx(GoReplayMeasurementResult) GoReplayAnyMeasurement_Result(GoReplayAnyMeasurement condition);
73
74 /**
75 * @class GoReplayAnyData
76 * @extends GoReplayCondition
77 * @ingroup GoSdk-Replay
78 * @brief Represents the Any Data condition.
79 */
80 typedef GoReplayCondition GoReplayAnyData;
81
82 /**
83 * Sets the required range count case.
84 *
85 * @public @memberof GoReplayAnyData
86 * @version Introduced in firmware 4.5.3.57
87 * @param condition GoReplayAnyData object.
88 * @param rangeCase The required range count case.
89 * @return Operation status.
90 */
91 GoFx(kStatus) GoReplayAnyData_SetRangeCountCase(GoReplayAnyData condition, GoReplayRangeCountCase rangeCase);
92
93 /**
94 * Gets the required range count case.
95 *
96 * @public @memberof GoReplayAnyData
97 * @version Introduced in firmware 4.5.3.57
98 * @param condition GoReplayAnyData object.
99 * @return The required range count case.
100 */
101 GoFx(GoReplayRangeCountCase) GoReplayAnyData_RangeCountCase(GoReplayAnyData condition);
102
103 /**
104 * Sets the required range count threshold.
105 *
106 * @public @memberof GoReplayAnyData
107 * @version Introduced in firmware 4.5.3.57
108 * @param condition GoReplayAnyData object.
109 * @param threshold The required range count threshold.
110 * @return Operation status.
111 */
112 GoFx(kStatus) GoReplayAnyData_SetRangeCountThreshold(GoReplayAnyData condition, k32u threshold);
113
114 /**
115 * Gets the required range count threshold.
116 *
117 * @public @memberof GoReplayAnyData
118 * @version Introduced in firmware 4.5.3.57
119 * @param condition GoReplayAnyData object.
120 * @return The required range count threshold.
121 */
122 GoFx(k32u) GoReplayAnyData_RangeCountThreshold(GoReplayAnyData condition);
123
124 /**
125 * @class GoReplayMeasurement
126 * @extends GoReplayCondition
127 * @ingroup GoSdk-Replay
128 * @brief Represents the Measurement condition.
129 */
130 typedef GoReplayCondition GoReplayMeasurement;
131
132 /**
133 * Sets the required measurement result.
134 *
135 * @public @memberof GoReplayAnyData
136 * @version Introduced in firmware 4.5.3.57
137 * @param condition GoReplayAnyData object.
138 * @param result The required measurement result.
139 * @return Operation status.
140 */
141 GoFx(kStatus) GoReplayMeasurement_SetResult(GoReplayAnyData condition, GoReplayMeasurementResult result);
142
143 /**
144 * Gets the required measurement result.
145 *
146 * @public @memberof GoReplayMeasurement
147 * @version Introduced in firmware 4.5.3.57
148 * @param condition GoReplayMeasurement object.
149 * @return The required measurement result.
150 */
151 GoFx(GoReplayMeasurementResult) GoReplayMeasurement_Result(GoReplayMeasurement condition);
152
153 /**
154 * Gets the ID count.
155 *
156 * @public @memberof GoReplayMeasurement
157 * @version Introduced in firmware 4.5.3.57
158 * @param condition GoReplayMeasurement object.
159 * @return The ID count.
160 */
161 GoFx(kSize) GoReplayMeasurement_IdCount(GoReplayMeasurement condition);
162
163 /**
164 * Gets the ID at the specified index.
165 *
166 * @public @memberof GoReplayMeasurement
167 * @version Introduced in firmware 4.5.3.57
168 * @param condition GoReplayMeasurement object.
169 * @param index The index of the ID.
170 * @return The ID at the specified index.
171 */
172 GoFx(k32u) GoReplayMeasurement_IdAt(GoReplayMeasurement condition, kSize index);
173
174 /**
175 * Sets the ID at the specified index.
176 *
177 * @public @memberof GoReplayAnyData
178 * @version Introduced in firmware 4.5.3.57
179 * @param condition GoReplayAnyData object.
180 * @param index The index of the ID.
181 * @param id The ID.
182 * @return Operation status.
183 */
184 GoFx(kStatus) GoReplayMeasurement_SetIdAt(GoReplayMeasurement condition, kSize index, k32u id);
185
186 #include <GoSdk/GoReplayCondition.x.h>
187
188 #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