LayoutLengthOptions Class¶
-
class
NXOpen.Formboard.
LayoutLengthOptions
¶ Bases:
NXOpen.Builder
Defines the various options for determining the rounded lengths of formboard geometry during the layout or update process.
Created automatically by containing classes.
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
NetlistLengthIncrement | Returns the connection list length increment. |
NetlistRoundingMethod | Returns or sets the rounding method to apply to Connection List lengths. |
OverstockLengthIncrement | Returns the overstock length increment. |
OverstockRoundingMethod | Returns or sets the rounding method to apply to overstock wrapped lengths. |
SegmentLengthIncrement | Returns the segment length increment. |
SegmentRoundingMethod | Returns or sets the rounding method to apply to segment lengths. |
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. |
Enumerations¶
LayoutLengthOptionsRoundingMethod Enumeration | Methods of rounding lengths for Formboard geometry. |
Property Detail¶
NetlistLengthIncrement¶
-
LayoutLengthOptions.
NetlistLengthIncrement
¶ Returns the connection list length increment.
Only used when the
Formboard.LayoutLengthOptions.NetlistRoundingMethod`()
isFormboard.LayoutLengthOptionsRoundingMethod.UpToNearest
orFormboard.LayoutLengthOptionsRoundingMethod.DownToNearest
.-------------------------------------
Getter Method
Signature
NetlistLengthIncrement
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
NetlistRoundingMethod¶
-
LayoutLengthOptions.
NetlistRoundingMethod
¶ Returns or sets the rounding method to apply to Connection List lengths.
-------------------------------------
Getter Method
Signature
NetlistRoundingMethod
Returns: Return type: NXOpen.Formboard.LayoutLengthOptionsRoundingMethod
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------
Setter Method
Signature
NetlistRoundingMethod
Parameters: netlistRoundingMethod ( NXOpen.Formboard.LayoutLengthOptionsRoundingMethod
) –New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
OverstockLengthIncrement¶
-
LayoutLengthOptions.
OverstockLengthIncrement
¶ Returns the overstock length increment.
Only used when the
Formboard.LayoutLengthOptions.OverstockRoundingMethod`()
isFormboard.LayoutLengthOptionsRoundingMethod.UpToNearest
orFormboard.LayoutLengthOptionsRoundingMethod.DownToNearest
.-------------------------------------
Getter Method
Signature
OverstockLengthIncrement
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
OverstockRoundingMethod¶
-
LayoutLengthOptions.
OverstockRoundingMethod
¶ Returns or sets the rounding method to apply to overstock wrapped lengths.
-------------------------------------
Getter Method
Signature
OverstockRoundingMethod
Returns: Return type: NXOpen.Formboard.LayoutLengthOptionsRoundingMethod
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------
Setter Method
Signature
OverstockRoundingMethod
Parameters: overstockRoundingMethod ( NXOpen.Formboard.LayoutLengthOptionsRoundingMethod
) –New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
SegmentLengthIncrement¶
-
LayoutLengthOptions.
SegmentLengthIncrement
¶ Returns the segment length increment.
Only used when the
Formboard.LayoutLengthOptions.SegmentRoundingMethod`()
isFormboard.LayoutLengthOptionsRoundingMethod.UpToNearest
orFormboard.LayoutLengthOptionsRoundingMethod.DownToNearest
.-------------------------------------
Getter Method
Signature
SegmentLengthIncrement
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
SegmentRoundingMethod¶
-
LayoutLengthOptions.
SegmentRoundingMethod
¶ Returns or sets the rounding method to apply to segment lengths.
-------------------------------------
Getter Method
Signature
SegmentRoundingMethod
Returns: Return type: NXOpen.Formboard.LayoutLengthOptionsRoundingMethod
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------
Setter Method
Signature
SegmentRoundingMethod
Parameters: segmentRoundingMethod ( NXOpen.Formboard.LayoutLengthOptionsRoundingMethod
) –New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
Method Detail¶
Validate¶
-
LayoutLengthOptions.
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.