All Frameworks  Class Hierarchy  This Framework  Indexes   

CATPDMReconcile Class CATEpeNode

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


public class CATEpeNode

Generic class to manage nodes in the test scenario structure.
Role: All information in this domain will be managed as nodes in a tree structure. Each node is typed and contains tags with valuation. The list of tags on a node depends on the node type.
The intend of those structure is to enable comparison between assembly structure stored. in many different system CATIA document in session or in ENOVIA systems.
The root node of those trees is a CATEpeInstance.


Constructor and Destructor Index


o CATEpeNode()
Constructs an accessor to a Reconciliation object (generic node object with no name).
o CATEpeNode(CATEpeNode&)
Copy constructor.
o ~CATEpeNode()
Destructor of the Reconciliator object accessor.

Method Index


o CreateNode(int,CATEpeNode*)
Create a Reconciliation object.
o GetChildren(int)
Gets children of a CATEpeNode.
o GetComparisonStatus()
Gets comparison status of an object.
o GetExposedEntity()
Access to object reconciliator internal object.
o GetExposedEntity(CATScmNode*)
Access to CAA reconciliator object from other reconciliator objects.
o GetFather()
Gets the father node.
o GetName()
Gets name.
o GetPDMId()
Gets the PDM Id.
o GetPdmTimeStamp()
Gets VPDM object Timestamp.
o GetStatus()
Gets Rule status of an object.
o GetType()
Gets the node type.
o IsOfType(int)
Checks that a node is of a certain type.
o Print(char* const)
Print a report on standard output.
o RemoveNode()
Enables to request deletion of a Reconciliation Object.
o ScanChildren(CATEpeNode* const)
Gets next child.
o ScanChildren(int,CATEpeNode* const)
Gets next child of a defined type.
o SetComparisonStatus(CATEpeNodeStatus)
Sets status of an object.
o SetName(CATUnicodeString&)
Sets the node name.
o operator=(CATEpeNode&)
Assignment operator from another object node.

Enumerated Type Index


o CATEpeNodeStatus
List of authorized comparison status.
o CATRecStatus
Enumeration of defining the rule status of an Object.

Constructor and Destructor


o CATEpeNode
public CATEpeNode()
Constructs an accessor to a Reconciliation object (generic node object with no name).
Role: This method does not create Reconciliation object, it just create an accessor to a Reconciliation object. To really add a Reconciliation object, you have to use CreateNode method.
o CATEpeNode
public CATEpeNode( const ixNode)
Copy constructor.
Parameters:
ixNode
Object accessor to be duplicated.
o ~CATEpeNode
public ~CATEpeNode()
Destructor of the Reconciliator object accessor.
Role: This method does not remove Reconciliation object it just deletes the accessor to the Reconciliation object. To really remove a Reconciliation object, you have to use RemoveNode method.

Methods


o CreateNode
public static CreateNode( inType= CATEpeNodeUnknown ,
ixFather= NULL )
Create a Reconciliation object.
Role: Enables to create a Reconciliation Object of a certain type.
Parameters:
inType
Node type
Legal values: see
CATScmNode
ixFather
Father node for this object.
See also:
CATEpeInstance, CATEpePartVersion, CATEpeFirstLevelInstance
o GetChildren
public GetChildren( inInTypeNode)
Gets children of a CATEpeNode.
Role: Gets children of a CATEpeNode.
Parameters:
inInTypeNode
Defines the type node you want to query on.
Legal values: It can be set to either:
  • CATEpeNodeUnknown To search among all child nodes.
  • CATEpeNodeDocument To search among object node type (Document, part, instance...).
  • CATEpeNodeProxyDocument To search among document not loaded (Proxy-document).
  • CATEpeNodeInstance To search among instance of Part Version.
  • CATEpeNodePartVersion To search among all "Part version" Objects.
  • CATEpeNodeFirstLevelInstance To search among all "Assembly Relation" Objects.
  • CATEpeNodeSession To search among all CATEpeSession Objects.
