Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
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-2021 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 
15 /**
16  * @class GoSection
17  * @extends kObject
18  * @ingroup GoSdk
19  * @brief Represents sections to be applied on surface data.
20  */
21 typedef kObject GoSection;
22 
23 /**
24  * Gets the ID of the section.
25  *
26  * @public @memberof GoSection
27  * @version Introduced in firmware 4.4.4.14
28  * @param section GoSection object.
29  * @return The section ID.
30  */
31 GoFx(k16s) GoSection_Id(GoSection section);
32 
33 /**
34  * Sets the name of the section.
35  *
36  * @public @memberof GoSection
37  * @version Introduced in firmware 4.4.4.14
38  * @param section GoSection object.
39  * @param name The name to be set for the section.
40  * @return Operation status.
41  */
42 GoFx(kStatus) GoSection_SetName(GoSection section, const kChar* name);
43 
44 /**
45  * Retrieves the name of the section.
46  *
47  * @public @memberof GoSection
48  * @version Introduced in firmware 4.4.4.14
49  * @param section GoSection object.
50  * @param name Receives the name of the section.
51  * @param capacity The maximum capacity of the name array.
52  * @return Operation status.
53  */
54 GoFx(kStatus) GoSection_Name(GoSection section, kChar* name, kSize capacity);
55 
56 /**
57  * Gets the start point of the section.
58  *
59  * @public @memberof GoSection
60  * @version Introduced in firmware 4.4.4.14
61  * @param section GoSection object.
62  * @return The firmware version.
63  */
65 
66 /**
67  * Sets the start point of the section.
68  *
69  * @public @memberof GoSection
70  * @version Introduced in firmware 4.4.4.14
71  * @param section GoSection object.
72  * @param point The new start point coordinates to set.
73  * @return Operation status.
74  */
76 
77 /**
78  * Gets the end point of the section.
79  *
80  * @public @memberof GoSection
81  * @version Introduced in firmware 4.4.4.14
82  * @param section GoSection object.
83  * @return The firmware version.
84  */
86 
87 /**
88  * Sets the end point of the section.
89  *
90  * @public @memberof GoSection
91  * @version Introduced in firmware 4.4.4.14
92  * @param section GoSection object.
93  * @param point The new end point coordinates to set.
94  * @return Operation status.
95  */
96 GoFx(kStatus) GoSection_SetEndPoint(GoSection section, kPoint64f point);
97 
98 /**
99  * Indicates whether the custom spacing interval is enabled.
100  *
101  * @public @memberof GoSection
102  * @version Introduced in firmware 4.4.4.14
103  * @param section GoSection object.
104  * @return kTRUE if enabled and kFALSE if disabled.
105  */
107 
108 /**
109  * Enables or disables the custom spacing interval.
110  *
111  * @public @memberof GoSection
112  * @version Introduced in firmware 4.4.4.14
113  * @param section GoSection object.
114  * @param enable kTRUE to enable the custom spacing interval and kFALSE to disable it.
115  * @return Operation status.
116  */
118 
119 /**
120  * Gets the current user defined spacing interval. (mm)
121  *
122  * @public @memberof GoSection
123  * @version Introduced in firmware 4.4.4.14
124  * @param section GoSection object.
125  * @return User defined spacing interval.
126  */
128 
129 /**
130  * Gets the current spacing interval minimum limit. (mm)
131  *
132  * @public @memberof GoSection
133  * @version Introduced in firmware 4.4.4.14
134  * @param section GoSection object.
135  * @return Spacing interval minimum limit.
136  */
138 
139 /**
140  * Gets the current spacing interval maximum limit. (mm)
141  *
142  * @public @memberof GoSection
143  * @version Introduced in firmware 4.4.4.14
144  * @param section GoSection object.
145  * @return Spacing interval maximum limit.
146  */
148 
149 /**
150  * Gets the spacing interval system value. (mm)
151  *
152  * @public @memberof GoSection
153  * @version Introduced in firmware 4.4.4.14
154  * @param section GoSection object.
155  * @return Spacing interval system value.
156  */
158 
159 /**
160  * Sets the spacing interval of the section.
161  *
162  * @public @memberof GoSection
163  * @version Introduced in firmware 4.4.4.14
164  * @param section GoSection object.
165  * @param value The spacing interval to set.
166  * @return Operation status.
167  */
168 GoFx(kStatus) GoSection_SetSpacingInterval(GoSection section, k64f value);
169 
170 #include <GoSdk/GoSection.x.h>
171 
172 #endif
k64f GoSection_SpacingIntervalSystemValue(GoSection section)
Gets the spacing interval system value.
kBool GoSection_CustomSpacingIntervalEnabled(GoSection section)
Indicates whether the custom spacing interval is enabled.
k16s GoSection_Id(GoSection section)
Gets the ID of the section.
Essential SDK declarations.
kPoint64f GoSection_EndPoint(GoSection section)
Gets the end point of the section.
kPoint64f GoSection_StartPoint(GoSection section)
Gets the start point of the section.
k64f GoSection_SpacingInterval(GoSection section)
Gets the current user defined spacing interval.
kStatus GoSection_SetStartPoint(GoSection section, kPoint64f point)
Sets the start point of the section.
k64f GoSection_SpacingIntervalLimitMin(GoSection section)
Gets the current spacing interval minimum limit.
kStatus GoSection_EnableCustomSpacingInterval(GoSection section, kBool enable)
Enables or disables the custom spacing interval.
kStatus GoSection_SetName(GoSection section, const kChar *name)
Sets the name of the section.
kStatus GoSection_SetSpacingInterval(GoSection section, k64f value)
Sets the spacing interval of the section.
kStatus GoSection_Name(GoSection section, kChar *name, kSize capacity)
Retrieves the name of the section.
kStatus GoSection_SetEndPoint(GoSection section, kPoint64f point)
Sets the end point of the section.
Represents sections to be applied on surface data.
k64f GoSection_SpacingIntervalLimitMax(GoSection section)
Gets the current spacing interval maximum limit.