Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoRecordingFilter.h
Go to the documentation of this file.
1
2 /**
3 * @file GoRecordingFilter.h
4 * @brief Declares the GoRecordingFilter class.
5 *
6 * @internal
7 * Copyright (C) 2016 by LMI Technologies Inc.
8 * Licensed under the MIT License.
9 * Redistributed files must retain the above copyright notice.
10 */
11 #ifndef GO_RECORDING_FILTER_H
12 #define GO_RECORDING_FILTER_H
13
14 #include <GoSdk/GoReplayCondition.h>
15
16 kBeginHeader()
17
18 /**
19 * @class GoRecordingFilter
20 * @extends kObject
21 * @ingroup GoSdk-Replay
22 * @brief Represents a recording filter configuration.
23 */
24 typedef kObject GoRecordingFilter;
25
26 /**
27 * Gets the condition combine type.
28 *
29 * @public @memberof GoRecordingFilter
30 * @version Introduced in firmware 4.5.3.57
31 * @param filter GoRecordingFilter object.
32 * @return The condition combine type.
33 */
34 GoFx(GoReplayCombineType) GoRecordingFilter_ConditionCombineType(GoRecordingFilter filter);
35
36 /**
37 * Sets the condition combine type.
38 *
39 * @public @memberof GoRecordingFilter
40 * @version Introduced in firmware 4.5.3.57
41 * @param filter GoRecordingFilter object.
42 * @param conditionCombineType GoReplayCombineType object.
43 * @return Operation status.
44 */
45 GoFx(kStatus) GoRecordingFilter_SetConditionCombineType(GoRecordingFilter filter, GoReplayCombineType conditionCombineType);
46
47 /**
48 * Gets the Any Measurement condition.
49 *
50 * @public @memberof GoRecordingFilter
51 * @version Introduced in firmware 4.5.3.57
52 * @param filter GoRecordingFilter object.
53 * @return The Any Measurement condition.
54 */
55 GoFx(GoReplayAnyMeasurement) GoRecordingFilter_AnyMeasurement(GoRecordingFilter filter);
56
57 /**
58 * Gets the Any Data condition.
59 *
60 * @public @memberof GoRecordingFilter
61 * @version Introduced in firmware 4.5.3.57
62 * @param filter GoRecordingFilter object.
63 * @return The Any Data condition.
64 */
65 GoFx(GoReplayAnyData) GoRecordingFilter_AnyData(GoRecordingFilter filter);
66
67 /**
68 * Gets the Measurement condition.
69 *
70 * @public @memberof GoRecordingFilter
71 * @version Introduced in firmware 4.5.3.57
72 * @param filter GoRecordingFilter object.
73 * @return The Measurement condition.
74 */
75 GoFx(GoReplayMeasurement) GoRecordingFilter_Measurement(GoRecordingFilter filter);
76
77 kEndHeader()
78 #include <GoSdk/GoRecordingFilter.x.h>
79
80 #endif
GoRecordingFilter::GoRecordingFilter_Measurement
GoReplayMeasurement GoRecordingFilter_Measurement(GoRecordingFilter filter)
Gets the Measurement condition.
GoRecordingFilter::GoRecordingFilter_AnyData
GoReplayAnyData GoRecordingFilter_AnyData(GoRecordingFilter filter)
Gets the Any Data condition.
GoRecordingFilter
Represents a recording filter configuration.
GoRecordingFilter::GoRecordingFilter_ConditionCombineType
GoReplayCombineType GoRecordingFilter_ConditionCombineType(GoRecordingFilter filter)
Gets the condition combine type.
GoReplayMeasurement
Represents the Measurement condition.
GoReplayCombineType
Represents a replay combine type.
GoRecordingFilter::GoRecordingFilter_SetConditionCombineType
kStatus GoRecordingFilter_SetConditionCombineType(GoRecordingFilter filter, GoReplayCombineType conditionCombineType)
Sets the condition combine type.
GoReplayCondition.h
Declares the GoReplayCondition classes.
GoRecordingFilter::GoRecordingFilter_AnyMeasurement
GoReplayAnyMeasurement GoRecordingFilter_AnyMeasurement(GoRecordingFilter filter)
Gets the Any Measurement condition.
GoReplayAnyData
Represents the Any Data condition.
kObject
kStatus
GoReplayAnyMeasurement
Represents the Any Measurement condition.