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

Description

Base class for a tool implementation.

Inheritance diagram for GdkTool:
Inheritance graph

Public Member Functions

kStatus GdkTool_AnchorPointSetRegion (GdkTool tool, const kArrayList *original, kArrayList *anchored)
 Applies the currently available anchoring parameters to a point set region. More...
 
kStatus GdkTool_AnchorProfileRegion (GdkTool tool, const GdkRegionXZ64f *original, GdkRegionXZ64f *anchored)
 Applies the currently available anchoring parameters to a profile region. More...
 
kStatus GdkTool_AnchorSurfaceRegion (GdkTool tool, const GdkRegion3d64f *original, GdkRegion3d64f *anchored)
 Applies the currently available anchoring parameters to a surface region. More...
 
GdkToolCfg GdkTool_Config (GdkTool tool)
 Returns the tool configuration. More...
 
kSize GdkTool_DataOutputIndexByType (GdkTool tool, const kChar *typeName)
 Find the index of a tool data output by its type name. More...
 
kSize GdkTool_FeatureIndexByType (GdkTool tool, const kChar *typeName)
 Find the index of a feature by its type name. More...
 
kSize GdkTool_InputDataIndex (GdkTool tool, const kChar *name)
 Returns the index for the named input. More...
 
kSize GdkTool_InputFeatureIndex (GdkTool tool, const kChar *name)
 [Deprecated] Use GdkTool_InputDataIndex() instead. More...
 
kSize GdkTool_MeasurementIndexByType (GdkTool tool, const kChar *typeName)
 Find the index of a measurement by its type name. More...
 
kAlloc GdkTool_MessageAlloc (GdkTool tool)
 Returns the message processing memory allocator. More...
 
GdkSensorInfo GdkTool_SensorInfo (GdkTool tool)
 Returns the sensor information. More...
 
kStatus GdkTool_SetupForScanning (GdkTool tool, GdkSensorInfo sensorInfo, GdkToolCfg toolCfg)
 Set up the tool instance in preparation for sensor scanning. More...
 
kStatus GdkTool_VCalcDataOutputRegion (const GdkToolEnv *env, GdkToolCfg toolConfig, GdkToolDataOutputCfg outputConfig, GdkRegion3d64f *region)
 [Deprecated] Use GdkTool_VCalcDataOutputRegionInstanced() instead. More...
 
kStatus GdkTool_VCalcDataOutputRegionInstanced (GdkTool tool, GdkToolDataOutputCfg outputConfig, GdkRegion3d64f *region)
 Calculates the tool instance's region for a given data output. More...
 
kBool GdkTool_VIsVisible (const GdkToolEnv *env)
 Determines whether or not this tools should show up in the list of tools. More...
 
kStatus GdkTool_VNewFeatureConfig (const GdkToolEnv *env, GdkToolCfg toolConfig, GdkFeatureCfg featureConfig)
 [Deprecated] Use GdkTool_VNewFeatureConfigInstanced() instead. More...
 
kStatus GdkTool_VNewFeatureConfigInstanced (GdkTool tool, GdkFeatureCfg featureConfig)
 Initializes newly added tool instance's feature configuration data. More...
 
kStatus GdkTool_VNewMeasurementConfig (const GdkToolEnv *env, GdkToolCfg toolConfig, GdkMeasurementCfg measurementConfig)
 [Deprecated] Use GdkTool_VNewMeasurementConfigInstanced() instead. More...
 
kStatus GdkTool_VNewMeasurementConfigInstanced (GdkTool tool, GdkMeasurementCfg measurementConfig)
 Initializes newly added tool intance's measurement configuration data. More...
 
kStatus GdkTool_VNewToolConfig (const GdkToolEnv *env, GdkToolCfg toolConfig)
 [Deprecated] Use GdkTool_VNewToolConfigInstanced() instead. More...
 
kStatus GdkTool_VNewToolConfigInstanced (GdkTool tool, GdkToolCfg toolConfig)
 Initializes newly added tool instance's configuration data. More...
 
kStatus GdkTool_VNewToolDataOutputConfig (const GdkToolEnv *env, GdkToolCfg toolConfig, GdkToolDataOutputCfg toolDataOutputConfig)
 [Deprecated] Use GdkTool_VNewToolDataOutputConfigInstanced() instead. More...
 
kStatus GdkTool_VNewToolDataOutputConfigInstanced (GdkTool tool, GdkToolDataOutputCfg toolDataOutputConfig)
 Initializes newly added tool instance's data output configuration data. More...
 
kStatus GdkTool_VProcess (GdkTool tool, GdkToolInput input, GdkToolOutput output)
 Process an incoming frame. More...
 
kStatus GdkTool_VStart (GdkTool tool)
 Called by the framework before data collection starts. More...
 
kStatus GdkTool_VStop (GdkTool tool)
 Called by the framework before data collection stop. More...
 
kStatus GdkTool_VUpdateConfig (const GdkToolEnv *env, GdkToolCfg toolConfig)
 [Deprecated] Use GdkTool_VUpdateConfigInstanced() instead. More...
 
kStatus GdkTool_VUpdateConfigInstanced (GdkTool tool, GdkToolCfg toolConfig)
 Update the tool instance's configuration due to configuration file changes. More...
 

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