RulesBuilder Class¶
-
class
NXOpen.Drafting.RulesBuilder¶ Bases:
NXOpen.BuilderThis class is used to specify knowledge fusion rules in a drawing template.
The rules are executed when the template is instantiated. To create a new instance of this class, use
NXOpen.Drafting.AutomationManager.CreateRulesBuilder()New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| DimensionRule | Returns or sets the dimension rule |
| NoteRule | Returns or sets the note rule |
| SymbolRule | Returns or sets the symbol rule |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
DimensionRule¶
-
RulesBuilder.DimensionRule¶ Returns or sets the dimension rule
-------------------------------------Getter Method
Signature
DimensionRuleReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DimensionRuleParameters: dimensionRule (str) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
NoteRule¶
-
RulesBuilder.NoteRule¶ Returns or sets the note rule
-------------------------------------Getter Method
Signature
NoteRuleReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NoteRuleParameters: noteRule (str) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
SymbolRule¶
-
RulesBuilder.SymbolRule¶ Returns or sets the symbol rule
-------------------------------------Getter Method
Signature
SymbolRuleReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SymbolRuleParameters: symbolRule (str) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
Method Detail¶
Validate¶
-
RulesBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.