Library | FileFrames | Expand

Class wfcWDetailSymbolInstItem

# include <wfcDetail.h>

class wfcWDetailSymbolInstItem
 : public virtual wfcAnnotation,
 : public virtual pfcDetailSymbolInstItem
{
    xaideclare(wfcWDetailSymbolInstItem)
    ...
};

Description

Extends the functionality of pfcDetailSymbolInstItem

This is the actual type of Detail SymbolInst Items in Object Toolkit.
Manual References:
Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes


Method Summary

voidAddLeader (pfcAttachment_ptr LeaderAttach)
 
voidAddVarText (pfcDetailVariantText_ptr Text)
Add variable text to the symbol instance.
wfcAnnotationPlane_ptrGetAnnotationPlane ()
LICENSE: 222
 
optional pfcDimension_ptrGetAttachedDimension ()
Finds the dimension to which the symbol instance is directly attached.
pfcDetailEntityInstructions_ptrGetEntityInstructions (pfcDetailEntityItem_ptr Item)
LICENSE: 222
Gets data of an entity in the symbol instance.
optional pfcFeature_ptrGetFeature ()
Return the feature that is shown the detail symbol instance.
pfcDetailNoteInstructions_ptrGetNoteInstructions (pfcDetailNoteItem_ptr Item, pfcDimDisplayMode DispMode)
LICENSE: 222
Gets data of a note in the symbol instance.
voidSetAnnotationPlane (wfcAnnotationPlane_ptr AnnotPlane)
LICENSE: 222
 

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

Methods Inherited from Class pfcDetailItem:

GetDetailType, Delete

Methods Inherited from Class pfcDetailSymbolInstItem:

Draw, Erase, Show, Remove, GetInstructions, Modify, ListGroups


Method Detail

optional pfcDimension_ptrGetAttachedDimension ()

Finds the dimension to which the symbol instance is directly attached.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The symbol instance is not placed on item to a dimension

pfcXToolkitBadContext - The symbol instance is placed on a dim but we are unable to fill in the output structure on account of the dimension's model being missing (perhaps it was suppressed in the assembly).


Manual References:
Drawings: Symbol Instance Data, Drawings: Symbol Instance Data
Returns:
The dimension to which the symbol instance is directly attached.


voidAddLeader (pfcAttachment_ptr LeaderAttach)

 

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.


Manual References:
Drawings: Symbol Instance Data, Drawings: Symbol Instance Data
Parameters:
LeaderAttach
 
Returns:


voidAddVarText (pfcDetailVariantText_ptr Text)

Add variable text to the symbol instance.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.


Manual References:
Drawings: Symbol Instance Data, Drawings: Symbol Instance Data
Parameters:
Text
The variable text.
Returns:


optional pfcFeature_ptrGetFeature ()

Return the feature that is shown the detail symbol instance.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The symbol instance is not generated from a solid model feature.


Manual References:
Drawings: Cross-referencing Weld Symbols and Drawing Annotations
Returns:
The feature (i.e. weld feature) that produces the symbol.


voidSetAnnotationPlane (wfcAnnotationPlane_ptr AnnotPlane)
LICENSE: 222

 

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - Annotation plane is not appropriate for this data.


Manual References:
Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols
Parameters:
AnnotPlane
 
Returns:


wfcAnnotationPlane_ptrGetAnnotationPlane ()
LICENSE: 222

 

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - Annotation plane is not appropriate for this data.


Manual References:
Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols, Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols
Returns:
 


pfcDetailEntityInstructions_ptrGetEntityInstructions (pfcDetailEntityItem_ptr Item)
LICENSE: 222

Gets data of an entity in the symbol instance.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No symbols were found in the model.


Manual References:
Drawings: Symbol Instance Data
Parameters:
Item
The entity attached to symbol instance.
Returns:
The entity data in symbol instance space.


pfcDetailNoteInstructions_ptrGetNoteInstructions (pfcDetailNoteItem_ptr Item, pfcDimDisplayMode DispMode)
LICENSE: 222

Gets data of a note in the symbol instance.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No symbols were found in the model.


Manual References:
Drawings: Symbol Instance Data, Drawings: Symbol Instance Data
Parameters:
Item
The pfcDetailNoteItem attached to symbol instance.
DispMode
The display mode.
Returns:
The note data in symbol instance space encapsulated in pfcDetailNoteInstructions_ptr.