NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::NcmScEngRetBuilder 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::NcmScEngRetBuilder:
NXOpen::TaggedObject

List of all members.

Public Types

enum  EngRetTypes {
  EngRetTypesSameAsDefault, EngRetTypesSameAsEngage, EngRetTypesLinear, EngRetTypesLinearAlongVector,
  EngRetTypesLinearNormalToPart, EngRetTypesArcParallelToToolAxis, EngRetTypesArcNormalToToolAxis, EngRetTypesArcTangentToApproach,
  EngRetTypesArcNormalToPart, EngRetTypesHelicalClw, EngRetTypesHelicalCclw, EngRetTypesPlungeLift,
  EngRetTypesNone, EngRetTypesPoints
}
 Available types for engage/retract in surface contouring. More...
enum  MeasureFromTypes { MeasureFromTypesDistance, MeasureFromTypesPlane }
 Available types for the Height or Length from which the linear/helical/plunge engage or linear/plunge retract is measured in Surface Contour Milling
Created in NX7.5.0. 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::NcmScEngRetBuilder::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.
double HelicalRampAngle ()
 Returns the engage/retract ramp angle for helical moves

NXOpen::CAM::InheritableDoubleBuilderHelicalRampAngleBuilder ()
 Returns the helical ramp angle builder
Created in NX8.0.0.
NXOpen::CAM::InheritableToolDepBuilderLengthBuilder ()
 Returns the engage/retract length builder
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderLinearExtensionBuilder ()
 Returns the engage/retract linear extension builder
Created in NX5.0.0.
NXOpen::CAM::NcmScEngRetBuilder::MeasureFromTypes MeasureFrom ()
 Returns the height or length from which engage linear/helical/plunge is measured
Created in NX7.5.0.
NXOpen::PlanePlane ()
 Returns the engage/retract plane
Created in NX7.5.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::NcmScEngRetBuilder::EngRetTypes newValue)
 Sets the type of engage/retract
Created in NX5.0.0.
void SetHelicalRampAngle (double newValue)
 Sets the engage/retract ramp angle for helical moves

void SetMeasureFrom (NXOpen::CAM::NcmScEngRetBuilder::MeasureFromTypes newValue)
 Sets the height or length from which engage linear/helical/plunge is measured
Created in NX7.5.0.
void SetPlane (NXOpen::Plane *plane)
 Sets the engage/retract plane
Created in NX7.5.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 SetSwingAngle (double newValue)
 Sets the engage/retract swing angle
Created in NX5.0.0.
void SetUseEffectDist (bool newValue)
 Sets the engage/retract use effective distance
Created in NX5.0.0.
void SetVector (NXOpen::SmartObject *vector)
 Sets the engage/retract vector
Created in NX5.0.0.
double SwingAngle ()
 Returns the engage/retract swing angle
Created in NX5.0.0.
bool UseEffectDist ()
 Returns the engage/retract use effective distance
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 surface contouring.

Enumerator:
EngRetTypesSameAsDefault 

Same as Default.

EngRetTypesSameAsEngage 

Same as Engage (only for retract)

EngRetTypesLinear 

Linear.

EngRetTypesLinearAlongVector 

Linear - Along Vector.

EngRetTypesLinearNormalToPart 

Linear - Normal to Part.

EngRetTypesArcParallelToToolAxis 

Arc - Parallel to Tool Axis.

EngRetTypesArcNormalToToolAxis 

Arc - Normal to Tool Axis.

EngRetTypesArcTangentToApproach 

Arc - Tangent to Approach.

EngRetTypesArcNormalToPart 

Arc - Normal to Part.

EngRetTypesHelicalClw 

Helical Clockwise.

EngRetTypesHelicalCclw 

Helical Counter Clockwise.

EngRetTypesPlungeLift 

Plunge Engage/Lift Retract.

EngRetTypesNone 

None.

EngRetTypesPoints 

to-from point

Available types for the Height or Length from which the linear/helical/plunge engage or linear/plunge retract is measured in Surface Contour Milling
Created in NX7.5.0.


Enumerator:
MeasureFromTypesDistance 

Measure from distance.

MeasureFromTypesPlane 

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

void NXOpen::CAM::NcmScEngRetBuilder::GetPoints ( std::vector< NXOpen::Point * > &  points)

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 engage/retract ramp angle for helical moves

Deprecated:
Deprecated in NX8.0.0.



Created in NX5.0.0.

License requirements : None

Returns the helical ramp angle builder
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 linear extension builder
Created in NX5.0.0.



License requirements : None

Returns the height or length from which engage linear/helical/plunge is measured
Created in NX7.5.0.



License requirements : None

Returns the engage/retract plane
Created in NX7.5.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 engage/retract ramp angle for helical moves

Deprecated:
Deprecated in NX8.0.0.



Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe ramp angle

Sets the height or length from which engage linear/helical/plunge is measured
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe new value

Sets the engage/retract plane
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
planethe engage/retract plane
void NXOpen::CAM::NcmScEngRetBuilder::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 swing angle
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe swing angle

Sets the engage/retract use effective distance
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 swing angle
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 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.