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

Represents a first plunge Builder
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::TurnEngageRetractBuilder:
NXOpen::TaggedObject

List of all members.

Public Types

enum  AutoOptions {
  AutoOptionsUserDefinedValues, AutoOptionsAutomaticValues, AutoOptionsClearWallsByAngleAndDistance, AutoOptionsWithdraw,
  AutoOptionsWithdrawByDistance, AutoOptionsClearWalls, AutoOptionsClearWallsByDistance, AutoOptionsSameAsPlungeRetract
}
 The auto engage retract options
Created in NX6.0.0. More...
enum  ExtendMethods { ExtendMethodsDistance, ExtendMethodsToBlank }
 the extend method options
Created in NX7.5.0. More...
enum  Types {
  TypesAutoCircular, TypesAutoLinear, TypesDelta, TypesAngleAndDistance,
  TypesRelativeLinear, TypesFromAPoint, TypesTwoCircles, TypesTwoPointTangent
}
 The engage retract type
Created in NX6.0.0. More...

Public Member Functions

double Angle ()
 Returns the Angle
Created in NX6.0.0.
NXOpen::CAM::TurnEngageRetractBuilder::AutoOptions AutomaticOption ()
 Returns the Auto Engage(Retract) Option
Created in NX6.0.0.
double DeltaXc ()
 Returns the Delta XC
Created in NX6.0.0.
double DeltaYc ()
 Returns the Delta YC
Created in NX6.0.0.
bool DirectTrimPoint ()
 Returns the Direct engage to(retract from) trim point
Created in NX6.0.0.
double Distance ()
 Returns the Distance
Created in NX6.0.0.
NXOpen::CAM::TurnEngageRetractBuilder::Types EngageRetractType ()
 Returns the Engage(Retract) Type
Created in NX6.0.0.
double ExtendDistance ()
 Returns the Extend Distance
Created in NX6.0.0.
NXOpen::CAM::TurnEngageRetractBuilder::ExtendMethods ExtendMethod ()
 Returns the Extend Method
Created in NX7.5.0.
double FirstRadius ()
 Returns the First Radius
Created in NX6.0.0.
NXOpen::PointPoint ()
 Returns the point
Created in NX6.0.0.
double Radius ()
 Returns the Radius
Created in NX6.0.0.
double SafeDistance ()
 Returns the Safe Distance
Created in NX6.0.0.
double SecondRadius ()
 Returns the Second Radius
Created in NX6.0.0.
void SetAngle (double angle)
 Sets the Angle
Created in NX6.0.0.
void SetAutomaticOption (NXOpen::CAM::TurnEngageRetractBuilder::AutoOptions engageRetractOption)
 Sets the Auto Engage(Retract) Option
Created in NX6.0.0.
void SetDeltaXc (double xc)
 Sets the Delta XC
Created in NX6.0.0.
void SetDeltaYc (double yc)
 Sets the Delta YC
Created in NX6.0.0.
void SetDirectTrimPoint (bool directTrimPoint)
 Sets the Direct engage to(retract from) trim point
Created in NX6.0.0.
void SetDistance (double distance)
 Sets the Distance
Created in NX6.0.0.
void SetEngageRetractType (NXOpen::CAM::TurnEngageRetractBuilder::Types engageRetractType)
 Sets the Engage(Retract) Type
Created in NX6.0.0.
void SetExtendDistance (double extendDistance)
 Sets the Extend Distance
Created in NX6.0.0.
void SetExtendMethod (NXOpen::CAM::TurnEngageRetractBuilder::ExtendMethods newValue)
 Sets the Extend Method
Created in NX7.5.0.
void SetFirstRadius (double firstRadius)
 Sets the First Radius
Created in NX6.0.0.
void SetPoint (NXOpen::Point *turnPoint)
 Sets the point
Created in NX6.0.0.
void SetRadius (double radius)
 Sets the Radius
