NamingRuleBuilder Class¶
-
class
NXOpen.AME.
NamingRuleBuilder
¶ Bases:
NXOpen.Builder
Naming Rule Builder
To create a new instance of this class, use
NXOpen.AME.NamingRuleListBuilder.CreateRule()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
ClassificationItem | Returns the classification item |
EoName | Returns or sets the engineering object name |
IndexDigitsInFunction | Returns or sets the index display digits in function aspect |
IndexDigitsInLocation | Returns or sets the index display digits in location aspect |
IndexDigitsInProduct | Returns or sets the index display digits in product aspect |
IndexIncrementInFunction | Returns or sets the index increment in function aspect |
IndexIncrementInLocation | Returns or sets the index increment in location aspect |
IndexIncrementInProduct | Returns or sets the index increment in product aspect |
NameInFunction | Returns or sets the name in function aspect |
NameInLocation | Returns or sets the name in location aspect |
NameInProduct | Returns or sets the name in product aspect |
SelectedClassification | Returns or sets the Classification ID |
StartIndexInFunction | Returns or sets the start index in function aspect |
StartIndexInLocation | Returns or sets the start index in location aspect |
StartIndexInProduct | Returns or sets the start index in product aspect |
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¶
ClassificationItem¶
-
NamingRuleBuilder.
ClassificationItem
¶ Returns the classification item
-------------------------------------
Getter Method
Signature
ClassificationItem
Returns: Return type: NXOpen.AME.SelectClassificationBuilder
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
EoName¶
-
NamingRuleBuilder.
EoName
¶ Returns or sets the engineering object name
-------------------------------------
Getter Method
Signature
EoName
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
EoName
Parameters: eoName (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
IndexDigitsInFunction¶
-
NamingRuleBuilder.
IndexDigitsInFunction
¶ Returns or sets the index display digits in function aspect
-------------------------------------
Getter Method
Signature
IndexDigitsInFunction
Returns: Return type: int New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
IndexDigitsInFunction
Parameters: indexIncrement (int) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
IndexDigitsInLocation¶
-
NamingRuleBuilder.
IndexDigitsInLocation
¶ Returns or sets the index display digits in location aspect
-------------------------------------
Getter Method
Signature
IndexDigitsInLocation
Returns: Return type: int New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
IndexDigitsInLocation
Parameters: indexIncrement (int) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
IndexDigitsInProduct¶
-
NamingRuleBuilder.
IndexDigitsInProduct
¶ Returns or sets the index display digits in product aspect
-------------------------------------
Getter Method
Signature
IndexDigitsInProduct
Returns: Return type: int New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
IndexDigitsInProduct
Parameters: indexIncrement (int) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
IndexIncrementInFunction¶
-
NamingRuleBuilder.
IndexIncrementInFunction
¶ Returns or sets the index increment in function aspect
-------------------------------------
Getter Method
Signature
IndexIncrementInFunction
Returns: Return type: int New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
IndexIncrementInFunction
Parameters: indexIncrement (int) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
IndexIncrementInLocation¶
-
NamingRuleBuilder.
IndexIncrementInLocation
¶ Returns or sets the index increment in location aspect
-------------------------------------
Getter Method
Signature
IndexIncrementInLocation
Returns: Return type: int New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
IndexIncrementInLocation
Parameters: indexIncrement (int) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
IndexIncrementInProduct¶
-
NamingRuleBuilder.
IndexIncrementInProduct
¶ Returns or sets the index increment in product aspect
-------------------------------------
Getter Method
Signature
IndexIncrementInProduct
Returns: Return type: int New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
IndexIncrementInProduct
Parameters: indexIncrement (int) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
NameInFunction¶
-
NamingRuleBuilder.
NameInFunction
¶ Returns or sets the name in function aspect
-------------------------------------
Getter Method
Signature
NameInFunction
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
NameInFunction
Parameters: nameInFunction (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
NameInLocation¶
-
NamingRuleBuilder.
NameInLocation
¶ Returns or sets the name in location aspect
-------------------------------------
Getter Method
Signature
NameInLocation
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
NameInLocation
Parameters: nameInLocation (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
NameInProduct¶
-
NamingRuleBuilder.
NameInProduct
¶ Returns or sets the name in product aspect
-------------------------------------
Getter Method
Signature
NameInProduct
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
NameInProduct
Parameters: nameInProduct (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedClassification¶
-
NamingRuleBuilder.
SelectedClassification
¶ Returns or sets the Classification ID
-------------------------------------
Getter Method
Signature
SelectedClassification
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
SelectedClassification
Parameters: classification (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
StartIndexInFunction¶
-
NamingRuleBuilder.
StartIndexInFunction
¶ Returns or sets the start index in function aspect
-------------------------------------
Getter Method
Signature
StartIndexInFunction
Returns: Return type: int New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
StartIndexInFunction
Parameters: startIndex (int) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
StartIndexInLocation¶
-
NamingRuleBuilder.
StartIndexInLocation
¶ Returns or sets the start index in location aspect
-------------------------------------
Getter Method
Signature
StartIndexInLocation
Returns: Return type: int New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
StartIndexInLocation
Parameters: startIndex (int) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
StartIndexInProduct¶
-
NamingRuleBuilder.
StartIndexInProduct
¶ Returns or sets the start index in product aspect
-------------------------------------
Getter Method
Signature
StartIndexInProduct
Returns: Return type: int New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
StartIndexInProduct
Parameters: startIndex (int) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
NamingRuleBuilder.
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.