StockOffsetPointBuilder Class

class NXOpen.Routing.StockOffsetPointBuilder

Bases: NXOpen.Builder

Applies Assemblies Constraints to a selected NXOpen.Point or NXOpen.Routing.ControlPoint to mimic the update/move behavior of the input smart NXOpen.Point.

The smart point may be a Routing stock offset point (see NXOpen.PointCollection.CreateStockOffsetPoint()) or any of the points created using the NXOpen.PointCollection class.

To create a new instance of this class, use NXOpen.Routing.RouteManager.CreateStockOffsetPointBuilder()

New in version NX6.0.0.

Properties

Property Description
ConstraintPoint Returns or sets the point that defines the location of the selected point.
PointSelection Returns the point selection.
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.
GetPointData Gets the stock offset data from the currently selected point or routing control point.
GetStockOffsetPointObject Gets the object on which a Stock Offset Point was based.
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

ConstraintPoint

StockOffsetPointBuilder.ConstraintPoint

Returns or sets the point that defines the location of the selected point.

On commit, this point is used for determining the set of Assemblies Constraints to apply to the selected point (or Routing control point). The input point itself is not used after the commit method.

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

Getter Method

Signature ConstraintPoint

Returns:
Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

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

Setter Method

Signature ConstraintPoint

Parameters:point (NXOpen.Point) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

PointSelection

StockOffsetPointBuilder.PointSelection

Returns the point selection.

Stores the point or Routing control point selected by the user.

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

Getter Method

Signature PointSelection

Returns:
Return type:NXOpen.SelectNXObject

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

Method Detail

GetPointData

StockOffsetPointBuilder.GetPointData

Gets the stock offset data from the currently selected point or routing control point.

Signature GetPointData()

Returns:a tuple
Return type:A tuple consisting of (pointType, basePoint, offsetDir, offsetExpression). pointType is a NXOpen.Routing.StockOffsetPointBuilderPointType. Type of point currently defined. basePoint is a NXOpen.Point. Base point for stock offset points, None for:py:class:Routing.StockOffsetPointBuilderPointType.Normal <Routing.StockOffsetPointBuilderPointType> points. offsetDir is a NXOpen.Direction. Offset direction for stock offset points, None for:py:class:Routing.StockOffsetPointBuilderPointType.Normal <Routing.StockOffsetPointBuilderPointType> points. offsetExpression is a str. Offset expression for stock offset points, None for:py:class:Routing.StockOffsetPointBuilderPointType.Normal <Routing.StockOffsetPointBuilderPointType> points.

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetStockOffsetPointObject

StockOffsetPointBuilder.GetStockOffsetPointObject

Gets the object on which a Stock Offset Point was based.

Returns None if the point is not a Stock Offset Point or if the Stock Offset Point was not offset from another object.

Signature GetStockOffsetPointObject()

Returns:
Return type:NXOpen.TaggedObject

New in version NX11.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

Validate

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