All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMSTEPExchanges Interface VPMIExExtractor

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

Usage: you can freely reimplement this interface.


interface VPMIExExtractor

Description of the Extractor Interface.
Role: This interface must be re-implemented when a new Export extractor component needs to be defined. These components enable to extract from the ENOVIA LCA repository a consistent set of information
For a specific set of data, they will:


Method Index


o Export(CATIAVPMObject*&,CATIContainer_var&)
Exports data to ENOV_DATAX working form.
o Export(CATIContainer_var&)
Exports data to ENOV_DATAX working form.
o GetID(CATUnicodeString&)
Gets Exchange Component identifier.
o GetImplName(CATUnicodeString&)
Gets implementation name of the exchange component.

Methods


o Export
public virtual HRESULT Export( const CATIAVPMObject*& iToBeExported,
const CATIContainer_var& iCandidate)= 0
Exports data to ENOV_DATAX working form.
Role: Same as the previous method, but the starting point is provided.
Parameters:
iToBeExported
Object to start the extaction operation.
iCandidate
CATIContainer that contains the SDAI working form to validate.
o Export
public virtual HRESULT Export( const CATIContainer_var& iCandidate)= 0
Exports data to ENOV_DATAX working form.
Role: Exports data to ENOV_DATAX working form by analyzing the actual EV5 model and creates ENOV_DATAX instances in the output model. It informs the Main Engine about the analyzed instances and the ENOV_DATAX instances they have been mapped with.
Parameters:
iCandidate
CATIContainer that contains the SDAI ENOV_DATAX working form to fill.
o GetID
public virtual HRESULT GetID(CATUnicodeString& oTheXComponentID)= 0
Gets Exchange Component identifier.
Role: This method provides the identifier of the Exchange Component. For a better understanding of exchange mechanisms at run-time, it is recommended to return the same value as the one provided in the STEP Exchanges Declarative Environment.
Parameters:
oTheXComponentID
Exchange component identifier.
o GetImplName
public virtual HRESULT GetImplName(CATUnicodeString& oTheXComponentImplID)= 0
Gets implementation name of the exchange component.
Role: This method provides the name of the implementation of the Exchange Component. For a better understanding of exchange mechanisms at run-time, it is recommended to return the same value as the one provided in the STEP Exchanges Declarative Environment.
Parameters:
oTheXComponentImplID
Implementation name of the exchange component.

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

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