All Frameworks  Class Hierarchy  This Framework  Indexes   

CATAnalysisInterfaces Interface 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 Accept()
Implements the OK action.
o GetCommentForType
public virtual GetCommentForType( const iType,
oComment)
Associate a comment to the file extention.
Parameters:
oComment
String that defines the comment.
o GetFileTypes
public virtual GetFileTypes( oTypes)
Defines the type of file that will be imported.
Parameters:
oTypes
String that defines the extention of the file.
o GetUserFrame
public virtual GetUserFrame( iParent,
iImportedDoc)
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 GetValues( oValues)
Get values for customisation.
Parameters:
oValues
array of values.
o Import
public virtual Import( iFileToImport,
iAnalysisDocument)
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 SetValues( iValue)
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.