API Documentation > Classes > Class pfcSelect
Class pfcSelect

package com.ptc.pfc.pfcSelect;

public class pfcSelect


Description
Contains global CIP definitions for module "pfcSelect"
Method Summary
static Selection
Used to create aSelection object, based on the path to a specified component.
static Selection
CreateModelItemSelection (ModelItem SelItem, /*optional*/ ComponentPath Path)
Used to create aSelection object, based on aModelItem and, optionally, itsComponentPath in an assembly.
static Selection
Used to create aSelection object, based on aModel
static Selection
CreateSelectionFromString (String SelectionString)
Creates a new selection object, given a Web.Link style selection string.
SelectionOptions_Create (String inOptionKeywords)
Specifies the options used in the selection.
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
SelectionOptions_Create
(String inOptionKeywords)
Specifies the options used in the selection.
User Guide References:
Parameters:
inOptionKeywords
The keywords to include in the selection
Returns:
A pointer to the new SelectionOptions object
SelectionPair_Create
SelectionPair_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.
User Guide References:
Parameters:
inSel1
The first Selected object.
inSel2
The second Selected object.
Returns:
The SelectionPair object.
CreateComponentSelection
static Selection
CreateComponentSelection
(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.
User Guide References:
Parameters:
Path
The ComponentPath of the object to selected within an assembly.
Returns:
The Selection object.
CreateModelSelection
static Selection
CreateModelSelection
(Model Model)
Used to create a Selection object, based on a Model
User Guide References:
Parameters:
Model
The Selected Model
Returns:
The Selection object.
CreateModelItemSelection
static Selection
CreateModelItemSelection
(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.
User Guide References:
Parameters:
SelItem
The Selected ModelItem
Path
The ComponentPath of the selected object within an assembly.
Returns:
The Selection object.
CreateSelectionFromString
static Selection
CreateSelectionFromString
(String SelectionString)
Creates a new selection object, given a Web.Link style selection string.
See Also:
User Guide References:
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.
Was this helpful?