All Frameworks  Class Hierarchy  This Framework  Indexes   

CATPDMReconcile Class CATEpeSession

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


public class CATEpeSession

Enables to manage a reconciliation session.
Role: CATEpeSession class federates all information that are managed during a Reconciliation operation.
A typical reconciliation process is made of following steps

  1. Initiate reconciliation session by creating a CATEpeSession with one one CATIA document in input.
  2. Get list of Documents to be reconciled using CATEpeSession::GetTopLevelObjectsfrom. (CATEpeObject )
  3. Set a Reconciliation rule on all relevant CATEpeObject. Rule could be applied on a CATEpeObject that represents either a CATIA Document or an ASM Product.
    If rule already set for this object, it will overwrite previous value.
  4. Execute Reconciliation using CATEpeSession::ExecuteReconciliation.

This class will also enable to access all ressources that are used in a Reconciliation, such as:
See also:
CATEpeObject


Method Index


o BuildVpdmView(CATEpeSession*&)
Creates VPDM product structure view.
o CloseReconcileSession()
Closes Reconciliation Session.
o CreateReconcileSession(CATLISTP(CATDocument)&,CATEpeSession*&)
Creates and returns the Reconciliation Session, if it is authorized Role: Creates and returns the Reconciliation Session, if there is no previous CATEpeSession existing.
o ExecuteProductStructureComparison(CATEpeInstance*&)
Executes Product structure comparison.
o ExecuteReconciliation()
Starts reconciliation Execution.
o GetComparisonStructure(CATEpeInstance*&)
Access to Product structure comparison results.
o GetEnvironment(CATUnicodeString&)
Gets the default Environment selected.
o GetEnvironments(CATListValCATUnicodeString&)
Gets list of authorized Environments.
o GetExposedEntity()
Access to object reconciliator internal object.
o GetExposedEntity(CATScmSession*)
Access to CAA reconciliator object from other reconciliator objects.
o GetSupportedDocumentTypes(CATListValCATUnicodeString*)
Gets list of supported Document Types in the Context of Reconciliation.
o GetTopLevelObjects(CATListOfCATEpeNode*)
Gets list of document Objects to be reconciled.
o IsDocTypeAuthorized(CATUnicodeString&)
Checks if this type of document is supported by reconciliator.
o IsEnvironmentAuthorized(CATUnicodeString&)
Checks if it is a supported environment for Reconciliator.
o IsExecuteAuthorized(CATBoolean&)
Checks if reconciliation Execution could be called.
o IsProdStructComparisonAvailable(CATBoolean&)
Checks if Product structure comparison is available.
o SetEnvironment(CATUnicodeString&)
Defines default Environment where objects need to be stored.

Enumerated Type Index


o CATReconcileRule
Enumeration of authorized rules.
o CATStorageMode
Enumeration of authorized storage mode.

Methods


o BuildVpdmView
public BuildVpdmView( oxVPDMSession)
Creates VPDM product structure view. Role: Create VPDM product structure view.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
oxVPDMSession
Session containing result of VPDM Product structure .
o CloseReconcileSession
public CloseReconcileSession()
Closes Reconciliation Session. Role: Closes Reconciliation Session.
o CreateReconcileSession
public static CreateReconcileSession( iLstDocIn,
oScmSession)
Creates and returns the Reconciliation Session, if it is authorized Role: Creates and returns the Reconciliation Session, if there is no previous CATEpeSession existing.
Returns:
Method return code
Legal values: Returns S_OK and 2 if there is already one Session existing.
Parameters:
iLstDocIn
List of CATDocument.
oScmSession
Pointer to newly created CATEpeSession .
o ExecuteProductStructureComparison
public ExecuteProductStructureComparison( oxTreeResult)
Executes Product structure comparison. Role: Executes Product structure comparison.
Note:Nothing will be done inside VPDM repository or inside CATIA session.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
oxTreeResult
Root of the assembly comparison structure.
o ExecuteReconciliation
public ExecuteReconciliation()
Starts reconciliation Execution. Role: Update CATIA session according what has been defined through Reconciliation rules on objects. Nothing will be done inside VPDM repository before save in VPDM will be requested.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
o GetComparisonStructure
public GetComparisonStructure( oxTreeResult)
Access to Product structure comparison results. Role: Access to Product structure comparison results.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
oxTreeResult
Root of the assembly comparison structure.
o GetEnvironment
public GetEnvironment( ocEnv)
Gets the default Environment selected. Role: Gets default Environment where objects will be stored.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
ocEnv
Environment.
o GetEnvironments
public static GetEnvironments( iocEnvListName)
Gets list of authorized Environments. Role: Gets list of authorized Environments.
Precondition: Assumes that the address of an already built CATListValCATUnicodeString is passed.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
iocEnvListName
List names of authorized Environments.
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 CATEpeSession.
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 GetSupportedDocumentTypes
public static GetSupportedDocumentTypes( oDocTypeList)
Gets list of supported Document Types in the Context of Reconciliation. Role: Gets list of supported Document Types in the Context of Reconciliation.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
oDocTypeList
List of document type supported in reconciliation operations.
o GetTopLevelObjects
public GetTopLevelObjects( ioListOfObjects)
Gets list of document Objects to be reconciled. Role: Gets list of document Objects to be reconciled. ( CATEpeObject ) If CATEpeObject corresponds to CATProduct and Structure Exposed is selected, then top level will delegate Reconciliation to their part children (second level of CATEpeObject)
Precondition: Assumes that the address of an already built CATListPtrCATEpeObject is passed.
Postcondition: List only to be emptied by RemoveAll and individual objects not to be deleted.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
ioListOfObjects
List of CATEpeObjects to be reconcilied.
o IsDocTypeAuthorized
public static IsDocTypeAuthorized( const icDocType)
Checks if this type of document is supported by reconciliator. Role: Checks if this type (DocType) of document is supported by reconciliator.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
icDocType
Document type.
o IsEnvironmentAuthorized
public IsEnvironmentAuthorized( const icEnvironment)
Checks if it is a supported environment for Reconciliator. Role: Checks if this type (Environment) is supported by reconciliator.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
icEnvironment
Environment late type.
o IsExecuteAuthorized
public IsExecuteAuthorized( oResult)
Checks if reconciliation Execution could be called. Role: Checks if reconciliation Execution could be called, ie Reconciliation rules are defined on all objects ( CATEpeObject ).
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
oResult
Indicates if Execute reconciliation is authorized.
Legal values:
  • TRUE if ExecuteReconciliation method could be called.
  • FALSE otherwise.
o IsProdStructComparisonAvailable
public IsProdStructComparisonAvailable( oResult)
Checks if Product structure comparison is available. Role: Checks if Product structure comparison information are available, ie at least one Document Reconciliation rules is set to Structure exposes.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
oResult
Indicates if Product structure comparison could computed.
Legal values:
  • TRUE if ExecuteProductStructureComparison method could be called.
  • FALSE otherwise.
o SetEnvironment
public SetEnvironment( const icEnv)
Defines default Environment where objects need to be stored. Role: Defines default Environment where objects need to be stored.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
icEnv
String defining the Environment.
Legal values: Could be found using
CATEpeSession.GetEnvironments.

Enumerated Types


o CATReconcileRule
enum CATReconcileRule {
  PUBEXP_RELOADFRMPDM,
  PUBEXP_OVERWRITEINPDM,
  PUBEXP_NEWOBJECT,
  PUBEXP_EXTERNALREFERENCE,
  PRODSTRUCTEXP_NEWOBJECT,
  PRODSTRUCTEXP_OVERWRITEINPDM,
  PRODSTRUCTEXP_RELOAD,
  PRODSTRUCTEXP_IGNORE,
  PRODSTRUCTEXP_CAP,
  DELEGATE,
  UNKNOWN,
  PUBEXP_NEWREVISION,
  PUBEXP_NEWVERSION,
  PUBEXP_NEWFROM,
  PRODSTRUCTEXP_NEWVERSION,
  PRODSTRUCTEXP_OVERWRITEBYDELTA,
  PRODSTRUCTEXP_NEWVERSIONBYDELTA,
  ALL_RULES,
  NO_RULE
}
Enumeration of authorized rules.
Role: Enumeration of authorized rules. We have 3 categories of status for reconciliation rules:
  • Rules corresponding to Publication exposed:: PUBEXP_RELOADFRMPDM, PUBEXP_OVERWRITEINPDM and PUBEXP_NEWOBJECT.
  • Rules corresponding to Structure exposed: PRODSTRUCTEXP_NEWOBJECT and PRODSTRUCTEXP_OVERWRITEINPDM.
  • Other rules: PRODSTRUCTEXP_RELOAD, PRODSTRUCTEXP_IGNORE, DELEGATE and UNKNOWN.
Parameters:
PUBEXP_RELOADFRMPDM
Reload document from VPDM repository.
PUBEXP_OVERWRITEINPDM
Overwrite document in VPDM repository.
PUBEXP_NEWREVISION
Overwrite document as a new revision in VPDM repository.
PUBEXP_NEWVERSION
Overwrite CATPart or CATProduct document with a new version requested on its root part in VPDM repository.
PUBEXP_NEWOBJECT
Save document as New in VPDM repository.
PUBEXP_NEWFROM
Save document as New document initialized for an existing one.
PUBEXP_EXTERNALREFERENCE
Used to manage keep broken links as is after reconciliation.
PRODSTRUCTEXP_OVERWRITEINPDM
Overwrite Part in VPDM repository.
PRODSTRUCTEXP_NEWVERSION
Overwrite Part as a new version in VPDM repository.
PRODSTRUCTEXP_NEWOBJECT
Save Part as new in VPDM repository.
PRODSTRUCTEXP_RELOAD
Part associated to a CATIA V4 model or to a CATShape with PUBEXP_RELOADFRMPDM as reconciliation rule.
PRODSTRUCTEXP_IGNORE
Part associated to a CATIA V4 model or to a CATShape with PUBEXP_EXTERNALREFERENCE as reconciliation rule.
PRODSTRUCTEXP_CAP
For future usage.
DELEGATE
Reconciliation rule is defined on children objects
UNKNOWN
No rule set.
ALL_RULES
All rules masks.
NO_RULE
No rules masks.
o CATStorageMode
enum CATStorageMode {
  PUBLICATION_EXPOSED,
  STRUCTURE_EXPOSED,
  BOTH_EXPOSED,
  NO_STORAGE_MODE
}
Enumeration of authorized storage mode.
Role: Enumeration of storage mode.
Parameters:
PUBLICATION_EXPOSED
Document will be saved in vault and only publications are exposed in VPDM repository.
STRUCTURE_EXPOSED
Document will be not saved in vault and document content is exposed in VPDM repository.
BOTH_EXPOSED
Document will be saved in vault as reference and document content is exposed in read only mode in VPDM repository.
NO_STORAGE_MODE
Storage mode not defined.

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

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