Gocator Development Kit
 All Classes Files Functions Variables Typedefs Friends Modules Pages
Tool Definition

A custom tool is represented by a class deriving from the base class GdkTool.

Once a class has been defined and registered with the project assembly, it will be automatically discovered by the framework and become available for use just like a built-in tool.

The following aspects of a tool can be controlled:

  • Name
  • Type
  • Configuration parameters
  • List of measurements
  • Visualization
  • Acceptable data type

During boot-up, the framework calls the GoTool_Describe static method on each tool class. The implementation of this method should describe the tool using the given GdkToolInfo object.

At a minimum, a tool should describe its type name, data type, acceptable source options and at least one measurement.

GdksFx(kStatus) GdksTestRawTool_VDescribe(GdkToolInfo toolInfo)
{
kCheck(GdkToolInfo_SetTypeName(toolInfo, "TestTool"));
kCheck(GdkToolInfo_SetSourceType(toolInfo, GT_DATA_TYPE_UNIFORM_PROFILE));
kCheck(GdkToolInfo_AddSourceOption(toolInfo, GT_DATA_SOURCE_TOP));
kCheck(GdkToolInfo_AddMeasurement(toolInfo, "X", kNULL));
return kOK;
}