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

Represents a builder for an inheritable double value in of a CAM.CAMObject
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::NcmPlanarEngRetBuilder:
NXOpen::TaggedObject

List of all members.

Public Types

enum  EngRetTypes {
  EngRetTypesSameAsDefault, EngRetTypesSameAsClosed, EngRetTypesSameAsEngage, EngRetTypesHelical,
  EngRetTypesRampOnShape, EngRetTypesZigzagRamp, EngRetTypesLinear, EngRetTypesArc,
  EngRetTypesHighSpeedArc, EngRetTypesPoints, EngRetTypesPlungeLift, EngRetTypesAlongVector,
  EngRetTypesAngAngPlane, EngRetTypesVectorPlane, EngRetTypesNone, EngRetTypesLinearRelativeCut
}
 Available types for engage/retract in Planar Milling. More...
enum  MeasureHeightFrom { MeasureHeightFromCurrentLevel, MeasureHeightFromPreviousLevel, MeasureHeightFromPlane }
 Available types for the Height From which engage helical/ramp/plunge is measured in Planar Milling. More...

Public Member Functions

double ArcAngle ()
 Returns the engage/retract arc angle
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderDiameterBuilder ()
 Returns the engage/retract diameter builder
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderEffectDistBuilder ()
 Returns the engage/retract effect dist builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarEngRetBuilder::EngRetTypes EngRetType ()
 Returns the type of engage/retract
Created in NX5.0.0.
void GetPoints (std::vector< NXOpen::Point * > &points)
 Gets engage/retract points
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderHeightBuilder ()
 Returns the engage/retract height builder
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarEngRetBuilder::MeasureHeightFrom HeightFrom ()
 Returns the height from which engage helical/ramp/plunge is measured
Created in NX7.0.0.
NXOpen::CAM::InheritableDoubleBuilderHelicalRampAngleBuilder ()
 Returns the helical ramp angle builder of Helical and Ramp on Shape type of Engages
Created in NX8.0.0.
NXOpen::CAM::InheritableToolDepBuilderLengthBuilder ()
 Returns the engage/retract length builder
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderMaxWidthBuilder ()
 Returns the engage/retract max width builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderMinClearanceBuilder ()
 Returns the engage/retract min clearance builder
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderMinRampLengthBuilder ()
 Returns the engage/retract minimum ramp length builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::SmartObjectPlane ()
 Returns the engage/retract plane,plane entity type covers Xform and Plane
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderRadiusBuilder ()
 Returns the engage/retract radius builder
Created in NX5.0.0.
double RampAngle ()
 Returns the engage/retract ramp angle
Created in NX5.0.0.
void SetArcAngle (double newValue)
 Sets the engage/retract arc angle
Created in NX5.0.0.
void SetEngRetType (NXOpen::CAM::NcmPlanarEngRetBuilder::EngRetTypes newValue)
 Sets the type of engage/retract
Created in NX5.0.0.
void SetHeightFrom (NXOpen::CAM::NcmPlanarEngRetBuilder::MeasureHeightFrom newValue)
 Sets the height from which engage helical/ramp/plunge is measured
Created in NX7.0.0.
void SetPlane (NXOpen::SmartObject *plane)
 Sets the engage/retract plane,plane entity type covers Xform and Plane
Created in NX5.0.0.
void SetPoints (const std::vector< NXOpen::Point * > &points)
 Sets engage/retract points
Created in NX5.0.0.
void SetRampAngle (double newValue)
 Sets the engage/retract ramp angle
Created in NX5.0.0.
void SetStartAtArcCenter (bool newValue)
 Sets the engage/retract start at arc center
Created in NX5.0.0.
void SetSwingAngle (double newValue)
 Sets the engage/retract swing angle
Created in NX5.0.0.
void SetTrim (bool newValue)
 Sets the engage/retract trim
Created in NX5.0.0.
void SetUseEffectDist (bool newValue)
 Sets the engage/retract use effective distance
Created in NX5.0.0.
void SetUseMaxWidth (bool newValue)
 Sets the engage/retract use max width
Created in NX5.0.0.
void SetVector (NXOpen::SmartObject *vector)
 Sets the engage/retract vector
Created in NX5.0.0.
bool StartAtArcCenter ()
 Returns the engage/retract start at arc center
Created in NX5.0.0.
double SwingAngle ()
 Returns the engage/retract swing angle
