All Frameworks  Class Hierarchy  This Framework  Indexes   

CATPDMReconcile Class CATEpeInstance

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


public class CATEpeInstance

Class representing an instance of Part in an Assembly structure.
Role: Define an instance of CATEpePartVersion within an Assembly structure.


Method Index


o GetAssemblyRelation()
Gets the Assembly relation reference of this instance.
o GetExposedEntity()
Access to object reconciliator internal object.
o GetExposedEntity(CATScmInstance*)
Access to CAA reconciliator object from other reconciliator objects.
o GetReference()
Gets the Part reference of this instance.
o ScanInstanceTree(CATEpeInstance*,int&)
Gets next child in the instance tree.
o SetAssemblyRelation(CATEpeFirstLevelInstance* const)
Sets the Assembly relation reference of this instance.

Methods


o GetAssemblyRelation
public GetAssemblyRelation()
Gets the Assembly relation reference of this instance.
Role: Gets the Assembly relation reference of this instance.
Returns:
Assembly relation object.
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 CATScmInstance.
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 CATEpeInstance.
Parameters:
ixObj
Internal session entity.
o GetReference
public GetReference()
Gets the Part reference of this instance.
Role: Gets the father Part of the current object.
Returns:
Father part.
o ScanInstanceTree
public ScanInstanceTree( ixPrevious,
ionUpDown)
Gets next child in the instance tree.
Role: Scans assembly structure instance tree (in depth first).
Returns:
Next child object node.
Return NULL if ixPrevious is not a child of current node or if it is the last child
Parameters:
ixPrevious
Current child object.
Legal values:
  • NULL To get the the root of the assembly (the CATEpeInstance itself) and depth level is initialized to 0.
ionUpDown
Level of depth on the CATEpeInstance. This value is initialized to 0 when full assembly scan is done or when scan is initialized (NULL value for ixPrevious). Otherwise computed by incrementation or decrementation of the input value.
o SetAssemblyRelation
public SetAssemblyRelation( ixAR)
Sets the Assembly relation reference of this instance.
Role: Sets the Assembly relation reference of this instance.
Parameters:
ixAR
Assembly relation object.

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

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