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)
User Guide References:
Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes:pfcDetailSymbolDefItem, Instructions:pfcDetailSymbolDefItem, Instructions:pfcDetailSymbolDefItem, Instructions:pfcDetailSymbolDefItem, Detail Symbol Definitions Information:pfcDetailSymbolDefItem, Detail Symbol Definitions Operations:pfcDetailSymbolDefItem, Retrieving Symbol Definitions:pfcDetailSymbolDefItem, Detail Symbol Group Information:pfcDetailSymbolDefItem, Detail Symbol Group Operations:pfcDetailSymbolDefItem
Direct Known Subclasses:
Methods Inherited from Class pfcChild::
Methods Inherited from Class pfcActionSource::
Methods Inherited from Class pfcRelationOwner::
Methods Inherited from Class pfcParent::
Methods Inherited from Class pfcParameterOwner::
Methods Inherited from Class pfcModelItem::
Methods Inherited from Class pfcDetailItem::
Method Summary
Creates a detail item in the symbol definition. | |
CreateSubgroup (pfcDetailSymbolGroupInstructions_ptr Instructions, optional pfcDetailSymbolGroup_ptr ParentGroup) | |
Create a subgroup in the specified symbol group. | |
Returns a detail item in a symbol definition, given its id and type. | |
Returns an instructions data object describing how a symbol definition is constructed. | |
Determine if the subgroups stored in the symbol definition on the indicated level are exclusive. | |
Lists the detail items in the symbol definition. | |
List the subgroups in the symbol definition. | |
void | |
Modifies a symbol definition. | |
void | |
Set the symbol groups exclusive at specified level. | |
void | |
Set the symbol groups independent at specified level. |
Method Detail
GetDetailItem |
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.
ListDetailItems |
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.
User Guide References:
Parameters:
Type
The type of detail items to list.
Returns:
The items found, or null, if no items were found.
CreateDetailItem |
Creates a detail item in the symbol definition.
User Guide References:
Parameters:
Instructions
The data item instructions. This should be a pfcDetailEntityInstructions or pfcDetailNoteInstructions object.
Returns:
The detail item created in the symbol definition.
CreateFreeNote |
Parameters:
TextLines
Attach
Returns:
GetInstructions | () |
Returns an instructions data object describing how a symbol definition is constructed.
User Guide References:
Returns:
The instructions data object.
void | Modify |
Modifies a symbol definition.
User Guide References:
Parameters:
Instructions
Data object containing modifications to the symbol definition.
Returns:
CreateSubgroup |
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.
User Guide References:
Parameters:
Instructions
The characteristics for creating the subgroup.
ParentGroup
The symbol group under which the subgroup is to be made.
Returns:
The symbol group.
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.
User Guide References:
Returns:
The list of sub symbol groups.
IsSubgroupLevelExclusive |
Determine if the subgroups stored in the symbol definition on the indicated level are exclusive.
User Guide References:
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 |
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.
User Guide References:
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 |
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.
User Guide References:
Parameters:
ParentGroup
The symbol groups at the level of this symbol group are set independent. If not specified, the top level is assumed.
Returns: