CIP JAVA documentation for class "com.ptc.wfc.wfcAnnotation.SurfaceFinish"

Interface SurfaceFinish

package com.ptc.wfc.wfcAnnotation; public interface SurfaceFinish extends com.ptc.wfc.wfcAnnotation.Annotation

Description

Method Summary
`void`	`Delete ()`
`AnnotationPlane`	`GetAnnotationPlane ()` `LICENSE: 222`
`Selections`	`GetReferences ()` `LICENSE: 222` Retrieve the surfaces referenced by a surface finish annotation.
`SurfaceCollection`	`GetSurfaceCollection ()` `LICENSE: 222`
`DetailSymbolInstInstructions`	`GetSymbolInstructions (DimDisplayMode DisplayMode)` `LICENSE: 222` Retrieve the symbol instructions from a surface finish.
`double`	`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 (DetailSymbolInstInstructions SymbolInstructions, /optional/ AnnotationPlane AnnotPlane)` `LICENSE: 222` Modify a surface finish.
`void`	`SetSurfaceCollection (SurfaceCollection Collection)` `LICENSE: 222`
`void`	`SetValue (double 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 Interface `com.ptc.wfc.wfcLayerState.LayerItem`
`IsLayerItemVisible`, `RemoveNoUpdate`, `GetLayers`, `AddNoUpdate`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WModelItem`
`DeleteUserDefinedName`, `Unhide`, `Hide`, `IsHidden`, `IsNameReadOnly`, `IsZoneFeature`, `GetDefaultName`

Methods Inherited from Interface `com.ptc.wfc.wfcAnnotation.Annotation`
`ShowInDrawing`, `Display`, `DisplayInDrawing`, `Undisplay`, `UndisplayInDrawing`, `IsShown`, `Update`, `GetTextStyle`, `SetTextStyle`, `GetTextStyleInDrawing`, `SetTextStyleInDrawing`, `UpdateAttachment`, `UpdatePosition`, `IsAssociative`, `GetAttachmentAssociativity`, `GetAnnotationElement`, `IsInactive`, `Rotate`, `ConvertLegacy`, `NeedsConversion`, `GetSecurityMarking`, `SetSecurityMarking`, `IsUsingXSecReference`

Methods Inherited from Interface com.ptc.wfc.wfcAnnotation.Annotation

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

SetValue

void SetValue (double 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):

XToolkitNoLicense - License check failure.

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

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

XToolkitCantWrite - 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:

GetValue

double 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):

XToolkitNoLicense - License check failure.

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

XToolkitInvalidType - 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.

GetSurfaceCollection

SurfaceCollection GetSurfaceCollection ()

LICENSE: 222

Exceptions thrown (but not limited to):

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

XToolkitNoLicense - License check failure.

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

Returns:

GetReferences

Selections GetReferences ()

LICENSE: 222

Retrieve the surfaces referenced by a surface finish annotation.

Exceptions thrown (but not limited to):

XToolkitNoLicense - 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.

SetSurfaceCollection

void SetSurfaceCollection (SurfaceCollection Collection)

LICENSE: 222

Exceptions thrown (but not limited to):

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

XToolkitNoLicense - License check failure.

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

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

Parameters:

Collection

Returns:

GetAnnotationPlane

AnnotationPlane GetAnnotationPlane ()

LICENSE: 222

Returns:

Modify

void Modify (DetailSymbolInstInstructions SymbolInstructions, /*optional*/ AnnotationPlane AnnotPlane)

LICENSE: 222

Modify a surface finish.

Exceptions thrown (but not limited to):

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

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

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

XToolkitNoLicense - License check failure

XToolkitCantWrite - 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:

GetSymbolInstructions

DetailSymbolInstInstructions GetSymbolInstructions (DimDisplayMode DisplayMode)

LICENSE: 222

Retrieve the symbol instructions from a surface finish.

Exceptions thrown (but not limited to):

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

XToolkitNoLicense - 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.

Delete

void Delete ()

Exceptions thrown (but not limited to):

XToolkitNoLicense - License check failure.

XToolkitCantWrite - 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:

Show

void Show ()

Exceptions thrown (but not limited to):

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

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

XToolkitNoLicense - License check failure.

XToolkitNotDisplayed - 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: