All Frameworks Class Hierarchy This Framework Indexes
PSNInteroperability Class CATVPMServices
CATVPMServices
Usage: you must use this class as is. You should never derive it.
public class CATVPMServices
Class for VPM document services.
Role:This class delivers services to be used with ENOVIAvpm
Method Index
- o
SaveAsInVPM(CATDocument*,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,SaveAsMode)
- SaveAs of a document in ENOVIAvpm V4 .
- o
SetPDMProperties(CATDocument*,Env,VaultMode)
- Set the PDM properties of a document for ENOVIAvpm V4.
Enumerated Type Index
- o
Env
-
- o
SaveAsMode
-
- o
VaultMode
-
Methods
o SaveAsInVPM
-
SaveAs of a document in ENOVIAvpm V4 .
Role:This method allows save an ENOVIAvpm V4 document loaded in session by replacing
an existing document in the ENOVIAvpm V4 database.
This method has the same effect as the "Extract&Save" menu in ENOVIAvpm V4 client application.
It proposes three similar modes for save:
- "Replace by target" : this mode creates a new document in VPM and
replaces the modified document in the session by the new one.
All links are rerouted to the new document.
- "Keep Modified" : this mode creates a new document in VPM and
keeps all the modification in the original part in the CATIA Session
- "Reload From Source" : this mode creates a new document in VPM and
replaces the modified document in the session by the original version in the database.
All links pointing to the replaced document will be rerouted if possible.
If not, the corresponding links are broken.
If ENOVIAvpm application is VX0SERV : the commit in database is not done.
If ENOVIAvpm application is VX0VPM : the commit in database is done.
If needed, your Imakefile.mk should include the module: CATPinServices
- Parameters:
-
- iDoc
- the document to save
- iCoid
- the Coid of the document to overwrite (Hexadecimal 16 crc long)
- iCompid
- the Compid of the document to overwrite (Hexadecimal 16 crc long)
- iCatenv
- the VPM environment name of the document (8 crc long)
For instance: "VPMENV "
- iCatab
- the VPM DOCUMENT table name (18 crc long)
For instance: "DOCUMENT "
- iCnxString
- (optional) The connection string of the entity in VPM.
- iSaveMode
-
- ReplaceByTarget Replace
- KeepModified Keep Modified
- ReloadFromSource Reload original version
- Returns:
-
- S_OK: The SaveAs has been successfuly executed
- E_FAIL: the method failed
- E_INVALIDARG: one of the input arguments is incorrect
o SetPDMProperties
-
Set the PDM properties of a document for ENOVIAvpm V4.
Role:This method sets the PDM properties for ENOVIAvpm V4 of a document loaded in session.
It sets the environment type and the exposition mode of a document.
This method is intended to be used on a filebase document that will be saved in ENOVIAvpm V4.
This method has the same effect as the "Set PDM Properties" interactive CATIA menu.
The VPM1 environment is dedicated to ENOVIAvpm V4.
For this environment, two expositions modes are available as VaultMode:
- the Publications Exposed mode (PermanentBlackBox)
- the Structure Exploded mode (VolatileExposed)
The rules for setting the environment type and the exposition mode of a document are:
- if VaultMode is set to PermanentBlackBox,
the exposition mode is propagated to the children of the structure in session
- if VaultMode is set to VolatileExposed,
the exposition mode is not propagated to the children
- it is not possible to set VolatileExposed on a document if this document has already a
pointing document in Publication Exposed mode
- if the document comes from ENOVIAvpm V4 database:
- its PDM exposition mode can't be modified
- its PDM environment can't be changed to File
Note:Only CATProduct type document supports the Structure Exploded mode.
*
If needed, your Imakefile.mk should include the module: CATPinServices
- Parameters:
-
- iDoc
- the document on which we set the PDM properties
- iDocEnv
- the environment type to set to the document:
- File for filebased environment
- VPM1 for ENOVIAvpm V4 environment
- iVaultMode
- the exposition mode for VPM1 environment only:
- PermanentBlackBox for Publications Exposed
- VolatileExposed for Structure Exploded
- Returns:
-
- S_OK: The PDM properties has been successfuly set
- E_FAIL: incompatible input parameters
- E_FAIL: the method failed
Enumerated Types
o Env
-
enum Env {
File,
VPM1
}
o SaveAsMode
-
enum SaveAsMode {
ReplaceByTarget,
KeepModified,
ReloadFromSource
}
o VaultMode
-
enum VaultMode {
PermanentBlackBox,
VolatileExposed
}
This object is included in the file: CATVPMServices.h
If needed, your Imakefile.mk should include the module: CATPinServices