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

Represents a CAM::NcmPlanarBuilder. More...

Inheritance diagram for NXOpen::CAM::NcmPlanarBuilder:
NXOpen::CAM::NcmSubopBuilder NXOpen::TaggedObject

List of all members.

Public Types

enum  CutcomTypes { CutcomTypesNone, CutcomTypesAllFinishPasses, CutcomTypesFinalFinishPass }
 Available types for cutter compensation in planar milling. More...
enum  DefaultRegionStartTypes { DefaultRegionStartTypesMidPoint, DefaultRegionStartTypesCorner }
 Available types for default region start in planar milling. More...
enum  FinalRet { FinalRetInherit, FinalRetPlunge, FinalRetNone }
 Available strategies for final retract in planar milling. More...
enum  FinalTypes {
  FinalTypesClearance, FinalTypesDistance, FinalTypesNone, FinalTypesShortestDistanceToClearance,
  FinalTypesCutPlaneToClearance
}
 Available types for final clearance in planar milling. More...
enum  InitialEng { InitialEngInherit, InitialEngLift, InitialEngNone }
 Available strategies for initial engage in planar milling. More...
enum  InitialTypes {
  InitialTypesClearance, InitialTypesDistance, InitialTypesNone, InitialTypesBlankPlane,
  InitialTypesShortestDistanceToClearance, InitialTypesCutPlaneToClearance
}
 Available types for initial clearance in planar milling. More...
enum  PredrillPointsOutputOptions { PredrillPointsOutputOptionsNone, PredrillPointsOutputOptionsAllRegions, PredrillPointsOutputOptionsBottomRegions }
 Available options for output of pre-drill points in planar milling. More...
enum  TransferBetweenLevelsTypes { TransferBetweenLevelsTypesPrevPlane, TransferBetweenLevelsTypesDirect, TransferBetweenLevelsTypesClearance }
 Available types for transfer between levels in planar milling. More...
enum  TransferBetweenRegionsTypes {
  TransferBetweenRegionsTypesClearance, TransferBetweenRegionsTypesPrevPlane, TransferBetweenRegionsTypesDirect, TransferBetweenRegionsTypesLowestSafeZ,
  TransferBetweenRegionsTypesBlankPlane, TransferBetweenRegionsTypesShortestToClearance, TransferBetweenRegionsTypesCutPlaneToClearance
}
 Available types for transfer between regions in planar milling. More...
enum  TransferWithinLevelsTypes {
  TransferWithinLevelsTypesLowestSafeZ, TransferWithinLevelsTypesPrevPlane, TransferWithinLevelsTypesDirect, TransferWithinLevelsTypesClearance,
  TransferWithinLevelsTypesBlankPlane, TransferWithinLevelsTypesShortestToClearance, TransferWithinLevelsTypesCutPlaneToClearance
}
 Available types for transfer within levels in planar milling. More...
enum  TransferWithinLevelsWiths { TransferWithinLevelsWithsUseEngret, TransferWithinLevelsWithsFollowBoundary, TransferWithinLevelsWithsLiftPlunge, TransferWithinLevelsWithsNone }
 Available strategies for transfer within levels in planar milling. More...

Public Member Functions

NXOpen::CAM::NcmClearanceBuilderClearanceBuilder ()
 Returns the clearance builder (inheritable tool dep)
Created in NX5.0.0.
bool CollisionCheck ()
 Returns the collision check activation
Created in NX5.0.0.
double CutcomMinimumAngle ()
 Returns the cutter compensation minimum angle
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderCutcomMinimumMoveBuilder ()
 Returns the cutter compensation minimum move builder (inheritable tool dep)
Created in NX5.0.0.
bool CutcomOutputContactPoint ()
 Returns the cutter compensation output contact point status
Created in NX5.0.0.
bool CutcomOutputPlane ()
 Returns the cutter compensation output plane status
Created in NX5.0.0.
int CutcomTrackingPointType ()
 Returns the cutter compensation tracking point selection
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarBuilder::CutcomTypes CutcomType ()
 Returns the cutter compensation type
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarBuilder::DefaultRegionStartTypes DefaultRegionStartType ()
 Returns the region start type
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarEngRetBuilderEngageClosedAreaBuilder ()
 Returns the default engage closed area builder
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarEngRetBuilderEngageInitialClosedBuilder ()
 Returns the initial engage closed area builder
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarEngRetBuilderEngageInitialOpenBuilder ()
 Returns the initial engage open area builder
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarEngRetBuilderEngageOpenAreaBuilder ()
 Returns the default engage open area builder
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderFinalSafeDistanceBuilder ()
 Returns the final safe distance builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarBuilder::FinalTypes FinalType ()
 Returns the final type
Created in NX5.0.0.
std::vector< NXOpen::Point * > GetPredrillPoints ()
 The pre-drill points.
void GetRegionStartPoints (std::vector< NXOpen::Point * > &regionStartPoints)
 Returns region start points
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderInitialSafeDistanceBuilder ()
 Returns the initial safe distance builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarBuilder::InitialTypes InitialType ()
 Returns the initial type
Created in NX5.0.0.
bool LimitEngRetToCutRegion ()
 Returns the flag to control limitation of engage and retract motions to cut regions
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderOverlapDistanceBuilder ()
 Returns the start/drill points overlap distance builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderPredrillPointsEffectDistBuilder ()
 Returns the pre-drill points effective distance builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarBuilder::PredrillPointsOutputOptions PredrillPointsOutput ()
 Returns the pre-drill points output option
Created in NX5.0.0.
bool PredrillPointsUseEffectDist ()
 Returns the pre-drill points use effective distance
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarEngRetBuilderRetractAreaBuilder ()
 Returns the retract area builder
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarEngRetBuilderRetractFinalBuilder ()
 Returns the final retract builder
Created in NX5.0.0.
void SetCollisionCheck (bool newValue)
 Sets the collision check activation
Created in NX5.0.0.
void SetCutcomMinimumAngle (double minimumAngle)
 Sets the cutter compensation minimum angle
Created in NX5.0.0.
void SetCutcomOutputContactPoint (bool newValue)
 Sets the cutter compensation output contact point status
Created in NX5.0.0.
void SetCutcomOutputPlane (bool outputPlane)
 Sets the cutter compensation output plane status
Created in NX5.0.0.
void SetCutcomTrackingPointType (int newValue)
 Sets the cutter compensation tracking point selection
Created in NX5.0.0.
void SetCutcomType (NXOpen::CAM::NcmPlanarBuilder::CutcomTypes cutcomType)
 Sets the cutter compensation type
Created in NX5.0.0.
void SetDefaultRegionStartType (NXOpen::CAM::NcmPlanarBuilder::DefaultRegionStartTypes defaultRegionStartType)
 Sets the region start type
Created in NX5.0.0.
void SetFinalType (NXOpen::CAM::NcmPlanarBuilder::FinalTypes finalType)
 Sets the final type
Created in NX5.0.0.
void SetInitialType (NXOpen::CAM::NcmPlanarBuilder::InitialTypes initialType)
 Sets the initial type
Created in NX5.0.0.
void SetLimitEngRetToCutRegion (bool newValue)
 Sets the flag to control limitation of engage and retract motions to cut regions
Created in NX5.0.0.
void SetPredrillPoints (const std::vector< NXOpen::Point * > &predrillPoints)
 The pre-drill points
Created in NX5.0.0.
void SetPredrillPointsOutput (NXOpen::CAM::NcmPlanarBuilder::PredrillPointsOutputOptions newValue)
 Sets the pre-drill points output option
Created in NX5.0.0.
void SetPredrillPointsUseEffectDist (bool newValue)
 Sets the pre-drill points use effective distance
Created in NX5.0.0.
void SetRegionStartPoints (const std::vector< NXOpen::Point * > &regionStartPoints)
 Sets region start points
Created in NX5.0.0.
void SetStartPointsUseEffectDist (bool newValue)
 Sets the start points use effective distance
Created in NX5.0.0.
void SetSuppressCutcom (bool suppressCutcom)
 Sets the suppress cutter compensation
Created in NX6.0.0.
void SetTransferBetweenLevelsType (NXOpen::CAM::NcmPlanarBuilder::TransferBetweenLevelsTypes transferType)
 Sets the transfer between levels type
Created in NX5.0.0.
void SetTransferBetweenRegionsType (NXOpen::CAM::NcmPlanarBuilder::TransferBetweenRegionsTypes transferType)
 Sets the transfer between regions type
Created in NX5.0.0.
void SetTransferWithinLevelsType (NXOpen::CAM::NcmPlanarBuilder::TransferWithinLevelsTypes transferType)
 Sets the transfer within levels type
Created in NX5.0.0.
void SetTransferWithinLevelsWith (NXOpen::CAM::NcmPlanarBuilder::TransferWithinLevelsWiths newValue)
 Sets the transfer within levels strategy
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderStartPointsEffectDistBuilder ()
 Returns the region start points effective distance builder (inheritable tool dep)
Created in NX5.0.0.
bool StartPointsUseEffectDist ()
 Returns the start points use effective distance
Created in NX5.0.0.
bool SuppressCutcom ()
 Returns the suppress cutter compensation
Created in NX6.0.0.
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceFromBuilder ()
 Returns the from point builder
Created in NX5.0.0.
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceGohomeBuilder ()
 Returns the gohome point builder
Created in NX5.0.0.
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceReturnBuilder ()
 Returns the return point builder
Created in NX5.0.0.
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceStartBuilder ()
 Returns the start point builder
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderTransferBetweenLevelsSafeDistanceBuilder ()
 Returns the transfer between levels safe distance builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarBuilder::TransferBetweenLevelsTypes TransferBetweenLevelsType ()
 Returns the transfer between levels type
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderTransferBetweenRegionsSafeDistanceBuilder ()
 Returns the transfer between regions safe distance builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarBuilder::TransferBetweenRegionsTypes TransferBetweenRegionsType ()
 Returns the transfer between regions type
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderTransferWithinLevelsHeightBuilder ()
 Returns the transfer within levels height builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderTransferWithinLevelsMaxFollowDistanceBuilder ()
 Returns the transfer within levels max follow distance builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::InheritableToolDepBuilderTransferWithinLevelsSafeDistanceBuilder ()
 Returns the transfer within levels safe distance builder (inheritable tool dep)
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarBuilder::TransferWithinLevelsTypes TransferWithinLevelsType ()
 Returns the transfer within levels type
Created in NX5.0.0.
NXOpen::CAM::NcmPlanarBuilder::TransferWithinLevelsWiths TransferWithinLevelsWith ()
 Returns the transfer within levels strategy
Created in NX5.0.0.

Detailed Description

Represents a CAM::NcmPlanarBuilder.


Created in NX5.0.0.


Member Enumeration Documentation

Available types for cutter compensation in planar milling.

Enumerator:
CutcomTypesNone 

cutter compensation off

CutcomTypesAllFinishPasses 

cutter compensation on all finish passes

CutcomTypesFinalFinishPass 

cutter compensation on last finish pass

Available types for default region start in planar milling.

Enumerator:
DefaultRegionStartTypesMidPoint 

start at mid point

DefaultRegionStartTypesCorner 

start_at_corners

Available strategies for final retract in planar milling.

Enumerator:
FinalRetInherit 

Use retract defs.

FinalRetPlunge 

plunge

FinalRetNone 

none

Available types for final clearance in planar milling.

Enumerator:
FinalTypesClearance 

tool axis clearance

FinalTypesDistance 

distance

FinalTypesNone 

none

FinalTypesShortestDistanceToClearance 

shortest distance to clearance

FinalTypesCutPlaneToClearance 

cut plane to clearance

Available strategies for initial engage in planar milling.

Enumerator:
InitialEngInherit 

Use engage defs.

InitialEngLift 

lift

InitialEngNone 

none

Available types for initial clearance in planar milling.

Enumerator:
InitialTypesClearance 

tool axis to clearance

InitialTypesDistance 

distance

InitialTypesNone 

none

InitialTypesBlankPlane 

blank plane

InitialTypesShortestDistanceToClearance 

shortest distance to clearance

InitialTypesCutPlaneToClearance 

cut plane to clearance

Available options for output of pre-drill points in planar milling.

Enumerator:
PredrillPointsOutputOptionsNone 

No Pre-Drill points.

PredrillPointsOutputOptionsAllRegions 

Pre-Drill Points for all regions.

PredrillPointsOutputOptionsBottomRegions 

Pre-Drill Points for bottom regions only.

Available types for transfer between levels in planar milling.

Enumerator:
TransferBetweenLevelsTypesPrevPlane 

previous plane

TransferBetweenLevelsTypesDirect 

direct

TransferBetweenLevelsTypesClearance 

clearance

Available types for transfer between regions in planar milling.

Enumerator:
TransferBetweenRegionsTypesClearance 

tool axis to clearance

TransferBetweenRegionsTypesPrevPlane 

previous plane

TransferBetweenRegionsTypesDirect 

direct

TransferBetweenRegionsTypesLowestSafeZ 

lowest safe z

TransferBetweenRegionsTypesBlankPlane 

Blank Plane.

TransferBetweenRegionsTypesShortestToClearance 

shortest to clearance

TransferBetweenRegionsTypesCutPlaneToClearance 

cut plane to clearance

Available types for transfer within levels in planar milling.

Enumerator:
TransferWithinLevelsTypesLowestSafeZ 

lowest Safe Z

TransferWithinLevelsTypesPrevPlane 

previous plane

TransferWithinLevelsTypesDirect 

direct

TransferWithinLevelsTypesClearance 

tool axis to clearance

TransferWithinLevelsTypesBlankPlane 

Blank Plane.

TransferWithinLevelsTypesShortestToClearance 

shortest to clearance

TransferWithinLevelsTypesCutPlaneToClearance 

cut plane to clearance

Available strategies for transfer within levels in planar milling.

Enumerator:
TransferWithinLevelsWithsUseEngret 

Use engage and retract defs.

TransferWithinLevelsWithsFollowBoundary 

follow boundary (for future use)

TransferWithinLevelsWithsLiftPlunge 

lift and plunge

TransferWithinLevelsWithsNone 

none


Member Function Documentation

Returns the clearance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the collision check activation
Created in NX5.0.0.



License requirements : None

Returns the cutter compensation minimum angle
Created in NX5.0.0.



License requirements : None

Returns the cutter compensation minimum move builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the cutter compensation output contact point status
Created in NX5.0.0.



License requirements : None

Returns the cutter compensation output plane status
Created in NX5.0.0.



License requirements : None

Returns the cutter compensation tracking point selection
Created in NX5.0.0.



License requirements : None

Returns the cutter compensation type
Created in NX5.0.0.



License requirements : None

Returns the region start type
Created in NX5.0.0.



License requirements : None

Returns the default engage closed area builder
Created in NX5.0.0.



License requirements : None

Returns the initial engage closed area builder
Created in NX5.0.0.



License requirements : None

Returns the initial engage open area builder
Created in NX5.0.0.



License requirements : None

Returns the default engage open area builder
Created in NX5.0.0.



License requirements : None

Returns the final safe distance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the final type
Created in NX5.0.0.



License requirements : None

The pre-drill points.

Returns:
Array of points
Created in NX5.0.0.

License requirements : None
void NXOpen::CAM::NcmPlanarBuilder::GetRegionStartPoints ( std::vector< NXOpen::Point * > &  regionStartPoints)

Returns region start points
Created in NX5.0.0.



License requirements : None

Parameters:
regionStartPointsThe points

Returns the initial safe distance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the initial type
Created in NX5.0.0.



License requirements : None

Returns the flag to control limitation of engage and retract motions to cut regions
Created in NX5.0.0.



License requirements : None

Returns the start/drill points overlap distance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the pre-drill points effective distance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the pre-drill points output option
Created in NX5.0.0.



License requirements : None

Returns the pre-drill points use effective distance
Created in NX5.0.0.



License requirements : None

Returns the retract area builder
Created in NX5.0.0.



License requirements : None

Returns the final retract builder
Created in NX5.0.0.



License requirements : None

Sets the collision check activation
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue

Sets the cutter compensation minimum angle
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
minimumAngleminimumangle

Sets the cutter compensation output contact point status
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue

Sets the cutter compensation output plane status
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
outputPlaneoutputplane

Sets the cutter compensation tracking point selection
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue

Sets the cutter compensation type
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
cutcomTypecutcomtype

Sets the region start type
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
defaultRegionStartTypedefaultregionstarttype

Sets the final type
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
finalTypefinaltype

Sets the initial type
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
initialTypeinitialtype

Sets the flag to control limitation of engage and retract motions to cut regions
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue
void NXOpen::CAM::NcmPlanarBuilder::SetPredrillPoints ( const std::vector< NXOpen::Point * > &  predrillPoints)

The pre-drill points
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
predrillPointsArray of points

Sets the pre-drill points output option
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue

Sets the pre-drill points use effective distance
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue
void NXOpen::CAM::NcmPlanarBuilder::SetRegionStartPoints ( const std::vector< NXOpen::Point * > &  regionStartPoints)

Sets region start points
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
regionStartPointsThe points

Sets the start points use effective distance
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue
void NXOpen::CAM::NcmPlanarBuilder::SetSuppressCutcom ( bool  suppressCutcom)

Sets the suppress cutter compensation
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
suppressCutcomsuppresscutcom

Sets the transfer between levels type
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
transferTypetransfertype

Sets the transfer between regions type
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
transferTypetransfertype

Sets the transfer within levels type
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
transferTypetransfertype

Sets the transfer within levels strategy
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
newValuenewvalue

Returns the region start points effective distance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the start points use effective distance
Created in NX5.0.0.



License requirements : None

Returns the suppress cutter compensation
Created in NX6.0.0.



License requirements : None

Returns the from point builder
Created in NX5.0.0.



License requirements : None

Returns the gohome point builder
Created in NX5.0.0.



License requirements : None

Returns the return point builder
Created in NX5.0.0.



License requirements : None

Returns the start point builder
Created in NX5.0.0.



License requirements : None

Returns the transfer between levels safe distance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the transfer between levels type
Created in NX5.0.0.



License requirements : None

Returns the transfer between regions safe distance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the transfer between regions type
Created in NX5.0.0.



License requirements : None

Returns the transfer within levels height builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the transfer within levels max follow distance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the transfer within levels safe distance builder (inheritable tool dep)
Created in NX5.0.0.



License requirements : None

Returns the transfer within levels type
Created in NX5.0.0.



License requirements : None

Returns the transfer within levels strategy
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.