Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups Pages
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) 2014 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 kBeginHeader()
15
16 /**
17 * @class GoDataSet
18 * @extends kObject
19 * @ingroup GoSdk-Data
20 * @brief Represents a collection of data channel or health channel messages.
21 */
22 typedef kObject GoDataSet;
23
24 /**
25 * Gets the sender ID (serial number) associated with this message collection.
26 *
27 * @public @memberof GoDataSet
28 * @param set Message collection.
29 * @return Sender ID.
30 */
31 GoFx(k32u) GoDataSet_SenderId(GoDataSet set);
32
33 /**
34 * Returns the message count in this collection.
35 *
36 * @public @memberof GoDataSet
37 * @param set Message collection.
38 * @return Count of messages.
39 */
40 GoFx(kSize) GoDataSet_Count(GoDataSet set);
41
42 /**
43 * Gets the message at the specified index.
44 *
45 * @public @memberof GoDataSet
46 * @param set Message collection.
47 * @param index Message index.
48 * @return Message object.
49 */
50 GoFx(kObject) GoDataSet_At(GoDataSet set, kSize index);
51
52 kEndHeader()
53 #include <GoSdk/Messages/GoDataSet.x.h>
54
55 #endif
GoDataSet::GoDataSet_SenderId
k32u GoDataSet_SenderId(GoDataSet set)
Gets the sender ID (serial number) associated with this message collection.
GoSdkDef.h
Essential SDK declarations.
GoDataSet::GoDataSet_At
kObject GoDataSet_At(GoDataSet set, kSize index)
Gets the message at the specified index.
GoDataSet
Represents a collection of data channel or health channel messages.
Definition: GoDataSet.h:14
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
GoDataSet::GoDataSet_Count
kSize GoDataSet_Count(GoDataSet set)
Returns the message count in this collection.