All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATCommonLayoutInterfaces Interface CATICloPartSelection
System.IUnknown
|
+---CATICloPartSelection
Usage: you can reimplement this interface by deriving the supplied CATECloPartSelectionAdapter adapter class.
interface CATICloPartSelection
Describe the functionality of your interface here
Using this prefered syntax will enable mkdoc to document your class.
Method Index
- o
FilterPartSelection(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIUnknownList*,CATIUnknownList*,CATIUnknownList*,CATIUnknownList*&)
- Interrupt the part place process before catalog part selection and override or modify the selection process.
- o
IsExternalProgramNeeded(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,int&)
- Method called by part placement UI to determine if a call to RefinePartSelection is needed.
- o
RefinePartSelection(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIUnknownList*,CATIUnknownList*,CATIUnknownList*,IUnknown*,CATListValCATUnicodeString&)
- Provide an supplemental part selection available from the part placement panel after the part placement engine selection has taken place.
Methods
o FilterPartSelection
-
Interrupt the part place process before catalog part selection and override or modify the selection process.
- Parameters:
-
- iuStandard
- input: The standard
- iuSpec
- input: The material specification ( NULL is non-spec)
- iuPartType
- input: part type of the parts
- iLFilterParameters
- input: The list of parameters used in the search. (this could be all the parameters used,
or only the ones that actually match keywords.)
- iLSortParameters
- input: A list of parameters used to sort the results of the search.
The list is sort by descriptions that best match parameters in this list.
(this could be all the parameters used, or only the ones that actually match keywords.)
- iListDescription
- input: list of the catalog descriptions available for selection
- iLParameters
- input: list of paramaters used by part placement
- oListDescription
- output: list of catalog descriptions to be displayed for user selection
- Returns:
- A boolean value.
Legal values:
- SUCCEEDED
- FAILED
o IsExternalProgramNeeded
-
Method called by part placement UI to determine if a call to RefinePartSelection is needed.
- Parameters:
-
- iuApplicationContext
- input: The application currently being used (e.g. CATPiping, CATTubing)
- iuStandard
- input: The standard
- iuSpec
- input: The material specification ( NULL is non-spec)
- iuPartType
- input: part type of the parts
- oiActivate
- output: flag to determine external program use. 1: Activate external program. 0: Do not activate.
- Returns:
- A boolean value.
Legal values:
- SUCCEEDED
- FAILED
o RefinePartSelection
-
Provide an supplemental part selection available from the part placement panel after the part placement engine selection has taken place.
- Parameters:
-
- iuApplicationContext
- input: The application currently being used (e.g. CATPiping, CATTubing)
- iuStandard
- input: The standard
- iuSpec
- input: The material specification ( NULL is non-spec)
- iuPartType
- input: part type of the parts
- iLEnvironmentParameters
- input: A list of parameters from by the parent product under which the part will be placed.
- iLFilterParameters
- input: The list of parameters used in the search. (this could be all the parameters used,
or only the ones that actually match keywords.)
- iLSortParameters
- input: A list of parameters used to sort the results of the search.
The list is sort by descriptions that best match parameters in this list.
(this could be all the parameters used, or only the ones that actually match keywords.)
- iListDescription
- input: list of the catalog descriptions available for selection
- iPartChapter
- input: chapter that the part placement engine searched.
- opListPartNumbersFound
- output: list of part numbers found by this method.
- Returns:
- A boolean value.
Legal values:
- SUCCEEDED
- FAILED
This object is included in the file: CATICloPartSelection.h