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
ActiveAxis()Returns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderAxisNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ActiveAxis(activeAxis)Parameters: 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
ActivePlane()Returns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderPlaneNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ActivePlane(activePlane)Parameters: 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
DisplayAxisBlock()Returns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderAxisBlockNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayAxisBlock(displayAxisBlock)Parameters: 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
DisplayPlaneBlock()Returns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderPlaneBlockNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayPlaneBlock(displayPlaneBlock)Parameters: 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
DisplayReferenceBlock()Returns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderReferenceBlockNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayReferenceBlock(displayReferenceBlock)Parameters: 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
DisplayXaxis()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayXaxis(displayXaxis)Parameters: 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
DisplayXyplane()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayXyplane(displayXYplane)Parameters: 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
DisplayXzplane()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayXzplane(displayXZplane)Parameters: 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
DisplayYaxis()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayYaxis(displayYaxis)Parameters: 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
DisplayYzplane()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayYzplane(displayYZplane)Parameters: 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
DisplayZaxis()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayZaxis(displayZaxis)Parameters: 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
SelectFixedCsys()Returns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
SelectProgramCsys¶
-
OrientXpressTestBuilder.SelectProgramCsys¶ Returns the select program defined csys
-------------------------------------Getter Method
Signature
SelectProgramCsys()Returns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Type¶
-
OrientXpressTestBuilder.Type¶ Returns or sets the test type
-------------------------------------Getter Method
Signature
Type()Returns: Return type: NXOpen.GeometricUtilities.OrientXpressTestBuilderTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Type(type)Parameters: 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.