Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSections.h
Go to the documentation of this file.
1 /**
2 * @file GoSections.h
3 * @brief Declares the GoSections class.
4 *
5 * @internal
6 * Copyright (C) 2016-2022 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SECTIONS_H
11 #define GO_SECTIONS_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoSection.h>
15
16 /**
17 * @class GoSections
18 * @extends kObject
19 * @note Supported with G2, G3
20 * @ingroup GoSdk-Surface
21 * @brief Represents the collection of sections and limits for defining them.
22 */
23 typedef kObject GoSections;
24
25 /**
26 * Gets the X axis minimum for section definition.
27 *
28 * @public @memberof GoSection
29 * @note Supported with G2, G3
30 * @version Introduced in firmware 4.4.4.14
31 * @param sections GoSections object.
32 * @return The minimum X value.
33 */
34 GoFx(k64f) GoSections_XLimitMin(GoSections sections);
35
36 /**
37 * Gets the X axis maximum for section definition.
38 *
39 * @public @memberof GoSection
40 * @note Supported with G2, G3
41 * @version Introduced in firmware 4.4.4.14
42 * @param sections GoSections object.
43 * @return The maximum X value.
44 */
45 GoFx(k64f) GoSections_XLimitMax(GoSections sections);
46
47 /**
48 * Gets the Y axis minimum for section definition.
49 *
50 * @public @memberof GoSection
51 * @note Supported with G2, G3
52 * @version Introduced in firmware 4.4.4.14
53 * @param sections GoSections object.
54 * @return The minimum Y value.
55 */
56 GoFx(k64f) GoSections_YLimitMin(GoSections sections);
57
58 /**
59 * Gets the Y axis maximum for section definition.
60 *
61 * @public @memberof GoSection
62 * @note Supported with G2, G3
63 * @version Introduced in firmware 4.4.4.14
64 * @param sections GoSections object.
65 * @return The maximum Y value.
66 */
67 GoFx(k64f) GoSections_YLimitMax(GoSections sections);
68
69 /**
70 * Returns the number of added sections.
71 *
72 * @public @memberof GoSection
73 * @note Supported with G2, G3
74 * @version Introduced in firmware 4.4.4.14
75 * @param sections GoSections object.
76 * @return The section count.
77 */
78 GoFx(kSize) GoSections_SectionCount(GoSections sections);
79
80 /**
81 * Retrieves the section at the specified index.
82 *
83 * @public @memberof GoSection
84 * @note Supported with G2, G3
85 * @version Introduced in firmware 4.4.4.14
86 * @param sections GoSections object.
87 * @param index The index of the section to retrieve.
88 * @return A section.
89 * @see GoSections_SectionCount
90 */
91 GoFx(GoSection) GoSections_SectionAt(GoSections sections, kSize index);
92
93 /**
94 * Adds a specified section to the configuration.
95 *
96 * @public @memberof GoSection
97 * @note Supported with G2, G3
98 * @version Introduced in firmware 4.4.4.14
99 * @param sections GoSections object.
100 * @param section The GoSection reference to add.
101 * @return Operation status.
102 */
103 GoFx(kStatus) GoSections_AddSection(GoSections sections, GoSection* section);
104
105 /**
106 * Removes the section at the specified index.
107 *
108 * @public @memberof GoSection
109 * @note Supported with G2, G3
110 * @version Introduced in firmware 4.4.4.14
111 * @param sections GoSections object.
112 * @param index The index of the section to remove.
113 * @return Operation status.
114 */
115 GoFx(kStatus) GoSections_RemoveSection(GoSections sections, kSize index);
116
117 /**
118 * Clears the section list.
119 *
120 * @public @memberof GoSection
121 * @note Supported with G2, G3
122 * @version Introduced in firmware 4.4.4.14
123 * @param sections GoSections object.
124 * @return Operation status.
125 */
126 GoFx(kStatus) GoSections_Clear(GoSections sections);
127
128 #include <GoSdk/GoSections.x.h>
129
130 #endif
kSize
GoSection::GoSections_XLimitMax
k64f GoSections_XLimitMax(GoSections sections)
Gets the X axis maximum for section definition.
GoSection::GoSections_YLimitMax
k64f GoSections_YLimitMax(GoSections sections)
Gets the Y axis maximum for section definition.
GoSdkDef.h
Essential SDK declarations.
GoSection::GoSections_RemoveSection
kStatus GoSections_RemoveSection(GoSections sections, kSize index)
Removes the section at the specified index.
GoSection::GoSections_XLimitMin
k64f GoSections_XLimitMin(GoSections sections)
Gets the X axis minimum for section definition.
GoSection.h
Declares the GoSection class.
GoSection::GoSections_SectionAt
GoSection GoSections_SectionAt(GoSections sections, kSize index)
Retrieves the section at the specified index.
GoSection::GoSections_AddSection
kStatus GoSections_AddSection(GoSections sections, GoSection *section)
Adds a specified section to the configuration.
kObject
kStatus
GoSection::GoSections_YLimitMin
k64f GoSections_YLimitMin(GoSections sections)
Gets the Y axis minimum for section definition.
k64f
GoSection::GoSections_SectionCount
kSize GoSections_SectionCount(GoSections sections)
Returns the number of added sections.
GoSection
Represents sections to be applied on surface data.
GoSection::GoSections_Clear
kStatus GoSections_Clear(GoSections sections)
Clears the section list.
GoSections
Represents the collection of sections and limits for defining them.