AutomationRuleBuilder Class¶
-
class
NXOpen.Drafting.
AutomationRuleBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.Drafting.AutomationRuleBuilder
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
AllowInsideGeometry | Returns or sets the allow inside geometry option allows annotation inside geometry |
EqualDimensionTolerance | Returns or sets the equal dimension comparison tolerance |
HideFeetAndInchMarks | Returns or sets the hide feet and inch marks option Show/Hide feet and inch marks. |
Increment | Returns or sets the increment Display dimension value in inches and fractions to nearest specified value |
LowerThreshold | Returns or sets the lower threshold display dimension value in feet, inches and fractions if it is greater than the specified value |
MaximumGapToGeometry | Returns or sets the maximum gap from the view geometry to the annotation |
MinimumGapBetweenAnnotations | Returns or sets the minimum gap between annotations |
MinimumGapToGeometry | Returns or sets the minimum gap from the view geometry to the annotation |
ReferenceGeometryGapTolerance | Returns or sets the reference geometry search gap tolerance |
RoundFeetAndInches | Returns or sets the round feet and inches determine wheather or not to display dimension value in inches and fractions to nearest specified value |
Tag | Returns the Tag for this object. |
UseFeetInchesAndFraction | Returns or sets the use feet inches and fraction determine wheather or not to display dimension value in feet, inches and fractions if it is greater than the specified value |
Methods¶
Method | Description |
---|---|
GetRulesList | The automation rules in the order of decreasing priorities. |
SetRulesList | The set of order list |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AllowInsideGeometry¶
-
AutomationRuleBuilder.
AllowInsideGeometry
¶ Returns or sets the allow inside geometry option allows annotation inside geometry
-------------------------------------
Getter Method
Signature
AllowInsideGeometry()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllowInsideGeometry(allowInsideGeometry)
Parameters: allowInsideGeometry (bool) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
EqualDimensionTolerance¶
-
AutomationRuleBuilder.
EqualDimensionTolerance
¶ Returns or sets the equal dimension comparison tolerance
-------------------------------------
Getter Method
Signature
EqualDimensionTolerance()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EqualDimensionTolerance(equalDimensionTolerance)
Parameters: equalDimensionTolerance (float) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
HideFeetAndInchMarks¶
-
AutomationRuleBuilder.
HideFeetAndInchMarks
¶ Returns or sets the hide feet and inch marks option Show/Hide feet and inch marks.
True to hide and False to show
-------------------------------------
Getter Method
Signature
HideFeetAndInchMarks()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HideFeetAndInchMarks(hideFeetAndInchMarks)
Parameters: hideFeetAndInchMarks (bool) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
Increment¶
-
AutomationRuleBuilder.
Increment
¶ Returns or sets the increment Display dimension value in inches and fractions to nearest specified value
-------------------------------------
Getter Method
Signature
Increment()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Increment(increment)
Parameters: increment (float) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
LowerThreshold¶
-
AutomationRuleBuilder.
LowerThreshold
¶ Returns or sets the lower threshold display dimension value in feet, inches and fractions if it is greater than the specified value
-------------------------------------
Getter Method
Signature
LowerThreshold()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LowerThreshold(lowerThreshold)
Parameters: lowerThreshold (float) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
MaximumGapToGeometry¶
-
AutomationRuleBuilder.
MaximumGapToGeometry
¶ Returns or sets the maximum gap from the view geometry to the annotation
-------------------------------------
Getter Method
Signature
MaximumGapToGeometry()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumGapToGeometry(maximumGapToGeometry)
Parameters: maximumGapToGeometry (float) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
MinimumGapBetweenAnnotations¶
-
AutomationRuleBuilder.
MinimumGapBetweenAnnotations
¶ Returns or sets the minimum gap between annotations
-------------------------------------
Getter Method
Signature
MinimumGapBetweenAnnotations()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumGapBetweenAnnotations(minimumGapBetweenAnnotations)
Parameters: minimumGapBetweenAnnotations (float) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
MinimumGapToGeometry¶
-
AutomationRuleBuilder.
MinimumGapToGeometry
¶ Returns or sets the minimum gap from the view geometry to the annotation
-------------------------------------
Getter Method
Signature
MinimumGapToGeometry()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumGapToGeometry(minimumGapToGeometry)
Parameters: minimumGapToGeometry (float) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
ReferenceGeometryGapTolerance¶
-
AutomationRuleBuilder.
ReferenceGeometryGapTolerance
¶ Returns or sets the reference geometry search gap tolerance
-------------------------------------
Getter Method
Signature
ReferenceGeometryGapTolerance()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceGeometryGapTolerance(referenceGeometryGapTolerance)
Parameters: referenceGeometryGapTolerance (float) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
RoundFeetAndInches¶
-
AutomationRuleBuilder.
RoundFeetAndInches
¶ Returns or sets the round feet and inches determine wheather or not to display dimension value in inches and fractions to nearest specified value
-------------------------------------
Getter Method
Signature
RoundFeetAndInches()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RoundFeetAndInches(roundFeetAndInches)
Parameters: roundFeetAndInches (bool) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
UseFeetInchesAndFraction¶
-
AutomationRuleBuilder.
UseFeetInchesAndFraction
¶ Returns or sets the use feet inches and fraction determine wheather or not to display dimension value in feet, inches and fractions if it is greater than the specified value
-------------------------------------
Getter Method
Signature
UseFeetInchesAndFraction()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseFeetInchesAndFraction(useFeetInchesAndFraction)
Parameters: useFeetInchesAndFraction (bool) – New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
Method Detail¶
GetRulesList¶
-
AutomationRuleBuilder.
GetRulesList
¶ The automation rules in the order of decreasing priorities.
So, the first rule in the VLA has the highest priority
Signature
GetRulesList()
Returns: Rules list Return type: list of str New in version NX9.0.0.
License requirements: None.
SetRulesList¶
-
AutomationRuleBuilder.
SetRulesList
¶ The set of order list
Signature
SetRulesList(rules)
Parameters: rules (list of str) – Rules list New in version NX9.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
Validate¶
-
AutomationRuleBuilder.
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.