All Frameworks  Class Hierarchy  This Framework  Indexes   

CATPDMReconcile Interface CATIPDMCharacteristicScm

Usage: you can freely reimplement this interface.


interface CATIPDMCharacteristicScm

Interface used by the Reconciliator in order to display and compare the characteristics of an object between its CATIA session and VPDM repository.
Role: Interface used by the Reconciliator in order to display and compare the characteristics of an object between its CATIA session and VPDM repository.

This interface is implemented by each characteristic.A characteristic depends of PDM environment.

In the facts a characteristic permits to know if there are obstacles to reconciliation searching data in PDM. A characteristic permits to compare these data to data of the object in session we want to reconcile. Consequently we have status on each characteristic we want to compare.

A characteristic is a late type which name is normalized: CATPDMCharac_Env_CharacName
With:

  1. Env the PDM environment
  2. and CharacName the criterion's name.

We deliver default implementations, but user can create their owns implementations.


Method Index


o ExecuteCharacteristic(CATScmObject*,CATUnicodeString**,CATListValCATUnicodeString**,CATListValCATUnicodeString**)
Executes the characteristic on defined PDM.
o GetName(CATUnicodeString&)
Provides characteristic name.
o IsApplicable(CATScmObject*)
Answers if the characteristic is applicable to an object.

Methods


o ExecuteCharacteristic
public virtual ExecuteCharacteristic( iCATRecObj,
oCharStatusList,
oCATCharList,
oPDMCharList)
Executes the characteristic on defined PDM.
Role: Executes the characteristic we want to compare between the object in session and the object stored in PDM and give a status
Parameters:
iCATRecObj
Object to reconcile
oCharStatusList
List characteristic’s status
oCATCharList
List of characteristics on CATIA side
oPDMCharList
List of characteristics on PDM side
Returns:
Error code of function.
Legal values: Returns S_OK if operation runs well.
o GetName
public virtual GetName( oName)
Provides characteristic name.
Role: Provide a NLS Display name of the characteristic.
Parameters:
oName
To output the Display name.
Returns:
Error code of function.
Legal values: Returns S_OK if operation runs well.
o IsApplicable
public virtual IsApplicable( iCATRecObj)
Answers if the characteristic is applicable to an object.
Role: Answers if the characteristic is applicable to an object.
Parameters:
iCATRecObj
Object on which characteristic need to be applied.
Returns:
Error code of function.
Legal values: Returns S_OK if operation runs well.

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

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