Lifecycle Applications

What You Will Learn With This Use Case

This use case is intended to show you how to add an existing object, in this case a part version, to an existing Engineering Change Order as an affected object. You will then see how to remove the affected object from the ECO. This example uses an ECO but the technique is the same for Actions, and Engineering Change Requests. You would use this operation if for example you would like to direct the modification of a certain part version. The part version is attached to the ECO as an affected object and the ECO controls the modification of the part. The ECO cannot be released until the work on the part is completed. Other affected objects include documents and tables of content. The ENOVInterfaces framework contains the interface ENOVICWAffectedObjects which allows you to directly add and remove affected objects for Change Management objects.

[Top]

The CAAEviAffectedObjects Use Case

CAAEviAffectedObjects is a use case of the CAAENOVInterfaces.edu framework that illustrates how you use the ENOVICWAffectedObjects interface to add and remove an affected object for to an existing Change Management object.

[Top]

What Does CAAEviAffectedObjects Do?

CAAEviAffectedObjects begins by opening a VPM session and creating a login a session. Then the Eco Manager is retrieved. To set up the demonstration, an ECO is created with the necessary parameters as well as a part version. For more information on how to create an ECO, refer to use case CAAEviEcoManager and refer to CAAEviActionManager to see how Actions and ECRs are created. After the necessary objects are created, the subject interface is used to add the part version to the ECO as an affected object and subsequently remove it.

The ENOVInterfaces interface/methods shown here are:

• ENOVICWAffectedObjects.h - AddAffectedObject
• ENOVICWAffectedObjects.h - RemoveAffectedObject

[Top]

How to Launch CAAEviAffectedObjects

To launch CAAEviAffectedObjects, you will need to set up the build time environment, then compile CAAEviAffectedObjects.cpp along with its prerequisites, set up the run time environment, and then execute the use case. The required interfaces can be found in the ENOVInterfaces, VPMInterfaces, VPMPersistency, System, and VPMTpManager frameworks. From the directory where the executable file is stored, enter"CAAEviAffectedObjects" to execute the program. [1].

[Top]

Where to Find the CAAEviAffectedObjects Code

The CAAEviAffectedObjects use case is made of a single file located in the CAAEviAffectedObjects.m module of the CAAENOVInterfaces.edu framework:

where InstallRootDirectory is the directory where the CAA CD-ROM is installed.

[Top]

Step-by-Step

For demonstration purposes, the code from the CAAEviAffectedObjects use case is shown here. After the preliminary set up of creating the ECO and part version, there are two logical steps:

• Add affected object to an ECO
• Remove affected object from ECO

[Top]

Add affected object to an ECO

    #include "ENOVICWAffectedObjects.h"
    #include "CATIVpmAFLAffectedObject.h"
    #include "CATUnicodeString.h"
    

These include statements give access to the interfaces demonstrated here.

//--- Add a Part Version as an Affected Object to ECO
  
    CATUnicodeString AOType("ENOVIA_CMAFFECTED_OBJECT");
    CATIVpmAFLAffectedObject_var AffObj = NULL_var;
    ENOVICWAffectedObjects_var spAffObj(Eco);
        
    rc = spAffObj->AddAffectedObject(partVersion, 
    				    AOType,
    				    AffObj);
    
    if (AffObj==NULL_var||rc!=S_OK)
    {
    	cout << "Failed to Add Affected Object." << endl;    
    	VPMSession::CloseSession();
    	return 7;
    }

    cout << "Added Affected Object succesfully." << endl;    
      

1. After the VPM session is opened, and the ECO and part version created, you can use the ENOVICWAffectedObjects interface to add the affected object to the ECO.
2. First, the ECO object, Eco, is cast as a ENOVICWAffectedObject type - spAffObj.
3. With the type AOType set as "ENOVIA_CMAFFECTED_OBJECT", spAffObj calls method AddAffectedObject.
4. The method returns S_OK if successful and the affected object AffObj is created.

[Top]

Remove affected object from ECO

    #include "ENOVICWAffectedObjects.h"
    #include "CATIVpmAFLAffectedObject.h"
        

These include statements gives access to the operations demonstrated here.

//--- Remove Affected Object from ECO
  
    rc = spAffObj->RemoveAffectedObject(AffObj);
    
    if (!SUCCEEDED(rc))
    {
    	cout << "ERROR in Removing Affected Object." << endl << flush;    
    	VPMSession::CloseSession();
    	return 8;
    }

    cout << "Removed Affected Object succesfully." << endl << flush;  
      

1. With the ECO object cast as a ENOVICWAffectedObject type - spAffObj, a call is made to method RemoveAffectedObject with the the affected object, AffObj, as a parameter.
2. The method returns S_OK if successful and the affected object AffObj is removed from the ECO.

[Top]

In Short

Use the ENOVICWAffectedObjects interface available in the ENOVInterfaces framework to add and remove an existing object as an affected object for a Change Management object.

[Top]

References

History

Copyright © 1994-2002, Dassault Systèmes. All rights reserved.