Gocator Development Kit
 All Classes Files Functions Variables Typedefs Friends Modules Pages
GdkRuntimeVars.h
Go to the documentation of this file.
1 /**
2 * @file GdkRuntimeVars.h
3 * @brief Declares the GdkRuntimeVars interfaces.
4 *
5 * Copyright (C) 2017-2022 by LMI Technologies Inc. All rights reserved.
6 */
7 #ifndef GDK_RUNTIME_VARS_H
8 #define GDK_RUNTIME_VARS_H
9 
10 #include <Gdk/GdkDef.h>
11 
12 /**
13 * Describes the interfaces to read and write runtime variables from a Gdk tool.
14 *
15 * @class GdkRuntimeVars
16 * @ingroup Gdk-Utils
17 */
18 
19 /**
20  * Read the 32-bit signed integer runtime variables from the sensor.
21  *
22  * @public @memberof GdkRuntimeVars
23  * @param dataOut kArray1 of k32s to hold the runtime variable
24  * data read from sensor.
25  * @return Operation status.
26  */
27 GdkFx(kStatus) GdkRuntimeVars_Read32s(kArray1 dataOut);
28 
29 /**
30  * Write 32-bit signed integer runtime variables into the sensor.
31  *
32  * @public @memberof GdkRuntimeVars
33  * @param dataIn kArray1 of k32s which holds the runtime variable
34  * data to be written into the sensor.
35  * @return Operation status.
36  */
38 
39 #endif // GDK_RUNTIME_VARS_H
Essential Gdk declarations.
kStatus GdkRuntimeVars_Read32s(kArray1 dataOut)
Read the 32-bit signed integer runtime variables from the sensor.
kStatus GdkRuntimeVars_Write32s(kArray1 dataIn)
Write 32-bit signed integer runtime variables into the sensor.