All Frameworks Class Hierarchy This Framework Previous Next Indexes
MecModInterfaces Interface CATIUpdateError
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---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:
- Consultation
To know if the feature
has an update error, the first method to use is the TestExistingUpdateError method. This method is available
in all cases. If there is an error, then you can use the
GetUpdateError method to have more details about the error.
- Creation
It is for those which must implement the
CATIBuild interface on a new mechanical feature. At the beginning of the
CATIBuild.Build method, the eventual last error is deleted by the
UnsetUpdateError method, and if an update error occurs during the method, an error is associated with the feature thanks to the
SetUpdateError method
- 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
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
-
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
-
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 TestExistingUpdateError
public virtual int TestExistingUpdateError( | )=0 |
-
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 void UnsetUpdateError( | )= 0 |
-
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