All Frameworks Class Hierarchy This Framework Indexes Previous Next

DataExchangeKernelItf Interface CATIExchangeInputDocument

Usage: you can freely reimplement this interface.

interface CATIExchangeInputDocument

Interface to exchange input documents.
Role: This interface describes the XCAD input document. The input document represents a CAD document to be converted Thru XCAD. This interface gives access to the document (filepath, attributes), and to representations which are the "units" of the document contents to be exchanged.
Available from CATIA V5R11.

See also:

Method Index

o Close(): Ends the transaction on the document.
o GetDocumentDescription(CATUnicodeString&): Retrieves the document's description.
o GetDocumentPATH(FilePath&): Retrieves the document's filepath.
o GetDocumentURL(URL&): Retrieves the document's URL.
o GetRepresentation(CATUnicodeString&,CATIExchangeRepresentation_var&): Queries the document for a given data representation.
o Initialize(FilePath&): Initializes transaction.
o SetLogError(CATIExchangeLogError*): Initialize the Log Error File.
o SetOption(CATUnicodeString&,CATUnicodeString&): Set an XCAD option.

Methods

o Close

public virtual Close(

)

Ends the transaction on the document.

o GetDocumentDescription

public virtual GetDocumentDescription( oDescription)

Retrieves the document's description. This information is to be used in case there is a title given to the document.
Use Case: this is used in IGES to support the product description in the header.

Parameters:

oDescription: Get the document's description.

o GetDocumentPATH

public virtual GetDocumentPATH( oDocFileName)

Retrieves the document's filepath. (A document may be a file on the file system).

Parameters:

oDocFileName: Get the document's filepath.

o GetDocumentURL

public virtual GetDocumentURL( oDocURL)

Retrieves the document's URL. (A document may be an URL).

Parameters:

oDocURL: Get the document's URL.

o GetRepresentation

public virtual GetRepresentation(	const	`iRepresentationName`,
		`oExportRep`)

Queries the document for a given data representation. In case of multiple documents, request of Brep on product document made of heterogeneous formats will require the document to flatten its assembly representation as a single Brep (Use case to define and confirm).

Parameters:

iRepresentationName: Set the document representation to be queried.
oExportRep: Get the export representation, NULL_var if unavailable.

o Initialize

public virtual Initialize( const iFile)

Initializes transaction.

Parameters:

iFile: Set the filepath.

o SetLogError

public virtual SetLogError( iLogError)

Initialize the Log Error File.

Parameters:

iLogError: Set the LogError.

o SetOption

public virtual SetOption(	const	`iOptionName`,
	const	`iOptionValue`)

Set an XCAD option.

Parameters:

iOptionName: Set the option name.
iOptionValue: Set the option value.

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