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

Represents an avoidance return Builder
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::TurnAvoidanceReturnBuilder:
NXOpen::TaggedObject

List of all members.

Public Types

enum  ReturnPointModes {
  ReturnPointModesPoint, ReturnPointModesDeltaAngleDistance, ReturnPointModesDeltaVectorDistance, ReturnPointModesDeltaMove,
  ReturnPointModesSameAsStart
}
 The return point mode options
Created in NX6.0.0. More...
enum  ReturnPointMotionTypes {
  ReturnPointMotionTypesNone, ReturnPointMotionTypesAutomatic, ReturnPointMotionTypesDirect, ReturnPointMotionTypesRadialThenAxial,
  ReturnPointMotionTypesAxialThenRadial, ReturnPointMotionTypesClearRadialThenDirect, ReturnPointMotionTypesClearAxialThenDirect, ReturnPointMotionTypesClearRadialOnly,
  ReturnPointMotionTypesClearAxialOnly
}
 the return point motion type options
Created in NX6.0.0. More...

Public Member Functions

double ReturnDeltaAngle ()
 Returns the return delta angle
Created in NX6.0.0.
double ReturnDeltaDistance ()
 Returns the return delta distance
Created in NX6.0.0.
NXOpen::NXObjectReturnDeltaVector ()
 Returns the return delta vector
Created in NX6.0.0.
double ReturnDeltaX ()
 Returns the return delta X
Created in NX6.0.0.
double ReturnDeltaY ()
 Returns the return delta Y
Created in NX6.0.0.
NXOpen::PointReturnPoint ()
 Returns the return point
Created in NX6.0.0.
NXOpen::CAM::TurnAvoidanceReturnBuilder::ReturnPointModes ReturnPointMode ()
 Returns the return point mode
Created in NX6.0.0.
NXOpen::CAM::TurnAvoidanceReturnBuilder::ReturnPointMotionTypes ReturnPointMotionType ()
 Returns the return point motion type
Created in NX6.0.0.
void SetReturnDeltaAngle (double returnDeltaAngle)
 Sets the return delta angle
Created in NX6.0.0.
void SetReturnDeltaDistance (double returnDeltaDistance)
 Sets the return delta distance
Created in NX6.0.0.
void SetReturnDeltaVector (NXOpen::NXObject *returnDeltaVector)
 Sets the return delta vector
Created in NX6.0.0.
void SetReturnDeltaX (double returnDeltaX)
 Sets the return delta X
Created in NX6.0.0.
void SetReturnDeltaY (double returnDeltaY)
 Sets the return delta Y
Created in NX6.0.0.
void SetReturnPoint (NXOpen::Point *returnPoint)
 Sets the return point
Created in NX6.0.0.
void SetReturnPointMode (NXOpen::CAM::TurnAvoidanceReturnBuilder::ReturnPointModes returnPointMode)
 Sets the return point mode
Created in NX6.0.0.
void SetReturnPointMotionType (NXOpen::CAM::TurnAvoidanceReturnBuilder::ReturnPointMotionTypes returnPointMotionType)
 Sets the return point motion type
Created in NX6.0.0.

Detailed Description

Represents an avoidance return Builder
Created in NX6.0.0.



Member Enumeration Documentation

The return point mode options
Created in NX6.0.0.


Enumerator:
ReturnPointModesPoint 

Point is defined by point.

ReturnPointModesDeltaAngleDistance 

Point is defined by angle and distance.

ReturnPointModesDeltaVectorDistance 

Point is defined by vector and distance.

ReturnPointModesDeltaMove 

Point is defined by delta move (X and Y coordinate).

ReturnPointModesSameAsStart 

Point is locked start point.

the return point motion type options
Created in NX6.0.0.


Enumerator:
ReturnPointMotionTypesNone 

Point is inactive.

ReturnPointMotionTypesAutomatic 

Motion type: Automatic to point.

ReturnPointMotionTypesDirect 

Motion type: Direct to point.

ReturnPointMotionTypesRadialThenAxial 

Motion type: Radial then axial to point.

ReturnPointMotionTypesAxialThenRadial 

Motion type: Axial then axial to point.

ReturnPointMotionTypesClearRadialThenDirect 

Motion type: Radial to clearance plane then direct to point.

ReturnPointMotionTypesClearAxialThenDirect 

Motion type: Axial to clearance plane then direct to point.

ReturnPointMotionTypesClearRadialOnly 

Motion type: Radial to clearance plane only (no motion to point).

ReturnPointMotionTypesClearAxialOnly 

Motion type: Axial to clearance plane only (no motion to point).


Member Function Documentation

Returns the return delta angle
Created in NX6.0.0.



License requirements : None

Returns the return delta distance
Created in NX6.0.0.



License requirements : None

Returns the return delta vector
Created in NX6.0.0.



License requirements : None

Returns the return delta X
Created in NX6.0.0.



License requirements : None

Returns the return delta Y
Created in NX6.0.0.



License requirements : None

Returns the return point
Created in NX6.0.0.



License requirements : None

Returns the return point mode
Created in NX6.0.0.



License requirements : None

Returns the return point motion type
Created in NX6.0.0.



License requirements : None

Sets the return delta angle
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
returnDeltaAnglethe return delta angle value

Sets the return delta distance
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
returnDeltaDistancethe return delta distance value

Sets the return delta vector
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
returnDeltaVectorthe return delta vector value

Sets the return delta X
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
returnDeltaXthe return delta x value

Sets the return delta Y
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
returnDeltaYthe return delta x value

Sets the return point
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
returnPointthe return point value

Sets the return point mode
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
returnPointModethe return point mode value

Sets the return point motion type
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
returnPointMotionTypethe return point motion type value

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