Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoTools Class Reference

Description

Represents a collection of tools.

Inheritance diagram for GoTools:
Inheritance graph

Public Member Functions

const GoFeatureOption * GoToolOption_FeatureOptionAt (GoToolOption option, kSize index)
 Retrieves the feature option at the given index of the tool option. More...
 
kSize GoToolOption_FeatureOptionCount (GoToolOption option)
 Returns the number of feature options available for the given tool option. More...
 
const GoMeasurementOption * GoToolOption_MeasurementOptionAt (GoToolOption option, kSize index)
 Retrieves the measurement option at the given index of the tool option. More...
 
kSize GoToolOption_MeasurementOptionCount (GoToolOption option)
 Returns the number of measurement options available for the given tool option. More...
 
const kCharGoToolOption_Name (GoToolOption option)
 Returns the name associated with the given tool option. More...
 
const GoToolDataOutputOption * GoToolOption_ToolDataOutputOptionAt (GoToolOption option, kSize index)
 Retrieves the tool data output option at the given index of the tool option. More...
 
kSize GoToolOption_ToolDataOutputOptionCount (GoToolOption option)
 Returns the number of tool data output options available for the given tool option. More...
 
kStatus GoTools_AddMeasurementByName (GoTools tools, GoTool tool, const kChar *type, const kChar *name, GoMeasurement *measurement)
 Adds a measurement to a tool via a string representing the type. More...
 
kStatus GoTools_AddTool (GoTools tools, GoToolType type, GoTool *tool)
 [Deprecated] Use GoTools_AddToolByName() instead. More...
 
kStatus GoTools_AddToolByName (GoTools tools, const kChar *optionName, GoTool *tool)
 Adds a tool by name. More...
 
kStatus GoTools_AssignMeasurementId (GoTools tools, GoMeasurement measurement)
 Automatically update a given measurement to use a valid ID within the set of tools contained in the GoTools object. More...
 
kStatus GoTools_ClearTools (GoTools tools)
 Removes all tools in the given GoTools instance. More...
 
GoMeasurement GoTools_FindMeasurementById (GoTools tools, k32u id)
 Returns an enabled measurement handle if the specified ID is valid. More...
 
kStatus GoTools_MoveTool (GoTools tools, kSize index, kSize newIndex)
 Moves a tool to another position in the array. More...
 
kStatus GoTools_RemoveTool (GoTools tools, kSize index)
 Removes a tool at the given index. More...
 
GoTool GoTools_ToolAt (GoTools tools, kSize index)
 Returns a tool handle at the given index. More...
 
kSize GoTools_ToolCount (GoTools tools)
 Returns the current number of tools. More...
 
GoToolOption GoTools_ToolOptionAt (GoTools tools, kSize index)
 Retrieves the tool option at the given index. More...
 
kSize GoTools_ToolOptionCount (GoTools tools)
 Returns the number of tool options available for the current configuration. More...
 

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