CIP C++ documentation for class "pfcDetailSymbolGroup"

Class pfcDetailSymbolGroup

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

Description

This interface represents a symbol group contained in a drawing symbol.

Direct Known Subclasses:: wfcWDetailSymbolGroup

Method Summary


`void`	`Delete ()`
	To delete the given symbol group.

`pfcDetailSymbolGroupInstructions_ptr`	`GetInstructions ()`
	To get the instructions object describing how the symbol group is constructed.

`pfcDetailSymbolDefItem_ptr`	`GetParentDefinition ()`
	The symbol definition of the given group.

`optional pfcDetailSymbolGroup_ptr`	`GetParentGroup ()`
	The parent symbol group of the level to which the given group belongs.

`optional pfcDetailSymbolGroups_ptr`	`ListChildren ()`
	To list the subgroups of the given symbol group.

`void`	`Modify (pfcDetailSymbolGroupInstructions_ptr Instructions)`
	To modify the given symbol group.

Method Detail

optional pfcDetailSymbolGroup_ptr GetParentGroup ()

The parent symbol group of the level to which the given group belongs.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The group is a top level group and does not have a parent.

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

pfcDetailSymbolDefItem_ptr GetParentDefinition ()

The symbol definition of the given group.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The group is a top level group and does not have a parent.

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

optional pfcDetailSymbolGroups_ptr ListChildren ()

To list the subgroups of the given symbol group.

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

pfcDetailSymbolGroupInstructions_ptr GetInstructions ()

To get the instructions object describing how the symbol group is constructed.

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

Returns:: The symbol group instructions object.

void Modify (pfcDetailSymbolGroupInstructions_ptr Instructions)

To modify the given symbol group.

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

Parameters:

Instructions: The instructions for modification of symbol group.

Returns:

void Delete ()

To delete the given symbol group.

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

Returns: