NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAM::InspectionLinkPmiBuilder Class Reference

Create Link PMI Dialog Builder
To create a new instance of this class, use NXOpen::CAM::InspectionOperationCollection::CreateInspectionLinkPmiBuilder

Created in NX7.0.0. More...

Inheritance diagram for NXOpen::CAM::InspectionLinkPmiBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CollisionAvoidanceEnumType { CollisionAvoidanceEnumTypeOff, CollisionAvoidanceEnumTypeOn }
 Specifies whether collision avoidance will be done. More...
 
enum  CreatePathsOptions { CreatePathsOptionsYes, CreatePathsOptionsNo }
 Specifies whether paths will be created by Link PMI. More...
 
enum  PathOrderTypes { PathOrderTypesOff, PathOrderTypesBySensor, PathOrderTypesNearestNeighbor, PathOrderTypesShortestPath }
 Specifies the Path Order Optimization Type. More...
 
enum  PmiScopeTypes { PmiScopeTypesWorkpieceOnly, PmiScopeTypesWorkpieceandComponents }
 Specifies the scope of the link PMI command. More...
 
enum  PointOrderTypes { PointOrderTypesOff, PointOrderTypesNearestNeighbor, PointOrderTypesShortestPath }
 Specifies the Point Order Optimization Type. More...
 

Public Member Functions

double AngleA ()
 Returns the A angle
Created in NX7.0.0. More...
 
double AngleB ()
 Returns the B angle
Created in NX7.0.0. More...
 
NXString AngleString ()
 Returns the angle specification string
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionLinkPmiBuilder::CollisionAvoidanceEnumType CollisionAvoidanceEnum ()
 Returns the collision avoidance enum
Created in NX7.0.0. More...
 
NXOpen::SelectNXObjectListComponentSelection ()
 Returns the component selector
Created in NX9.0.3. More...
 
NXOpen::CAM::InspectionLinkPmiBuilder::CreatePathsOptions CreatePathsEnum ()
 Returns the create paths enum
Created in NX7.0.0. More...
 
std::vector< NXStringGetResults ()
 Get results from Link PMI. More...
 
bool IncludeSubComponents ()
 Returns the include sub-components option
Created in NX9.0.3. More...
 
void LinkToPmi ()
 Links PMI and GDT to Inspection features and tolerances. More...
 
void OutputResults (NXOpen::ListingWindow::DeviceType deviceType, const NXString &fileName)
 Output results report from Link PMI. More...
 
void OutputResults (NXOpen::ListingWindow::DeviceType deviceType, const char *fileName)
 Output results report from Link PMI. More...
 
NXOpen::CAM::InspectionLinkPmiBuilder::PathOrderTypes PathOrderEnum ()
 Returns the path order optimization type enum
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionLinkPmiBuilder::PointOrderTypes PointOrderEnum ()
 Returns the point order optimization type enum
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionMoveBuilder::ProbeTipTypes ProbeTipType ()
 Returns the preferred probe tip type
Created in NX9.0.1. More...
 
NXString ProgramLocationString ()
 Returns the program location string
Created in NX7.0.0. More...
 
void SafePlaneDisplayAction ()
 Button to display selected safe plane
Created in NX7.0.0. More...
 
void SafePlaneSelectAction ()
 Button to select safe plane
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionLinkPmiBuilder::PmiScopeTypes ScopeEnum ()
 Returns the scope of the Link PMI function
Created in NX7.0.0. More...
 
void SetAngleA (double angleA)
 Sets the A angle
Created in NX7.0.0. More...
 
void SetAngleB (double angleB)
 Sets the B angle
Created in NX7.0.0. More...
 
void SetAngleString (const NXString &angleString)
 Sets the angle specification string
Created in NX7.0.0. More...
 
void SetAngleString (const char *angleString)
 Sets the angle specification string
Created in NX7.0.0. More...
 
void SetCollisionAvoidanceEnum (NXOpen::CAM::InspectionLinkPmiBuilder::CollisionAvoidanceEnumType collisionAvoidanceEnum)
 Sets the collision avoidance enum
