CIP C++ documentation for class "wfcSetDatumTag"

Class wfcSetDatumTag

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

Description

Method Summary


`void`	`AddReferences (wfcAnnotationReferences_ptr References)`
	Add DFS semantic references

`void`	`Delete ()`
	LICENSE: 222 Delete a new datum feature symbol annotation.

`void`	`DeleteReference (xint Index)`
	Delete DFS semantic reference

`void`	`EraseFromDrawingView (pfcDrawing_ptr Drawing, pfcView2D_ptr 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 wfcSetDatumTagAdditionalText_ptr`	`GetAdditionalText ()`
	LICENSE: 222 Gets Additional text and Position to datum feature symbol annotation.

`pfcPoint3D_ptr`	`GetAdditionalTextLocation (optional pfcDrawing_ptr Drawing, optional pfcView2D_ptr View)`
	LICENSE: 222 Gets Additional text point of datum feature symbol.

`wfcAnnotationPlane_ptr`	`GetAnnotationPlane ()`
	LICENSE: 222 Obtains the annotation plane for a set datum tag.

`xbool`	`GetASMEDisplay ()`
	LICENSE: 222 Outputs whether a specified datum feature symbol annotation ASME is set.

`pfcSelection_ptr`	`GetAttachment ()`
	LICENSE: 222 Obtains the item to which the set datum tag is attached.

`optional wfcSetDatumTagDimGTolDisplay`	`GetDimGTolDisplay ()`
	LICENSE: 222 Returns display type for DFS attached to dimension or gtol.

`xbool`	`GetElbow ()`
	LICENSE: 222 Outputs whether a specified datum feature symbol annotation Elbow is set.

`xstring`	`GetLabel ()`
	LICENSE: 222 Get label of datum feature symbol annotation

`pfcModelItem_ptr`	`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.

`wfcAnnotationReferences_ptr`	`GetReferences ()`
	Get DFS semantic references

`pfcPoint3D_ptr`	`GetTextLocation (optional pfcDrawing_ptr Drawing, optional pfcView2D_ptr View)`
	LICENSE: 222 Gets text point of datum feature symbol.

`xbool`	`IsShownInDrawingView (pfcDrawing_ptr Drawing, pfcView2D_ptr View)`
	LICENSE: 222 Determines if an Set Datum Tag is shown in a particular view of a drawing.

`void`	`SetAdditionalText (wfcSetDatumTagAdditionalText_ptr AddlText)`
	LICENSE: 222 Sets Additional text and Position to datum feature symbol annotation.

`void`	`SetAnnotationPlane (wfcAnnotationPlane_ptr Plane)`
	LICENSE: 222 Assigns the annotation plane for a set datum tag.

`void`	`SetASMEDisplay (xbool ASME)`
	LICENSE: 222 Set or unset ASME display of datum feature symbol annotation.

`void`	`SetAttachment (pfcSelection_ptr Reference)`
	LICENSE: 222 Assigns the item to which the set datum tag is attached.

`void`	`SetElbow (xbool Elbow)`
	LICENSE: 222 Sets or unset Elbow to datum feature symbol annotation.

`void`	`SetLabel (xrstring Label)`
	LICENSE: 222 Sets label to datum feature symbol annotation

`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

pfcSelection_ptr GetAttachment ()

LICENSE: 222

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

Exceptions thrown (but not limited to):

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

void SetAttachment (pfcSelection_ptr 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:

void SetAnnotationPlane (wfcAnnotationPlane_ptr 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:

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

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

Returns:

void SetLabel (xrstring 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:

xstring 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

void SetASMEDisplay (xbool ASME)

LICENSE: 222

Set or unset ASME display of datum feature symbol annotation.

Exceptions thrown (but not limited to):

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

xbool GetASMEDisplay ()

LICENSE: 222

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

Exceptions thrown (but not limited to):

pfcXToolkitCantAccess - 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

void SetElbow (xbool Elbow)

LICENSE: 222

Sets or unset Elbow to datum feature symbol annotation.

Exceptions thrown (but not limited to):

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

xbool GetElbow ()

LICENSE: 222

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

Exceptions thrown (but not limited to):

pfcXToolkitCantAccess - 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

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

optional wfcSetDatumTagAdditionalText_ptr 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.

void SetAdditionalText (wfcSetDatumTagAdditionalText_ptr 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:

pfcPoint3D_ptr GetAdditionalTextLocation (optional pfcDrawing_ptr Drawing, optional pfcView2D_ptr 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

pfcPoint3D_ptr GetTextLocation (optional pfcDrawing_ptr Drawing, optional pfcView2D_ptr 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

xbool IsShownInDrawingView (pfcDrawing_ptr Drawing, pfcView2D_ptr View)

LICENSE: 222

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

Exceptions thrown (but not limited to):

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

void EraseFromDrawingView (pfcDrawing_ptr Drawing, pfcView2D_ptr 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):

pfcXToolkitBadContext - DFS cannot be shown in specified drawing view.

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

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