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

Description

Represents a ...

+ Inheritance diagram for GoProfileArea:

Public Member Functions

GoMeasurement GoProfileArea_AreaMeasurement (GoProfileArea tool)
 Returns a GoProfileArea Area measurement object. More...
 
GoProfileBaseline GoProfileArea_Baseline (GoProfileArea tool)
 Gets the profile area baseline. More...
 
kBool GoProfileArea_BaselineUsed (GoProfileArea tool)
 Returns a boolean representing whether the profile area baseline is used. More...
 
GoMeasurement GoProfileArea_CentroidXMeasurement (GoProfileArea tool)
 Returns a GoProfileArea CentroidX measurement object. More...
 
GoMeasurement GoProfileArea_CentroidZMeasurement (GoProfileArea tool)
 Returns a GoProfileArea CentroidZ measurement object. More...
 
GoProfileLineRegion GoProfileArea_LineRegion (GoProfileArea tool)
 Gets the reference profile line. More...
 
GoProfileRegion GoProfileArea_Region (GoProfileArea tool)
 Gets the profile region. More...
 
kStatus GoProfileArea_SetBaseline (GoProfileArea tool, GoProfileBaseline type)
 Sets the profile area type. More...
 
kStatus GoProfileArea_SetType (GoProfileArea tool, GoProfileAreaType type)
 Sets the profile area type. More...
 
GoProfileAreaType GoProfileArea_Type (GoProfileArea tool)
 Gets the profile area type. More...
 
kBool GoProfileArea_TypeUsed (GoProfileArea tool)
 Gets the boolean representing whether the area type is used. 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 GoProfileArea_AreaMeasurement ( GoProfileArea  tool)

Returns a GoProfileArea Area measurement object.

Parameters
toolGoProfileArea object.
Returns
A GoProfileArea Area measurement.
GoProfileBaseline GoProfileArea_Baseline ( GoProfileArea  tool)

Gets the profile area baseline.

Parameters
toolGoProfileArea object.
Returns
The profile area baseline.
kBool GoProfileArea_BaselineUsed ( GoProfileArea  tool)

Returns a boolean representing whether the profile area baseline is used.

Parameters
toolGoProfileArea object.
Returns
kTRUE if the baseline is used; kFALSE otherwise.
GoMeasurement GoProfileArea_CentroidXMeasurement ( GoProfileArea  tool)

Returns a GoProfileArea CentroidX measurement object.

Parameters
toolGoProfileArea object.
Returns
A GoProfileArea CentroidX measurement.
GoMeasurement GoProfileArea_CentroidZMeasurement ( GoProfileArea  tool)

Returns a GoProfileArea CentroidZ measurement object.

Parameters
toolGoProfileArea object.
Returns
A GoProfileArea CentroidZ measurement.
GoProfileLineRegion GoProfileArea_LineRegion ( GoProfileArea  tool)

Gets the reference profile line.

Parameters
toolGoProfileArea object.
Returns
The reference profile line.
GoProfileRegion GoProfileArea_Region ( GoProfileArea  tool)

Gets the profile region.

Parameters
toolGoProfileArea object.
Returns
The profile region.
kStatus GoProfileArea_SetBaseline ( GoProfileArea  tool,
GoProfileBaseline  type 
)

Sets the profile area type.

Parameters
toolGoProfileArea object.
typeThe baseline type to set.
Returns
Operation status.
kStatus GoProfileArea_SetType ( GoProfileArea  tool,
GoProfileAreaType  type 
)

Sets the profile area type.

Parameters
toolGoProfileArea object.
typeGoProfileAreaType object.
Returns
Operation status.
GoProfileAreaType GoProfileArea_Type ( GoProfileArea  tool)

Gets the profile area type.

Parameters
toolGoProfileArea object.
Returns
The profile area type.
kBool GoProfileArea_TypeUsed ( GoProfileArea  tool)

Gets the boolean representing whether the area type is used.

Parameters
toolGoProfileArea object.
Returns
kTRUE if profile area type is used; kFALSE otherwise.
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: