Description

Represents a base profile tool.

Inheritance diagram for GoProfileTool:

Public Member Functions
kStatus	GoProfileTool_SetSource (GoProfileTool tool, GoDataSource source)
	Sets the data source. More...

kStatus	GoProfileTool_SetXAnchor (GoProfileTool tool, k32s id)
	Sets the X-anchoring source. More...

kStatus	GoProfileTool_SetZAnchor (GoProfileTool tool, k32s id)
	Sets the Z-anchoring source. More...

GoDataSource	GoProfileTool_Source (GoProfileTool tool)
	Gets the data source. More...

GoDataSource	GoProfileTool_SourceOptionAt (GoProfileTool tool, kSize index)
	Gets the data source option at the given index. More...

kSize	GoProfileTool_SourceOptionCount (GoProfileTool tool)
	Gets the data source option list count. More...

k32s	GoProfileTool_XAnchor (GoProfileTool tool)
	Gets the current X-anchoring source. More...

kBool	GoProfileTool_XAnchorEnabled (GoProfileTool tool)
	Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring. More...

k32u	GoProfileTool_XAnchorOptionAt (GoProfileTool tool, kSize index)
	Gets the X-anchoring option at the given index. More...

kSize	GoProfileTool_XAnchorOptionCount (GoProfileTool tool)
	Gets the X-anchoring option list count. More...

k32s	GoProfileTool_ZAnchor (GoProfileTool tool)
	Gets the current Z-anchoring source. More...

kBool	GoProfileTool_ZAnchorEnabled (GoProfileTool tool)
	Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring. More...

k32u	GoProfileTool_ZAnchorOptionAt (GoProfileTool tool, kSize index)
	Gets the Z-anchoring option at the given index. More...

kSize	GoProfileTool_ZAnchorOptionCount (GoProfileTool tool)
	Gets the Z-anchoring option list count. More...

GoMeasurement	GoTool_FindMeasurementByType (GoTool tool, GoMeasurementType type)
	Retrieves the first found instance of a measurement for a given enumeration 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...

GoToolType	GoTool_Type (GoTool tool)
	Retrieves the tool type enumeration value of the tool. More...

Member Function Documentation

kStatus GoProfileTool_SetSource	(	GoProfileTool	tool,
		GoDataSource	source
	)

Sets the data source.

Parameters

tool	GoProfileTool object.
source	GoDataSource object.

Returns: Operation status.

kStatus GoProfileTool_SetXAnchor	(	GoProfileTool	tool,
		k32s	id
	)

Sets the X-anchoring source.

Parameters

tool	GoProfileTool object.
id	The measurement ID of a valid X-anchoring source.

Returns: Operation status.

kStatus GoProfileTool_SetZAnchor	(	GoProfileTool	tool,
		k32s	id
	)

Sets the Z-anchoring source.

Parameters

tool	GoProfileTool object.
id	The measurement ID of a valid Z-anchoring source.

Returns: Operation status.

GoDataSource GoProfileTool_Source ( GoProfileTool tool )

Gets the data source.

Parameters

tool	GoProfileTool object.

Returns: The current profile tool data source.

GoDataSource GoProfileTool_SourceOptionAt	(	GoProfileTool	tool,
		kSize	index
	)

Gets the data source option at the given index.

Parameters

tool	GoProfileTool object.
index	The index of the option list to access.

Returns: The profile tool data source option at the given index, or k32U_MAX if an invalid index is given.

kSize GoProfileTool_SourceOptionCount ( GoProfileTool tool )

Gets the data source option list count.

Parameters

tool	GoProfileTool object.

Returns: The current profile tool data source option list count.

k32s GoProfileTool_XAnchor ( GoProfileTool tool )

Gets the current X-anchoring source.

Parameters

tool	GoProfileTool object.

Returns: The X-anchoring source or -1 if no source is currently set.

kBool GoProfileTool_XAnchorEnabled ( GoProfileTool tool )

Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring.

Parameters

tool	GoProfileTool object.

Returns: kTRUE if a valid anchoring source is currently set and kFALSE otherwise.

k32u GoProfileTool_XAnchorOptionAt	(	GoProfileTool	tool,
		kSize	index
	)

Gets the X-anchoring option at the given index.

Parameters

tool	GoProfileTool object.
index	The index of the option list to access.

Returns: The X-anchoring option at the given index or k32U_MAX if invalid.

kSize GoProfileTool_XAnchorOptionCount ( GoProfileTool tool )

Gets the X-anchoring option list count.

Parameters

tool	GoProfileTool object.

Returns: The X-anchoring option list count.

k32s GoProfileTool_ZAnchor ( GoProfileTool tool )

Gets the current Z-anchoring source.

Parameters

tool	GoProfileTool object.

Returns: The Z-anchoring source or -1 if no source is currently set.

kBool GoProfileTool_ZAnchorEnabled ( GoProfileTool tool )

Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring.

Parameters

tool	GoProfileTool object.

Returns: kTRUE if a valid anchoring source is currently set and kFALSE otherwise.

k32u GoProfileTool_ZAnchorOptionAt	(	GoProfileTool	tool,
		kSize	index
	)

Gets the Z-anchoring option at the given index.

Parameters

tool	GoProfileTool object.
index	The index of the option list to access.

Returns: The Z-anchoring option at the given index or k32U_MAX if invalid.

kSize GoProfileTool_ZAnchorOptionCount ( GoProfileTool tool )

Gets the Z-anchoring option list count.

Parameters

tool	GoProfileTool object.

Returns: The X-anchoring option list count.

GoMeasurement GoTool_FindMeasurementByType	(	GoTool	tool,
		GoMeasurementType	type
	)

inherited

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

Parameters

tool	GoTool object.
type	A 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

tool	GoTool object.
index	The index of the measurement.

Returns: The measurement at the given index or kNULL if an invalid index is provided.

kSize GoTool_MeasurementCount ( GoTool tool )

inherited

Returns the measurement count.

Parameters

tool	GoTool object.

Returns: The measurement count.

kStatus GoTool_Name	(	GoTool	tool,
		kChar *	name,
		kSize	capacity
	)

inherited

Retrieves the name of the tool.

Parameters

tool	GoTool object.
name	Receives the name of the tool.
capacity	The 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

tool	GoTool object.
name	The name to be set for the tool.

Returns: Operation status.

GoToolType GoTool_Type ( GoTool tool )

inherited

Retrieves the tool type enumeration value of the tool.

Parameters

tool	GoTool object.

Returns: The tool type enumeration value.

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

Tools/GoProfileTools.h

Description

Public Member Functions

Member Function Documentation