All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFunctionalModelerUseItf Interface CATIFctRepReferenceNonCATIAContent

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIFctRepReferenceNonCATIAContent

Interface providing means to manage non CATIA document associated to a Functional Representation Reference.

Role: This interface, only implemented on Functional Representation Reference with non CATIA content, provides means to check-in/check-out the associated non CATIA document.

Method Index

o CheckIn(CATUnicodeString): Updates the stream associated to this Representation Reference using the given file identified by its path.
o CheckOut(CATUnicodeString&): Exports the stream associated to this Functional Representation Reference in the file system.

Methods

o CheckIn

public virtual CheckIn( const iDocumentPath)

Updates the stream associated to this Representation Reference using the given file identified by its path.
The file type has to match the kind of document type specified at the Representation Reference creation.

Parameters:

iDocumentPath: A file path (including its extension).
Input Parameter.
This parameter MUST NOT be provided by caller as empty. This method returns an error otherwise.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

o CheckOut

public virtual CheckOut( iDocumentPath)

Exports the stream associated to this Functional Representation Reference in the file system.

Parameters:

iDocumentPath: A path corresponding to the stream associated to the Representation Reference.
The extension of the filename has to be the same than the type defined at the creation of the non CATIA content Representation.
Input parameter.
This parameter MUST NOT be provided by caller as empty. This method returns an error otherwise.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

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