All Frameworks  Class Hierarchy  This Framework  Indexes   

CATPDMReconcile Class CATEpeProxyDocument

Usage: you must use this class as is. You should never derive it.


public class CATEpeProxyDocument

Class representing a not loaded CATIA document.
Role: Define a not loaded CATIA document in a reconciliation session. Document to be reloaded from VPDM repository.


Method Index


o GetDirectoryPath()
Gets directory path of the not loaded CATIA document.
o GetDocumentType()
Gets document type.
o GetExposedEntity()
Access to object reconciliator internal object.
o GetExposedEntity(CATScmProxyDocument*)
Access to CAA reconciliator object from other reconciliator objects.
o GetFilePath()
Gets file path of the not loaded CATIA document.

Methods


o GetDirectoryPath
public GetDirectoryPath()
Gets directory path of the not loaded CATIA document.
Role: Gets directory path of the not loaded CATIA document.
Returns:
String that represents the directory path.
o GetDocumentType
public GetDocumentType()
Gets document type.
Role: Gets document type of the not loaded CATIA document.
Returns:
String that represents the document type.
o GetExposedEntity
public GetExposedEntity()
Access to object reconciliator internal object. Role: Access to object reconciliator internal object..
Returns:
Method return code
Legal values: Returns NULL if one error occur, otherwise provide access associated CATScmProxyDocument.
o GetExposedEntity
public static GetExposedEntity( const ixObj)
Access to CAA reconciliator object from other reconciliator objects. Role: Access to CAA reconciliator object from other reconciliator objects.
Returns:
Method return code
Legal values: Returns NULL if one error occur, otherwise provide access associated CATEpeProxyDocument.
Parameters:
ixObj
Internal session entity.
o GetFilePath
public GetFilePath()
Gets file path of the not loaded CATIA document.
Role: Gets complete file path of the not loaded CATIA document.
Returns:
String that represents the complete file path.

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

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