Created in NX6.0.0.
void SetSafeDistance (double safeDistance)
 Sets the Safe Distance
Created in NX6.0.0.
void SetSecondRadius (double secondRadius)
 Sets the Second Radius
Created in NX6.0.0.
void SetTangentialExtension (bool tangentialExtension)
 Sets the Tangential Extension
Created in NX6.0.0.
bool TangentialExtension ()
 Returns the Tangential Extension
Created in NX6.0.0.

Detailed Description

Represents a first plunge Builder
Created in NX6.0.0.



Member Enumeration Documentation

The auto engage retract options
Created in NX6.0.0.


Enumerator:
AutoOptionsUserDefinedValues 

User Defined Values.

AutoOptionsAutomaticValues 

Automatic Values.

AutoOptionsClearWallsByAngleAndDistance 

Clear Walls by Angle and Distance.

AutoOptionsWithdraw 

Withdraw.

AutoOptionsWithdrawByDistance 

Withdraw by Distance.

AutoOptionsClearWalls 

Clear Walls.

AutoOptionsClearWallsByDistance 

Clear Walls by Distance.

AutoOptionsSameAsPlungeRetract 

Same as Plunge Retract.

the extend method options
Created in NX7.5.0.


Enumerator:
ExtendMethodsDistance 

Extend by distance.

ExtendMethodsToBlank 

Extend to blank.

The engage retract type
Created in NX6.0.0.


Enumerator:
TypesAutoCircular 

Auto Circular.

TypesAutoLinear 

Auto Linear.

TypesDelta 

Delta.

TypesAngleAndDistance 

Angle and Distance.

TypesRelativeLinear 

Relative Linear.

TypesFromAPoint 

From a Point.

TypesTwoCircles 

Two Circles.

TypesTwoPointTangent 

Two Point Tangent.


Member Function Documentation

Returns the Angle
Created in NX6.0.0.



License requirements : None

Returns the Auto Engage(Retract) Option
Created in NX6.0.0.



License requirements : None

Returns the Delta XC
Created in NX6.0.0.



License requirements : None

Returns the Delta YC
Created in NX6.0.0.



License requirements : None

Returns the Direct engage to(retract from) trim point
Created in NX6.0.0.



License requirements : None

Returns the Distance
Created in NX6.0.0.



License requirements : None

Returns the Engage(Retract) Type
Created in NX6.0.0.



License requirements : None

Returns the Extend Distance
Created in NX6.0.0.



License requirements : None

Returns the Extend Method
Created in NX7.5.0.



License requirements : None

Returns the First Radius
Created in NX6.0.0.



License requirements : None

Returns the point
Created in NX6.0.0.



License requirements : None

Returns the Radius
Created in NX6.0.0.



License requirements : None

Returns the Safe Distance
Created in NX6.0.0.



License requirements : None

Returns the Second Radius
Created in NX6.0.0.



License requirements : None

Sets the Angle
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
anglethe Angle value

Sets the Auto Engage(Retract) Option
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
engageRetractOptionthe Auto Engage(Retract) Option value

Sets the Delta XC
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
xcthe Delta XC value

Sets the Delta YC
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
ycthe Delta YC value

Sets the Direct engage to(retract from) trim point
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
directTrimPointthe Direct engage to(retract from) trim point

Sets the Distance
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
distancethe Distance value

Sets the Engage(Retract) Type
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
engageRetractTypethe Engage(Retract) Type value

Sets the Extend Distance
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
extendDistancethe Extend Distance value

Sets the Extend Method
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe Extend Method value

Sets the First Radius
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
firstRadiusthe First Radius value

Sets the point
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
turnPointthe point value

Sets the Radius
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
radiusthe Radius value

Sets the Safe Distance
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
safeDistancethe Safe Distance value

Sets the Second Radius
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
secondRadiusthe Second Radius value

Sets the Tangential Extension
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
tangentialExtensionthe Tangential Extension

Returns the Tangential Extension
Created in NX6.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.