NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAM::NcmHoleMachining Class Reference

Represents a NXOpen::CAM::NcmHoleMachining. More...

Inheritance diagram for NXOpen::CAM::NcmHoleMachining:
NXOpen::CAM::NcmSubopBuilder NXOpen::CAM::BaseBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAM::NcmHoleDrilling

Public Types

enum  CutcomTypes { CutcomTypesNone, CutcomTypesAllPasses, CutcomTypesFinalPass }
 Available types for cutter compensation in hole machining. More...
 
enum  FinalTypes {
  FinalTypesClearance, FinalTypesDistance, FinalTypesNone, FinalTypesClearanceShortestDistance,
  FinalTypesClearanceCutPlane
}
 Available types for final clearance in hole machining. More...
 
enum  InitialTypes {
  InitialTypesClearance, InitialTypesDistance, InitialTypesNone, InitialTypesBlankPlane,
  InitialTypesClearanceShortestDistance, InitialTypesClearanceCutPlane
}
 Available types for initial clearance in hole machining. More...
 
enum  OverlapTypes { OverlapTypesAxial, OverlapTypesAlongCut, OverlapTypesAngle }
 Available types for overlap types. More...
 
- Public Types inherited from NXOpen::CAM::NcmSubopBuilder
enum  DefaultRegionStartTypes { DefaultRegionStartTypesMidPoint, DefaultRegionStartTypesCorner }
 Available types for default region start in subop milling. More...
 

Public Member Functions

bool CollisionCheck ()
 Returns the collision check activation
Created in NX9.0.0. More...
 
double CutcomMinimumAngle ()
 Returns the cutter compensation minimum angle
Created in NX7.5.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderCutcomMinimumMove ()
 Returns the cutter compensation minimum move builder (inheritable tool dep)
Created in NX7.5.0. More...
 
bool CutcomOutputContactPoint ()
 Returns the cutter compensation output contact point status
Created in NX7.5.0. More...
 
bool CutcomOutputPlane ()
 Returns the cutter compensation output plane status
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmHoleMachining::CutcomTypes CutcomType ()
 Returns the cutter compensation type
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmHoleMachiningEngRetEngage ()
 Returns the engage settings
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmHoleMachiningEngRetFinalRetract ()
 Returns the final retract settings
Created in NX7.5.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderFinalSafeDistance ()
 Returns the final safe distance builder (inheritable tool dep)
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmHoleMachining::FinalTypes FinalType ()
 Returns the final type
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmHoleMachiningEngRetInitialEngage ()
 Returns the initial engage settings
Created in NX7.5.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderInitialSafeDistance ()
 Returns the initial safe distance builder (inheritable tool dep)
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmHoleMachining::InitialTypes InitialType ()
 Returns the initial type
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmSmoothingBuilderNcmSmoothing ()
 Returns the non cutting smoothing
Created in NX10.0.3. More...
 
double NumberOfThreads ()
 Returns the number of threads
Created in NX7.5.0. More...
 
double OverlapAngle ()
 Returns the overlap angle
Created in NX7.5.0. More...
 
double OverlapDistance ()
 Returns the overlap distance
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmHoleMachining::OverlapTypes OverlapType ()
 Returns the region start type
Created in NX7.5.0. More...
 
double RegionStartAngle ()
 Returns the region start angle
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmHoleMachiningEngRetRetract ()
 Returns the retract settings
Created in NX7.5.0. More...
 
void SetCollisionCheck (bool newValue)
 Sets the collision check activation
Created in NX9.0.0. More...
 
void SetCutcomMinimumAngle (double minimumAngle)
 Sets the cutter compensation minimum angle
Created in NX7.5.0. More...
 
void SetCutcomOutputContactPoint (bool newValue)
 Sets the cutter compensation output contact point status
Created in NX7.5.0. More...
 
void SetCutcomOutputPlane (bool outputPlane)
 Sets the cutter compensation output plane status
Created in NX7.5.0. More...
 
void SetCutcomType (NXOpen::CAM::NcmHoleMachining::CutcomTypes cutcomType)
 Sets the cutter compensation type
