InspectionLinkPmiBuilder Class¶
-
class
NXOpen.CAM.InspectionLinkPmiBuilder¶ Bases:
NXOpen.BuilderCreate Link PMI Dialog Builder
To create a new instance of this class, use
NXOpen.CAM.InspectionOperationCollection.CreateInspectionLinkPmiBuilder()New in version NX7.0.0.
Properties¶
| Property | Description |
|---|---|
| AngleA | Returns or sets the A angle |
| AngleB | Returns or sets the B angle |
| AngleString | Returns or sets the angle specification string |
| CollisionAvoidanceEnum | Returns or sets the collision avoidance enum |
| ComponentSelection | Returns the component selector |
| CreatePathsEnum | Returns or sets the create paths enum |
| IncludeSubComponents | Returns or sets the include sub-components option |
| PathOrderEnum | Returns or sets the path order optimization type enum |
| PointOrderEnum | Returns or sets the point order optimization type enum |
| ProbeTipType | Returns or sets the preferred probe tip type |
| ProgramLocationString | Returns or sets the program location string |
| ScopeEnum | Returns or sets the scope of the Link PMI function |
| Tag | Returns the Tag for this object. |
| TipString | Returns or sets the tip to use for inspection string |
| ToolString | Returns or sets the tool to use for inspection string |
| ViewString | Returns or sets the PMI View selection string |
| WorkpieceString | Returns or sets the name of the workpiece to be processed by Link PMI |
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. |
| GetResults | Get results from Link PMI. |
| LinkToPmi | Links PMI and GDT to Inspection features and tolerances. |
| OutputResults | Output results report from Link PMI. |
| SafePlaneDisplayAction | Button to display selected safe plane |
| SafePlaneSelectAction | Button to select safe plane |
| 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¶
| InspectionLinkPmiBuilderCollisionAvoidanceEnumType Enumeration | Specifies whether collision avoidance will be done |
| InspectionLinkPmiBuilderCreatePathsOptions Enumeration | Specifies whether paths will be created by Link PMI |
| InspectionLinkPmiBuilderPathOrderTypes Enumeration | Specifies the Path Order Optimization Type |
| InspectionLinkPmiBuilderPmiScopeTypes Enumeration | Specifies the scope of the link PMI command |
| InspectionLinkPmiBuilderPointOrderTypes Enumeration | Specifies the Point Order Optimization Type |
Property Detail¶
AngleA¶
-
InspectionLinkPmiBuilder.AngleA¶ Returns or sets the A angle
-------------------------------------Getter Method
Signature
AngleAReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleAParameters: angleA (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
AngleB¶
-
InspectionLinkPmiBuilder.AngleB¶ Returns or sets the B angle
-------------------------------------Getter Method
Signature
AngleBReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleBParameters: angleB (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
AngleString¶
-
InspectionLinkPmiBuilder.AngleString¶ Returns or sets the angle specification string
-------------------------------------Getter Method
Signature
AngleStringReturns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleStringParameters: angleString (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ComponentSelection¶
-
InspectionLinkPmiBuilder.ComponentSelection¶ Returns the component selector
-------------------------------------Getter Method
Signature
ComponentSelectionReturns: Return type: NXOpen.SelectNXObjectListNew in version NX9.0.3.
License requirements: None.
CreatePathsEnum¶
-
InspectionLinkPmiBuilder.CreatePathsEnum¶ Returns or sets the create paths enum
-------------------------------------Getter Method
Signature
CreatePathsEnumReturns: Return type: NXOpen.CAM.InspectionLinkPmiBuilderCreatePathsOptionsNew in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreatePathsEnumParameters: createPathsEnum ( NXOpen.CAM.InspectionLinkPmiBuilderCreatePathsOptions) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
IncludeSubComponents¶
-
InspectionLinkPmiBuilder.IncludeSubComponents¶ Returns or sets the include sub-components option
-------------------------------------Getter Method
Signature
IncludeSubComponentsReturns: Return type: bool New in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
IncludeSubComponentsParameters: includeSubComponents (bool) – New in version NX9.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
PathOrderEnum¶
-
InspectionLinkPmiBuilder.PathOrderEnum¶ Returns or sets the path order optimization type enum
-------------------------------------Getter Method
Signature
PathOrderEnumReturns: Return type: NXOpen.CAM.InspectionLinkPmiBuilderPathOrderTypesNew in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PathOrderEnumParameters: pathOrderEnum ( NXOpen.CAM.InspectionLinkPmiBuilderPathOrderTypes) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
PointOrderEnum¶
-
InspectionLinkPmiBuilder.PointOrderEnum¶ Returns or sets the point order optimization type enum
-------------------------------------Getter Method
Signature
PointOrderEnumReturns: Return type: NXOpen.CAM.InspectionLinkPmiBuilderPointOrderTypesNew in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PointOrderEnumParameters: pointOrderEnum ( NXOpen.CAM.InspectionLinkPmiBuilderPointOrderTypes) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ProbeTipType¶
-
InspectionLinkPmiBuilder.ProbeTipType¶ Returns or sets the preferred probe tip type
-------------------------------------Getter Method
Signature
ProbeTipTypeReturns: Return type: NXOpen.CAM.InspectionMoveBuilderProbeTipTypesNew in version NX9.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
ProbeTipTypeParameters: tipType ( NXOpen.CAM.InspectionMoveBuilderProbeTipTypes) –New in version NX9.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ProgramLocationString¶
-
InspectionLinkPmiBuilder.ProgramLocationString¶ Returns or sets the program location string
-------------------------------------Getter Method
Signature
ProgramLocationStringReturns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ProgramLocationStringParameters: programLocationString (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ScopeEnum¶
-
InspectionLinkPmiBuilder.ScopeEnum¶ Returns or sets the scope of the Link PMI function
-------------------------------------Getter Method
Signature
ScopeEnumReturns: Return type: NXOpen.CAM.InspectionLinkPmiBuilderPmiScopeTypesNew in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScopeEnumParameters: scopeEnum ( NXOpen.CAM.InspectionLinkPmiBuilderPmiScopeTypes) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
TipString¶
-
InspectionLinkPmiBuilder.TipString¶ Returns or sets the tip to use for inspection string
-------------------------------------Getter Method
Signature
TipStringReturns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TipStringParameters: tipString (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ToolString¶
-
InspectionLinkPmiBuilder.ToolString¶ Returns or sets the tool to use for inspection string
-------------------------------------Getter Method
Signature
ToolStringReturns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToolStringParameters: toolString (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ViewString¶
-
InspectionLinkPmiBuilder.ViewString¶ Returns or sets the PMI View selection string
-------------------------------------Getter Method
Signature
ViewStringReturns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ViewStringParameters: viewString (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
WorkpieceString¶
-
InspectionLinkPmiBuilder.WorkpieceString¶ Returns or sets the name of the workpiece to be processed by Link PMI
-------------------------------------Getter Method
Signature
WorkpieceStringReturns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
WorkpieceStringParameters: workpieceString (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
GetResults¶
-
InspectionLinkPmiBuilder.GetResults¶ Get results from Link PMI.
Signature
GetResults()Returns: Results strings Return type: list of str New in version NX8.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
LinkToPmi¶
-
InspectionLinkPmiBuilder.LinkToPmi¶ Links PMI and GDT to Inspection features and tolerances.
Signature
LinkToPmi()New in version NX8.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
OutputResults¶
-
InspectionLinkPmiBuilder.OutputResults¶ Output results report from Link PMI.
Signature
OutputResults(deviceType, fileName)Parameters: - deviceType (
NXOpen.ListingWindowDeviceType) – The type of device (file, Information window, or both) - fileName (str) – Name of the file. Used only if the device type is file or both.
New in version NX8.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
- deviceType (
SafePlaneDisplayAction¶
-
InspectionLinkPmiBuilder.SafePlaneDisplayAction¶ Button to display selected safe plane
Signature
SafePlaneDisplayAction()New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SafePlaneSelectAction¶
-
InspectionLinkPmiBuilder.SafePlaneSelectAction¶ Button to select safe plane
Signature
SafePlaneSelectAction()New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Validate¶
-
InspectionLinkPmiBuilder.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.