All Frameworks Class Hierarchy This Framework Next Indexes
KnowHow Interface CATICheck
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---KnowHow.CATIGenericRuleBaseComponent
|
+---KnowHow.CATIRuleBaseComponent
|
+---CATICheck
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICheck
Interface dedicated to defining the basic possibilities of an expert check.
Role : the goal of an expert check is to check a condition over a kind of objects
(for instance that all the holes of a part have a diameter of at least
15mm, or that no two holes have the same diameter).
The second example would have been made with the following check:
Check.1
- Variables
- "H1:SimpleHole; H2:Simplehole"
- Body
- "H1.Diameter != H2.Diameter"
All the possible t-uples (H1, H2) (for H1, H2 any SimpleHoles) are evaluated by the check.
If the condition is true for all of them, then the check is correct. If at least one of them makes
the condition false, then the check is false.
If the check is false, then a corrective action can be done with a correction function. This
function is applied on each t-uple failing the condition of the check, when the user decides to
(manually) or automatically.
If the check is false, the user also can do nothing and simply justify the falseness of the check
with a comment. Then the check is considered as true.
Method Index
- o
ApplyCorrect()
- Triggers the application of the correction function of the check on the t-uples failing the condition.
- o
ApplyHighlight()
- Highlights each object of the t-uples failing the condition.
- o
GetAutomaticCorrect()
- Gets the correction function triggering mode.
- o
GetCorrectFunction()
- Gets the VB script executed as a correction function.
- o
GetCorrectFunctionComment()
- Gets the comment of the correction function.
- o
GetCorrectFunctionType()
- Gets the correction function type.
- o
GetHelp()
- Gets the help string.
- o
GetJustification()
- Gets the justification string.
- o
GetStatus()
- Gets the validity of the check.
- o
SetAutomaticCorrect(boolean)
- Sets the correction function to be triggered automatically or not.
- o
SetCorrectFunction(CATUnicodeString)
- Sets the script executed as a correction function.
- o
SetCorrectFunctionComment(CATUnicodeString)
- Sets the comment of the correction function.
- o
SetCorrectFunctionType(CATExpertReportEnum::CorrectingFunctionTypeEnum)
- Sets the correction function type.
- o
SetHelp(CATUnicodeString)
- Sets the help string.
- o
SetJustification(CATUnicodeString)
- Sets the justification string.
Methods
o ApplyCorrect
public virtual void ApplyCorrect( | )=0 |
-
Triggers the application of the correction function of the check on the t-uples failing the condition.
o ApplyHighlight
public virtual void ApplyHighlight( | )=0 |
-
Highlights each object of the t-uples failing the condition.
o GetAutomaticCorrect
public virtual boolean GetAutomaticCorrect( | )=0 |
-
Gets the correction function triggering mode.
- Returns:
- true or false.
o GetCorrectFunction
-
Gets the VB script executed as a correction function.
- Returns:
- Script of the correction function
o GetCorrectFunctionComment
-
Gets the comment of the correction function.
- Returns:
- the comment.
o GetCorrectFunctionType
public virtual CATExpertReportEnum::CorrectingFunctionTypeEnum GetCorrectFunctionType( | )=0 |
-
Gets the correction function type.
- Returns:
- Type of correction function (
CATExpertReportEnum.CorrectingFunctionTypeEnum ).
o GetHelp
-
Gets the help string.
- Returns:
- the help string.
o GetJustification
-
Gets the justification string.
The justification string is a comment explainig why a false check (i.e.
at least one t-uple fails the condition) can be considered as true.
- Returns:
- the justification string.
o GetStatus
public virtual CATExpertReportEnum::ValidityTypeEnum GetStatus( | )=0 |
-
Gets the validity of the check.
- Returns:
- the validity.
o SetAutomaticCorrect
public virtual void SetAutomaticCorrect( | boolean | iIsAutomatic)=0 |
-
Sets the correction function to be triggered automatically or not.
- Parameters:
-
- iIsAutomatic
- true or false.
o SetCorrectFunction
-
Sets the script executed as a correction function.
- Parameters:
-
- iScript
- VB script to be executed.
o SetCorrectFunctionComment
-
Sets the comment of the correction function.
- Parameters:
-
- iComment
- the comment.
o SetCorrectFunctionType
public virtual void SetCorrectFunctionType( | CATExpertReportEnum::CorrectingFunctionTypeEnum | iType)=0 |
-
Sets the correction function type.
- Parameters:
-
- iType
- Type of correction function (
CATExpertReportEnum.CorrectingFunctionTypeEnum ).
o SetHelp
-
Sets the help string.
- Parameters:
-
- iHelp
- the help string.
o SetJustification
-
Sets the justification string.
The justification string is a comment explainig why a false check (i.e.
at least one t-uple fails the condition) can be considered as true.
- Parameters:
-
- iJustification
- the justification string.
This object is included in the file: CATICheck.h
If needed, your Imakefile.mk should include the module: CATKWERule