KnowledgeInterfaces Interface CATIKweErrorManager

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

interface CATIKweErrorManager

Interface representing the way to manage parse and evaluation errors.
This interface is mono implemented and accessible from .

Method Index


o ErrorCatch(CATIKweErrorManager::Filter&,CATIKweErrorManager::Behavior&,CATUnicodeString&,int&,CATIKweErrorManager::Severity&)
Catches the error if any and treat it depending on the behavior required.
o ErrorClean(CATIKweErrorManager::Behavior&)
Cleans the error if any and treat it depending on the behavior required.
o ErrorTry()
If a method raises some Knowledge Error and you want to catch them, you need to call ErrorTry before and ErrorCatch or ErrorClean after.

Enumerated Type Index


o Behavior
Behavior when catching or cleaning the error.
o Filter
Type of error we want to catch.
o Severity
Severity of error.

Methods


o ErrorCatch
public virtual ErrorCatch( const iFilter,
const iBehavior,
oMessage,
oLineNumber,
oSeverity)
Catches the error if any and treat it depending on the behavior required.
Parameters:
iFilter
kind of error we want to catch.
iBehavior
behavior requested at the end of the clean operation.
oMessage
message of the error if any.
oLineNumber
line number where error occurred
oSeverity
severity of the error
Returns:
number of error raised (0 if none).
o ErrorClean
public virtual ErrorClean( const iBehavior)
Cleans the error if any and treat it depending on the behavior required.
Parameters:
iBehavior
behavior requested at the end of the clean operation.
Returns:
number of error raised (0 if none).
o ErrorTry
public virtual ErrorTry()
If a method raises some Knowledge Error and you want to catch them, you need to call ErrorTry before and ErrorCatch or ErrorClean after.

Enumerated Types


o Behavior 
enum Behavior {
  Popup,
  Silent,
  Forward
}
Behavior when catching or cleaning the error.
    Popup: triggers a popup window displaying the message (or a trace in batch mode). Silent: simply erase the error from the manager. Forward: Forward the error to an upper error manager.
o Filter 
enum Filter {
  All,
  Parse,
  MagnitudeConsistency,
  Evaluation
}
Type of error we want to catch.
    All: we want to catch evaluation error, parse error or magnitude consistency checking. Parse: we want to catch only parse error. MagnitudeConsistency: we want to catch only magnitude consistency errors Evaluation: we want to catch only evaluation error.
o Severity 
enum Severity {
  Error,
  Warning
}
Severity of error.
    Error: the treatment has failed. Warning: the treatment has not failed.
This object is included in the file: CATIKweErrorManager.h
If needed, your Imakefile.mk should include the module: KnowledgeItf

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.