AlignStockBuilder Class¶
-
class
NXOpen.Routing.AlignStockBuilder¶ Bases:
NXOpen.BuilderRepresents a
Routing.AlignStockBuilderBuilder for aligning non-circular stocks.Two methods are provided to user to make stocks alignment: Routing Object: specify the referencing routing object and deriving the reference rotate vector from it, Vector to Vector: specify the to vector as reference and the from vector as the target, then align them.
To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateAlignStockBuilder()Default values.
Property Value AlignmentMethod RoutingObject New in version NX9.0.3.
Properties¶
| Property | Description |
|---|---|
| AlignmentMethod | Returns or sets the alignment method. |
| ReferenceObject | Returns the reference object. |
| ReferenceVector | Returns or sets the reference vector. |
| StocksToAlign | Returns a collection of stocks to align. |
| Tag | Returns the Tag for this object. |
| TargetVector | Returns or sets the target vector. |
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¶
| AlignStockBuilderStockAlignmentMethod Enumeration | Methods of aligning stocks. |
Property Detail¶
AlignmentMethod¶
-
AlignStockBuilder.AlignmentMethod¶ Returns or sets the alignment method.
-------------------------------------Getter Method
Signature
AlignmentMethodReturns: Return type: NXOpen.Routing.AlignStockBuilderStockAlignmentMethodNew in version NX9.0.3.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
AlignmentMethodParameters: alignmentMethod ( NXOpen.Routing.AlignStockBuilderStockAlignmentMethod) –New in version NX9.0.3.
License requirements: routing_base (“Routing Basic”)
ReferenceObject¶
-
AlignStockBuilder.ReferenceObject¶ Returns the reference object.
The reference object could be a stock or a qualified part.
-------------------------------------Getter Method
Signature
ReferenceObjectReturns: Return type: NXOpen.Routing.RouteObjectCollectorNew in version NX9.0.3.
License requirements: routing_base (“Routing Basic”)
ReferenceVector¶
-
AlignStockBuilder.ReferenceVector¶ Returns or sets the reference vector.
-------------------------------------Getter Method
Signature
ReferenceVectorReturns: Return type: NXOpen.DirectionNew in version NX9.0.3.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
ReferenceVectorParameters: toVector ( NXOpen.Direction) –New in version NX9.0.3.
License requirements: routing_base (“Routing Basic”)
StocksToAlign¶
-
AlignStockBuilder.StocksToAlign¶ Returns a collection of stocks to align.
-------------------------------------Getter Method
Signature
StocksToAlignReturns: Return type: NXOpen.Routing.RouteObjectCollectorNew in version NX9.0.3.
License requirements: routing_base (“Routing Basic”)
TargetVector¶
-
AlignStockBuilder.TargetVector¶ Returns or sets the target vector.
-------------------------------------Getter Method
Signature
TargetVectorReturns: Return type: NXOpen.DirectionNew in version NX9.0.3.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
TargetVectorParameters: fromVector ( NXOpen.Direction) –New in version NX9.0.3.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
Validate¶
-
AlignStockBuilder.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.