CATMecModExtendItf Interface CATIMmiUpdateError
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMmiUpdateError
Interface to manage update error associated with mechanical features.
Role: This interface allows users to retrieve an update error associated
with a mechanical feature. A feature has an update error when its build has failed.
To know if the feature has an update error, the first method to use is the
method. This method is always available. If there is an error, then you can use the
method to get more details on the error.
See
to manage the Update Error associated with the feature.
Method Index
- o
GetMmiUpdateError(CATError*&)
- Retrieves the update error associated with the feature.
- o
SetMmiUpdateError(CATError*&)
- Interface to associate an update error with the current feature.
- o
UnsetMmiUpdateError()
- Unsets the update error associated with the feature.
Methods
o GetMmiUpdateError
| public virtual GetMmiUpdateError( | | oUpdateError) |
-
Retrieves the update error associated with the feature.
Role:This method returns the update error associated with the mechanical feature. It is
important to check the existance of the error by the
method. 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 been explicitely done.
Lifecycle deviation rule: do not release the returned pointer
- Parameters:
-
- oUpdateError
- The update error. See
to manage the Update Error
- Returns:
-
S_OK Error retrieved.
E_FAIL otherwise.
- Returns:
-
o SetMmiUpdateError
| public virtual SetMmiUpdateError( | | iUpdateError) |
-
Interface to associate an update error with the current feature.
Role:It enables to give an update error to the feature during its Build process.
This method must only be used in a
method.
- Parameters:
-
- iUpdateError
- The update error to be associated with the current feature.
- Returns:
-
S_OK Association succeeded.
E_FAIL otherwise.
o UnsetMmiUpdateError
| public virtual UnsetMmiUpdateError( | ) |
-
Unsets the update error associated with the feature.
This method must be only used in a
method. It should be called at the beginning of the Build method, it is useless to test if the feature has an error.
- Returns:
-
S_OK Unset succeeded.
E_FAIL otherwise.
This object is included in the file: CATIMmiUpdateError.h
If needed, your Imakefile.mk should include the module: CATMecModExtendItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.