All Frameworks Class Hierarchy This Framework Indexes Previous Next

DataExchangeKernelItf Interface CATIExchangeOutputDocument

Usage: you can freely reimplement this interface.

interface CATIExchangeOutputDocument

Interface to exchange output documents.
Role: This interface describes the XCAD output document. The output document represents a CAD translator. It encloses the target document created thru the XCAD conversion.
Available from CATIA V5R11.

See also:

Method Index

o Close(): Ends the transaction on the document.
o GetOptionStatus(CATUnicodeString&,XCADOptionStatus&,CATUnicodeString&): Gets an option status
o Import(CATIExchangeInputDocument_var&): Start the data translation mechanism.
o Initialize(): Initializes transaction.
o SaveAs(FilePath*): Saves the document to a given file pointer.
o SetConversionOptions(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&): Sets the options for the XCAD conversion in 2 lists of same size.
o SetLogError(CATIExchangeLogError*): Initialize the Log Error File.

Methods

o Close

public virtual Close(

)

Ends the transaction on the document.

o GetOptionStatus

public virtual GetOptionStatus(	const	`iOptionName`,
		`oOptionStatus`,
		`oOptionMessage`)

Gets an option status

Parameters:

iOptionName: Set the option name.
oOptionStatus: Get the option status.
oOptionMessage: Get an additional message.

o Import

public virtual Import( iDocument)

Start the data translation mechanism.

Parameters:

iDocument: Set the document to be translated.

o Initialize

public virtual Initialize(

)

Initializes transaction.

o SaveAs

public virtual SaveAs( const iFile)

Saves the document to a given file pointer.

Parameters:

iFile: Set the filepath.
iFileType: Set the file type.

o SetConversionOptions

public virtual SetConversionOptions(	const	`iOptionNames`,
	const	`iOptionValues`)

Sets the options for the XCAD conversion in 2 lists of same size.

Parameters:

iOptionNames: Set the option names.
iOptionValues: Set the option values.

o SetLogError

public virtual SetLogError( const iLogError)

Initialize the Log Error File.

Parameters:

iLogError: Set the LogError.

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