Created in NX7.0.0. More...
 
void SetCreatePathsEnum (NXOpen::CAM::InspectionLinkPmiBuilder::CreatePathsOptions createPathsEnum)
 Sets the create paths enum
Created in NX7.0.0. More...
 
void SetIncludeSubComponents (bool includeSubComponents)
 Sets the include sub-components option
Created in NX9.0.3. More...
 
void SetPathOrderEnum (NXOpen::CAM::InspectionLinkPmiBuilder::PathOrderTypes pathOrderEnum)
 Sets the path order optimization type enum
Created in NX7.0.0. More...
 
void SetPointOrderEnum (NXOpen::CAM::InspectionLinkPmiBuilder::PointOrderTypes pointOrderEnum)
 Sets the point order optimization type enum
Created in NX7.0.0. More...
 
void SetProbeTipType (NXOpen::CAM::InspectionMoveBuilder::ProbeTipTypes tipType)
 Sets the preferred probe tip type
Created in NX9.0.1. More...
 
void SetProgramLocationString (const NXString &programLocationString)
 Sets the program location string
Created in NX7.0.0. More...
 
void SetProgramLocationString (const char *programLocationString)
 Sets the program location string
Created in NX7.0.0. More...
 
void SetScopeEnum (NXOpen::CAM::InspectionLinkPmiBuilder::PmiScopeTypes scopeEnum)
 Sets the scope of the Link PMI function
Created in NX7.0.0. More...
 
void SetTipString (const NXString &tipString)
 Sets the tip to use for inspection string
Created in NX7.0.0. More...
 
void SetTipString (const char *tipString)
 Sets the tip to use for inspection string
Created in NX7.0.0. More...
 
void SetToolString (const NXString &toolString)
 Sets the tool to use for inspection string
Created in NX7.0.0. More...
 
void SetToolString (const char *toolString)
 Sets the tool to use for inspection string
Created in NX7.0.0. More...
 
void SetViewString (const NXString &viewString)
 Sets the PMI View selection string
Created in NX7.0.0. More...
 
void SetViewString (const char *viewString)
 Sets the PMI View selection string
Created in NX7.0.0. More...
 
void SetWorkpieceString (const NXString &workpieceString)
 Sets the name of the workpiece to be processed by Link PMI
Created in NX7.0.0. More...
 
void SetWorkpieceString (const char *workpieceString)
 Sets the name of the workpiece to be processed by Link PMI
Created in NX7.0.0. More...
 
NXString TipString ()
 Returns the tip to use for inspection string
Created in NX7.0.0. More...
 
NXString ToolString ()
 Returns the tool to use for inspection string
Created in NX7.0.0. More...
 
NXString ViewString ()
 Returns the PMI View selection string
Created in NX7.0.0. More...
 
NXString WorkpieceString ()
 Returns the name of the workpiece to be processed by Link PMI
Created in NX7.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Create Link PMI Dialog Builder
To create a new instance of this class, use NXOpen::CAM::InspectionOperationCollection::CreateInspectionLinkPmiBuilder

Created in NX7.0.0.


Member Enumeration Documentation

Specifies whether collision avoidance will be done.

Enumerator
CollisionAvoidanceEnumTypeOff 

Collision avoidance will not be done.

CollisionAvoidanceEnumTypeOn 

Collision avoidance will be done.

Specifies whether paths will be created by Link PMI.

Enumerator
CreatePathsOptionsYes 

Paths will be created by Link PMI.

CreatePathsOptionsNo 

Paths will not be created by Link PMI.

Specifies the Path Order Optimization Type.

Enumerator
PathOrderTypesOff 

No path order optimization will be done.

PathOrderTypesBySensor 

Path order optimization will use the by sensor method.

PathOrderTypesNearestNeighbor 

Path order optimization will use the nearest neighbor method.

PathOrderTypesShortestPath 

Path order optimization will use the shortest path method.

Specifies the scope of the link PMI command.

Enumerator
PmiScopeTypesWorkpieceOnly 

Link PMI will be performed for the workpiece only.

PmiScopeTypesWorkpieceandComponents 

Link PMI will be performed for the workpiece and components.

Specifies the Point Order Optimization Type.

Enumerator
PointOrderTypesOff 

No point order optimization will be done.

PointOrderTypesNearestNeighbor 

Point order optimization will use the nearest neighbor method.

PointOrderTypesShortestPath 

Point order optimization will use the shortest path method.

Member Function Documentation

double NXOpen::CAM::InspectionLinkPmiBuilder::AngleA ( )

Returns the A angle
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionLinkPmiBuilder::AngleB ( )

Returns the B angle
Created in NX7.0.0.



License requirements : None

NXString NXOpen::CAM::InspectionLinkPmiBuilder::AngleString ( )

Returns the angle specification string
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InspectionLinkPmiBuilder::CollisionAvoidanceEnumType NXOpen::CAM::InspectionLinkPmiBuilder::CollisionAvoidanceEnum ( )

Returns the collision avoidance enum
Created in NX7.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::CAM::InspectionLinkPmiBuilder::ComponentSelection ( )

Returns the component selector
Created in NX9.0.3.



License requirements : None

NXOpen::CAM::InspectionLinkPmiBuilder::CreatePathsOptions NXOpen::CAM::InspectionLinkPmiBuilder::CreatePathsEnum ( )

Returns the create paths enum
Created in NX7.0.0.



License requirements : None

std::vector<NXString> NXOpen::CAM::InspectionLinkPmiBuilder::GetResults ( )

Get results from Link PMI.

Returns
Results strings
Created in NX8.0.1.

License requirements : insp_programming ("INSPECTION PROGRAMMING")
bool NXOpen::CAM::InspectionLinkPmiBuilder::IncludeSubComponents ( )

Returns the include sub-components option
Created in NX9.0.3.



License requirements : None

void NXOpen::CAM::InspectionLinkPmiBuilder::LinkToPmi ( )

Links PMI and GDT to Inspection features and tolerances.


Created in NX8.0.1.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionLinkPmiBuilder::OutputResults ( NXOpen::ListingWindow::DeviceType  deviceType,
const NXString fileName 
)

Output results report from Link PMI.


Created in NX8.0.1.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
deviceTypeThe type of device (file, Information window, or both)
fileNameName of the file. Used only if the device type is file or both.
void NXOpen::CAM::InspectionLinkPmiBuilder::OutputResults ( NXOpen::ListingWindow::DeviceType  deviceType,
const char *  fileName 
)

Output results report from Link PMI.


Created in NX8.0.1.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
deviceTypeThe type of device (file, Information window, or both)
fileNameName of the file. Used only if the device type is file or both.
NXOpen::CAM::InspectionLinkPmiBuilder::PathOrderTypes NXOpen::CAM::InspectionLinkPmiBuilder::PathOrderEnum ( )

Returns the path order optimization type enum
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InspectionLinkPmiBuilder::PointOrderTypes NXOpen::CAM::InspectionLinkPmiBuilder::PointOrderEnum ( )

Returns the point order optimization type enum
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InspectionMoveBuilder::ProbeTipTypes NXOpen::CAM::InspectionLinkPmiBuilder::ProbeTipType ( )

Returns the preferred probe tip type
Created in NX9.0.1.



License requirements : None

NXString NXOpen::CAM::InspectionLinkPmiBuilder::ProgramLocationString ( )

Returns the program location string
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionLinkPmiBuilder::SafePlaneDisplayAction ( )

Button to display selected safe plane
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionLinkPmiBuilder::SafePlaneSelectAction ( )

Button to select safe plane
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

NXOpen::CAM::InspectionLinkPmiBuilder::PmiScopeTypes NXOpen::CAM::InspectionLinkPmiBuilder::ScopeEnum ( )

Returns the scope of the Link PMI function
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionLinkPmiBuilder::SetAngleA ( double  angleA)

Sets the A angle
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
angleAanglea
void NXOpen::CAM::InspectionLinkPmiBuilder::SetAngleB ( double  angleB)

Sets the B angle
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
angleBangleb
void NXOpen::CAM::InspectionLinkPmiBuilder::SetAngleString ( const NXString angleString)

Sets the angle specification string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
angleStringanglestring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetAngleString ( const char *  angleString)

Sets the angle specification string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
angleStringanglestring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetCollisionAvoidanceEnum ( NXOpen::CAM::InspectionLinkPmiBuilder::CollisionAvoidanceEnumType  collisionAvoidanceEnum)

Sets the collision avoidance enum
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
collisionAvoidanceEnumcollisionavoidanceenum
void NXOpen::CAM::InspectionLinkPmiBuilder::SetCreatePathsEnum ( NXOpen::CAM::InspectionLinkPmiBuilder::CreatePathsOptions  createPathsEnum)

Sets the create paths enum
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
createPathsEnumcreatepathsenum
void NXOpen::CAM::InspectionLinkPmiBuilder::SetIncludeSubComponents ( bool  includeSubComponents)

Sets the include sub-components option
Created in NX9.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
includeSubComponentsincludesubcomponents
void NXOpen::CAM::InspectionLinkPmiBuilder::SetPathOrderEnum ( NXOpen::CAM::InspectionLinkPmiBuilder::PathOrderTypes  pathOrderEnum)

Sets the path order optimization type enum
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
pathOrderEnumpathorderenum
void NXOpen::CAM::InspectionLinkPmiBuilder::SetPointOrderEnum ( NXOpen::CAM::InspectionLinkPmiBuilder::PointOrderTypes  pointOrderEnum)

Sets the point order optimization type enum
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
pointOrderEnumpointorderenum
void NXOpen::CAM::InspectionLinkPmiBuilder::SetProbeTipType ( NXOpen::CAM::InspectionMoveBuilder::ProbeTipTypes  tipType)

Sets the preferred probe tip type
Created in NX9.0.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
tipTypetiptype
void NXOpen::CAM::InspectionLinkPmiBuilder::SetProgramLocationString ( const NXString programLocationString)

Sets the program location string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
programLocationStringprogramlocationstring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetProgramLocationString ( const char *  programLocationString)

Sets the program location string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
programLocationStringprogramlocationstring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetScopeEnum ( NXOpen::CAM::InspectionLinkPmiBuilder::PmiScopeTypes  scopeEnum)

Sets the scope of the Link PMI function
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
scopeEnumscopeenum
void NXOpen::CAM::InspectionLinkPmiBuilder::SetTipString ( const NXString tipString)

Sets the tip to use for inspection string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
tipStringtipstring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetTipString ( const char *  tipString)

Sets the tip to use for inspection string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
tipStringtipstring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetToolString ( const NXString toolString)

Sets the tool to use for inspection string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
toolStringtoolstring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetToolString ( const char *  toolString)

Sets the tool to use for inspection string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
toolStringtoolstring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetViewString ( const NXString viewString)

Sets the PMI View selection string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
viewStringviewstring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetViewString ( const char *  viewString)

Sets the PMI View selection string
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
viewStringviewstring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetWorkpieceString ( const NXString workpieceString)

Sets the name of the workpiece to be processed by Link PMI
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
workpieceStringworkpiecestring
void NXOpen::CAM::InspectionLinkPmiBuilder::SetWorkpieceString ( const char *  workpieceString)

Sets the name of the workpiece to be processed by Link PMI
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
workpieceStringworkpiecestring
NXString NXOpen::CAM::InspectionLinkPmiBuilder::TipString ( )

Returns the tip to use for inspection string
Created in NX7.0.0.



License requirements : None

NXString NXOpen::CAM::InspectionLinkPmiBuilder::ToolString ( )

Returns the tool to use for inspection string
Created in NX7.0.0.



License requirements : None

NXString NXOpen::CAM::InspectionLinkPmiBuilder::ViewString ( )

Returns the PMI View selection string
Created in NX7.0.0.



License requirements : None

NXString NXOpen::CAM::InspectionLinkPmiBuilder::WorkpieceString ( )

Returns the name of the workpiece to be processed by Link PMI
Created in NX7.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.