Created in NX7.5.0. More...
 
void SetFinalType (NXOpen::CAM::NcmHoleMachining::FinalTypes finalType)
 Sets the final type
Created in NX7.5.0. More...
 
void SetInitialType (NXOpen::CAM::NcmHoleMachining::InitialTypes initialType)
 Sets the initial type
Created in NX7.5.0. More...
 
void SetNumberOfThreads (double numberOfThreads)
 Sets the number of threads
Created in NX7.5.0. More...
 
void SetOverlapAngle (double overlapAngle)
 Sets the overlap angle
Created in NX7.5.0. More...
 
void SetOverlapDistance (double overlapDistance)
 Sets the overlap distance
Created in NX7.5.0. More...
 
void SetOverlapType (NXOpen::CAM::NcmHoleMachining::OverlapTypes overlapType)
 Sets the region start type
Created in NX7.5.0. More...
 
void SetRegionStartAngle (double regionStartAngle)
 Sets the region start angle
Created in NX7.5.0. More...
 
void SetStartFromCenter (bool startFromCenter)
 Sets the start from center
Created in NX7.5.5. More...
 
void SetSuppressCutcom (bool suppressCutcom)
 Sets the suppress cutter compensation
Created in NX7.5.0. More...
 
void SetTrackingData (const NXString &trackingData)
 Sets the tracking data (tracking point type)
Created in NX9.0.2. More...
 
void SetTrackingData (const char *trackingData)
 Sets the tracking data (tracking point type)
Created in NX9.0.2. More...
 
bool StartFromCenter ()
 Returns the start from center
Created in NX7.5.5. More...
 
bool SuppressCutcom ()
 Returns the suppress cutter compensation
Created in NX7.5.0. More...
 
NXString TrackingData ()
 Returns the tracking data (tracking point type)
Created in NX9.0.2. More...
 
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceFrom ()
 Returns the from point builder
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceGohome ()
 Returns the gohome point builder
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceReturn ()
 Returns the return point builder
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceStart ()
 Returns the start point builder
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmTransferTransferBetweenRegions ()
 Returns the transfer between regions
Created in NX9.0.0. More...
 
NXOpen::CAM::NcmClearanceBuilderTransferClearance ()
 Returns the clearance setting
Created in NX7.5.0. More...
 
NXOpen::CAM::NcmTransferBuilderTransferInitialFinal ()
 Returns the transfer settings for initial and final
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::NcmSubopBuilder
NXOpen::CAM::NcmSubopBuilder::DefaultRegionStartTypes DefaultRegionStartType ()
 Returns the region start type
Created in NX8.5.0. More...
 
void GetRegionStartPoints (std::vector< NXOpen::Point * > &regionStartPoints)
 Returns region start points
Created in NX8.5.0. More...
 
void SetDefaultRegionStartType (NXOpen::CAM::NcmSubopBuilder::DefaultRegionStartTypes defaultRegionStartType)
 Sets the region start type
Created in NX8.5.0. More...
 
void SetRegionStartPoints (const std::vector< NXOpen::Point * > &regionStartPoints)
 Sets region start points
Created in NX8.5.0. More...
 
void SetStartPointsUseEffectDist (bool newValue)
 Sets the start points use effective distance
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderStartPointsEffectDistBuilder ()
 Returns the region start points effective distance builder (inheritable tool dep)
Created in NX8.5.0. More...
 
bool StartPointsUseEffectDist ()
 Returns the start points use effective distance
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::BaseBuilder
NXOpen::TaggedObjectGetCustomizableItemBuilder (const NXString &name)
 Returns the customizable item builder for given customizable item name. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const char *name)
 Returns the customizable item builder for given customizable item name. More...
 
std::vector< NXStringGetCustomizableItemNames ()
 Returns the names for all customizable item ids. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::CAM::NcmHoleMachining.


Created in NX7.5.0.

Member Enumeration Documentation

Available types for cutter compensation in hole machining.

Enumerator
CutcomTypesNone 

cutter compensation off

CutcomTypesAllPasses 

