OrientXpressTestBuilder Class¶
-
class
NXOpen.GeometricUtilities.OrientXpressTestBuilder¶ Bases:
NXOpen.BuilderRepresents a
ModlUtilsJA.OrientXpressTestbuilderOrientXpressTest is not supported in KF.
New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| ActiveAxis | Returns or sets the active axis |
| ActivePlane | Returns or sets the active plane |
| DisplayAxisBlock | Returns or sets the display axis block |
| DisplayPlaneBlock | Returns or sets the display plane block |
| DisplayReferenceBlock | Returns or sets the display reference block |
| DisplayXaxis | Returns or sets the display x-axis |
| DisplayXyplane | Returns or sets the display xy-plane |
| DisplayXzplane | Returns or sets the display xz-plane |
| DisplayYaxis | Returns or sets the display y-axis |
| DisplayYzplane | Returns or sets the display yz-plane |
| DisplayZaxis | Returns or sets the display z-axis |
| SelectFixedCsys | Returns the select fixed csys |
| SelectProgramCsys | Returns the select program defined csys |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the test type |
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¶
| OrientXpressTestBuilderAxis Enumeration | the active axis options |
| OrientXpressTestBuilderAxisBlock Enumeration | the options to show or hide the axis block |
| OrientXpressTestBuilderPlane Enumeration | the active plane options |
| OrientXpressTestBuilderPlaneBlock Enumeration | the options to show or hide the plane block |
| OrientXpressTestBuilderReferenceBlock Enumeration | the options to show or hide the reference block |
| OrientXpressTestBuilderTypes Enumeration | the test types |
Property Detail¶
ActiveAxis¶
-
OrientXpressTestBuilder.ActiveAxis¶ Returns or sets the active axis
-------------------------------------Getter Method
Signature
ActiveAxisReturns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderAxisNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ActiveAxisParameters: activeAxis ( NXOpen.GeometricUtilities.OrientXpressTestBuilderAxis) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ActivePlane¶
-
OrientXpressTestBuilder.ActivePlane¶ Returns or sets the active plane
-------------------------------------Getter Method
Signature
ActivePlaneReturns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderPlaneNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ActivePlaneParameters: activePlane ( NXOpen.GeometricUtilities.OrientXpressTestBuilderPlane) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayAxisBlock¶
-
OrientXpressTestBuilder.DisplayAxisBlock¶ Returns or sets the display axis block
-------------------------------------Getter Method
Signature
DisplayAxisBlockReturns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderAxisBlockNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayAxisBlockParameters: displayAxisBlock ( NXOpen.GeometricUtilities.OrientXpressTestBuilderAxisBlock) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayPlaneBlock¶
-
OrientXpressTestBuilder.DisplayPlaneBlock¶ Returns or sets the display plane block
-------------------------------------Getter Method
Signature
DisplayPlaneBlockReturns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderPlaneBlockNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayPlaneBlockParameters: displayPlaneBlock ( NXOpen.GeometricUtilities.OrientXpressTestBuilderPlaneBlock) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayReferenceBlock¶
-
OrientXpressTestBuilder.DisplayReferenceBlock¶ Returns or sets the display reference block
-------------------------------------Getter Method
Signature
DisplayReferenceBlockReturns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderReferenceBlockNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayReferenceBlockParameters: displayReferenceBlock ( NXOpen.GeometricUtilities.OrientXpressTestBuilderReferenceBlock) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayXaxis¶
-
OrientXpressTestBuilder.DisplayXaxis¶ Returns or sets the display x-axis
-------------------------------------Getter Method
Signature
DisplayXaxisReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayXaxisParameters: displayXaxis (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayXyplane¶
-
OrientXpressTestBuilder.DisplayXyplane¶ Returns or sets the display xy-plane
-------------------------------------Getter Method
Signature
DisplayXyplaneReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayXyplaneParameters: displayXYplane (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayXzplane¶
-
OrientXpressTestBuilder.DisplayXzplane¶ Returns or sets the display xz-plane
-------------------------------------Getter Method
Signature
DisplayXzplaneReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayXzplaneParameters: displayXZplane (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayYaxis¶
-
OrientXpressTestBuilder.DisplayYaxis¶ Returns or sets the display y-axis
-------------------------------------Getter Method
Signature
DisplayYaxisReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayYaxisParameters: displayYaxis (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayYzplane¶
-
OrientXpressTestBuilder.DisplayYzplane¶ Returns or sets the display yz-plane
-------------------------------------Getter Method
Signature
DisplayYzplaneReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayYzplaneParameters: displayYZplane (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DisplayZaxis¶
-
OrientXpressTestBuilder.DisplayZaxis¶ Returns or sets the display z-axis
-------------------------------------Getter Method
Signature
DisplayZaxisReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayZaxisParameters: displayZaxis (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SelectFixedCsys¶
-
OrientXpressTestBuilder.SelectFixedCsys¶ Returns the select fixed csys
-------------------------------------Getter Method
Signature
SelectFixedCsysReturns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
SelectProgramCsys¶
-
OrientXpressTestBuilder.SelectProgramCsys¶ Returns the select program defined csys
-------------------------------------Getter Method
Signature
SelectProgramCsysReturns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Type¶
-
OrientXpressTestBuilder.Type¶ Returns or sets the test type
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypeParameters: type ( NXOpen.GeometricUtilities.OrientXpressTestBuilderTypes) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
Validate¶
-
OrientXpressTestBuilder.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.