CIP JAVA documentation for class "com.ptc.pfc.pfcSimpRep.pfcSimpRep"

Class pfcSimpRep

package com.ptc.pfc.pfcSimpRep; public class pfcSimpRep

Description

Contains global CIP definitions for module "pfcSimpRep"

Method Summary
`static CreateNewSimpRepInstructions`	`CreateNewSimpRepInstructions_Create (String NewSimpName)` reates a new object used to create a new representation.
`static RetrieveExistingSimpRepInstructions`	`RetrieveExistingSimpRepInstructions_Create (String ExistSimpName)` Creates a new object used to retrieve an existing simplified representation.
`static SimpRepAutomatic`	`SimpRepAutomatic_Create ()` Creates a new object that represents the automatic representation of the component.
`static SimpRepBoundBox`	`SimpRepBoundBox_Create ()`
`static SimpRepCompItemPath`	`SimpRepCompItemPath_Create (intseq ItemPath)` Creates a new object that used to point to a component.
`static SimpRepDefaultEnvelope`	`SimpRepDefaultEnvelope_Create ()`
`static SimpRepExclude`	`SimpRepExclude_Create ()` Creates a new object for excluding this component from the simplified representation.
`static SimpRepFeatItemPath`	`SimpRepFeatItemPath_Create (int FeatId)` Creates a new object used to point to a feature that is not a component. NOTE: Not implemented in this J-Link release.
`static SimpRepGeom`	`SimpRepGeom_Create ()` Creates a new object that represents the "geometry only" representation of the component.
`static SimpRepGraphics`	`SimpRepGraphics_Create ()` Creates a new object that represents the "graphics only" representation of the component.
`static SimpRepInclude`	`SimpRepInclude_Create ()` Creates a new object that includes this component in the simplified representation.
`static SimpRepItem`	`SimpRepItem_Create (SimpRepItemPath ItemPath)` Creates a new object that defines the status of the component or feature in a simplified representation.
`static SimpRepLightWeightGraphics`	`SimpRepLightWeightGraphics_Create ()`
`static SimpRepNone`	`SimpRepNone_Create ()`
`static SimpRepReverse`	`SimpRepReverse_Create ()` Creates a new object that reverses the default rule for the component in the simplified rep.
`static SimpRepSubstitute`	`SimpRepSubstitute_Create (Substitution SubsData)` Creates a new object used to substitute the component in the simplified representation.
`static SimpRepSymb`	`SimpRepSymb_Create ()` Creates a new object that represents the symbolic representation of the component.
`static SubstAsmRep`	`SubstAsmRep_Create (intseq SubstPath, SimpRep AsmRep)` Creates a new object used to substitute an assembly with a simplified representation.
`static SubstEnvelope`	`SubstEnvelope_Create (intseq SubstPath)` Creates a new object used to substitute with an envelope.
`static SubstInterchg`	`SubstInterchg_Create (intseq SubstPath)` Creates a new object used to substitute using an interchange assembly or a family table.
`static SubstPrtRep`	`SubstPrtRep_Create (intseq SubstPath, SimpRep PartRep)` Creates a new object used to substitute a part with a simplified representation.

Method Detail

SimpRepCompItemPath_Create

static SimpRepCompItemPath SimpRepCompItemPath_Create (intseq ItemPath)

Creates a new object that used to point to a component.

The return value is used as a component of SimpRepItem .

Parameters:

ItemPath: Path to the item.

Returns:: The pfcSimpRepCompItemPath object.

SimpRepFeatItemPath_Create

static SimpRepFeatItemPath SimpRepFeatItemPath_Create (int FeatId)

Creates a new object used to point to a feature that is not a component.

NOTE: Not implemented in this J-Link release.

Not implemented in this J-Link release.

Exceptions thrown (but not limited to):

XToolkitNotImplemented - Method is not implemented

Parameters:

FeatId: The Feat Id.

Returns:: The pfcSimpRepFeatItemPath object.

SubstInterchg_Create

static SubstInterchg SubstInterchg_Create (intseq SubstPath)

Creates a new object used to substitute using an interchange assembly or a family table.

The return value is used as a component of the SimpRepInstructions .

Parameters:

SubstPath: Path to the substitute component.

Returns:: The pfcSubstInterchg object.

SubstPrtRep_Create

static SubstPrtRep SubstPrtRep_Create (intseq SubstPath, SimpRep PartRep)

Creates a new object used to substitute a part with a simplified representation.

The return value is used as a component of the SimpRepInstructions .

Parameters:

SubstPath: Path to the substitute component.
PartRep: Simplified representation handle.

Returns:: The pfcSubstPrtRep object.

