CIP C++ documentation for class "wfcWSimpRep"

Class wfcWSimpRep

# include <wfcCombState.h> class wfcWSimpRep : public virtual pfcSimpRep, : public virtual wfcWModelItem { xaideclare(wfcWSimpRep) ... };

Description

Adds more functionality to pfcSimpRep.

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

Method Summary


`void`	`DeleteSimpRepInstructionItem (pfcSimpRepItem_ptr SimprepItem)`
	Deletes the specified item from the `pfcSimpRepInstructions`

`xbool`	`GetSimprepdataTempvalue ()`
	Retrieves the value of the IsTemporary field from `pfcSimpRepInstructions`

`xstring`	`GetSimprepSubstitutionName (pfcSimpRepItemPath_ptr ItemPath)`
	Returns the name of the substituted rep at the given path

`xbool`	`IsSimpRepInstructionDefault ()`
	default action to be applied to the components pfcSIMPREP_INCLUDE or pfcSIMPREP_EXCLUDE

`void`	`SetSimprepdataName (xrstring SimpRepName)`
	Sets name of the simplified rep

`void`	`SetSimpRepInstructionDefaultAction (pfcSimpRepActionType DefaultAction)`
	Sets the default action in the `pfcSimpRepActionType`

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 pfcSimpRep:: GetSimpRepType, GetInstructions, SetInstructions

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Method Detail

xbool GetSimprepdataTempvalue ()

Retrieves the value of the IsTemporary field from pfcSimpRepInstructions

Manual References:: Simplified Representations: Modifying Simplified Representations, Simplified Representations: Modifying Simplified Representations

Returns:: Returns IsTemporary field value from pfcSimpRepInstructions

xstring GetSimprepSubstitutionName (pfcSimpRepItemPath_ptr ItemPath)

Returns the name of the substituted rep at the given path

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - There is no substituted rep at the given item path.

Manual References:: Simplified Representations: Extracting Information About Simplified Representations, Simplified Representations: Extracting Information About Simplified Representations

Parameters:

ItemPath: The path to the substituted rep

Returns:: The name of the substituted rep

xbool IsSimpRepInstructionDefault ()

default action to be applied to the components pfcSIMPREP_INCLUDE or pfcSIMPREP_EXCLUDE

Manual References:: Simplified Representations: Extracting Information About Simplified Representations, Simplified Representations: Extracting Information About Simplified Representations

Returns:

void SetSimprepdataName (xrstring SimpRepName)

Sets name of the simplified rep

Manual References:: Simplified Representations: Modifying Simplified Representations

Parameters:

SimpRepName: Name of the simplified rep

Returns:

void DeleteSimpRepInstructionItem (pfcSimpRepItem_ptr SimprepItem)

Deletes the specified item from the pfcSimpRepInstructions

If an item is deleted from pfcSimpRepInstructions, its last status in the simplified representation will remain unchanged after calling <reference 4 to unknown entity pfcSimpRep_tk::SetInstructions>. This should not be confused with deleting the item from the simplified representation, which can be achieved by setting the item action to pfcSIMPREP_NONE.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The function did not find the specified item in the structure.

Manual References:: Simplified Representations: Adding Items to and Deleting Items from a Simplified Representation

Parameters:

SimprepItem: The item to delete

Returns:

void SetSimpRepInstructionDefaultAction (pfcSimpRepActionType DefaultAction)

Sets the default action in the pfcSimpRepActionType

Manual References:: Simplified Representations: Extracting Information About Simplified Representations

Parameters:

DefaultAction: The default action type pfcSIMPREP_INCLUDE or pfcSIMPREP_EXCLUDE

Returns: