Library | PackageFrames | Expand Java Toolkit

Class pfcSelect

package com.ptc.pfc.pfcSelect;

public class pfcSelect


Description

Contains global CIP definitions for module "pfcSelect"


Method Summary
static SelectionCreateComponentSelection (ComponentPath Path)
    Used to create a Selection object, based on the path to a specified component.
static SelectionCreateModelItemSelection (ModelItem SelItem, /*optional*/ ComponentPath Path)
    Used to create a Selection object, based on a ModelItem and, optionally, its ComponentPath in an assembly.
static SelectionCreateModelSelection (Model Model)
    Used to create a Selection object, based on a Model
static SelectionCreateSelectionFromString (String SelectionString)
    Creates a new selection object, given a Web.Link style selection string.
static SelectionOptionsSelectionOptions_Create (String inOptionKeywords)
    Specifies the options used in the selection.
static SelectionPairSelectionPair_Create (Selection inSel1, Selection inSel2)
    Creates a new SelectionPair object; it's a field of SelectionEvaluator and GlobalInterference classes and represents the data necessary to call several functions that deal with interference.

Method Detail

SelectionOptions_Create

static SelectionOptionsSelectionOptions_Create (String inOptionKeywords)


    Specifies the options used in the selection.

The return value is an argument to BaseSession.Select(SelectionOptions, /*optional*/ Selections) .
Manual References:
Selection: Interactive Selection, Selection: Interactive Selection
Parameters:
inOptionKeywords
The keywords to include in the selection
Returns:
A pointer to the new SelectionOptions object

SelectionPair_Create

static SelectionPairSelectionPair_Create (Selection inSel1, Selection inSel2)


    Creates a new SelectionPair object; it's a field of SelectionEvaluator and GlobalInterference classes and represents the data necessary to call several functions that deal with interference.
Manual References:
Geometry Evaluation: Analyzing Interference Information, Geometry Evaluation: Analyzing Interference Information
Parameters:
inSel1
The first Selected object.
inSel2
The second Selected object.
Returns:
The SelectionPair object.

CreateComponentSelection

static SelectionCreateComponentSelection (ComponentPath Path)


    Used to create a Selection object, based on the path to a specified component.

Exceptions thrown (but not limited to):

XToolkitInvalidPtr - The selection argument is an invalid pointer.


Manual References:
Selection: Programmatic Selection, Selection: Programmatic Selection
Parameters:
Path
The ComponentPath of the object to selected within an assembly.
Returns:
The Selection object.

CreateModelSelection

static SelectionCreateModelSelection (Model Model)


    Used to create a Selection object, based on a Model
Manual References:
Selection: Programmatic Selection, Selection: Programmatic Selection
Parameters:
Model
The Selected Model
Returns:
The Selection object.

CreateModelItemSelection

static SelectionCreateModelItemSelection (ModelItem SelItem, /*optional*/ ComponentPath Path)


    Used to create a Selection object, based on a ModelItem and, optionally, its ComponentPath in an assembly.

Exceptions thrown (but not limited to):

XToolkitInvalidPtr - The selection argument is an invalid pointer.


Manual References:
Selection: Programmatic Selection, Selection: Programmatic Selection
Parameters:
SelItem
The Selected ModelItem
Path
The ComponentPath of the selected object within an assembly.
Returns:
The Selection object.

CreateSelectionFromString

static SelectionCreateSelectionFromString (String SelectionString)


    Creates a new selection object, given a Web.Link style selection string.
See Also:
pfcSelect.CreateModelItemSelection(ModelItem, /*optional*/ ComponentPath), pfcSelect.CreateComponentSelection(ComponentPath)
Manual References:
Selection: Programmatic Selection, Selection: Programmatic Selection
Parameters:
SelectionString
The selection string. The string should follow the following formats (items in brackets [] are optional): TopLevelObject:[SubAsm]:[SubAs:LeafComponent]/[ModelItem]

The top level object should provided as: "name.type"

Each component in the path can have one of the following formats:
  • "name.type"
  • "name.type(#comp_id)"
  • "name.type(comp_name)"
The component name is the name of the component feature in the context of its parent assembly.

The model item can have one of the following formats:
  • "itemtype(#item_id)
  • "itemtype(item_name)
Itemtype must one of the following:
  • Feature
  • Dimension
Returns:
The created selection object.