Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoProfilePanel Class Reference

Description

Represents a ...

+ Inheritance diagram for GoProfilePanel:

Public Member Functions

GoMeasurement GoProfilePanel_FlushMeasurement (GoProfilePanel tool)
 Returns a GoProfilePanel Flush measurement object. More...
 
GoMeasurement GoProfilePanel_GapMeasurement (GoProfilePanel tool)
 Returns a GoProfilePanel Gap measurement object. More...
 
GoProfileEdge GoProfilePanel_LeftEdge (GoProfilePanel tool)
 Gets the left profile edge. More...
 
k64f GoProfilePanel_MaxGapWidth (GoProfilePanel tool)
 Gets the maximum gap width. More...
 
GoProfilePanelSide GoProfilePanel_RefEdgeSide (GoProfilePanel tool)
 Gets the reference edge side. More...
 
GoProfileEdge GoProfilePanel_RightEdge (GoProfilePanel tool)
 Gets the right profile edge. More...
 
kStatus GoProfilePanel_SetMaxGapWidth (GoProfilePanel tool, k64f width)
 Sets the maximum gap width. More...
 
kStatus GoProfilePanel_SetRefEdgeSide (GoProfilePanel tool, GoProfilePanelSide side)
 Sets the reference edge side. More...
 
kStatus GoProfileTool_SetSource (GoProfileTool tool, GoDataSource source)
 Sets the profile data source. More...
 
GoDataSource GoProfileTool_Source (GoProfileTool tool)
 Gets the profile data source. More...
 
GoMeasurement GoTool_FindMeasurementByType (GoTool tool, GoMeasurementType type)
 Retrieves the first found instance of a measurement for a given type. More...
 
GoMeasurement GoTool_MeasurementAt (GoTool tool, kSize index)
 Retrieves the measurement at the given index. More...
 
kSize GoTool_MeasurementCount (GoTool tool)
 Returns the measurement count. More...
 
kStatus GoTool_Name (GoTool tool, kChar *name, kSize capacity)
 Retrieves the name of the tool. More...
 
kStatus GoTool_SetName (GoTool tool, const kChar *name)
 Sets the name of the tool. More...
 

Member Function Documentation

GoMeasurement GoProfilePanel_FlushMeasurement ( GoProfilePanel  tool)

Returns a GoProfilePanel Flush measurement object.

Parameters
toolGoProfilePanel object.
Returns
A GoProfilePanel Flush measurement.
GoMeasurement GoProfilePanel_GapMeasurement ( GoProfilePanel  tool)

Returns a GoProfilePanel Gap measurement object.

Parameters
toolGoProfilePanel object.
Returns
A GoProfilePanel Gap measurement.
GoProfileEdge GoProfilePanel_LeftEdge ( GoProfilePanel  tool)

Gets the left profile edge.

Parameters
toolGoProfilePanel object.
Returns
The left profile edge.
k64f GoProfilePanel_MaxGapWidth ( GoProfilePanel  tool)

Gets the maximum gap width.

Parameters
toolGoProfilePanel object.
Returns
The maximum gap width.
GoProfilePanelSide GoProfilePanel_RefEdgeSide ( GoProfilePanel  tool)

Gets the reference edge side.

Parameters
toolGoProfilePanel object.
Returns
The reference edge side.
GoProfileEdge GoProfilePanel_RightEdge ( GoProfilePanel  tool)

Gets the right profile edge.

Parameters
toolGoProfilePanel object.
Returns
The right profile edge.
kStatus GoProfilePanel_SetMaxGapWidth ( GoProfilePanel  tool,
k64f  width 
)

Sets the maximum gap width.

Parameters
toolGoProfilePanel object.
widthThe maximum gap width value to set.
Returns
Operation status.
kStatus GoProfilePanel_SetRefEdgeSide ( GoProfilePanel  tool,
GoProfilePanelSide  side 
)

Sets the reference edge side.

Parameters
toolGoProfilePanel object.
sideThe reference edge side.
Returns
Operation status.
kStatus GoProfileTool_SetSource ( GoProfileTool  tool,
GoDataSource  source 
)
inherited

Sets the profile data source.

Parameters
toolGoProfileTool object.
sourceGoDataSource object.
Returns
Operation status.
GoDataSource GoProfileTool_Source ( GoProfileTool  tool)
inherited

Gets the profile data source.

Parameters
toolGoProfileTool object.
Returns
The profile data source.
GoMeasurement GoTool_FindMeasurementByType ( GoTool  tool,
GoMeasurementType  type 
)
inherited

Retrieves the first found instance of a measurement for a given type.

Parameters
toolGoTool object.
typeA GoMeasurementType representing the measurement type to find in the given tool.
Returns
A measurement object if one is found, otherwise kNULL.
GoMeasurement GoTool_MeasurementAt ( GoTool  tool,
kSize  index 
)
inherited

Retrieves the measurement at the given index.

Parameters
toolGoTool object.
indexThe index of the measurement.
Returns
The measurement.
kSize GoTool_MeasurementCount ( GoTool  tool)
inherited

Returns the measurement count.

Parameters
toolGoTool object.
Returns
The measurement count.
kStatus GoTool_Name ( GoTool  tool,
kChar *  name,
kSize  capacity 
)
inherited

Retrieves the name of the tool.

Parameters
toolGoTool object.
nameReceives the name of the tool.
capacityThe maximum capacity of the name array.
Returns
Operation status.
kStatus GoTool_SetName ( GoTool  tool,
const kChar *  name 
)
inherited

Sets the name of the tool.

Parameters
toolGoTool object.
nameThe name to be set for the tool.
Returns
Operation status.

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