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

Description

Describes a tool type which is essentially the class description of the tool to be used to instantiate instances of the tool.

Inheritance diagram for GdkToolInfo:
Inheritance graph

Public Member Functions

kStatus GdkToolInfo_AddFeature (GdkToolInfo info, const kChar *type, GdkFeatureDataType dataType, GdkFeatureInfo *featureInfo)
 [Deprecated] Use GdkToolInfo_AddOutput() instead. More...
 
kStatus GdkToolInfo_AddInput (GdkToolInfo info, GdkDataType dataType, const kChar *name, const kChar *label, GdkParamInfo *paramInfo)
 Adds an input data set to a tool with the specified data type. More...
 
kStatus GdkToolInfo_AddMeasurement (GdkToolInfo info, const kChar *type, GdkMeasurementInfo *measurementInfo)
 [Deprecated] Use GdkToolInfo_AddOutput() instead. More...
 
kStatus GdkToolInfo_AddOutput (GdkToolInfo info, GdkDataType dataType, const kChar *name, const kChar *label, GdkOutputInfo *outputInfo)
 Adds a data output type to a tool with the specified data type. More...
 
kStatus GdkToolInfo_AddParam (GdkToolInfo info, GdkParamType paramType, const kChar *name, const kChar *label, const void *defValue, GdkParamInfo *paramInfo)
 Adds a parameter to a tool. More...
 
kStatus GdkToolInfo_AddSourceOption (GdkToolInfo info, GdkDataSource source)
 Add an option to the list of acceptable data sources. More...
 
kStatus GdkToolInfo_AddSourceType (GdkToolInfo info, GdkDataType type)
 Adds the data source type accepted by the tool. More...
 
kStatus GdkToolInfo_AddToolDataOutput (GdkToolInfo info, const kChar *name, GdkDataType dataType, GdkToolDataOutputInfo *tdOutputInfo)
 [Deprecated] Use GdkToolInfo_AddOutput() instead. More...
 
kStatus GdkToolInfo_AddVersion (GdkToolInfo info, const kChar *name, GdkToolVersionInfo *newVersion)
 Adds a tool configuration version. More...
 
kBool GdkToolInfo_AnchoringEnabled (GdkToolInfo info, GdkAnchorParam axis)
 Checks anchoring capability for a specified anchoring parameter. More...
 
GdkToolVersionInfo GdkToolInfo_DefaultVersion (GdkToolInfo info)
 Return the default version object. More...
 
kStatus GdkToolInfo_EnableAnchoring (GdkToolInfo info, GdkAnchorParam axis, kBool enabled)
 Enables or disables anchoring capability for a specified anchoring parameter. More...
 
kSize GdkToolInfo_FeatureCount (GdkToolInfo info)
 [Deprecated] Use GdkTool_FeatureIndexByType() to retrieve index of outputs instead. More...
 
const kCharGdkToolInfo_Label (GdkToolInfo info)
 Returns the tool display label. More...
 
kSize GdkToolInfo_MeasurementCount (GdkToolInfo info)
 [Deprecated] Use GdkTool_MeasurementIndexByType() to retrieve index of outputs instead. More...
 
GdkParamsInfo GdkToolInfo_Params (GdkToolInfo info)
 Returns the schema for the parameters. More...
 
kStatus GdkToolInfo_SetDefaultVersion (GdkToolInfo info, GdkToolVersionInfo version)
 Sets the default version object. More...
 
kStatus GdkToolInfo_SetLabel (GdkToolInfo info, const kChar *label)
 Sets the tool display label. More...
 
kStatus GdkToolInfo_SetSourceType (GdkToolInfo info, GdkDataType type)
 [Deprecated] Use GdkToolInfo_AddSourceType() instead. More...
 
kStatus GdkToolInfo_SetTypeName (GdkToolInfo info, const kChar *name)
 Sets the tool type name. More...
 
kStatus GdkToolInfo_SetVersionName (GdkToolInfo info, const kChar *name)
 Sets the version name explicitly. More...
 
kSize GdkToolInfo_ToolDataOutputCount (GdkToolInfo info)
 [Deprecated] Use GdkTool_DataOutputIndexByType() to retrieve index of outputs instead. More...
 
const kCharGdkToolInfo_TypeName (GdkToolInfo info)
 Returns the tool type name. More...
 
GdkToolVersionInfo GdkToolInfo_VersionAt (GdkToolInfo info, kSize index)
 Returns the version object at the specified index. More...
 
kSize GdkToolInfo_VersionCount (GdkToolInfo info)
 Returns the number of version objects. More...
 

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