Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoExtParam.h
1 ///@cond private
2
3 /**
4 * @file GoExtParam.h
5 * @brief Declares the GoExtParam class.
6 *
7 * @internal
8 * Copyright (C) 2016-2022 by LMI Technologies Inc.
9 * Licensed under the MIT License.
10 * Redistributed files must retain the above copyright notice.
11 */
12 #ifndef GO_EXT_VALUE_H
13 #define GO_EXT_VALUE_H
14
15 #include <GoSdk/GoSdkDef.h>
16 #include <GoSdk/Tools/GoProfileToolUtils.h>
17 #include <GoSdk/Tools/GoSurfaceToolUtils.h>
18 #include <kApi/Data/kXml.h>
19
20 typedef struct GoExtParamIntOption
21 {
22 k32s value;
23 kText64 description;
24 } GoExtParamIntOption;
25
26 typedef struct GoExtParamFloatOption
27 {
28 k64f value;
29 kText64 description;
30 } GoExtParamFloatOption;
31
32 typedef kObject GoExtParam;
33 GoFx(const kChar*) GoExtParam_Label(GoExtParam param);
34 GoFx(const kChar*) GoExtParam_Id(GoExtParam param);
35 GoFx(GoExtParamType) GoExtParam_Type(GoExtParam param);
36 GoFx(kBool) GoExtParam_Used(GoExtParam param);
37 GoFx(const kChar*) GoExtParam_UnitType(GoExtParam param);
38
39 typedef GoExtParam GoExtParamBool;
40 GoFx(kBool) GoExtParamBool_Value(GoExtParamBool param);
41 GoFx(kStatus) GoExtParamBool_SetValue(GoExtParamBool param, kBool newVal);
42
43 typedef GoExtParam GoExtParamInt;
44 GoFx(k32s) GoExtParamInt_Value(GoExtParamInt param);
45 GoFx(kStatus) GoExtParamInt_SetValue(GoExtParamInt param, k32s newVal);
46 GoFx(kBool) GoExtParamInt_IsValueLimitUsed(GoExtParamInt param);
47 GoFx(k32s) GoExtParamInt_ValueMin(GoExtParamInt param);
48 GoFx(k32s) GoExtParamInt_ValueMax(GoExtParamInt param);
49 GoFx(kSize) GoExtParamInt_OptionCount(GoExtParamInt param);
50 GoFx(k32s) GoExtParamInt_OptionValueAt(GoExtParamInt param, kSize index);
51 GoFx(const kChar*) GoExtParamInt_OptionDescriptionAt(GoExtParamInt param, kSize index);
52
53 typedef GoExtParam GoExtParamFloat;
54 GoFx(k64f) GoExtParamFloat_Value(GoExtParamFloat param);
55 GoFx(kStatus) GoExtParamFloat_SetValue(GoExtParamFloat param, k64f newVal);
56 GoFx(kBool) GoExtParamFloat_IsValueLimitUsed(GoExtParamFloat param);
57 GoFx(k64f) GoExtParamFloat_ValueMin(GoExtParamFloat param);
58 GoFx(k64f) GoExtParamFloat_ValueMax(GoExtParamFloat param);
59 GoFx(kSize) GoExtParamFloat_OptionCount(GoExtParamFloat param);
60 GoFx(k64f) GoExtParamFloat_OptionValueAt(GoExtParamFloat param, kSize index);
61 GoFx(const kChar*) GoExtParamFloat_OptionDescriptionAt(GoExtParamFloat param, kSize index);
62
63 typedef GoExtParam GoExtParamFeature;
64 GoFx(kStatus) GoExtParamFeature_SetFeatureId(GoExtParamFeature param, k32s newVal);
65 GoFx(k32s) GoExtParamFeature_FeatureId(GoExtParamFeature param);
66 GoFx(k32s) GoExtParamFeature_ValueMin(GoExtParamFeature param);
67 GoFx(k32s) GoExtParamFeature_ValueMax(GoExtParamFeature param);
68 GoFx(kSize) GoExtParamFeature_OptionCount(GoExtParamFeature param);
69 GoFx(k32s) GoExtParamFeature_OptionValueAt(GoExtParamFeature param, kSize index);
70 GoFx(const kChar*) GoExtParamFeature_OptionDescriptionAt(GoExtParamFeature param, kSize index);
71
72 typedef GoExtParam GoExtParamString;
73 GoFx(kString) GoExtParamString_Value(GoExtParamString param);
74
75 typedef GoExtParam GoExtParamProfileRegion;
76 GoFx(GoProfileRegion) GoExtParamProfileRegion_Value(GoExtParamProfileRegion param);
77
78 typedef GoExtParam GoExtParamSurfaceRegion2d;
79 GoFx(GoSurfaceRegion2d) GoExtParamSurfaceRegion2d_Value(GoExtParamSurfaceRegion2d param);
80
81 typedef GoExtParam GoExtParamSurfaceRegion3d;
82 GoFx(GoRegion3d) GoExtParamSurfaceRegion3d_Value(GoExtParamSurfaceRegion3d param);
83
84 typedef GoExtParam GoExtParamDataInput;
85 GoFx(GoDataStreamId) GoExtParamDataInput_Value(GoExtParamDataInput param);
86 GoFx(kStatus) GoExtParamDataInput_SetValue(GoExtParamDataInput param, GoDataStreamId newVal);
87 GoFx(kSize) GoExtParamDataInput_OptionCount(GoExtParamDataInput param);
88 GoFx(GoDataStreamId) GoExtParamDataInput_OptionValueAt(GoExtParamDataInput param, kSize index);
89
90 typedef GoExtParam GoExtParamPointSetRegion;
91 GoFx(GoPointSetRegion) GoExtParamPointSetRegion_Value(GoExtParamPointSetRegion param);
92
93 #include <GoSdk/Tools/GoExtParam.x.h>
94
95 #endif
96 ///@endcond
kText64
GoSurfaceToolUtils.h
Declares all surface tools and their related classes.
kSize
kChar
GoProfileRegion
Represents a profile region used in various profile tools.
GoSdkDef.h
Essential SDK declarations.
GoDataStreamId
Represents a data stream id which consists of a data step, step id and source id. ...
Definition: GoSdkDef.h:1240
GoSurfaceRegion2d
Represents a two dimensional surface tool region.
k32s
GoRegion3d
Represents a three dimensional surface region.
GoPointSetRegion
Represents a point set region.
kString
GoProfileToolUtils.h
Declares shared profile tool configuration classes.
kObject
kStatus
kXml.h
k64f
kBool