Equipment & Systems Engineering

What You Will Learn With This Use Case

This use case is intended to help you make your first steps in programming with CATIA EHF Interfaces. Its main intent is to allow you to flatten a harness.

[Top]

The CAAEhfFlattenManager Use Case

CAAEhfFlattenManager.m is a use case of the CAAElecFlatteningItf.edu framework that illustrates the CATIA EHF Interfaces framework capabilities.

[Top]

What Does CAAEhfFlattenManager Do?

The goal of CAAEhfFlattenManager use case is to show how to flatten a harness.

                                               [Top]

How to Launch CAAEhfFlattenManager ?

• To launch CAAEhfFlattenManager , you will need to set up the build time environment, then compile CAAEhfFlattenManager 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 "CAAEhfFlattenManager input.CATProduct"

   

• input.CATProduct - the path to the existing external CATProduct to be browsed. You may reference the supplied CATProduct document called "Extracted.CATProduct" found in the 'WS'/'OS'/resources/graphic/ModelFlattenManager directory if under Unix. In this case, 'OS' can be any of the following:
  • aix_a for IBM
  • hpux_a for HP
  • solaris_a for SUN

Under Windows, the path would indicate:

'WS'\intel_a\resources\graphic\ModelFlattenManager directory.

[Top]

 Where to Find the CAAEhfFlattenManager Code

The CAAEhfFlattenManager  sample is made of a single class named CAAEhfFlattenManager located in the CAAEhfFlattenManager.m module of the CAAElecFlatteningItf.edu framework:

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

This sample deals with the following classes:

[Top]

Step-by-Step

------------------------------------------

We will now first comment the Electrical environment and it’s components creation by looking at the code of the Main . There are 8 logical steps in Main :

[Top]

Check the input data.

...
if ( 2 > argc ) 
{
retCode = 1; 
goto EscapeWay;
}
...

[Top]

Create a session and open the document.

We need a CATSession pointer to create the Session.

...
pSession = CATSession::Create_Session(sessionIdent);

...

We need a CATDocument pointer to opening the document.

...
CATDocumentServices::Open(argv[1], pDoc, cusInType);

...

Once the current session has been created, the CATProduct document can be loaded into the session . pDoc is a pointer to this document.

[Top][Top]

Retrieve the root product of the input document.

We need a CATProduct pointer to retrieving the root product. 

....
  hr = pDoc->QueryInterface(IID_CATIDocRoots, (void**)(&pIDocRootsOnDoc));
if(FAILED(hr))
{
retCode = 4;
goto EscapeWay;
}

// Get the root product which is the first element of root elements
pListUnkRootProducts = pIDocRootsOnDoc->GiveDocRoots();
if(NULL == pListUnkRootProducts)
{
retCode = 5;
goto EscapeWay;
}

nProducts = pListUnkRootProducts->Size();
if( 0 == nProducts)
{
retCode = 6;
goto EscapeWay;
}

hUnkRootProd = (*pListUnkRootProducts)[1];
if(NULL_var == hUnkRootProd)
{
retCode = 7;
goto EscapeWay;
}

hr = hUnkRootProd->QueryInterface(IID_CATIProduct, (void**)(&pIRootProduct));
if(FAILED(hr))
{
retCode = 8;
goto EscapeWay;
}

....

[Top]

Initializing Electrical Environment.

We initialize the Document by using CATIEleDocServices interface pointer and the method Initialize() on it.

....
  // Initialise Electrical Environment
hr = pDoc->QueryInterface(IID_CATIEleDocServices,(void**)&pIEleDocServices );
if ( FAILED(hr) )
{
retCode = 9; 
goto EscapeWay;
}

hr = pIEleDocServices->Initialize();
if ( FAILED(hr) )
{
retCode = 10; 
goto EscapeWay;
}

....

Initializing the electrical environment is mandatory to enable access to electrical object or electrical attributes.

Get the Flattening parameters.

....
  hr = pIRootProduct->QueryInterface(IID_CATIEhfEnvironment,(void**)&pIEhfEnvironment);
if ( FAILED(hr) )
{
retCode = 11;
goto EscapeWay;
}

hr = pIEhfEnvironment->GetFlatteningParameters(&phListFlatteningPara);
if ( ( FAILED(hr) ) || ( NULL == phListFlatteningPara ) )
{
retCode = 12;
goto EscapeWay;
}

nbFlatteningPara = phListFlatteningPara->Size();
if (0 >= nbFlatteningPara)
{
retCode = 13;
goto EscapeWay;
}

hUnkFlatteningPara = (*phListFlatteningPara)[1];
if (NULL_var == hUnkFlatteningPara)
{
retCode = 14;
goto EscapeWay;
}

hr = hUnkFlatteningPara->QueryInterface(IID_CATIEhfFlatteningParameters, (void **)&pIFlatteningPara);
if ( FAILED(hr) )
{
retCode = 15;
goto EscapeWay;

}

....

Get the list of geometrial bundles

....
  phUnkListChildren = pIRootProduct->GetAllChildren("CATIEhiGeoBundle");
if( NULL == phUnkListChildren )
{
retCode = 16;
goto EscapeWay;
}

numGBN = phUnkListChildren->Size();
if( 0 >= numGBN )
{
retCode = 17;
goto EscapeWay; 
}

hUnkListElem = (*phUnkListChildren)[1] ;
if( NULL_var == hUnkListElem )
{
retCode = 18;
goto EscapeWay;
}

hr = hUnkListElem->QueryInterface(IID_CATBaseUnknown, (void**)&pIUnkGBN) ;
if( FAILED(hr) )
{
retCode = 19;
goto EscapeWay; 
}

ListOfGBNs.Append(pIUnkGBN) ;

....

[Top]

Flatten the harness

 ...

  hr = pIRootProduct->QueryInterface(IID_CATIEhfFlattenManager,(void**)&pIFlatten);
if ( FAILED(hr) )
{
retCode = 20;
goto EscapeWay;
}

hr = pIFlatten->FlattenHarness( &ListOfGBNs );
if (FAILED( hr))
{
retCode = 21;
goto EscapeWay;
}
 ...

[Top]

Epilogue

Removing document from session and closing the session.

 ...

  CATDocumentServices::Remove (*pDoc) ;

  if ( NULL != pSession )
  {
    pSession->Delete_Session(sessionIdent);
  }

In Short

This use case has demonstrated the way to flatten a harness. 

[Top]

History

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