cutter compensation on all passes

CutcomTypesFinalPass 

cutter compensation on last pass

Available types for final clearance in hole machining.

Enumerator
FinalTypesClearance 

clearance

FinalTypesDistance 

distance

FinalTypesNone 

none

FinalTypesClearanceShortestDistance 

Clearance - Shortest Distance.

FinalTypesClearanceCutPlane 

Clearance - Cut Plane.

Available types for initial clearance in hole machining.

Enumerator
InitialTypesClearance 

Clearance - Tool Axis.

InitialTypesDistance 

distance

InitialTypesNone 

none

InitialTypesBlankPlane 

blank plane

InitialTypesClearanceShortestDistance 

Clearance - Shortest Distance.

InitialTypesClearanceCutPlane 

Clearance - Cut Plane.

Available types for overlap types.

Enumerator
OverlapTypesAxial 

axial

OverlapTypesAlongCut 

along cut

OverlapTypesAngle 

angle

Member Function Documentation

bool NXOpen::CAM::NcmHoleMachining::CollisionCheck ( )

Returns the collision check activation
Created in NX9.0.0.



License requirements : None

double NXOpen::CAM::NcmHoleMachining::CutcomMinimumAngle ( )

Returns the cutter compensation minimum angle
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmHoleMachining::CutcomMinimumMove ( )

Returns the cutter compensation minimum move builder (inheritable tool dep)
Created in NX7.5.0.



License requirements : None

bool NXOpen::CAM::NcmHoleMachining::CutcomOutputContactPoint ( )

Returns the cutter compensation output contact point status
Created in NX7.5.0.



License requirements : None

bool NXOpen::CAM::NcmHoleMachining::CutcomOutputPlane ( )

Returns the cutter compensation output plane status
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmHoleMachining::CutcomTypes NXOpen::CAM::NcmHoleMachining::CutcomType ( )

Returns the cutter compensation type
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmHoleMachiningEngRet* NXOpen::CAM::NcmHoleMachining::Engage ( )

Returns the engage settings
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmHoleMachiningEngRet* NXOpen::CAM::NcmHoleMachining::FinalRetract ( )

Returns the final retract settings
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmHoleMachining::FinalSafeDistance ( )

Returns the final safe distance builder (inheritable tool dep)
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmHoleMachining::FinalTypes NXOpen::CAM::NcmHoleMachining::FinalType ( )

Returns the final type
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmHoleMachiningEngRet* NXOpen::CAM::NcmHoleMachining::InitialEngage ( )

Returns the initial engage settings
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmHoleMachining::InitialSafeDistance ( )

Returns the initial safe distance builder (inheritable tool dep)
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmHoleMachining::InitialTypes NXOpen::CAM::NcmHoleMachining::InitialType ( )

Returns the initial type
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmSmoothingBuilder* NXOpen::CAM::NcmHoleMachining::NcmSmoothing ( )

Returns the non cutting smoothing
Created in NX10.0.3.



License requirements : None

double NXOpen::CAM::NcmHoleMachining::NumberOfThreads ( )

Returns the number of threads
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NcmHoleMachining::OverlapAngle ( )

Returns the overlap angle
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NcmHoleMachining::OverlapDistance ( )

Returns the overlap distance
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmHoleMachining::OverlapTypes NXOpen::CAM::NcmHoleMachining::OverlapType ( )

Returns the region start type
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NcmHoleMachining::RegionStartAngle ( )

Returns the region start angle
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmHoleMachiningEngRet* NXOpen::CAM::NcmHoleMachining::Retract ( )

Returns the retract settings
Created in NX7.5.0.



License requirements : None

void NXOpen::CAM::NcmHoleMachining::SetCollisionCheck ( bool  newValue)

Sets the collision check activation
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::NcmHoleMachining::SetCutcomMinimumAngle ( double  minimumAngle)

Sets the cutter compensation minimum angle
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
minimumAngleminimumangle
void NXOpen::CAM::NcmHoleMachining::SetCutcomOutputContactPoint ( bool  newValue)

