CATMecModUseItf Interface CATIMmiUseUpdateError
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMmiUseUpdateError
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.
Method Index
- o
GetAssociatedSickFeatures(CATLISTV(CATIMmiMechanicalFeature_var)&)
- Retrieves the list of sick features associated with the update error.
- o
GetDiagnostic(CATUnicodeString&)
- Retrieves the update error diagnosis.
- o
GetFullDiagnostic(CATUnicodeString&,int)
- Retrieves all the chained sick features diagnosis.
- o
HasAnUpdateError()
- Returns a value indicating whether an update error is associated with the current feature.
Methods
o GetAssociatedSickFeatures
| public virtual GetAssociatedSickFeatures( | | oSickFeatures) |
-
Retrieves the list of sick features associated with the update error.
- Parameters:
-
- oSickFeatures
- The list of sick features
- Returns:
-
Legal values:
- S_OK if the features have been successfully retried.
- S_FALSE otherwise.
o GetDiagnostic
| public virtual GetDiagnostic( | | oString) |
-
Retrieves the update error diagnosis.
o GetFullDiagnostic
| public virtual GetFullDiagnostic( | | oString, |
| | iIndentation | =1) |
-
Retrieves all the chained sick features diagnosis.
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.
- Parameters:
-
- oString
- The concatenation of diagnoses.
- iIndentation
- The count of space before the first diagnosis string.
- Returns:
-
Legal values:
- S_OK if the diagnostic has been successfully retried.
- E_FAIL otherwise.
o HasAnUpdateError
| public virtual HasAnUpdateError( | ) |
-
Returns a value indicating whether an update error is associated with the current feature.
- Returns:
-
Legal values:
- S_OK an update error exists on the current feature.
- S_FALSE no update error exists on the current feature.
This object is included in the file: CATIMmiUseUpdateError.h
If needed, your Imakefile.mk should include the module: CATMecModUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.