All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ProductStructure Interface CATIProductSelection

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

Usage: you can reimplement this interface by deriving the supplied CATPrdCommonFileSelection adapter class.


interface CATIProductSelection

Interface allowing to extract products (features) from a selection.
Role:This interface doesn't describe selection, it is specific for each environment by derived interfaces. For file environment, implementation is done by CATPrdCommonFileSelection on inherit CATIProductFileSelection interface.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

See also:
CATIProductFileSelection, CATPrdCommonFileSelection


Method Index


o ExtractProducts(CATIContainer*,CATIProduct*,CATListValCATBaseUnknown_var*&)
Extracts products corresponding to the selection.
o GetSelectionCount(long&)
Count of selected objects.

Methods


o ExtractProducts
public virtual HRESULT ExtractProducts(CATIContainer* iOptionalContainer,
CATIProduct* iTargetProduct,
CATListValCATBaseUnknown_var*& oList)= 0
Extracts products corresponding to the selection. The selection can be multiple.
note: generally the default implementation for specific environment shouldn't be overloaded ( use provided adapters as CATPrdCommonFileSelection )
Parameters:
iOptionalContainer
Some implementations may generate some products corresponding to the selection and need the iOptionalContainer for this purpose.
iTargetProduct
Some implementation may need to know attributes of the iTargetProduct but it must be unchanged.
oList
The extracted products are added to the oList; if oList is not initialized, the implementation must create it.
o GetSelectionCount
public virtual HRESULT GetSelectionCount(long& oCount)= 0
Count of selected objects.
Role: Enables to evaluate how many products are to be generated, before to launch the extraction.
note: generally the default implementation for specific environment shouldn't be overloaded ( use provided adapters as CATPrdCommonFileSelection )
Parameters:
oCount
number of selected products.

This object is included in the file: CATIProductSelection.h
If needed, your Imakefile.mk should include the module: CATProductStructure1

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