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

Description

Represents a profile area tool.

Inheritance diagram for GoProfileArea:
Inheritance graph

Public Member Functions

GoProfileAreaArea 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...
 
GoProfileAreaCenterPoint GoProfileArea_CenterPoint (GoProfileArea tool)
 Returns a GoProfileArea Center point feature object. More...
 
GoProfileAreaCentroidX GoProfileArea_CentroidXMeasurement (GoProfileArea tool)
 Returns a GoProfileArea Centroid X measurement object. More...
 
GoProfileAreaCentroidZ GoProfileArea_CentroidZMeasurement (GoProfileArea tool)
 Returns a GoProfileArea Centroid Z measurement object. More...
 
kStatus GoProfileArea_EnableRegion (GoProfileArea tool, kBool enable)
 Enables or disables the region. More...
 
GoProfileLineRegion GoProfileArea_LineRegion (GoProfileArea tool)
 Gets the reference profile line. More...
 
GoProfileRegion GoProfileArea_Region (GoProfileArea tool)
 Gets the profile region. More...
 
kBool GoProfileArea_RegionEnabled (GoProfileArea tool)
 Indicates whether the region is enabled. 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 data source. More...
 
kStatus GoProfileTool_SetStream (GoProfileTool tool, GoDataStream stream)
 Sets the data stream. 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...
 
GoDataStream GoProfileTool_Stream (GoProfileTool tool)
 Gets the data stream. More...
 
GoDataStream GoProfileTool_StreamOptionAt (GoProfileTool tool, kSize index)
 Gets the data stream option at the given index. More...
 
kSize GoProfileTool_StreamOptionCount (GoProfileTool tool)
 Gets the data stream 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...
 
kStatus GoTool_AddExtMeasurement (GoTool tool, kType type, kBool isFilterable, GoExtMeasurement *measurement)
 [Deprecated] More...
 
kStatus GoTool_AddFeatureOutput (GoTool tool, kType type, GoFeature *featureOutput)
 Adds the given feature output to the tool set. More...
 
kStatus GoTool_AddMeasurement (GoTool tool, kType type, kBool isFilterable, GoMeasurement *measurement)
 Adds the given measurement to the tool set. More...
 
kStatus GoTool_ClearFeatureOutputs (GoTool tool)
 Removes all feature outputs for the given tool. More...
 
kStatus GoTool_ClearMeasurements (GoTool tool)
 Removes all measurements for the given tool. More...
 
GoFeature GoTool_FeatureOutputAt (GoTool tool, kSize index)
 Retrieves the feature output at the given index. More...
 
kSize GoTool_FeatureOutputCount (GoTool tool)
 Returns the feature output count. More...
 
GoFeature GoTool_FindFeatureOutputByType (GoTool tool, GoFeatureType type)
 Retrieves the instance of a feature output for a given enumeration type. More...
 
GoMeasurement GoTool_FindMeasurementByType (GoTool tool, GoMeasurementType type)
 Retrieves the first found instance of a measurement for a given enumeration type. More...
 
k32s GoTool_Id (GoTool tool)
 Retrieves the id of the instance of the tool. 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_RemoveFeatureOutput (GoTool tool, kSize index)
 Removes a feature output at a given index. More...
 
kStatus GoTool_RemoveMeasurement (GoTool tool, kSize index)
 Removes a measurement at a given index. 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...
 

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