NXOpen::CAM::ProbeProtectedParametersBuilder Class Reference

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

Inheritance diagram for NXOpen::CAM::ProbeProtectedParametersBuilder:

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.
double	ClearanceDistance ()
	Returns the safe clearance distance for external features Created in NX5.0.0.
NXOpen::CAM::ProbeProtectedParametersBuilder::CollisionFlagTypes	CollisionFlag ()
	Returns the collision flag Created in NX5.0.0.
NXOpen::CAM::ProbeProtectedParametersBuilder::DepMethodTypes	ReturnFlag ()
	Returns the return to clearance plane flag Created in NX5.0.0.
void	SetApproachFlag (NXOpen::CAM::ProbeProtectedParametersBuilder::AppMethodTypes approachFrom)
	Sets the approach from clearance plane flag Created in NX5.0.0.
void	SetClearanceDistance (double clearanceDistance)
	Sets the safe clearance distance for external features Created in NX5.0.0.
void	SetCollisionFlag (NXOpen::CAM::ProbeProtectedParametersBuilder::CollisionFlagTypes collFlag)
	Sets the collision flag Created in NX5.0.0.
void	SetReturnFlag (NXOpen::CAM::ProbeProtectedParametersBuilder::DepMethodTypes returnTo)
	Sets the return to clearance plane flag Created in NX5.0.0.
void	SetStandoffDistance (double standoffDistance)
	Sets the standoff distance Created in NX5.0.0.
double	StandoffDistance ()
	Returns the standoff distance Created in NX5.0.0.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

Member Enumeration Documentation

enum NXOpen::CAM::ProbeProtectedParametersBuilder::AppMethodTypes

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

enum NXOpen::CAM::ProbeProtectedParametersBuilder::CollisionFlagTypes

the collision flag types

Enumerator:

CollisionFlagTypesAlarm	PATH OBSTRUCTED alarm.
CollisionFlagTypesFlag	Error flag.

enum NXOpen::CAM::ProbeProtectedParametersBuilder::DepMethodTypes

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

approachFrom

approach 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

clearanceDistance

clearancedistance

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

collFlag

coll 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

returnTo

return to

void NXOpen::CAM::ProbeProtectedParametersBuilder::SetStandoffDistance

(

double

standoffDistance

)

Sets the standoff distance
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

standoffDistance

standoffdistance

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:

• CAM_ProbeProtectedParametersBuilder.hxx