All Frameworks Object Hierarchy This Framework Previous Next Indexes
ExpertCheckRuntime (Object)
IUnknown
|
+---IDispatch
|
+---CATBaseUnknown
|
+---CATBaseDispatch
|
+---AnyObject
|
+---ExpertRuleBaseComponentRuntime
|
+---ExpertCheckRuntime
Runtime part of a check.
The following example shows how to access the Check check1
from an existing RuleSet RS1 of the RuleBase RB1.
Dim CATDocs As Document
Set CATDocs = CATIA.Documents
Dim partdoc As PartDocument
Set partdoc = CATDocs.Add("CATPart")
Dim part As Part
Set part = partdoc.Part
Dim relations As Relations
Set relations = part.Relations
Dim Rulebase As ExpertRuleBaseRuntime
Set RuleBase = relations.Item("RB1")
Dim Ruleset As ExpertRuleSetRuntime
Set RuleSet = RuleBase.RuleSet.ExpertRuleBaseComponentRuntimes.Item("RS1")
Dim Check1 As ExpertCheckRuntime
Set Check1 = RuleSet.ExpertRuleBaseComponentRuntimes.Item("Check1")
- See also:
- Relations, ExpertRuleBase
Property Index
-
AutomaticCorrect
- Returns or sets the status of the automatic correction facility.
-
CheckEdition
- Returns the editable object corresponding to this check.
-
CorrectFunction
- Returns or sets the body to be called in order to correct the check.
-
CorrectFunctionComment
- Returns or sets the comment of the correct function of the check.
-
CorrectFunctionType
- Returns or sets the type of the body to be called in order to correct the check.
-
Failures
- Returns the list of the tuples that don't satisfy this check.
-
Help
- Returns or sets the contextual help of the check object.
-
Justification
- Returns or sets the reason why the check was overridden.
-
Priority
- Returns or sets the priority of the check.
-
Succeeds
- Returns the list of the tuples that satisfy this check.
Method Index
-
Correct
- Applies the "correction" function on failed elements.
-
Highlight
- Highlights the Failures on the check.
-
Status
- Returns the Status of the check.
Properties
o Property AutomaticCorrect( | ) As boolean |
-
Returns or sets the status of the automatic correction facility.
When set to TRUE, the check automatically calls the user function
defined by put_CorrectFunction when it fails.
-
Returns the editable object corresponding to this check.
Be careful that, according to your licence, or the type of check
you're handling, you may not have the right to edit the check.
- Example:
-
Dim aCheckEdition As ExpertCheck
Set aCheckEdition = aCheckRuntime.CheckEdition
If not(aCheckEdition is Nothing) Then
CATIA.SystemService.Print aCheckEdition.Body
End if
o Property CorrectFunction( | ) As CATBSTR |
-
Returns or sets the body to be called in order to correct the check.
o Property CorrectFunctionComment( | ) As CATBSTR |
-
Returns or sets the comment of the correct function of the check.
o Property CorrectFunctionType( | ) As long |
-
Returns or sets the type of the body to be called in order to correct the check.
- 1
- Visual Basic
- 2
- Comment
- 3
- Http
- 4
- User Function
-
Returns the list of the tuples that don't satisfy this check.
-
Returns or sets the contextual help of the check object.
o Property Justification( | ) As CATBSTR |
-
Returns or sets the reason why the check was overridden.
o Property Priority( | ) As double |
-
Returns or sets the priority of the check.
The priority of expert checks
indicates the order in which the checks are evaluated. Checks with
the same priority are evaluated in the order of their creation.
-
Returns the list of the tuples that satisfy this check.
Methods
-
Applies the "correction" function on failed elements.
-
Highlights the Failures on the check.
-
Returns the Status of the check.
- Example:
-
Dim Check1 As ExpertCheck
Set Check1 = RuleSet.ExpertRuleBaseComponentRuntimes.Item("Check1")
status = Check1.Status ()
- Returns:
- 1=OK, 0=KO.