Sets the cutter compensation output contact point status
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::NcmHoleMachining::SetCutcomOutputPlane ( bool  outputPlane)

Sets the cutter compensation output plane status
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
outputPlaneoutputplane
void NXOpen::CAM::NcmHoleMachining::SetCutcomType ( NXOpen::CAM::NcmHoleMachining::CutcomTypes  cutcomType)

Sets the cutter compensation type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
cutcomTypecutcomtype
void NXOpen::CAM::NcmHoleMachining::SetFinalType ( NXOpen::CAM::NcmHoleMachining::FinalTypes  finalType)

Sets the final type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
finalTypefinaltype
void NXOpen::CAM::NcmHoleMachining::SetInitialType ( NXOpen::CAM::NcmHoleMachining::InitialTypes  initialType)

Sets the initial type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
initialTypeinitialtype
void NXOpen::CAM::NcmHoleMachining::SetNumberOfThreads ( double  numberOfThreads)

Sets the number of threads
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
numberOfThreadsnumberofthreads
void NXOpen::CAM::NcmHoleMachining::SetOverlapAngle ( double  overlapAngle)

Sets the overlap angle
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
overlapAngleoverlapangle
void NXOpen::CAM::NcmHoleMachining::SetOverlapDistance ( double  overlapDistance)

Sets the overlap distance
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
overlapDistanceoverlapdistance
void NXOpen::CAM::NcmHoleMachining::SetOverlapType ( NXOpen::CAM::NcmHoleMachining::OverlapTypes  overlapType)

Sets the region start type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
overlapTypeoverlaptype
void NXOpen::CAM::NcmHoleMachining::SetRegionStartAngle ( double  regionStartAngle)

Sets the region start angle
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
regionStartAngleregionstartangle
void NXOpen::CAM::NcmHoleMachining::SetStartFromCenter ( bool  startFromCenter)

Sets the start from center
Created in NX7.5.5.



License requirements : cam_base ("CAM BASE")

Parameters
startFromCenterthe start from center
void NXOpen::CAM::NcmHoleMachining::SetSuppressCutcom ( bool  suppressCutcom)

Sets the suppress cutter compensation
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
suppressCutcomsuppresscutcom
void NXOpen::CAM::NcmHoleMachining::SetTrackingData ( const NXString trackingData)

Sets the tracking data (tracking point type)
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
trackingDatatracking data
void NXOpen::CAM::NcmHoleMachining::SetTrackingData ( const char *  trackingData)

Sets the tracking data (tracking point type)
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
trackingDatatracking data
bool NXOpen::CAM::NcmHoleMachining::StartFromCenter ( )

Returns the start from center
Created in NX7.5.5.



License requirements : None

bool NXOpen::CAM::NcmHoleMachining::SuppressCutcom ( )

Returns the suppress cutter compensation
Created in NX7.5.0.



License requirements : None

NXString NXOpen::CAM::NcmHoleMachining::TrackingData ( )

Returns the tracking data (tracking point type)
Created in NX9.0.2.



License requirements : None

NXOpen::CAM::NcmAvoidancePointBuilder* NXOpen::CAM::NcmHoleMachining::TransferAvoidanceFrom ( )

Returns the from point builder
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmAvoidancePointBuilder* NXOpen::CAM::NcmHoleMachining::TransferAvoidanceGohome ( )

Returns the gohome point builder
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmAvoidancePointBuilder* NXOpen::CAM::NcmHoleMachining::TransferAvoidanceReturn ( )

Returns the return point builder
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmAvoidancePointBuilder* NXOpen::CAM::NcmHoleMachining::TransferAvoidanceStart ( )

Returns the start point builder
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmTransfer* NXOpen::CAM::NcmHoleMachining::TransferBetweenRegions ( )

Returns the transfer between regions
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::NcmClearanceBuilder* NXOpen::CAM::NcmHoleMachining::TransferClearance ( )

Returns the clearance setting
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::NcmTransferBuilder* NXOpen::CAM::NcmHoleMachining::TransferInitialFinal ( )

Returns the transfer settings for initial and final
Created in NX7.5.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.