All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamImportDefine

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

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


interface CATISamImportDefine

Interface to define interactivity in import.

BOA information: this interface can 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.


Method Index


o Accept()
Implements the OK action.
o GetCommentForType(CATString,CATUnicodeString&)
Associate a comment to the file extention.
o GetFileTypes(CATListValCATString&)
Defines the type of file that will be imported.
o GetUserFrame(CATDialog*,CATDocument*)
Returns an interactive frame.
o GetValues(CATSafeArrayVariant*&)
Get values for customisation.
o Import(CATDocument*,CATDocument*)
Import in order to launch the import specific code.
o SetValues(CATSafeArrayVariant*)
Set Values for customisation.

Methods


o Accept
public virtual HRESULT Accept()= 0
Implements the OK action.
o GetCommentForType
public virtual HRESULT GetCommentForType( const CATString iType,
CATUnicodeString& oComment) = 0
Associate a comment to the file extention.
Parameters:
oComment
String that defines the comment.
o GetFileTypes
public virtual HRESULT GetFileTypes(CATListValCATString& oTypes) = 0
Defines the type of file that will be imported.
Parameters:
oTypes
String that defines the extention of the file.
o GetUserFrame
public virtual CATDlgFrame* GetUserFrame(CATDialog* iParent,
CATDocument* iImportedDoc) = 0
Returns an interactive frame.
Parameters:
iParent
the parent for output frame.
iImpotedDoc
pointer to the imported document.
Returns:
the frame to display.
o GetValues
public virtual HRESULT GetValues(CATSafeArrayVariant*& oValues) = 0
Get values for customisation.
Parameters:
oValues
array of values.
o Import
public virtual HRESULT Import(CATDocument* iFileToImport,
CATDocument* iAnalysisDocument) = 0
Import in order to launch the import specific code.
Parameters:
iFileToImport
input the CATDocument to import.
iAnalysisDocument
input the current CATDocument in which the import is done.
o SetValues
public virtual HRESULT SetValues(CATSafeArrayVariant* iValue) = 0
Set Values for customisation.
Parameters:
iValues
array of values.

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

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