Created in NX5.0.0.
bool Trim ()
 Returns the engage/retract trim
Created in NX5.0.0.
bool UseEffectDist ()
 Returns the engage/retract use effective distance
Created in NX5.0.0.
bool UseMaxWidth ()
 Returns the engage/retract use max width
Created in NX5.0.0.
NXOpen::SmartObjectVector ()
 Returns the engage/retract vector
Created in NX5.0.0.

Detailed Description

Represents a builder for an inheritable double value in of a CAM.CAMObject
Created in NX5.0.0.



Member Enumeration Documentation

Available types for engage/retract in Planar Milling.

Enumerator:
EngRetTypesSameAsDefault 

Same as Default (Inherit)

EngRetTypesSameAsClosed 

Same as Closed Engage (from open)

EngRetTypesSameAsEngage 

Same as (Open) Engage (from retract)

EngRetTypesHelical 

Helical Ramp.

EngRetTypesRampOnShape 

Ramp on shape.

EngRetTypesZigzagRamp 

ZigZag Ramp.

EngRetTypesLinear 

Linear.

EngRetTypesArc 

Arc.

EngRetTypesHighSpeedArc 

High Speed Arcs.

EngRetTypesPoints 

to-from points

EngRetTypesPlungeLift 

Plunge Engage/Lift Retract.

EngRetTypesAlongVector 

Vector Dist.

EngRetTypesAngAngPlane 

Linear to plane.

EngRetTypesVectorPlane 

Vector to plane.

EngRetTypesNone 

None.

EngRetTypesLinearRelativeCut 

Linear relative to cut direction.

Available types for the Height From which engage helical/ramp/plunge is measured in Planar Milling.

Enumerator:
MeasureHeightFromCurrentLevel 

Measure from current level.

MeasureHeightFromPreviousLevel 

Measure from previous level.

MeasureHeightFromPlane 

Measure from user-defined plane.


Member Function Documentation

Returns the engage/retract arc angle
Created in NX5.0.0.



License requirements : None

Returns the engage/retract diameter builder
Created in NX5.0.0.



License requirements : None

Returns the engage/retract effect dist builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the type of engage/retract
Created in NX5.0.0.



License requirements : None

Gets engage/retract points
Created in NX5.0.0.



License requirements : None

Parameters:
pointsArray of points

Returns the engage/retract height builder
Created in NX5.0.0.



License requirements : None

Returns the height from which engage helical/ramp/plunge is measured
Created in NX7.0.0.



License requirements : None

Returns the helical ramp angle builder of Helical and Ramp on Shape type of Engages
Created in NX8.0.0.



License requirements : None

Returns the engage/retract length builder
Created in NX5.0.0.



License requirements : None

Returns the engage/retract max width builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the engage/retract min clearance builder
Created in NX5.0.0.



License requirements : None

Returns the engage/retract minimum ramp length builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the engage/retract plane,plane entity type covers Xform and Plane
Created in NX5.0.0.



License requirements : None

Returns the engage/retract radius builder
Created in NX5.0.0.



License requirements : None

Returns the engage/retract ramp angle
Created in NX5.0.0.



License requirements : None

Sets the engage/retract arc angle
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe arc angle

Sets the type of engage/retract
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe new value

Sets the height from which engage helical/ramp/plunge is measured
Created in NX7.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe new value

Sets the engage/retract plane,plane entity type covers Xform and Plane
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
planethe engage/retract plane
void NXOpen::CAM::NcmPlanarEngRetBuilder::SetPoints ( const std::vector< NXOpen::Point * > &  points)

Sets engage/retract points
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
pointsArray of points

Sets the engage/retract ramp angle
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe ramp angle

Sets the engage/retract start at arc center
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe start at arc center

Sets the engage/retract swing angle
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe swing angle

Sets the engage/retract trim
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue

Sets the engage/retract use effective distance
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue

Sets the engage/retract use max width
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue

Sets the engage/retract vector
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
vectorthe engage/retract vector

Returns the engage/retract start at arc center
Created in NX5.0.0.



License requirements : None

Returns the engage/retract swing angle
Created in NX5.0.0.



License requirements : None

Returns the engage/retract trim
Created in NX5.0.0.



License requirements : None

Returns the engage/retract use effective distance
Created in NX5.0.0.



License requirements : None

Returns the engage/retract use max width
Created in NX5.0.0.



License requirements : None

Returns the engage/retract vector
Created in NX5.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.