Gocator API
GoDataSet.h
Go to the documentation of this file.
1 /**
2  * @file GoDataSet.h
3  * @brief Declares the GoDataSet class.
4  *
5  * @internal
6  * Copyright (C) 2016-2019 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_SDK_DATA_SET_H
11 #define GO_SDK_DATA_SET_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 
15 /**
16  * @class GoDataSet
17  * @extends kObject
18  * @ingroup GoSdk-Data
19  * @brief Represents a collection of data channel or health channel messages.
20  */
21 typedef kObject GoDataSet;
22 
23 /**
24  * Gets the sender ID (serial number) associated with this message collection.
25  *
26  * @public @memberof GoDataSet
27  * @version Introduced in firmware 4.0.10.27
28  * @param set Message collection.
29  * @return Sender ID.
30  */
32 
33 /**
34  * Returns the message count in this collection.
35  *
36  * @public @memberof GoDataSet
37  * @version Introduced in firmware 4.0.10.27
38  * @param set Message collection.
39  * @return Count of messages.
40  */
42 
43 /**
44  * Gets the message at the specified index.
45  *
46  * @public @memberof GoDataSet
47  * @version Introduced in firmware 4.0.10.27
48  * @param set Message collection.
49  * @param index Message index.
50  * @return Message object.
51  */
52 GoFx(kObject) GoDataSet_At(GoDataSet set, kSize index);
53 
54 #include <GoSdk/Messages/GoDataSet.x.h>
55 
56 #endif
kSize GoDataSet_Count(GoDataSet set)
Returns the message count in this collection.
k32u GoDataSet_SenderId(GoDataSet set)
Gets the sender ID (serial number) associated with this message collection.
Essential SDK declarations.
Represents a collection of data channel or health channel messages.
kObject GoDataSet_At(GoDataSet set, kSize index)
Gets the message at the specified index.