What You Will Learn With This Use Case

The following operations are detailed is this use case:

How to create a CATIA V5 session
How to open a CATIA V5 document
How to Initialize the Electrical Environment
How to Filter the current session with a criteria (say CRIT1)
How to close the Document and the session

The CAAFilterSample Use Case

CAAFilterSample is a use case of the CAAElecRoutingItf.edu framework that illustrates the use of the CATIEleUipFilteringCriteria interface capabilities.

What Does CAAFilterSample Do

The goal of CAAFilterSample is to filter out devices/supports/BNSs in a given Harness Network through which no wires are routed.

How to Launch CAAFilterSample

To launch CAAFilterSample you will need to set up the build time environment, then compile CAAUipFilteringCriteriaExt.cpp ( which implements CATIEleUipFilteringCriteria interface) and CAAEwrFilter.cpp ( which calls the APIs of CATIEleUipFilteringCriteria for Filtering Mgmt) along with its prerequisites, set up the run time environment, and then execute the sample.

To launch the use case, execute the following command:

mkrun -c CAAEwrFilter input_data.CATProduct <OutPutFolder>
input_data.CATProduct - the path where the file is stored and the name of the CATProduct document to be opened.Unix InstallRootDirectory/CAAElecRoutingItf.edu/CNext/resources/graphic/CAAEwrFilter/CAA_EwrFilterSample.CATProduct
Windows InstallRootDirectory\CAAElecRoutingItf.edu\CNext\resources\graphic\CAAEwrFilter\CAA_EwrFilterSample.CATProduct

<OutPutFolder> - the path where the file(s) will be stored after applying the Filter Criterion.

Where to Find the CAAFilterSample related Code

The code needed for CAAFilterSample is located in the CAAEwrCriteria.m use case module and CAAEwrFilter.m use case module of the CAAElecRoutingItf.edu framework:

Unix InstallRootDirectory/CAAElecRoutingItf.edu/CAAEwrCriteria.m /src/CAAUipFilteringCriteriaExt.cpp
Windows InstallRootDirectory\CAAElecRoutingItf.edu\CAAEwrCriteria.m\src\CAAUipFilteringCriteriaExt.cpp

Unix InstallRootDirectory/CAAElecRoutingItf.edu/CAAEwrFilter.m/src/CAAEwrFilter.cpp
Windows InstallRootDirectory\CAAElecRoutingItf.edu\CAAEwrFilter.m\src\CAAEwrFilter.cpp

where InstallRootDirectory is the root directory of your CAA V5 installation.

Step-by-Step

There are 5 steps in CAAEwrListWiresInBundleSegment:

1. Prolog
2. Initializing Electrical Environment
3. Filtering Session with Criteria
4. Saving Session
5. Epilog.

We will now comment each of those sections by looking at the code.

Following is a SNAPSHOT OF THE HARNESS PRODUCT being treated for Filtering Criteria.
It is desired to Hide Devices and Bundle Segments not connected and or routed through by Wires which affiliate to the criteria( say CRIT1)



1. Prolog:
Creating the Session and Opening an Existing CATProduct Document.
Retrieving the Root Product of the CATProduct Document.

 

2.Initializing Electrical Environment
To initialize the electrical environment, use the CATIElecDocServices interface:



3. Filtering Session with Criteria CRIT1
Lets say Wire.1, Wire.3 and Wire.5 are deactivated from the Session. This state corresponds to the CRIT1 Criteria to be
applied for filtering the Document opened in Session.



 

Applying the Criteria CRIT1 causes the following changes in the Product opened in the session. ( Wire2, Wire4, Wire6, Wire7 are deactivated from the session)


4. Saving Session
After applying the Filter Criteria, save the session with the filtered Products in an output folder which was provided as a third argument to the "mkrun -c CAAEwrFilter.." launch.



5. Epilog
Remove The Document From Session.
To remove the document, use the CATDocumentServices::Remove method.




When the Filtered Product is opened in CATIA, due to the application of Criteria CRIT1, it is now seen as follows