SpecifyRuleBuilder Class

class NXOpen.Drafting.SpecifyRuleBuilder

Bases: NXOpen.Builder

This class is used to specify knowledge fusion rule for a note object in a drawing template.

The rule is stored on the note and is executed when the template is instantiated. To create a new instance of this class, use NXOpen.Drafting.AutomationManager.CreateSpecifyRuleBuilder()

New in version NX8.0.0.

Properties

Property	Description
Note	Returns or sets the note to add rule to
Rule	Returns or sets the 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

Note

SpecifyRuleBuilder.Note

Returns or sets the note to add rule to

-------------------------------------

Getter Method

Signature Note

Returns:Note object Return type:NXOpen.Annotations.Note

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Note

Parameters:note (NXOpen.Annotations.Note) – Note object

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Rule

SpecifyRuleBuilder.Rule

Returns or sets the rule

-------------------------------------

Getter Method

Signature Rule

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Rule

Parameters:rule (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Method Detail

Validate

SpecifyRuleBuilder.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.