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, AddActionListenerWithType

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, ConvertLegacy, NeedsConversion, GetSecurityMarking, SetSecurityMarking, IsUsingXSecReference

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().

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

pfcXToolkitBadContext - The surface finish does not have a value named 'roughness_height' (for symbol based surface finishes).

pfcXToolkitInvalidType - The surface finish roughness height is not a numeric value.

pfcXToolkitCantWrite - Could not modify the given item because it has read-only access.

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish 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.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

pfcXToolkitBadContext - The surface finish does not have a value named 'roughness_height' (for symbol based surface finishes).

pfcXToolkitInvalidType - The surface finish roughness height is not a numeric value.

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish Annotations

Returns:: The value of the surface finish.

wfcSurfaceCollection_ptr GetSurfaceCollection ()

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The surface finish is not in an annotation element and cannot use a surface collection reference.

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish Annotations

Returns:

pfcSelections_ptr GetReferences ()

LICENSE: 222

Retrieve the surfaces referenced by a surface finish annotation.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish Annotations

Returns:: Array of surfaces referenced by the surface finish.

void SetSurfaceCollection (wfcSurfaceCollection_ptr Collection)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The surface finish is not in an annotation element and cannot use a surface collection reference.

pfcXToolkitNoLicense - License check failure.

pfcXToolkitCantWrite - Could not modify the given item because it has read-only access.

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish Annotations

Parameters:

Collection

Returns:

wfcAnnotationPlane_ptr GetAnnotationPlane ()

LICENSE: 222

Returns:

void Modify (pfcDetailSymbolInstInstructions_ptr SymbolInstructions, optional wfcAnnotationPlane_ptr AnnotPlane)

LICENSE: 222

Modify a surface finish.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Invalid type of leader or attachment for creation of a surface finish.

pfcXToolkitFound - Leader or attachment to surface which already has a surface finish other than the one being modified.

pfcXToolkitBadContext - The surface finish is not based on a symbol (and cannot be modified using symbol data).

pfcXToolkitNoLicense - License check failure

pfcXToolkitCantWrite - Could not modify the given item because it has read-only access.

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish Annotations

Parameters:

SymbolInstructions: The symbol instructions that govern the surface finish.
AnnotPlane

Returns:

pfcDetailSymbolInstInstructions_ptr GetSymbolInstructions (pfcDimDisplayMode DisplayMode)

LICENSE: 222

Retrieve the symbol instructions from a surface finish.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The surface finish is not based on a symbol (and cannot be represented using symbol data).

pfcXToolkitNoLicense - License check failure

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish Annotations

Parameters:

DisplayMode

The display mode for the symbol retrieval.

pfcDISPMODE_NUMERIC - callouts will be represented by their values.

pfcDISPMODE_SYMBOLIC - callouts will contain the names of the referenced parameters.

Returns:: The symbol instructions that govern the surface finish.

void Delete ()

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

pfcXToolkitCantWrite - Could not delete the given item because it has read-only access.

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish Annotations

Returns:

void Show ()

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The annotation is already shown in the target model.

pfcXToolkitInvalidMatrix - The annotation cannot be shown due to orientation conflicts in the view.

pfcXToolkitNoLicense - License check failure.

pfcXToolkitNotDisplayed - Annotation is present on hidden or blank layer and so can't be shown.

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations, Annotations: Annotation Features and Annotations: Surface Finish Annotations

Returns: