All Frameworks Class Hierarchy This Framework Indexes
CATPDMReconcile Class CATEpeDocument
Usage: you must use this class as is. You should never derive it.
public class CATEpeDocument
Class representing a CATIA document.
Role:
Define a CATIA document in a reconciliation session. Document to be
mapped on VPDM repository for reload/New/Overwrite operation.
Method Index
- o
GetApplicativeContainerMode(int&,CATUnicodeString&)
- Gets Applicative container save mode.
- o
GetCatiaName()
- Gets CATIA display name.
- 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(CATScmDocument*)
- Access to CAA reconciliator object from other reconciliator objects.
- o
SetApplicativeContainerMode(int,CATUnicodeString&)
- Sets Applicative container save mode.
Methods
o GetApplicativeContainerMode
| public GetApplicativeContainerMode( | | onMode, |
| | ocName) |
-
Gets Applicative container save mode.
Role: Gets Applicative container save mode.
This option is* only valid for CATProduct document.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- onMode
- Defines if an application container must be saved.
Legal values:
- 0 if an Applicative container has not to be saved.
- 1 if an Applicative container has to be saved.
- ocName
- Name of this application container.
o GetCatiaName
-
Gets CATIA display name.
Role: Gets CATIA display name
- Returns:
- String that represents the CATIA document name.
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
-
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 CATScmDocument.
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 CATEpeNode.
- Parameters:
-
- ixObj
- Internal session entity.
o SetApplicativeContainerMode
| public SetApplicativeContainerMode( | | inMode, |
| | icName) |
-
Sets Applicative container save mode.
Role: Sets Applicative container save mode.
This option is only valid for CATProduct document.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- inMode
- Defines if an application container must be saved.
Legal values:
- 0 if an Applicative container has not to be saved.
- 1 if an Applicative container has to be saved.
- icName
- Name of this application container.
This object is included in the file: CATEpeDocument.h
If needed, your Imakefile.mk should include the module: CATPDMReconcileModel