All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMIntegrationAccess Interface CATIAdpPLMErrorIterator

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIAdpPLMErrorIterator

Iterator to handle the set of PLM errors logged by a PLM Error Reviewer.

Role: This interface scans sequentially the set of errors logged by a given PLM ErrorReviewer ( ) :

When the Error Reviewer is passed to a PLMServer access operation, it is filled with all PLM errors eventually raised by this operation.
These PLM Errors are added to the set of PLM errors that may already be stored in the Error Reviewer.
The set of errors is only reset when deleting the Reviewer.

The Iterator is to be created first using :
The returned iteration pointer enables to scan the current set of Errors stored by the PLMError Reviewer.

When the Error Reviewer is used to perform another PLMServer access operation, another Iterator is to be
created to scan the updated set of PLM Errors. example:

 // Use a PLM Error Reviewer calling service(s) that may fill it with PLMErrors
 HRC = CATAdpOpenSaveServices::Save(NULL, piErrorReviewer);

// Scan eventual errors raised using and

 
 if (FAILED(HR))
 {
   CATIAdpPLMErrorIterator * piErrorIterator = NULL;
   CATIAdpPLMError* piPLMError = NULL;
   HR = piErrorReviewer->GetPLMErrorIterator(piErrorIterator);
   if (SUCCEEDED(HR) && piErrorIterator)
   {
     while (SUCCEEDED(piErrorIterator->Next(piPLMError)) && piPLMError)
     {

// Read error content using

 
        ...
	      piPLMError->Release();
	      piPLMError = NULL;
     }
   }
 }

See also:: , ,

Method Index

o Next(CATIAdpPLMError*&): Iterates on the next PLM Error.
o Rewind(): Rewinds iterator for another iteration.

Methods

o Next

public virtual Next( opPLMError)

Iterates on the next PLM Error.
Role: This method gets the next PLM Error Cell stored by the ErrorReviewer.

Parameters:

opPLMError: the PLM Error read by the iterator or NULL when the end of the error set has been reached.

Returns:

S_OK : iteration successfull
E_FAIL : iteration failed

o Rewind

public virtual Rewind(

)

Rewinds iterator for another iteration.

Returns:: S_OK : Rewind successfull
E_FAIL : Rewind failed

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