pycatia.general_knowledge_interfaces.expert_check_runtime

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.general_knowledge_interfaces.expert_check_runtime.ExpertCheckRuntime(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

GenKnowledgeInterfaces.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 automatic_correct: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

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.

Return type:

bool

property check_edition: ExpertCheck

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property CheckEdition() As ExpertCheck (Read Only)

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

Return type:

ExpertCheck

correct() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub Correct()

Applies the “correction” function on failed elements.

Return type:

None

property correct_function: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property CorrectFunction() As CATBSTR

Returns or sets the body to be called in order to correct the check.

Return type:

str

property correct_function_comment: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property CorrectFunctionComment() As CATBSTR

Returns or sets the comment of the correct function of the check.

Return type:

str

property correct_function_type: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

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

Return type:

int

property failures: ExpertReportObjects

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Failures() As ExpertReportObjects (Read Only)

Returns the list of the tuples that don’t satisfy this check.

Return type:

ExpertReportObjects

property help: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Help() As CATBSTR

Returns or sets the contextual help of the check object.

Return type:

str

highlight() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub Highlight()

Highlights the Failures on the check.

Return type:

None

property justification: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Justification() As CATBSTR

Returns or sets the reason why the check was overridden.

Return type:

str

property priority: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

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.

Return type:

float

status() → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func Status() As long

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.

Return type:

int

property succeeds: ExpertReportObjects

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Succeeds() As ExpertReportObjects (Read Only)

Returns the list of the tuples that satisfy this check.

Return type:

ExpertReportObjects