CIP C++ documentation for class "pfcDetailSymbolDefItem"

Class pfcDetailSymbolDefItem

# include <pfcDetail.h> class pfcDetailSymbolDefItem : public virtual pfcDetailItem { xaideclare(pfcDetailSymbolDefItem) ... };

Description

This interface represents a symbol definition in a Creo Parametric model.

See Also:: pfcDetailItemOwner::GetDetailItem(pfcDetailType, xint), pfcDetailItemOwner::ListDetailItems(optional pfcDetailType, optional xint), pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr), pfcDetailItemOwner::RetrieveSymbolDefinition(xrstring, optional xrstring, optional xint, optional xbool)

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Direct Known Subclasses:: wfcWDetailSymbolDefItem

Method Summary


`pfcDetailItem_ptr`	`CreateDetailItem (pfcDetailCreateInstructions_ptr Instructions)`
	Creates a detail item in the symbol definition.

`pfcDetailNoteItem_ptr`	`CreateFreeNote (pfcDetailTextLines_ptr TextLines, pfcFreeAttachment_ptr Attach)`


`pfcDetailSymbolGroup_ptr`	`CreateSubgroup (pfcDetailSymbolGroupInstructions_ptr Instructions, optional pfcDetailSymbolGroup_ptr ParentGroup)`
	Create a subgroup in the specified symbol group.

`optional pfcDetailItem_ptr`	`GetDetailItem (pfcDetailType Type, xint Id)`
	Returns a detail item in a symbol definition, given its id and type.

`pfcDetailSymbolDefInstructions_ptr`	`GetInstructions ()`
	Returns an instructions data object describing how a symbol definition is constructed.

`xbool`	`IsSubgroupLevelExclusive (optional pfcDetailSymbolGroup_ptr ParentGroup)`
	Determine if the subgroups stored in the symbol definition on the indicated level are exclusive.

`optional pfcDetailItems_ptr`	`ListDetailItems (optional pfcDetailType Type)`
	Lists the detail items in the symbol definition.

`optional pfcDetailSymbolGroups_ptr`	`ListSubgroups ()`
	List the subgroups in the symbol definition.

`void`	`Modify (pfcDetailSymbolDefInstructions_ptr Instructions)`
	Modifies a symbol definition.

`void`	`SetSubgroupLevelExclusive (optional pfcDetailSymbolGroup_ptr ParentGroup)`
	Set the symbol groups exclusive at specified level.

`void`	`SetSubgroupLevelIndependent (optional pfcDetailSymbolGroup_ptr ParentGroup)`
	Set the symbol groups independent at specified level.

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class pfcDetailItem:: GetDetailType, Delete

Method Detail

optional pfcDetailItem_ptr GetDetailItem (pfcDetailType Type, xint Id)

Returns a detail item in a symbol definition, given its id and type.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - This means either:

No entities were found, OR
No notes were found.

pfcXToolkitOutOfMemory - Found too many (either/all of) entities, notes to be contained in the output array. Use Visit instead.

Parameters:

Type: The detail type.
Id: The integer identifier.

Returns:: The detail item, or null, if the item was not found.

optional pfcDetailItems_ptr ListDetailItems (optional pfcDetailType Type)

Lists the detail items in the symbol definition.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - This means either:

No items were found, OR
No entities were found, OR
No groups were found, OR
No notes were found, OR
No symbol definitions were found, OR
No symbol instances were found.

pfcXToolkitOutOfMemory - Found too many (either/all of) entities, groups, notes, symbol definitions, symbol instances to be contained in the output array. Use Visit instead.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

Parameters:

Type: The type of detail items to list.

Returns:: The items found, or null, if no items were found.

pfcDetailItem_ptr CreateDetailItem (pfcDetailCreateInstructions_ptr Instructions)

Creates a detail item in the symbol definition.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

Parameters:

Instructions: The data item instructions. This should be a pfcDetailEntityInstructions or pfcDetailNoteInstructions object.

Returns:: The detail item created in the symbol definition.

pfcDetailNoteItem_ptr CreateFreeNote (pfcDetailTextLines_ptr TextLines, pfcFreeAttachment_ptr Attach)

Parameters:

TextLines
Attach

Returns:

pfcDetailSymbolDefInstructions_ptr GetInstructions ()

Returns an instructions data object describing how a symbol definition is constructed.

Manual References:: Drawings: Detail Symbol Definitions

Returns:: The instructions data object.

void Modify (pfcDetailSymbolDefInstructions_ptr Instructions)

Modifies a symbol definition.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

Parameters:

Instructions: Data object containing modifications to the symbol definition.

Returns:

pfcDetailSymbolGroup_ptr CreateSubgroup (pfcDetailSymbolGroupInstructions_ptr Instructions, optional pfcDetailSymbolGroup_ptr ParentGroup)

Create a subgroup in the specified symbol group.

If no symbol group is specificed, the subgroup is created under the top level symbol group.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidName - A group with the provided name already exists at this level.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Parameters:

Instructions: The characteristics for creating the subgroup.
ParentGroup: The symbol group under which the subgroup is to be made.

Returns:: The symbol group.

optional pfcDetailSymbolGroups_ptr ListSubgroups ()

List the subgroups in the symbol definition.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No groups are stored in the symbol definition at this level.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Returns:: The list of sub symbol groups.

xbool IsSubgroupLevelExclusive (optional pfcDetailSymbolGroup_ptr ParentGroup)

Determine if the subgroups stored in the symbol definition on the indicated level are exclusive.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Parameters:

ParentGroup: The exclusiveness is determined at the level of this symbol group. If not specifed, the top level is assumed.

Returns:: true if the subgroups are exclusive and false if independent.

void SetSubgroupLevelExclusive (optional pfcDetailSymbolGroup_ptr ParentGroup)

Set the symbol groups exclusive at specified level.

Once set exclusive, only one of the groups at this level may be active in the model at any time.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The status was already set to the designated value.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Parameters:

ParentGroup: The symbol groups at the level of this symbol group are set exclusive. If not specified, the top level is assumed.

Returns:

void SetSubgroupLevelIndependent (optional pfcDetailSymbolGroup_ptr ParentGroup)

Set the symbol groups independent at specified level.

Once set independent, any number of groups at this level may be active in the model at any time.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The status was already set to the designated value.

Manual References:: Drawings: Detail Symbol Groups

Parameters:

ParentGroup: The symbol groups at the level of this symbol group are set independent. If not specified, the top level is assumed.

Returns: