SelectionTestBuilder Class¶
-
class
NXOpen.Features.SelectionTestBuilder¶ Bases:
NXOpen.BuilderBuilder for the SelectionTest class
To create a new instance of this class, use
NXOpen.DebugSession.CreateSelectionTestBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| Axis | Returns or sets the axis. |
| BuilderFilterSelectObject | Returns the object used for single selection of a generic object using a builder based filter |
| ComboSelectObject1 | Returns the object used for combo selection of faces and curves (chaining only, selection intent not remembered) |
| ComboSelectObject2 | Returns the object used for combo selection of faces and curves (with selection intent remembered) |
| ComboSelectObject3 | Returns the object used for combo selection of faces and sections (with selection intent remembered) |
| Csys | Returns or sets the CSYS. |
| Curve | Returns the object used for creating/selecting curves. |
| Face | Returns the object used for creating/selecting faces. |
| Feature | Returns the object used for selection of features. |
| MultiSelectObject | Returns the object used for multi selection of a generic object. |
| Plane | Returns or sets the plane. |
| Point | Returns or sets the point. |
| Section | Returns the object used for building sections. |
| SingleSelectObject | Returns the object used for single selection of a generic object. |
| SuperSection | Returns the object used for building super sections. |
| Tag | Returns the Tag for this object. |
| Vector | Returns or sets the 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. |
Property Detail¶
Axis¶
-
SelectionTestBuilder.Axis¶ Returns or sets the axis.
-------------------------------------Getter Method
Signature
Axis()Returns: Return type: NXOpen.AxisNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Axis(axis)Parameters: axis ( NXOpen.Axis) –New in version NX5.0.0.
License requirements: None.
BuilderFilterSelectObject¶
-
SelectionTestBuilder.BuilderFilterSelectObject¶ Returns the object used for single selection of a generic object using a builder based filter
-------------------------------------Getter Method
Signature
BuilderFilterSelectObject()Returns: Return type: NXOpen.SelectNXObjectNew in version NX10.0.0.
License requirements: None.
ComboSelectObject1¶
-
SelectionTestBuilder.ComboSelectObject1¶ Returns the object used for combo selection of faces and curves (chaining only, selection intent not remembered)
-------------------------------------Getter Method
Signature
ComboSelectObject1()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX7.5.1.
License requirements: None.
ComboSelectObject2¶
-
SelectionTestBuilder.ComboSelectObject2¶ Returns the object used for combo selection of faces and curves (with selection intent remembered)
-------------------------------------Getter Method
Signature
ComboSelectObject2()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX7.5.1.
License requirements: None.
ComboSelectObject3¶
-
SelectionTestBuilder.ComboSelectObject3¶ Returns the object used for combo selection of faces and sections (with selection intent remembered)
-------------------------------------Getter Method
Signature
ComboSelectObject3()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX7.5.1.
License requirements: None.
Csys¶
-
SelectionTestBuilder.Csys¶ Returns or sets the CSYS.
-------------------------------------Getter Method
Signature
Csys()Returns: Return type: NXOpen.CoordinateSystemNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Csys(csys)Parameters: csys ( NXOpen.CoordinateSystem) –New in version NX5.0.0.
License requirements: None.
Curve¶
-
SelectionTestBuilder.Curve¶ Returns the object used for creating/selecting curves.
-------------------------------------Getter Method
Signature
Curve()Returns: Return type: NXOpen.ScCollectorNew in version NX5.0.0.
License requirements: None.
Face¶
-
SelectionTestBuilder.Face¶ Returns the object used for creating/selecting faces.
-------------------------------------Getter Method
Signature
Face()Returns: Return type: NXOpen.ScCollectorNew in version NX5.0.0.
License requirements: None.
Feature¶
-
SelectionTestBuilder.Feature¶ Returns the object used for selection of features.
-------------------------------------Getter Method
Signature
Feature()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX5.0.0.
License requirements: None.
MultiSelectObject¶
-
SelectionTestBuilder.MultiSelectObject¶ Returns the object used for multi selection of a generic object.
-------------------------------------Getter Method
Signature
MultiSelectObject()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX5.0.0.
License requirements: None.
Plane¶
-
SelectionTestBuilder.Plane¶ Returns or sets the plane.
-------------------------------------Getter Method
Signature
Plane()Returns: Return type: NXOpen.PlaneNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Plane(plane)Parameters: plane ( NXOpen.Plane) –New in version NX5.0.0.
License requirements: None.
Point¶
-
SelectionTestBuilder.Point¶ Returns or sets the point.
-------------------------------------Getter Method
Signature
Point()Returns: Return type: NXOpen.PointNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Point(point)Parameters: point ( NXOpen.Point) –New in version NX5.0.0.
License requirements: None.
Section¶
-
SelectionTestBuilder.Section¶ Returns the object used for building sections.
-------------------------------------Getter Method
Signature
Section()Returns: Return type: NXOpen.SectionNew in version NX5.0.0.
License requirements: None.
SingleSelectObject¶
-
SelectionTestBuilder.SingleSelectObject¶ Returns the object used for single selection of a generic object.
-------------------------------------Getter Method
Signature
SingleSelectObject()Returns: Return type: NXOpen.SelectObjectNew in version NX5.0.0.
License requirements: None.
SuperSection¶
-
SelectionTestBuilder.SuperSection¶ Returns the object used for building super sections.
-------------------------------------Getter Method
Signature
SuperSection()Returns: Return type: NXOpen.SectionNew in version NX5.0.0.
License requirements: None.
Vector¶
-
SelectionTestBuilder.Vector¶ Returns or sets the vector.
-------------------------------------Getter Method
Signature
Vector()Returns: Return type: NXOpen.DirectionNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Vector(vector)Parameters: vector ( NXOpen.Direction) –New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
SelectionTestBuilder.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.