All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowHow Interface CATIReportObject

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

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


interface CATIReportObject

Interface dedicated to the behaviour of an element (t-uple) of a report.
Role this interface describes what can be done on an object returned by a report on an expert check. A report object is an object containing an entry vector of a check and telling whether that entry vector makes the check true or not (its validity).
Because of optimization, the entry vector may not contain as many elements as the check variables declaration has. For instance, let's one define the following check on holes ".Diameter > 10mm or .Angle < 5deg". If it exists some drafts and a hole with a diameter of 12mm, then whatever the drafts, the condition of the check, given this hole, will be true. So there will be a report object, containing only this hole, with a validity of true.

See also:
CATICheck, CATICheckReport


Method Index


o AddInstanceInTuple(CATIInstance_var&)
Adds the instance at the end of the report object instances list.
o GetCheckReport()
Gets the check report that generated this report object.
o GetInstanceFromTuple(int)
Gets the instance at the position index in the t-uple.
o GetValidity()
Gets the validity of the report object.
o SetFromCheck(CATUnicodeString&)
Do not use.
o SetValidity(CATICheckReport::ReportEnum)
Sets the validity of the report object.
o TupleReset()
Clears the t-uple.
o TupleSize()
Gets the size of the t-uple.

Methods


o AddInstanceInTuple
public virtual void AddInstanceInTuple( const CATIInstance_var& spInstance)=0
Adds the instance at the end of the report object instances list.
Parameters:
spInstance
an instance.
o GetCheckReport
public virtual CATICheckReport_var GetCheckReport()=0
Gets the check report that generated this report object.
o GetInstanceFromTuple
public virtual CATIInstance_var GetInstanceFromTuple(int iIndex)=0
Gets the instance at the position index in the t-uple.
Parameters:
iIndex
position of the instance.
Returns:
an instance.
o GetValidity
public virtual CATICheckReport::ReportEnum GetValidity()=0
Gets the validity of the report object.
Returns:
validity of the report object.
o SetFromCheck
public virtual void SetFromCheck( const CATUnicodeString& iCheckName)=0
Do not use.
Parameters:
iCheckName
Check name
o SetValidity
public virtual void SetValidity(CATICheckReport::ReportEnum iValidity)=0
Sets the validity of the report object.
Parameters:
iValidity
validity of the report object.
o TupleReset
public virtual void TupleReset()=0
Clears the t-uple.
o TupleSize
public virtual int TupleSize()=0
Gets the size of the t-uple.
Returns:
size of the t-uple.

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

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