All Frameworks  Class Hierarchy  This Framework  Indexes   

MecModInterfaces Interface CATIUpdateError

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


interface CATIUpdateError

Interface to manage update error associated with mechanical features.
Role: This interface allows users to retrieve, create, or unset an update error associated with a mechanical feature. A feature has an update error when its build has failed. There are two usages of this interface:

See also:
CATMfErrUpdate


Method Index


o GetFullDiagnostic(int)
Returns all the chained sick features diagnoses.
o GetUpdateError()
Gets the update error associated with the feature.
o SetUpdateError(CATMfErrUpdate*)
Associates an update error to the current feature.
o TestExistingUpdateError()
Gets a value indicating whether an update error is associated with the current feature.
o UnsetUpdateError()
Unsets the update error associated with the feature.

Methods


o GetFullDiagnostic
public virtual GetFullDiagnostic( iIndentation=1)
Returns all the chained sick features diagnoses.
Role: On an error it is possible to associate a set of features. Those features are called "sick" features. They are chained because an error has sick features, which them-self can have an update error with sick features and so one. This method makes the concatenation of all the sick features diagnoses from the current feature. It is the same method as the CATMfErrUpdate.GetFullDiagnostic method.
Parameters:
iIndentation
The count of space before the first diagnosis string.
o GetUpdateError
public virtual GetUpdateError()
Gets the update error associated with the feature.
Role:This method returns the update error associated to the mechanical feature. It is important to check the existance of the error by the TestExistingUpdateError method, and do not consider the NULL returned value as a valid respons. The error is not a persistent data. It means that in batch mode,when the Part's document is opened the error is not associated with the feature until an update has not been explicitely done.
Lifecycle deviation rule: do not release the returned pointer
Returns:
The update error. A NULL pointer doesn't mean that the feature has no error. See the role of this method.
o SetUpdateError
public virtual SetUpdateError( iUpdateError)
Associates an update error to the current feature.
Role:It enables to set an update error to the feature. This method must only be used in a CATIBuild.Build method.
Parameters:
iUpdateError
The update error to be associated with the current feature.
o TestExistingUpdateError
public virtual TestExistingUpdateError()
Gets a value indicating whether an update error is associated with the current feature.
Returns:
An integer value.
Legal values:
  • 1 an update error exists on the current feature.
  • 0 no update error exists on the current feature.
o UnsetUpdateError
public virtual UnsetUpdateError()
Unsets the update error associated with the feature.
Role:It enables to unset the possible update error to the feature. This method must be only used in a CATIBuild.Build method. You call it at the beginning of the method, it is useless to test if the feature has an error.

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

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