Returns:
List of Nodes.
o GetComparisonStatus
public GetComparisonStatus()
Gets comparison status of an object.
Role: Gets comparison status of an object among authorized status.
Returns:
Object status among authorized status.
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 CATScmNode.
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 CATEpeNode.
Parameters:
ixObj
Internal session entity.
o GetFather
public GetFather()
Gets the father node.
Role: Gets the father node of the current object.
Returns:
Father node object.
o GetName
public GetName()
Gets name.
Role: Gets the object name.
Returns:
Object name.
o GetPDMId
public GetPDMId()
Gets the PDM Id.
Role: Gets the PDM Id.
Returns:
Object PDM Id.
o GetPdmTimeStamp
public GetPdmTimeStamp()
Gets VPDM object Timestamp.
Role: Gets VPDM object Timestamp.
Returns:
Returns VPDM time stamp of this object
o GetStatus
public GetStatus()
Gets Rule status of an object.
Role: Gets rule status of an object among authorized status.
Returns:
Object status among authorized status.
o GetType
public GetType()
Gets the node type.
Role: Gets the object type information.
Returns:
Gets the node type
Legal values: It can be set to either:
  • CATEpeNodeUnknownObject type not define
o IsOfType
public IsOfType( inType)
Checks that a node is of a certain type.
Role: Checks that a node is of a certain type with respect to inheritance.
Returns:
  • 1 if the CATEpeNode is to type inType
  • O otherwise
    • Parameters:
      inType
      Object type.
o Print
public Print( const cInfo= NULL )
Print a report on standard output.
Role: Print the content of this node and its children.
Parameters:
inLevel
Enable to have an indented presentation according to the tree depth of the node.
o RemoveNode
public RemoveNode()
Enables to request deletion of a Reconciliation Object.
Role: Enables to request deletion of a Reconciliation Object. This operation will remove the object from the memory and cut all relationship of this object from another objects in the session. This operation is in particular requested in the case of implementation of Product structure comparison User Exit.
o ScanChildren
public ScanChildren( const ixPrevious)
Gets next child.
Role: Scans the list of children of current node object.
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 first child
    o ScanChildren
    public ScanChildren( inInTypeNode,
    const ixPrevious)
    Gets next child of a defined type.
    Role: Scans the list of children having a defined type.
    Returns:
    Next child object node.
    Return NULL if ixPrevious is not a child of current node or if it is the last child
    Parameters:
    inInTypeNode
    Defines the type node you want to query on.
    Legal values: It can be set to either:
    • CATEpeNodeDocument To search among object node type (Document, part, instance...).
    • CATEpeNodeProxyDocument To search among document not loaded (Proxy-document).
    • CATEpeNodeInstance To search among instance of Part Version.
    • CATEpeNodePartVersion To search among all "Part version" Objects.
    • CATEpeNodeFirstLevelInstance To search among all "Assembly Relation" Objects.
    • CATEpeNodeSession To search among all CATEpeSession Objects.
    ixPrevious
    Current child object.
    Legal values:
    • NULL to get the first child
      o SetComparisonStatus
      public SetComparisonStatus( inStatus)
      Sets status of an object.
      Role: Sets status of an object among authorized status.
      Parameters:
      inStatus
      Object status among authorized status.
      o SetName
      public SetName( const icName)
      Sets the node name.
      Role: Sets the instance id.
      Returns:
      Returns error code
      Parameters:
      icName
      Node name.
      o operator=
      public operator=( const ixNode)
      Assignment operator from another object node.
      Parameters:
      ixNode
      Object accessor used as reference for the assignment.

      Enumerated Types


      o CATEpeNodeStatus
      enum CATEpeNodeStatus {
        UnknownStatus,
        IdenticalStatus,
        InstanceMovedStatus,
        NewInstanceStatus,
        SuppressInstanceStatus,
        IgnoreStatus,
        OnlyVPDMStatus
      }
      
      List of authorized comparison status.
      Parameters:
      UnknownStatus
      No comparison status defined.
      IdenticalStatus
      Object identical both in CATIA and VPDM repository.
      InstanceMovedStatus
      Object identical, but instance moved between CATIA and VPDM repository.
      NewInstanceStatus
      Object known only in CATIA.
      IgnoreStatus
      Object existing in CATIA, but not to be saved in VPDM repository.
      SuppressInstanceStatus
      Object not existing in CATIA, but present in VPDM repository.
      o CATRecStatus
      enum CATRecStatus {
        NOTCOMPLETED,
        COMPLETED,
        INHERITED
      }
      
      Enumeration of defining the rule status of an Object.
      Parameters:
      NOTCOMPLETED
      Reconciliation rule not completely defined for this object.
      COMPLETED
      Reconciliation rule completely defined for this object.
      INHERITED
      Reconciliation rule defined by inheritance from another object. Example: Assembly Product associated to CATIA V4 model will inherited information about reconciliation from the rule set on the CATIA V4 model (the associated shape). .

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

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