Gocator API

GoSection.h
Go to the documentation of this file.
1 /**
2 * @file GoSection.h
3 * @brief Declares the GoSection class.
4 *
5 * @internal
6 * Copyright (C) 2016-2020 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SDK_SECTION_H
11 #define GO_SDK_SECTION_H
12
13 #include <GoSdk/GoSdkDef.h>
14 kBeginHeader()
15
16 /**
17 * @class GoSection
18 * @extends kObject
19 * @ingroup GoSdk
20 * @brief Represents sections to be applied on surface data.
21 */
22 typedef kObject GoSection;
23
24 /**
25 * Gets the ID of the section.
26 *
27 * @public @memberof GoSection
28 * @version Introduced in firmware 4.4.4.14
29 * @param section GoSection object.
30 * @return The section ID.
31 */
32 GoFx(k16s) GoSection_Id(GoSection section);
33
34 /**
35 * Sets the name of the section.
36 *
37 * @public @memberof GoSection
38 * @version Introduced in firmware 4.4.4.14
39 * @param section GoSection object.
40 * @param name The name to be set for the section.
41 * @return Operation status.
42 */
43 GoFx(kStatus) GoSection_SetName(GoSection section, const kChar* name);
44
45 /**
46 * Retrieves the name of the section.
47 *
48 * @public @memberof GoSection
49 * @version Introduced in firmware 4.4.4.14
50 * @param section GoSection object.
51 * @param name Receives the name of the section.
52 * @param capacity The maximum capacity of the name array.
53 * @return Operation status.
54 */
55 GoFx(kStatus) GoSection_Name(GoSection section, kChar* name, kSize capacity);
56
57 /**
58 * Gets the start point of the section.
59 *
60 * @public @memberof GoSection
61 * @version Introduced in firmware 4.4.4.14
62 * @param section GoSection object.
63 * @return The firmware version.
64 */
65 GoFx(kPoint64f) GoSection_StartPoint(GoSection section);
66
67 /**
68 * Sets the start point of the section.
69 *
70 * @public @memberof GoSection
71 * @version Introduced in firmware 4.4.4.14
72 * @param section GoSection object.
73 * @param point The new start point coordinates to set.
74 * @return Operation status.
75 */
76 GoFx(kStatus) GoSection_SetStartPoint(GoSection section, kPoint64f point);
77
78 /**
79 * Gets the end point of the section.
80 *
81 * @public @memberof GoSection
82 * @version Introduced in firmware 4.4.4.14
83 * @param section GoSection object.
84 * @return The firmware version.
85 */
86 GoFx(kPoint64f) GoSection_EndPoint(GoSection section);
87
88 /**
89 * Sets the end point of the section.
90 *
91 * @public @memberof GoSection
92 * @version Introduced in firmware 4.4.4.14
93 * @param section GoSection object.
94 * @param point The new end point coordinates to set.
95 * @return Operation status.
96 */
97 GoFx(kStatus) GoSection_SetEndPoint(GoSection section, kPoint64f point);
98
99 /**
100 * Indicates whether the custom spacing interval is enabled.
101 *
102 * @public @memberof GoSection
103 * @version Introduced in firmware 4.4.4.14
104 * @param section GoSection object.
105 * @return kTRUE if enabled and kFALSE if disabled.
106 */
107 GoFx(kBool) GoSection_CustomSpacingIntervalEnabled(GoSection section);
108
109 /**
110 * Enables or disables the custom spacing interval.
111 *
112 * @public @memberof GoSection
113 * @version Introduced in firmware 4.4.4.14
114 * @param section GoSection object.
115 * @param enable kTRUE to enable the custom spacing interval and kFALSE to disable it.
116 * @return Operation status.
117 */
118 GoFx(kStatus) GoSection_EnableCustomSpacingInterval(GoSection section, kBool enable);
119
120 /**
121 * Gets the current user defined spacing interval. (mm)
122 *
123 * @public @memberof GoSection
124 * @version Introduced in firmware 4.4.4.14
125 * @param section GoSection object.
126 * @return User defined spacing interval.
127 */
128 GoFx(k64f) GoSection_SpacingInterval(GoSection section);
129
130 /**
131 * Gets the current spacing interval minimum limit. (mm)
132 *
133 * @public @memberof GoSection
134 * @version Introduced in firmware 4.4.4.14
135 * @param section GoSection object.
136 * @return Spacing interval minimum limit.
137 */
138 GoFx(k64f) GoSection_SpacingIntervalLimitMin(GoSection section);
139
140 /**
141 * Gets the current spacing interval maximum limit. (mm)
142 *
143 * @public @memberof GoSection
144 * @version Introduced in firmware 4.4.4.14
145 * @param section GoSection object.
146 * @return Spacing interval maximum limit.
147 */
148 GoFx(k64f) GoSection_SpacingIntervalLimitMax(GoSection section);
149
150 /**
151 * Gets the spacing interval system value. (mm)
152 *
153 * @public @memberof GoSection
154 * @version Introduced in firmware 4.4.4.14
155 * @param section GoSection object.
156 * @return Spacing interval system value.
157 */
158 GoFx(k64f) GoSection_SpacingIntervalSystemValue(GoSection section);
159
160 /**
161 * Sets the spacing interval of the section.
162 *
163 * @public @memberof GoSection
164 * @version Introduced in firmware 4.4.4.14
165 * @param section GoSection object.
166 * @param value The spacing interval to set.
167 * @return Operation status.
168 */
169 GoFx(kStatus) GoSection_SetSpacingInterval(GoSection section, k64f value);
170
171 kEndHeader()
172
173 #include <GoSdk/GoSection.x.h>
174
175 #endif
GoSection::GoSection_SpacingIntervalSystemValue
k64f GoSection_SpacingIntervalSystemValue(GoSection section)
Gets the spacing interval system value.
kSize
GoSection::GoSection_CustomSpacingIntervalEnabled
kBool GoSection_CustomSpacingIntervalEnabled(GoSection section)
Indicates whether the custom spacing interval is enabled.
GoSection::GoSection_Id
k16s GoSection_Id(GoSection section)
Gets the ID of the section.
kChar
GoSdkDef.h
Essential SDK declarations.
GoSection::GoSection_EndPoint
kPoint64f GoSection_EndPoint(GoSection section)
Gets the end point of the section.
GoSection::GoSection_StartPoint
kPoint64f GoSection_StartPoint(GoSection section)
Gets the start point of the section.
GoSection::GoSection_SpacingInterval
k64f GoSection_SpacingInterval(GoSection section)
Gets the current user defined spacing interval.
GoSection::GoSection_SetStartPoint
kStatus GoSection_SetStartPoint(GoSection section, kPoint64f point)
Sets the start point of the section.
GoSection::GoSection_SpacingIntervalLimitMin
k64f GoSection_SpacingIntervalLimitMin(GoSection section)
Gets the current spacing interval minimum limit.
kPoint64f
GoSection::GoSection_EnableCustomSpacingInterval
kStatus GoSection_EnableCustomSpacingInterval(GoSection section, kBool enable)
Enables or disables the custom spacing interval.
k16s
kObject
GoSection::GoSection_SetName
kStatus GoSection_SetName(GoSection section, const kChar *name)
Sets the name of the section.
kStatus
GoSection::GoSection_SetSpacingInterval
kStatus GoSection_SetSpacingInterval(GoSection section, k64f value)
Sets the spacing interval of the section.
GoSection::GoSection_Name
kStatus GoSection_Name(GoSection section, kChar *name, kSize capacity)
Retrieves the name of the section.
GoSection::GoSection_SetEndPoint
kStatus GoSection_SetEndPoint(GoSection section, kPoint64f point)
Sets the end point of the section.
k64f
kBool
GoSection
Represents sections to be applied on surface data.
GoSection::GoSection_SpacingIntervalLimitMax
k64f GoSection_SpacingIntervalLimitMax(GoSection section)
Gets the current spacing interval maximum limit.