All Frameworks  Class Hierarchy  This Framework  Indexes   

CATPDMReconcile Interface CATIUExitPVRCommands

Usage: you can freely reimplement this interface.


interface CATIUExitPVRCommands

Interface to allow the user to implement customize behavior in context of Product View Result Creation or Synchronization.
Role: This interface is a user exit, that allows an customer to provide its own customization for when creating or synchronizing Product View Result (PVR).
You should implement it on the CATUExitPVRCommands component by using the CATObject mechanism on a late Type "CATUExitPVRCommands"


Method Index


o AfterPRCOpenFromPVR(CATDocument*,CATDocument*)
User Exit called after opening a PRC from PVR specication.
o GetDefaultNamesForPVRCreation(int,int,CATListValCATUnicodeString&,CATListValCATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Enables to define default name to be used in Product View Result (PVR) document creation command.
o UpdateAttributeOnPvrSynchro(CATDocument*,int,CATUnicodeString&,CATUnicodeString&)
Enables to update an attribute value on PVR document.

Methods


o AfterPRCOpenFromPVR
public virtual AfterPRCOpenFromPVR( ixPVRDoc,
ixPRCDoc)
User Exit called after opening a PRC from PVR specication.
Role: Enables to implement customer operation after the PRC is opened from a PVR opened in CATIA.
Parameters:
ixPVRDoc
[in] PVR CATProduct document.
ixPRCDoc
[in] PRC CATProduct document.
Returns:
S_OK if everything ran ok, otherwise...
o GetDefaultNamesForPVRCreation
public virtual GetDefaultNamesForPVRCreation( ilNewFrom,
ilFilteredPVR,
const iAttributeIdLst,
const iAttributeValueLst,
ioPVRName,
ioPVSName)
Enables to define default name to be used in Product View Result (PVR) document creation command.
Role: Enables to define default name for PVR and Expand Capture name in Product View Result document creation command. Note: User Exit will be called at PVR creation command initiation and when end-user will request to go back to default name concerning PVR or PVS.
Parameters:
ilNewFrom
[in] One existing Product View Result document will be used to initialized new PVR.
Legal values:
0
Means no PVR will be used to initialize the PVR to be created.
otherwise
All other values means one PVR new from is defined.
ilFilteredPVR
[in] PVR will be associated to an Expand Capture.
Legal values:
0
Means no Expand filter defined.
otherwise
All other values means one Expand filter will be used.
iAttributeIdLst
[in] List of attribute Id build by having a prefix for object type followed by character '.' as separator and the attribute Id.
Legal values:
PV.V_ID
For the attribute V_ID of the Part Version (root of the PVR assembly).
PRC.V_Name
For the attribute V_Name of the PRC (root of the PVR assembly or the assembly).

Legal values for object types:
PRC
Product Root Class representing the root of the assembly of the PVR to be created or the PRC on which the part instance is located.
PVS
Expand Capture (PVS) selected if defined in PVR creation command context.
PV
Part Version representing the root of the assembly of the PVR.
iAttributeValueLst
[in] List of attribute values corresponding to iAttributeIdLst.
ioPVRName
[inout] Default name for PVR to be created.
ioPVSName
[inout] Default name to be used in case of PVS creation.
Returns:
Method return code.
Legal values:
S_OK
If user exit run well.
E_FAIL
In case of error in the user exit.
o UpdateAttributeOnPvrSynchro
public virtual UpdateAttributeOnPvrSynchro( ixPVRDoc,
inIsyncNeeded,
ocAttrId,
ocAttrVal)
Enables to update an attribute value on PVR document.
Role: Enables to update an attribute value on document to capture in particular PVR synchronization status.
Parameters:
ixPVRDoc
[in] Product View Result document in loaded in CATIA session.
inIsyncNeeded
[in] Synchronization status.
Legal values:
0
Means that PVR product structure is up to date compared to ENOVIA structure.
1
Means that PVR product structure need to be synchronized.
ocAttrId
[out] Id of the attribute that need to be updated.
ocAttrVal
[out] Attribute value to be set.
Returns:
Method return code.
Legal values:
S_OK
If user exit run well and an attribute value needs to be updated.
S_FALSE
If user exit run well and no attribute update is required.
E_FAIL
In case of error in the user exit.

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

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