SubstAsmRep_Create

static SubstAsmRep SubstAsmRep_Create (intseq SubstPath, SimpRep AsmRep)

Creates a new object used to substitute an assembly with a simplified representation.

The return value is used as a component of the SimpRepInstructions .

Parameters:

SubstPath: Path to the substitute component.
AsmRep: Simplified representation handle.

Returns:: The pfcSubstAsmRep object.

SubstEnvelope_Create

static SubstEnvelope SubstEnvelope_Create (intseq SubstPath)

Creates a new object used to substitute with an envelope.

The return value is used as a component of the SimpRepInstructions.

Parameters:

SubstPath: Path to the substitute component.

Returns:: The pfcSubstEnvelope object.

SimpRepReverse_Create

static SimpRepReverse SimpRepReverse_Create ()

Creates a new object that reverses the default rule for the component in the simplified rep.

The return value is used as a component of SimpRepItem .

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

Returns:: The pfcSimpRepReverse object.

SimpRepInclude_Create

static SimpRepInclude SimpRepInclude_Create ()

Creates a new object that includes this component in the simplified representation.

The return value is used as a component of SimpRepItem .

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

Returns:: The pfcSimpRepInclude object.

SimpRepExclude_Create

static SimpRepExclude SimpRepExclude_Create ()

Creates a new object for excluding this component from the simplified representation.

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

Returns:: The pfcSimpRepExclude object.

SimpRepSubstitute_Create

static SimpRepSubstitute SimpRepSubstitute_Create (Substitution SubsData)

Creates a new object used to substitute the component in the simplified representation.

The return value is used as a component of SimpRepItem .

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

Parameters:

SubsData: Specifies the substitution type and substitute data.

Returns:: The pfcSimpRepSubstitute object.

SimpRepNone_Create

static SimpRepNone SimpRepNone_Create ()

Returns:

SimpRepGeom_Create

static SimpRepGeom SimpRepGeom_Create ()

Creates a new object that represents the "geometry only" representation of the component.

The return value is used as a component of SimpRepItem .

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

Returns:: The pfcSimpRepGeom object.

SimpRepGraphics_Create

static SimpRepGraphics SimpRepGraphics_Create ()

Creates a new object that represents the "graphics only" representation of the component.

The return value is used as a component of SimpRepItem .

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

Returns:: The pfcSimpRepGraphics object.

SimpRepSymb_Create

static SimpRepSymb SimpRepSymb_Create ()

Creates a new object that represents the symbolic representation of the component.

The return value is used as a component of SimpRepItem .

Returns:: The newly created object.

SimpRepDefaultEnvelope_Create

static SimpRepDefaultEnvelope SimpRepDefaultEnvelope_Create ()

Returns:

SimpRepBoundBox_Create

static SimpRepBoundBox SimpRepBoundBox_Create ()

Returns:

SimpRepLightWeightGraphics_Create

static SimpRepLightWeightGraphics SimpRepLightWeightGraphics_Create ()

Returns:

SimpRepAutomatic_Create

static SimpRepAutomatic SimpRepAutomatic_Create ()

Creates a new object that represents the automatic representation of the component.

The return value is used as a component of SimpRepItem .

Returns:: The newly created object.

SimpRepItem_Create

static SimpRepItem SimpRepItem_Create (SimpRepItemPath ItemPath)

Creates a new object that defines the status of the component or feature in a simplified representation.

The return value is used as a component of SimpRepItem .

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

Parameters:

ItemPath: Specifies the simplified representation item.

Returns:: The pfcSimpRepItem object.

RetrieveExistingSimpRepInstructions_Create

static RetrieveExistingSimpRepInstructions RetrieveExistingSimpRepInstructions_Create (String ExistSimpName)

Creates a new object used to retrieve an existing simplified representation.

The return value must be passed to BaseSession.RetrieveAssemSimpRep(String, /*optional*/ SimpRepInstructions) .

Manual References:: Simplified Representations: Retrieving Simplified Representations, Simplified Representations: Retrieving Simplified Representations

Parameters:

ExistSimpName: Name of the existing representation.

Returns:: The pfcRetrieveExistingSimpRepInstructions object.

CreateNewSimpRepInstructions_Create

static CreateNewSimpRepInstructions CreateNewSimpRepInstructions_Create (String NewSimpName)

reates a new object used to create a new representation.

Manual References:: Simplified Representations: Creating and Deleting Simplified Representations, Simplified Representations: Creating and Deleting Simplified Representations

Parameters:

NewSimpName: Name of the creating representation.

Returns:: The pfcCreateNewSimpRepInstructions object.