All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModExtendItf Interface CATIMmiErrUpdate

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

interface CATIMmiErrUpdate

Interface to manage update error.
Role:An update error is an error which occurs during the build process of the feature. This error can be corrected by the end-user by modifying a parameter of the feature. An update error is made of:

A list of sick features:

A diagnosis.

An associated feature that aggregates the update error

About the chained sick features: A sick feature can have an update error and this error has perhaps also sick features, and so one. So from a current error, you can recursively find a set of chained sick features.

Method Index

o AddMmiSickFeature(CATError*&,CATIMmiMechanicalFeature_var&): Adds a sick feature in the list of sick features.
o AddMmiSickFeatures(CATError*&,CATLISTV(CATIMmiMechanicalFeature_var)&): Adds a list of sick features in the list of sick features.
o CreateNewError(CATError*&): Creates a new update error.
o GetMmiAllSickFeatures(CATError*&,CATLISTV(CATIMmiMechanicalFeature_var)&): Retrieves a list of chained sick features associated with the update error.
o GetMmiAssociatedFeature(CATError*&,CATIMmiMechanicalFeature_var&): Retrieves the feature that aggregates the error.
o GetMmiDeepSickFeatures(CATError*&,CATLISTV(CATIMmiMechanicalFeature_var)&): Retrieves only the deeper sick feature(s) for the given update error.
o GetMmiDiagnostic(CATError*&,CATUnicodeString&): Retrieves the update error diagnosis.
o GetMmiFullDiagnostic(CATError*&,CATUnicodeString&,int): Retrieves all the chained sick features diagnoses.
o GetMmiNLSDiagnostic(CATError*&,CATUnicodeString&): Retrieves a complete error diagnosis.
o GetMmiSickFeatures(CATError*&,CATLISTV(CATIMmiMechanicalFeature_var)&): Retrieves the list of sick features associated with the update error.
o IsAnUpdateError(CATError*&): Checks if the error is an update error.
o IsMmiCycleDetected(CATError*&,CATBoolean&): Checks if the error is due to a cyclicity.
o RemoveMmiSickFeature(CATError*&,CATIMmiMechanicalFeature_var&): Removes a sick feature from the list of sick features.
o SetMmiAssociatedFeature(CATError*&,CATIMmiMechanicalFeature_var&): Sets the feature to the error.
o SetMmiDiagnostic(CATError*&,CATUnicodeString&): Sets the update error diagnosis.

Methods

o AddMmiSickFeature

public virtual AddMmiSickFeature(		`iError`,
		`iSickFeature`)

Adds a sick feature in the list of sick features.

Parameters:

iError: The error on wich the sick feature is added.
iSickFeature: The new sick feature.

Returns:

S_OK if the sick feature is successfully added.
E_FAIL otherwise

o AddMmiSickFeatures

public virtual AddMmiSickFeatures(		`iError`,
		`iSickFeatures`)

Adds a list of sick features in the list of sick features.

Parameters:

iError: The error on wich the sick feature is added.
iSickFeatures: The new list of sick features.

Returns:

S_OK if the sick feature are successfully added.
E_FAIL otherwise

o CreateNewError

public virtual CreateNewError( oError)

Creates a new update error.

Parameters:

oError: The created error.

Returns:

S_OK the error is created
E_FAIL otherwise

o GetMmiAllSickFeatures

public virtual GetMmiAllSickFeatures(		`iError`,
		`oSickFetaures`)

Retrieves a list of chained sick features associated with the update error.
Role:This method returns the sick features of the current error and the sick features of each error associated with the previous sick features and so one....

Parameters:

iError: The error from wich the sick features are retrieved.
oSickFeatures: The list of chained sick features associated to the error.

Returns:

S_OK if the features are successfully retrieved.
E_FAIL otherwise

o GetMmiAssociatedFeature

public virtual GetMmiAssociatedFeature(		`iError`,
		`oAssociatedFeature`)

Retrieves the feature that aggregates the error.

Parameters:

iError: The error from wich the feature is retrieved.
oAssociatedFeature: The feature associated to the update error.

