All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowHow Interface CATICheckReport

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATICheckReport
 

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


interface CATICheckReport

Interface dedicated to retrieving the t-uples of an expert check, or information on that check.
Role this interface can be used to retrieve the list of t-uples failing or succeeding the condition of a check. The CATICheck implementation and the CATICheckReport implementation have to be made on the same feature.

See also:
CATICheck


Method Index


o AddTupleFailed(CATListValCATIInstance_var&)
Add one t-uples in the list of failed t-uples.
o AddTupleSucceeded(CATListValCATIInstance_var&)
Add one t-uples in the list of succeeded t-uples.
o ExtractReportObjects(ReportEnum,CATListValCATIReportObject_var&)
Retrieves the list of specified t-uples.
o GetGenericRuleBaseComponent()
Returns the component (check, ruleset or rulebase) to which this check report is linked.
o NumberFailed()
Returns the number of t-uples failing the condition.
o NumberSucceeded()
Returns the number of t-uples succeeding the condition.
o ResetReport()
Resets the report.
o SetReport(ReportEnum)
Sets the report type.
o StopGenerateTuple()
Stop to fill the t-uples list automatically.

Enumerated Type Index


o ReportEnum
Type of t-uples to be retrieved.

Methods


o AddTupleFailed
public virtual HRESULT AddTupleFailed(CATListValCATIInstance_var& iListToBeFilled) =0
Add one t-uples in the list of failed t-uples.
Parameters:
iListToBeFilled
list of CATIInstance.
Returns:
S_OK or E_FAILED
o AddTupleSucceeded
public virtual HRESULT AddTupleSucceeded(CATListValCATIInstance_var& ilListToBeFilled) =0
Add one t-uples in the list of succeeded t-uples.
Parameters:
iListToBeFilled
list of CATIInstance.
Returns:
S_OK or E_FAILED
o ExtractReportObjects
public virtual int ExtractReportObjects(ReportEnum iReportType,
CATListValCATIReportObject_var& iolListToBeFilled)=0
Retrieves the list of specified t-uples.
Parameters:
iReportType
Type of the t-uples to be retrieved.
iolListToBeFilled
List to be filled with the t-uples, seen as
CATIReportObject .
Returns:
Number of t-uples.
o GetGenericRuleBaseComponent
public virtual CATIGenericRuleBaseComponent_var GetGenericRuleBaseComponent()=0
Returns the component (check, ruleset or rulebase) to which this check report is linked.
Returns:
component to which this check report is linked.
o NumberFailed
public virtual int NumberFailed()=0
Returns the number of t-uples failing the condition.
Returns:
number of t-uples failing the condition.
o NumberSucceeded
public virtual int NumberSucceeded()=0
Returns the number of t-uples succeeding the condition.
Returns:
number of t-uples succeeding the condition.
o ResetReport
public virtual void ResetReport()=0
Resets the report. The list of t-uples of the report can become out-of-date, without the CATICheckReport knowing it (for instance if an object of a type adressed by the check, has been created, the report needs to be reset and extracted again).
o SetReport
public virtual void SetReport(ReportEnum iReportType= None)=0
Sets the report type.
Parameters:
iReportType
Type of the t-uples to be retrieved.
o StopGenerateTuple
public virtual void StopGenerateTuple()=0
Stop to fill the t-uples list automatically. You must use AddTupleFailed and AddTupleSucceeded to fill the t-uples.

Enumerated Types


o ReportEnum
enum ReportEnum {
  None,
  Fail,
  Pass,
  All
}
Type of t-uples to be retrieved.
Parameters:
None
None of the t-uples.
Fail
Only the t-uples failing the condition.
Pass
Only the t-uples succeeding the condition.
All
All the t-uples.

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

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