All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATCommonLayoutInterfaces Class CATECloPartSelectionAdapter

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATECloPartSelectionAdapter
 

Usage: you can derive this class.


public class CATECloPartSelectionAdapter

Interface to calculate the weld offset


Constructor and Destructor Index


o CATECloPartSelectionAdapter()
o ~CATECloPartSelectionAdapter()

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.

Constructor and Destructor


o CATECloPartSelectionAdapter
public CATECloPartSelectionAdapter()
o ~CATECloPartSelectionAdapter
public virtual ~CATECloPartSelectionAdapter()

Methods


o FilterPartSelection
public virtual HRESULT FilterPartSelection( const CATUnicodeString& iuStandard,
const CATUnicodeString& iuSpec,
const CATUnicodeString& iuPartType,
const CATIUnknownList* iLFilterParameters,
const CATIUnknownList* iLSortParameters,
const CATIUnknownList* iListDescription,
CATIUnknownList*& oListDescription)
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
public virtual HRESULT IsExternalProgramNeeded( const CATUnicodeString& iuApplicationContext,
const CATUnicodeString& iuStandard,
const CATUnicodeString& iuSpec,
const CATUnicodeString& iuPartType,
int& oiActivate)
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
public virtual HRESULT RefinePartSelection( const CATUnicodeString& iuApplicationContext,
const CATUnicodeString& iuStandard,
const CATUnicodeString& iuSpec,
const CATUnicodeString& iuPartType,
const CATIUnknownList* iLEnvironmentParameters,
const CATIUnknownList* iLFilterParameters,
const CATIUnknownList* iLSortParameters,
const IUnknown* ipiCatalogObjectToBeSearched,
CATListValCATUnicodeString& opListPartNumbersFound)
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: CATECloPartSelectionAdapter.h
If needed, your Imakefile.mk should include the module: CATCommonLayoutItfCPP

Copyright © 2003, Dassault Systèmes. All rights reserved.