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

Interface SetDatumTag

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

Description

Method Summary
`void`	`AddReferences (AnnotationReferences References)` Add DFS semantic references
`void`	`Delete ()` `LICENSE: 222` Delete a new datum feature symbol annotation.
`void`	`DeleteReference (int Index)` Delete DFS semantic reference
`void`	`EraseFromDrawingView (Drawing Drawing, View2D View)` Sets an set datum tag to be erased from drawing view. This changes the drawing database to not show the annotation until it is explicitly shown again.
`/optional/ SetDatumTagAdditionalText`	`GetAdditionalText ()` `LICENSE: 222` Gets Additional text and Position to datum feature symbol annotation.
`Point3D`	`GetAdditionalTextLocation ( /optional/ Drawing Drawing, /optional/ View2D View)` `LICENSE: 222` Gets Additional text point of datum feature symbol.
`AnnotationPlane`	`GetAnnotationPlane ()` `LICENSE: 222` Obtains the annotation plane for a set datum tag.
`boolean`	`GetASMEDisplay ()` `LICENSE: 222` Outputs whether a specified datum feature symbol annotation ASME is set.
`Selection`	`GetAttachment ()` `LICENSE: 222` Obtains the item to which the set datum tag is attached.
`/optional/ SetDatumTagDimGTolDisplay`	`GetDimGTolDisplay ()` `LICENSE: 222` Returns display type for DFS attached to dimension or gtol.
`boolean`	`GetElbow ()` `LICENSE: 222` Outputs whether a specified datum feature symbol annotation Elbow is set.
`String`	`GetLabel ()` `LICENSE: 222` Get label of datum feature symbol annotation
`ModelItem`	`GetPlacement ()` `LICENSE: 222` Obtains the item (type,id,owner only) to which the set datum tag is attached (dimension, gtol, or geometry). This function is useful in cases where it is not possible to construct the selection. For example , Solid owned DFS attached to solid owned dimension created in drawing.
`AnnotationReferences`	`GetReferences ()` Get DFS semantic references
`Point3D`	`GetTextLocation ( /optional/ Drawing Drawing, /optional/ View2D View)` `LICENSE: 222` Gets text point of datum feature symbol.
`boolean`	`IsShownInDrawingView (Drawing Drawing, View2D View)` `LICENSE: 222` Determines if an Set Datum Tag is shown in a particular view of a drawing.
`void`	`SetAdditionalText (SetDatumTagAdditionalText AddlText)` `LICENSE: 222` Sets Additional text and Position to datum feature symbol annotation.
`void`	`SetAnnotationPlane (AnnotationPlane Plane)` `LICENSE: 222` Assigns the annotation plane for a set datum tag.
`void`	`SetASMEDisplay (boolean ASME)` `LICENSE: 222` Set or unset ASME display of datum feature symbol annotation.
`void`	`SetAttachment (Selection Reference)` `LICENSE: 222` Assigns the item to which the set datum tag is attached.
`void`	`SetElbow (boolean Elbow)` `LICENSE: 222` Sets or unset Elbow to datum feature symbol annotation.
`void`	`SetLabel (String Label)` `LICENSE: 222` Sets label to datum feature symbol annotation
`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

GetAttachment

Selection GetAttachment ()

LICENSE: 222

Obtains the item to which the set datum tag is attached.

Exceptions thrown (but not limited to):

XToolkitNotFound - The set datum tag attachment is to the datum itself.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: The attachment.

SetAttachment

void SetAttachment (Selection Reference)

LICENSE: 222

Assigns the item to which the set datum tag is attached.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Reference: The attachment.

Returns:

SetAnnotationPlane

void SetAnnotationPlane (AnnotationPlane Plane)

LICENSE: 222

Assigns the annotation plane for a set datum tag.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Plane: The annotation plane.

Returns:

GetAnnotationPlane

AnnotationPlane GetAnnotationPlane ()

LICENSE: 222

Obtains the annotation plane for a set datum tag.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: The annotation plane.

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: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:

SetLabel

void SetLabel (String Label)

LICENSE: 222

Sets label to datum feature symbol annotation

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Label: Label of datum feature symbol

Returns:

GetLabel

String GetLabel ()

LICENSE: 222

Get label of datum feature symbol annotation

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: Label of datum feature symbol

SetASMEDisplay

void SetASMEDisplay (boolean ASME)

LICENSE: 222

Set or unset ASME display of datum feature symbol annotation.

Exceptions thrown (but not limited to):

XToolkitCantModify - Datum feature symbol annotation can't be modified.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

ASME: Pass True to set ASME display otherwise False

Returns:

GetASMEDisplay

boolean GetASMEDisplay ()

LICENSE: 222

Outputs whether a specified datum feature symbol annotation ASME is set.

Exceptions thrown (but not limited to):

XToolkitCantAccess - Datum feature symbol annotation can't be accessed.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: True if symbol has ASME display otherwise False

SetElbow

void SetElbow (boolean Elbow)

LICENSE: 222

Sets or unset Elbow to datum feature symbol annotation.

Exceptions thrown (but not limited to):

XToolkitCantModify - Datum feature symbol annotation can't be modified.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Elbow: Leader - Pass True to set Elbow display otherwise False

Returns:

GetElbow

boolean GetElbow ()

LICENSE: 222

Outputs whether a specified datum feature symbol annotation Elbow is set.

Exceptions thrown (but not limited to):

XToolkitCantAccess - Datum feature symbol annotation can't be accessed.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: True if dfs has Elbow display otherwise False

GetPlacement

ModelItem GetPlacement ()

LICENSE: 222

Obtains the item (type,id,owner only) to which the set datum tag is attached (dimension, gtol, or geometry). This function is useful in cases where it is not possible to construct the selection. For example , Solid owned DFS attached to solid owned dimension created in drawing.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: The attachment item.

GetAdditionalText

/*optional*/ SetDatumTagAdditionalText GetAdditionalText ()

LICENSE: 222

Gets Additional text and Position to datum feature symbol annotation.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: Label and position where the Additional text Appears.

SetAdditionalText

void SetAdditionalText (SetDatumTagAdditionalText AddlText)

LICENSE: 222

Sets Additional text and Position to datum feature symbol annotation.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

AddlText: Label and position where the Additional text Appears.

Returns:

GetAdditionalTextLocation

Point3D GetAdditionalTextLocation ( /*optional*/ Drawing Drawing, /*optional*/ View2D View)

LICENSE: 222

Gets Additional text point of datum feature symbol.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Drawing: Pass drawing for dfs owned by solid and shown in drawing. Pass NULL otherwise.
View: Pass view if drw is not NULL. Pass NULL otherwise.

Returns:: Additional text point

GetTextLocation

Point3D GetTextLocation ( /*optional*/ Drawing Drawing, /*optional*/ View2D View)

LICENSE: 222

Gets text point of datum feature symbol.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Drawing: Pass drawing for dfs owned by solid and shown in drawing. Pass NULL otherwise.
View: View in which DFS is shown if drawing is not NULL.

Returns:: Text point

IsShownInDrawingView

boolean IsShownInDrawingView (Drawing Drawing, View2D View)

LICENSE: 222

Determines if an Set Datum Tag is shown in a particular view of a drawing.

Exceptions thrown (but not limited to):

XToolkitBadContext - DFS cannot be shown in specified drawing view.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Drawing: The drawing that shows the annotation.
View: Drawing view.

Returns:: True if the set datum tag is shown, False if it is not shown in the target view.

EraseFromDrawingView

void EraseFromDrawingView (Drawing Drawing, View2D View)

Sets an set datum tag to be erased from drawing view. This changes the drawing database to not show the annotation until it is explicitly shown again.

Exceptions thrown (but not limited to):

XToolkitBadContext - DFS cannot be shown in specified drawing view.

XToolkitNoChange - The annotation is not shown in the target drawing view.

XToolkitAmbiguous - DFS is place on a serface in solid but the view of the DFS is not passed.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Drawing: The drawing where dfs needs to be shown.
View: Drawing view.

Returns:

GetDimGTolDisplay

/*optional*/ SetDatumTagDimGTolDisplay GetDimGTolDisplay ()

LICENSE: 222

Returns display type for DFS attached to dimension or gtol.

Exceptions thrown (but not limited to):

XToolkitInvalidType - DFS is not attached to dimension or gtol.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: Display type

Delete

void Delete ()

LICENSE: 222

Delete a new datum feature symbol annotation.

Exceptions thrown (but not limited to):

XToolkitCantModify - Cannot delete set datum tag.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:

AddReferences

void AddReferences (AnnotationReferences References)

Add DFS semantic references

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

References: Array of DFS references

Returns:

GetReferences

AnnotationReferences GetReferences ()

Get DFS semantic references

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: Array of DFS references

DeleteReference

void DeleteReference (int Index)

Delete DFS semantic reference

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Index: Index number to delete

Returns: