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

Represents a cut level object for cavity mill and zlevel mill. More...

Inheritance diagram for NXOpen::CAM::CutLevel:
NXOpen::TaggedObject

List of all members.

Public Types

enum  MeasureTypes { MeasureTypesTopLevel, MeasureTypesRangeTop, MeasureTypesRangeBottom, MeasureTypesWcsOrigin }
 measure from types
Created in NX7.5.0. More...
enum  RangeTypes { RangeTypesAutomatic, RangeTypesUserDefined, RangeTypesSingle }
 range types
Created in NX7.5.0. More...
enum  Types { TypesConstant, TypesOptimized, TypesRangeBottom }
 cut level types
Created in NX7.5.0. More...

Public Member Functions

int AddRangeFromDepth (double rangeDepth, double depthPerCut, NXOpen::CAM::CutLevel::MeasureTypes measureType, int referencedRange)
 Add a new range by specifying the range depth.
int AddRangeFromGeometry (NXOpen::NXObject *selectedObject, double depthPerCut)
 Add a new range by specifying the level geometry.
void ApplyGlobalDepthPerCut ()
 Update the cut levels based on the global depth per cut
Created in NX7.5.0.
NXOpen::CAM::CutLevel::Types CutLevelType ()
 Returns the cut level type
Created in NX7.5.0.
void DeleteRange (int index)
 Delete a range
Created in NX7.5.0.
NXOpen::CAM::InheritableToolDepBuilderDistanceBelow ()
 Returns the distance below the bottom of the last range
Created in NX7.5.0.
NXOpen::CAM::StepoverBuilderGlobalDepthPerCut ()
 Returns the global depth per cut
Created in NX7.5.0.
bool InitializeData ()
 Prepare and update cut level data.
NXOpen::CAM::CutLevel::RangeTypes RangeType ()
 Returns the range type
Created in NX7.5.0.
void SetCutLevelType (NXOpen::CAM::CutLevel::Types newValue)
 Sets the cut level type
Created in NX7.5.0.
void SetRangeDepth (int index, double rangeDepth, NXOpen::CAM::CutLevel::MeasureTypes measureType)
 Set the range depth
Created in NX7.5.0.
void SetRangeDepthPerCut (int index, double depthPerCut)
 Set the range depth per cut
Created in NX7.5.0.
void SetRangeGeometry (int index, NXOpen::NXObject *geometry)
 Set the range geometry
Created in NX7.5.0.
void SetRangeType (NXOpen::CAM::CutLevel::RangeTypes newValue)
 Sets the range type
Created in NX7.5.0.
void SetTopGeometry (NXOpen::NXObject *currentValue)
 Set the top selected geometry
Created in NX7.5.0.
void SetTopOffCriticalDepths (bool newValue)
 Sets the top off critical depths
Created in NX7.5.0.
void SetTopZc (double newValue)
 Sets the top ZC value
Created in NX7.5.0.
bool TopOffCriticalDepths ()
 Returns the top off critical depths
Created in NX7.5.0.
double TopZc ()
 Returns the top ZC value
Created in NX7.5.0.

Detailed Description

Represents a cut level object for cavity mill and zlevel mill.


Created in NX7.5.0.


Member Enumeration Documentation

measure from types
Created in NX7.5.0.


Enumerator:
MeasureTypesTopLevel 

Top Level.

MeasureTypesRangeTop 

Current Range Top.

MeasureTypesRangeBottom 

Current Range Bottom.

MeasureTypesWcsOrigin 

WCS Origin.

range types
Created in NX7.5.0.


Enumerator:
RangeTypesAutomatic 

Automatic.

RangeTypesUserDefined 

User Defined.

RangeTypesSingle 

Single.

cut level types
Created in NX7.5.0.


Enumerator:
TypesConstant 

Constant.

TypesOptimized 

Optimized.

TypesRangeBottom 

Only at Range Bottom.


Member Function Documentation

int NXOpen::CAM::CutLevel::AddRangeFromDepth ( double  rangeDepth,
double  depthPerCut,
NXOpen::CAM::CutLevel::MeasureTypes  measureType,
int  referencedRange 
)

Add a new range by specifying the range depth.

Returns:
the index of the new range.
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")
Parameters:
rangeDepththe range depth from reference point
depthPerCutthe local depth per cut, if zero, set with global depth per cut
measureTypethe measure type for the depth
referencedRangethe position of referenced range, only valid when measure type is range top or bottom. if -1, referencing the last range.
int NXOpen::CAM::CutLevel::AddRangeFromGeometry ( NXOpen::NXObject selectedObject,
double  depthPerCut 
)

Add a new range by specifying the level geometry.

Returns:
the index of the new range.
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")
Parameters:
selectedObjectthe geometry associated to the current level
depthPerCutthe local depth per cut, if zero, set with global depth per cut

Update the cut levels based on the global depth per cut
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Returns the cut level type
Created in NX7.5.0.



License requirements : None

Delete a range
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
indexthe range index to be deleted

Returns the distance below the bottom of the last range
Created in NX7.5.0.



License requirements : None

Returns the global depth per cut
Created in NX7.5.0.



License requirements : None

Prepare and update cut level data.

Returns:
whether or not the cut level data is ready to use.
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Returns the range type
Created in NX7.5.0.



License requirements : None

Sets the cut level type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe cut level type
void NXOpen::CAM::CutLevel::SetRangeDepth ( int  index,
double  rangeDepth,
NXOpen::CAM::CutLevel::MeasureTypes  measureType 
)

Set the range depth
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
indexthe range index to be modified
rangeDepththe range depth
measureTypethe measure type for the depth
void NXOpen::CAM::CutLevel::SetRangeDepthPerCut ( int  index,
double  depthPerCut 
)

Set the range depth per cut
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
indexthe range index to be modified
depthPerCutthe local depth per cut
void NXOpen::CAM::CutLevel::SetRangeGeometry ( int  index,
NXOpen::NXObject geometry 
)

Set the range geometry
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
indexthe range index to be modified
geometrythe geometry associated to the current level

Sets the range type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe range type

Set the top selected geometry
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
currentValuethe top object

Sets the top off critical depths
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe top off critical depths
void NXOpen::CAM::CutLevel::SetTopZc ( double  newValue)

Sets the top ZC value
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuethe ZC value

Returns the top off critical depths
Created in NX7.5.0.



License requirements : None

Returns the top ZC value
Created in NX7.5.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.