Returns:

S_OK if the feature correctly is retrieved.
E_FAIL otherwise.

o GetMmiDeepSickFeatures

public virtual GetMmiDeepSickFeatures(		`iError`,
		`oDeepSickFeatures`)

Retrieves only the deeper sick feature(s) for the given update error.
Role:This method retrieves the deeper sick features of the iError parameter. The returned feature(s) are those that the user sees in the Update Error Dialog box.

Parameters:

iError: The error used to find the sick features.
oDeepSickFeatures: The list of the deeper sick features of iErrUpdate .

Returns:

S_OK if the features are correctly retrieved.
E_FAIL otherwise

o GetMmiDiagnostic

public virtual GetMmiDiagnostic(		`iError`,
		`oDiagnostic`)

Retrieves the update error diagnosis.

Parameters:

iError: The error on wich the diagnosis is retrieved.
oDiagnostic: The diagnosis.

Returns:

S_OK if the diagnosis is correctly retrieved.
E_FAIL otherwise

o GetMmiFullDiagnostic

public virtual GetMmiFullDiagnostic(	`iError`,
	`oDiagnostic`,
	`iIndentation`	`=1`)

Retrieves all the chained sick features diagnoses.
Role: This method makes the concatenation of all the sick features diagnoses from the current feature. It is the same method as the method.

Parameters:

iError: The error on wich the diagnosis is retrieved.
oDiagnostic: The diagnosis.
iIndentation: The count of space before the first diagnosis.

Returns:

S_OK if the diagnosis is correctly retrieved.
E_FAIL otherwise

o GetMmiNLSDiagnostic

public virtual GetMmiNLSDiagnostic(		`iError`,
		`oNLSDiagnostic`)

Retrieves a complete error diagnosis.
Role:This method returns the concatenation of several diagnoses: the diagnoses of the error (given by ) and the diagnoses of the chained sick feature.

Parameters:

iError: The error on wich the NLS dignosis is retrieved.
oNLSDiagnostic: The diagnosis

Returns:

S_OK if the diagnosis is correctly retrieved.
E_FAIL otherwise

o GetMmiSickFeatures

public virtual GetMmiSickFeatures(		`iError`,
		`oSickFeatures`)

Retrieves the list of sick features associated with the update error.

Parameters:

iError: The error from wich the sick features are retrieved.
oSickFeatures: The sick features associated with the error.

Returns:

S_OK if the features are successfully retrieved.
E_FAIL otherwise

o IsAnUpdateError

public virtual IsAnUpdateError( iError)

Checks if the error is an update error.

Parameters:

iError: The error to check.

Returns:

S_OK the error is an update error
E_FAIL otherwise

o IsMmiCycleDetected

public virtual IsMmiCycleDetected(		`iError`,
		`oCyclicity`)

Checks if the error is due to a cyclicity.

Parameters:

iError: the error to check.
oCyclicity: TRUE if is an cyclicity error.

Returns:

S_OK if the information is retrieved.
E_FAIL otherwise

o RemoveMmiSickFeature

public virtual RemoveMmiSickFeature(		`iError`,
		`iFeature`)

Removes a sick feature from the list of sick features.

Parameters:

iError: The error on wich the sick feature is removed.
iFeature: The feature to be removed from the list

Returns:

S_OK if the sick feature are successfully removed.
E_FAIL otherwise

o SetMmiAssociatedFeature

public virtual SetMmiAssociatedFeature(		`iError`,
		`iFeature`)

Sets the feature to the error.

Parameters:

iError: The error on wich the feature is set.
iFeature: The iFeature to associate to the error.

Returns:

S_OK if the feature is successfully associated to the error.
E_FAIL otherwise

o SetMmiDiagnostic

public virtual SetMmiDiagnostic(		`iError`,
	const	`iDiagnosis`)

Sets the update error diagnosis.

Parameters:

iError: The error on wich the diagnosis is set.
iDiagnosis: The diagnosis.

Returns:

S_OK if the diagnosis is correctly set.
E_FAIL otherwise

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