CIP C++ documentation for class "wfcSurfaceFinish"

Class wfcSurfaceFinish

# include <wfcAnnotation.h> class wfcSurfaceFinish : public virtual wfcAnnotation { xaideclare(wfcSurfaceFinish) ... };

Description

Method Summary


`void`	`Delete ()`


`wfcAnnotationPlane_ptr`	`GetAnnotationPlane ()`
	LICENSE: 222

`pfcSelections_ptr`	`GetReferences ()`
	LICENSE: 222 Retrieve the surfaces referenced by a surface finish annotation.

`wfcSurfaceCollection_ptr`	`GetSurfaceCollection ()`
	LICENSE: 222

`pfcDetailSymbolInstInstructions_ptr`	`GetSymbolInstructions (pfcDimDisplayMode DisplayMode)`
	LICENSE: 222 Retrieve the symbol instructions from a surface finish.

`xreal`	`GetValue ()`
	Retrieve the value of a surface finish annotation. If getting the value of a surface finish based on a symbol, this gets the value of the variable text "roughness_height". Retrieve other values using wfcSurfaceFinish::GetSymbolInstructions.

`void`	`Modify (pfcDetailSymbolInstInstructions_ptr SymbolInstructions, optional wfcAnnotationPlane_ptr AnnotPlane)`
	LICENSE: 222 Modify a surface finish.

`void`	`SetSurfaceCollection (wfcSurfaceCollection_ptr Collection)`
	LICENSE: 222

`void`	`SetValue (xreal Value)`
	Set the value of a surface finish annotation. If setting the value of a surface finish based on a symbol, this sets the value of the variable text "roughness_height". Modify other values using wfcSurfaceFinish::Modify().

`void`	`Show ()`

Methods Inherited from Class wfcLayerItem:: IsLayerItemVisible, RemoveNoUpdate, GetLayers, AddNoUpdate

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Methods Inherited from Class wfcAnnotation:: ShowInDrawing, Display, DisplayInDrawing, Undisplay, UndisplayInDrawing, IsShown, Update, GetTextStyle, SetTextStyle, GetTextStyleInDrawing, SetTextStyleInDrawing, UpdateAttachment, UpdatePosition, IsAssociative, GetAttachmentAssociativity, GetAnnotationElement, IsInactive, Rotate

Method Detail

void SetValue (xreal Value)

Set the value of a surface finish annotation. If setting the value of a surface finish based on a symbol, this sets the value of the variable text "roughness_height". Modify other values using wfcSurfaceFinish::Modify().

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish Annotations, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

Value: The value of the surface finish.

Returns:

xreal GetValue ()

Retrieve the value of a surface finish annotation. If getting the value of a surface finish based on a symbol, this gets the value of the variable text "roughness_height". Retrieve other values using wfcSurfaceFinish::GetSymbolInstructions.