NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::InspectionPathBuilder Class Reference

Represents the builder for a CMM Inspection path. More...

Inheritance diagram for NXOpen::CAM::InspectionPathBuilder:
NXOpen::CAM::OperationBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  EntryExitType { EntryExitTypeEntry, EntryExitTypeExit }
 the entry/exit flag More...
enum  FirstLastType { FirstLastTypeFirst, FirstLastTypeLast }
 the first/last flag More...
enum  InspectModeType { InspectModeTypeDefault, InspectModeTypeProgram, InspectModeTypeManual, InspectModeTypeAuto }
 the inspection mode More...
enum  SequenceType { SequenceTypeNone, SequenceTypeNearest, SequenceTypeUStrip, SequenceTypeVStrip }
 the path point sequence optimization method More...

Public Member Functions

bool CreateEntryPoint ()
 Returns a flag to indicate if an entry point is required
Created in NX7.0.0.
bool CreateExitPoint ()
 Returns a flag to indicate if an exit point is required
Created in NX7.0.0.
void EditEntryExitPoints (bool regenerate)
 Edit entry or exit point
Created in NX8.0.0.
void EditStartEndPoints (bool regenerate)
 Edit first or last point in safe plane
Created in NX8.0.0.
NXString FeatureOpName ()
 Returns the inspection feature operation name
Created in NX7.0.0.
void FlipApproachDirection ()
 Flips the approach direction vector
Created in NX7.0.0.
std::vector< double > GetApproachDirection ()
 Gets the approach direction vector values.
NXOpen::CAM::InheritableDoubleBuilderHeightAboveFeature ()
 Returns the height above feature for entry and exit points
Created in NX7.0.0.
NXOpen::CAM::InspectionPathBuilder::InspectModeType InspectionMode ()
 Returns the inspection mode setting
Created in NX7.0.0.
NXOpen::CAM::InheritableIntBuilderNumPoints ()
 Returns the number of points in the path
Created in NX7.0.0.
NXString PathOpName ()
 Returns the inspection path operation name
Created in NX7.0.0.
bool ProjectLastPointToSafePlane ()
 Returns a flag to indicate if last point is created in safe plane
Created in NX7.0.0.
bool ProjectStartPointToSafePlane ()
 Returns a flag to indicate if start point is created in safe plane
Created in NX7.0.0.
bool ReGenerateEntryExit (NXOpen::CAM::InspectionPathBuilder::EntryExitType entryExit)
 ReGenerate entry or exit point.
bool ReGenerateInSafePlane (NXOpen::CAM::InspectionPathBuilder::FirstLastType firstLast)
 ReGenerate first or last point in safe plane.
NXOpen::NXObjectSafePlaneXform ()
 Returns the safe plane
Created in NX7.0.0.
NXOpen::SelectNXObjectListSelectFeature ()
 Returns the selector for the inspection feature
Created in NX7.0.0.
NXOpen::CAM::InspectionPathBuilder::SequenceType SequenceOptimization ()
 Returns the path point sequence optimization setting
Created in NX7.0.0.
void SetApproachDirection (const std::vector< double > &direction)
 Sets the approach direction vector values
Created in NX7.0.0.
void SetCreateEntryPoint (bool createPoint)
 Sets a flag to indicate if an entry point is required
Created in NX7.0.0.
void SetCreateExitPoint (bool createPoint)
 Sets a flag to indicate if an exit point is required
Created in NX7.0.0.
void SetFeatureOpName (const NXString &featureOpName)
 Sets the inspection feature operation name
Created in NX7.0.0.
void SetInspectionMode (NXOpen::CAM::InspectionPathBuilder::InspectModeType inspectMode)
 Sets the inspection mode setting
Created in NX7.0.0.
void SetPathOpName (const NXString &pathOpName)
 Sets the inspection path operation name
Created in NX7.0.0.
void SetProjectLastPointToSafePlane (bool projectPoint)
 Sets a flag to indicate if last point is created in safe plane
Created in NX7.0.0.
void SetProjectStartPointToSafePlane (bool projectPoint)
 Sets a flag to indicate if start point is created in safe plane
Created in NX7.0.0.
void SetSafePlaneXform (NXOpen::NXObject *planeXform)
 Sets the safe plane
Created in NX7.0.0.
void SetSequenceOptimization (NXOpen::CAM::InspectionPathBuilder::SequenceType sequenceOpt)
 Sets the path point sequence optimization setting
Created in NX7.0.0.
void SetUseEntryAvoidance (bool useAvoidance)
 Sets a flag to indicate if collision avoidance is required at entry
Created in NX7.0.0.
void SetUseExitAvoidance (bool useAvoidance)
 Sets a flag to indicate if collision avoidance is required at exit
Created in NX7.0.0.
void UpdateParameters ()
 Update Inspection path based on selected feature.
void UpdateSensors (NXOpen::CAM::InspectionSetup *setup, NXOpen::CAM::InspectionGroup *parentProgramGroup, NXOpen::CAM::InspectionGroup *parentMethodGroup, NXOpen::CAM::InspectionGroup *parentToolGroup, NXOpen::CAM::InspectionGroup *parentGeometryGroup, const NXString &typeName)
 Update sensor definitions
Created in NX7.5.1.
bool UseEntryAvoidance ()
 Returns a flag to indicate if collision avoidance is required at entry
Created in NX7.0.0.
bool UseExitAvoidance ()
 Returns a flag to indicate if collision avoidance is required at exit
Created in NX7.0.0.

Detailed Description

Represents the builder for a CMM Inspection path.


To create a new instance of this class, use CAM::InspectionOperationCollection::CreateInspectionPathBuilder

Created in NX7.0.0.


Member Enumeration Documentation

the entry/exit flag

Enumerator:
EntryExitTypeEntry 

Entry Point.

EntryExitTypeExit 

Exit Point.

the first/last flag

Enumerator:
FirstLastTypeFirst 

First Point.

FirstLastTypeLast 

Last Point.

the inspection mode

Enumerator:
InspectModeTypeDefault 

Default from method.

InspectModeTypeProgram 

Specified by program.

InspectModeTypeManual 

Manual.

InspectModeTypeAuto 

Auto determined by application.

the path point sequence optimization method

Enumerator:
SequenceTypeNone 

None.

SequenceTypeNearest 

Nearest neighbor.

SequenceTypeUStrip 

U strip.

SequenceTypeVStrip 

V strip.


Member Function Documentation

Returns a flag to indicate if an entry point is required
Created in NX7.0.0.



License requirements : None

Returns a flag to indicate if an exit point is required
Created in NX7.0.0.



License requirements : None

Edit entry or exit point
Created in NX8.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
regenerateregenerate

Edit first or last point in safe plane
Created in NX8.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
regenerateregenerate

Returns the inspection feature operation name
Created in NX7.0.0.



License requirements : None

Flips the approach direction vector
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Gets the approach direction vector values.

Returns:
the approach direction values
Created in NX7.0.0.

License requirements : None

Returns the height above feature for entry and exit points
Created in NX7.0.0.



License requirements : None

Returns the inspection mode setting
Created in NX7.0.0.



License requirements : None

Returns the number of points in the path
Created in NX7.0.0.



License requirements : None

Returns the inspection path operation name
Created in NX7.0.0.



License requirements : None

Returns a flag to indicate if last point is created in safe plane
Created in NX7.0.0.



License requirements : None

Returns a flag to indicate if start point is created in safe plane
Created in NX7.0.0.



License requirements : None

ReGenerate entry or exit point.

Returns:

Created in NX7.5.1.

License requirements : insp_programming ("INSPECTION PROGRAMMING")
Parameters:
entryExitType of point to recreate

ReGenerate first or last point in safe plane.

Returns:

Created in NX7.5.1.

License requirements : insp_programming ("INSPECTION PROGRAMMING")
Parameters:
firstLastType of point to recreate

Returns the safe plane
Created in NX7.0.0.



License requirements : None

Returns the selector for the inspection feature
Created in NX7.0.0.



License requirements : None

Returns the path point sequence optimization setting
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionPathBuilder::SetApproachDirection ( const std::vector< double > &  direction)

Sets the approach direction vector values
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
directionthe approach direction values

Sets a flag to indicate if an entry point is required
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
createPointcreatepoint

Sets a flag to indicate if an exit point is required
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
createPointcreatepoint

Sets the inspection feature operation name
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
featureOpNamefeatureopname

Sets the inspection mode setting
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
inspectModeinspectmode

Sets the inspection path operation name
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
pathOpNamepathopname

Sets a flag to indicate if last point is created in safe plane
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
projectPointprojectpoint

Sets a flag to indicate if start point is created in safe plane
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
projectPointprojectpoint

Sets the safe plane
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
planeXformplanexform

Sets the path point sequence optimization setting
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
sequenceOptsequenceopt

Sets a flag to indicate if collision avoidance is required at entry
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
useAvoidanceuseavoidance

Sets a flag to indicate if collision avoidance is required at exit
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
useAvoidanceuseavoidance

Update Inspection path based on selected feature.


Created in NX7.5.1.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionPathBuilder::UpdateSensors ( NXOpen::CAM::InspectionSetup setup,
NXOpen::CAM::InspectionGroup parentProgramGroup,
NXOpen::CAM::InspectionGroup parentMethodGroup,
NXOpen::CAM::InspectionGroup parentToolGroup,
NXOpen::CAM::InspectionGroup parentGeometryGroup,
const NXString typeName 
)

Update sensor definitions
Created in NX7.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters:
setupthe setup
parentProgramGroupthe parent program group
parentMethodGroupthe parent method group
parentToolGroupthe parent tool group
parentGeometryGroupthe parent geometry group
typeNamethe name of the template type
NOTE: The full Unicode character set is not supported for this parameter.

Returns a flag to indicate if collision avoidance is required at entry
Created in NX7.0.0.



License requirements : None

Returns a flag to indicate if collision avoidance is required at exit
Created in NX7.0.0.



License requirements : None


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