pycatia.general_knowledge_interfaces.expert_rule_base_component_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_rule_base_component_runtime.ExpertRuleBaseComponentRuntime(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
ExpertRuleBaseComponentRuntime

Represents a rule base component in a ruleset.
accurate_type() str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AccurateType() As CATBSTR

Returns as a string the type of component. Returns a string among
(“ExpertCheck”, “ExpertCheckRuntime”, “ExpertRule”, “ExpertRuleRuntime”,
“ExpertRuleSet”, “ExpertRuleSetRuntime”).

Returns:
Type name of the rule base component
Return type:

str

activate() None

Note

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

Activates the RuleBaseComponent.

Example:
This example activates the SolidActivity ExpertCheck:

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
part.Relations.Item(“RuleBase”).RuleSet.ExpertRuleBaseComponentRuntimes.Item(“SolidActivity”).Activate()
Return type:

None

property comment: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Comment() As CATBSTR

Returns or sets the comment of a rulebase component.
Return type:

str

deactivate() None

Note

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

Desactivates the RuleBaseComponent.

Example:
This example Desactivates the SolidActivity
ExpertCheck:

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
part.Relations.Item(“RuleBase”).RuleSet.ExpertRuleBaseComponentRuntimes.Item(“SolidActivity”).Deactivate()
Return type:

None

is_activate() bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Isactivate() As boolean

Tells if the RuleBaseComponent is active.

Example:
This example tells if the SolidActivity ExpertCheck is active
:

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
status = part.Relations.Item(“RuleBase”).RuleSet.ExpertRuleBaseComponentRuntimes.Item(“SolidActivity”).Isactivate()


Returns:
Activity of the rule base component
Return type:

bool

is_use_only() bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func IsUseOnly() As boolean

Retrieves the use-only status of the component.

Returns:
Use only status of the component
Return type:

bool

parse() str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Parse() As CATBSTR

Syntactically analyses (ie parses) the component.

Returns:
Empty string if the parse is correct, otherwise comments on the errors
Return type:

str

set_use_only() None

Note

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

Prevents any access to the component for reading or deleting.
Be careful : this operation is not reversible.
Return type:

None