CIP JAVA documentation for class "com.ptc.wfc.wfcCombState.WSimpRep"

Interface WSimpRep

package com.ptc.wfc.wfcCombState; public interface WSimpRep extends com.ptc.pfc.pfcSimpRep.SimpRep, com.ptc.wfc.wfcModelItem.WModelItem

Description

Adds more functionality to SimpRep.

Method Summary
`void`	`DeleteSimpRepInstructionItem (SimpRepItem SimprepItem)` Deletes the specified item from the `SimpRepInstructions`
`boolean`	`GetSimprepdataTempvalue ()` Retrieves the value of the IsTemporary field from `SimpRepInstructions`
`String`	`GetSimprepSubstitutionName (SimpRepItemPath ItemPath)` Returns the name of the substituted rep at the given path
`boolean`	`IsSimpRepInstructionDefault ()` default action to be applied to the components pfcSIMPREP_INCLUDE or pfcSIMPREP_EXCLUDE
`void`	`SetSimprepdataName (String SimpRepName)` Sets name of the simplified rep
`void`	`SetSimpRepInstructionDefaultAction (SimpRepActionType DefaultAction)` Sets the default action in the `SimpRepActionType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.pfc.pfcSimpRep.SimpRep`
`GetSimpRepType`, `GetInstructions`, `SetInstructions`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WModelItem`
`DeleteUserDefinedName`, `Unhide`, `Hide`, `IsHidden`, `IsNameReadOnly`, `IsZoneFeature`, `GetDefaultName`

Method Detail

GetSimprepdataTempvalue

boolean GetSimprepdataTempvalue ()

Retrieves the value of the IsTemporary field from SimpRepInstructions

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

Returns:: Returns IsTemporary field value from SimpRepInstructions

GetSimprepSubstitutionName

String GetSimprepSubstitutionName (SimpRepItemPath ItemPath)

Returns the name of the substituted rep at the given path

Exceptions thrown (but not limited to):

XToolkitBadContext - 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

IsSimpRepInstructionDefault

boolean 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:

SetSimprepdataName

void SetSimprepdataName (String SimpRepName)

Sets name of the simplified rep

Manual References:: Simplified Representations: Modifying Simplified Representations

Parameters:

SimpRepName: Name of the simplified rep

Returns:

DeleteSimpRepInstructionItem

void DeleteSimpRepInstructionItem (SimpRepItem SimprepItem)

Deletes the specified item from the SimpRepInstructions

If an item is deleted from SimpRepInstructions, its last status in the simplified representation will remain unchanged after calling <reference 6 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):

XToolkitNotFound - 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:

SetSimpRepInstructionDefaultAction

void SetSimpRepInstructionDefaultAction (SimpRepActionType DefaultAction)

Sets the default action in the SimpRepActionType

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

Parameters:

DefaultAction: The default action type pfcSIMPREP_INCLUDE or pfcSIMPREP_EXCLUDE

Returns: