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

Represents the Probe Protected Parameters Builder
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::ProbeProtectedParametersBuilder:
NXOpen::TaggedObject

Public Types

enum  AppMethodTypes {
  AppMethodTypesNone, AppMethodTypesClearance, AppMethodTypesDirect, AppMethodTypesRadialAxial,
  AppMethodTypesAxialRadial, AppMethodTypesRadialAxialWithClearance, AppMethodTypesAxialRadialWithClearance
}
 the approach types More...
 
enum  CollisionFlagTypes { CollisionFlagTypesAlarm, CollisionFlagTypesFlag }
 the collision flag types More...
 
enum  DepMethodTypes { DepMethodTypesNone, DepMethodTypesClearance }
 the departure types More...
 

Public Member Functions

NXOpen::CAM::ProbeProtectedParametersBuilder::AppMethodTypes ApproachFlag ()
 Returns the approach from clearance plane flag
Created in NX5.0.0. More...
 
double ClearanceDistance ()
 Returns the safe clearance distance for external features
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeProtectedParametersBuilder::CollisionFlagTypes CollisionFlag ()
 Returns the collision flag
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeProtectedParametersBuilder::DepMethodTypes ReturnFlag ()
 Returns the return to clearance plane flag
Created in NX5.0.0. More...
 
void SetApproachFlag (NXOpen::CAM::ProbeProtectedParametersBuilder::AppMethodTypes approachFrom)
 Sets the approach from clearance plane flag
Created in NX5.0.0. More...
 
void SetClearanceDistance (double clearanceDistance)
 Sets the safe clearance distance for external features
Created in NX5.0.0. More...
 
void SetCollisionFlag (NXOpen::CAM::ProbeProtectedParametersBuilder::CollisionFlagTypes collFlag)
 Sets the collision flag
Created in NX5.0.0. More...
 
void SetReturnFlag (NXOpen::CAM::ProbeProtectedParametersBuilder::DepMethodTypes returnTo)
 Sets the return to clearance plane flag
Created in NX5.0.0. More...
 
void SetStandoffDistance (double standoffDistance)
 Sets the standoff distance
Created in NX5.0.0. More...
 
double StandoffDistance ()
 Returns the standoff distance
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the Probe Protected Parameters Builder
Created in NX5.0.0.


Member Enumeration Documentation

the approach types

Enumerator
AppMethodTypesNone 

none

AppMethodTypesClearance 

from/to clearance

AppMethodTypesDirect 

direct

AppMethodTypesRadialAxial 

radial and then axial

AppMethodTypesAxialRadial 

axial and then radial

AppMethodTypesRadialAxialWithClearance 

radial and then axial from/to clearance

AppMethodTypesAxialRadialWithClearance 

axial and then radial from/to clearance

the collision flag types

Enumerator
CollisionFlagTypesAlarm 

PATH OBSTRUCTED alarm.

CollisionFlagTypesFlag 

Error flag.

the departure types

Enumerator
DepMethodTypesNone 

none

DepMethodTypesClearance 

from/to clearance

Member Function Documentation

NXOpen::CAM::ProbeProtectedParametersBuilder::AppMethodTypes NXOpen::CAM::ProbeProtectedParametersBuilder::ApproachFlag ( )

Returns the approach from clearance plane flag
Created in NX5.0.0.



License requirements : None

double NXOpen::CAM::ProbeProtectedParametersBuilder::ClearanceDistance ( )

Returns the safe clearance distance for external features
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::ProbeProtectedParametersBuilder::CollisionFlagTypes NXOpen::CAM::ProbeProtectedParametersBuilder::CollisionFlag ( )

Returns the collision flag
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::ProbeProtectedParametersBuilder::DepMethodTypes NXOpen::CAM::ProbeProtectedParametersBuilder::ReturnFlag ( )

Returns the return to clearance plane flag
Created in NX5.0.0.



License requirements : None

void NXOpen::CAM::ProbeProtectedParametersBuilder::SetApproachFlag ( NXOpen::CAM::ProbeProtectedParametersBuilder::AppMethodTypes  approachFrom)

Sets the approach from clearance plane flag
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
approachFromapproach from
void NXOpen::CAM::ProbeProtectedParametersBuilder::SetClearanceDistance ( double  clearanceDistance)

Sets the safe clearance distance for external features
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
clearanceDistanceclearancedistance
void NXOpen::CAM::ProbeProtectedParametersBuilder::SetCollisionFlag ( NXOpen::CAM::ProbeProtectedParametersBuilder::CollisionFlagTypes  collFlag)

Sets the collision flag
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
collFlagcoll flag
void NXOpen::CAM::ProbeProtectedParametersBuilder::SetReturnFlag ( NXOpen::CAM::ProbeProtectedParametersBuilder::DepMethodTypes  returnTo)

Sets the return to clearance plane flag
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
returnToreturn to
void NXOpen::CAM::ProbeProtectedParametersBuilder::SetStandoffDistance ( double  standoffDistance)

Sets the standoff distance
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
standoffDistancestandoffdistance
double NXOpen::CAM::ProbeProtectedParametersBuilder::StandoffDistance ( )

Returns the standoff distance
Created in NX5.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.