Gocator Development Kit
 All Classes Files Functions Variables Typedefs Friends Modules Pages
GdkToolCfg Class Reference

Description

Represents the configuration instance for a tool.

Where the GdkToolInfo is used to define the tool class, the GdkToolCfg is used to interface with the instance of the corresponding tool class.

Public Member Functions

kStatus GdkToolCfg_AddFeature (GdkToolCfg config, const kChar *type, GdkFeatureCfg *featureCfg)
 Add a new feature to the tool. More...
 
kStatus GdkToolCfg_AddMeasurement (GdkToolCfg config, const kChar *type, GdkMeasurementCfg *measurementCfg)
 Add a new measurement to the tool. More...
 
kStatus GdkToolCfg_AddToolDataOutput (GdkToolCfg config, const kChar *type, GdkToolDataOutputCfg *dataOutputCfg)
 Add a new data output to the tool. More...
 
k32s GdkToolCfg_Anchor (GdkToolCfg config, GdkAnchorParam axis)
 Returns the anchor source used by the tool. More...
 
GdkFeatureCfg GdkToolCfg_FeatureAt (GdkToolCfg config, kSize index)
 Returns the feature at an index. More...
 
kSize GdkToolCfg_FeatureCount (GdkToolCfg config)
 Returns the number of features in the tool. More...
 
GdkParam GdkToolCfg_FindParameter (GdkToolCfg config, const kChar *name)
 Returns the parameter matching the name passed. More...
 
GdkMeasurementCfg GdkToolCfg_MeasurementAt (GdkToolCfg config, kSize index)
 Returns the measurement at an index. More...
 
kSize GdkToolCfg_MeasurementCount (GdkToolCfg config)
 Returns the number of measurements in the tool. More...
 
const kCharGdkToolCfg_Name (GdkToolCfg config)
 Returns the tool name. More...
 
GdkToolOutputCfg GdkToolCfg_OutputAt (GdkToolCfg config, kSize index)
 Returns the output of the tool at the index. More...
 
kSize GdkToolCfg_OutputCount (GdkToolCfg config)
 Returns the count of outputs in the tool. More...
 
GdkParam GdkToolCfg_ParameterAt (GdkToolCfg config, kSize index)
 Returns the parameter at an index. More...
 
kSize GdkToolCfg_ParameterCount (GdkToolCfg config)
 Returns the count of parameters in the tool. More...
 
GdkParams GdkToolCfg_Parameters (GdkToolCfg config)
 Returns user-defined parameter set. More...
 
kStatus GdkToolCfg_RemoveFeature (GdkToolCfg config, kSize index)
 Removes the feature at an index. More...
 
kStatus GdkToolCfg_RemoveMeasurement (GdkToolCfg config, kSize index)
 Removes the measurement at an index. More...
 
kStatus GdkToolCfg_RemoveToolDataOutput (GdkToolCfg config, kSize index)
 Removes the tool data output at an index. More...
 
kStatus GdkToolCfg_SetAnchor (GdkToolCfg config, GdkAnchorParam axis, k32s id)
 Set the anchor source used by the tool. More...
 
kStatus GdkToolCfg_SetSource (GdkToolCfg config, GdkDataSource source)
 Set the data source used by the tool. More...
 
GdkDataSource GdkToolCfg_Source (GdkToolCfg config)
 Returns the data source used by the tool. More...
 
GdkToolDataOutputCfg GdkToolCfg_ToolDataOutputAt (GdkToolCfg config, kSize index)
 Returns the data output at an index. More...
 
kSize GdkToolCfg_ToolDataOutputCount (GdkToolCfg config)
 Returns the number of data outputs in the tool. More...
 
const kCharGdkToolCfg_Version (GdkToolCfg config)
 Returns the version of the configuration. More...
 
kBool GdkToolCfg_VersionUnknown (GdkToolCfg config)
 Returns whether the version not set. More...
 

The documentation for this class was generated from the following file: