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

Represents a CAM::NcmTransferBuilder. More...

Inheritance diagram for NXOpen::CAM::NcmTransferBuilder:
NXOpen::TaggedObject

Public Types

enum  AppDepMethodTypes {
  AppDepMethodTypesSame, AppDepMethodTypesNone, AppDepMethodTypesAlongToolAxis, AppDepMethodTypesAlongVector,
  AppDepMethodTypesToolAxisClearance, AppDepMethodTypesShortestDistanceClearance, AppDepMethodTypesVectorClearance, AppDepMethodTypesTangentClearance,
  AppDepMethodTypesAutomatic
}
 Available methods for approach and departure. More...
 
enum  AppDepToolAxisOptions { AppDepToolAxisOptionsNoChange, AppDepToolAxisOptionsSpecify }
 Available options for tool axis behavior. More...
 
enum  LongMotionTypes { LongMotionTypesStepover, LongMotionTypesRetractTraverseEngage }
 Available motion types for smooth. More...
 
enum  TraverseTypes {
  TraverseTypesSame, TraverseTypesShortestToClearance, TraverseTypesLowestSafeZ, TraverseTypesDirect,
  TraverseTypesSmooth
}
 Available types for traverse. More...
 

Public Member Functions

NXOpen::CAM::NcmClearanceBuilderApproachClearanceBuilder ()
 Returns the approach clearance builder
Created in NX5.0.0.
 
NXOpen::CAM::InheritableToolDepBuilderApproachHeightBuilder ()
 Returns the approach height builder
Created in NX6.0.0.
 
NXOpen::CAM::InheritableToolDepBuilderApproachLengthBuilder ()
 Returns the approach length builder
Created in NX6.0.0.
 
NXOpen::CAM::NcmTransferBuilder::AppDepMethodTypes ApproachMethod ()
 Returns the approach method
Created in NX5.0.0.
 
NXOpen::TaggedObjectApproachPostCommands ()
 Returns the approach post commands
Created in NX5.0.0.
 
NXOpen::SmartObjectApproachToolAxis ()
 Returns the approach tool axis
Created in NX5.0.0.
 
NXOpen::CAM::NcmTransferBuilder::AppDepToolAxisOptions ApproachToolAxisOption ()
 Returns the tool axis option for approach
Created in NX5.0.0.
 
NXOpen::SmartObjectApproachVector ()
 Returns the approach vector
Created in NX5.0.0.
 
NXOpen::CAM::UdeSetAppUdeSet ()
 Returns the Approach UDE Set
Created in NX7.5.0.
 
NXOpen::CAM::NcmClearanceBuilderDepartureClearanceBuilder ()
 Returns the departure clearance
Created in NX5.0.0.
 
NXOpen::CAM::InheritableToolDepBuilderDepartureHeightBuilder ()
 Returns the departure height builder
Created in NX6.0.0.
 
NXOpen::CAM::InheritableToolDepBuilderDepartureLengthBuilder ()
 Returns the departure length builder
Created in NX6.0.0.
 
NXOpen::CAM::NcmTransferBuilder::AppDepMethodTypes DepartureMethod ()
 Returns the departure method
Created in NX5.0.0.
 
NXOpen::TaggedObjectDeparturePostCommands ()
 Returns the departure post commands
Created in NX5.0.0.
 
NXOpen::SmartObjectDepartureToolAxis ()
 Returns the departure tool axis
Created in NX5.0.0.
 
NXOpen::CAM::NcmTransferBuilder::AppDepToolAxisOptions DepartureToolAxisOption ()
 Returns the tool axis option for departure
Created in NX5.0.0.
 
NXOpen::SmartObjectDepartureVector ()
 Returns the departure vector
Created in NX5.0.0.
 
NXOpen::CAM::UdeSetDepUdeSet ()
 Returns the Depature UDE Set
Created in NX7.5.0.
 
void SetApproachMethod (NXOpen::CAM::NcmTransferBuilder::AppDepMethodTypes newValue)
 Sets the approach method
Created in NX5.0.0.
 
void SetApproachPostCommands (NXOpen::TaggedObject *newValue)
 Sets the approach post commands
Created in NX5.0.0.
 
void SetApproachToolAxis (NXOpen::SmartObject *newValue)
 Sets the approach tool axis
Created in NX5.0.0.
 
void SetApproachToolAxisOption (NXOpen::CAM::NcmTransferBuilder::AppDepToolAxisOptions newValue)
 Sets the tool axis option for approach
Created in NX5.0.0.
 
void SetApproachVector (NXOpen::SmartObject *newValue)
 Sets the approach vector
Created in NX5.0.0.
 
void SetDepartureMethod (NXOpen::CAM::NcmTransferBuilder::AppDepMethodTypes newValue)
 Sets the departure method
Created in NX5.0.0.
 
void SetDeparturePostCommands (NXOpen::TaggedObject *newValue)
 Sets the departure post commands
Created in NX5.0.0.
 
void SetDepartureToolAxis (NXOpen::SmartObject *newValue)
 Sets the departure tool axis
Created in NX5.0.0.
 
void SetDepartureToolAxisOption (NXOpen::CAM::NcmTransferBuilder::AppDepToolAxisOptions newValue)
 Sets the tool axis option for departure
Created in NX5.0.0.
 
void SetDepartureVector (NXOpen::SmartObject *newValue)
 Sets the departure vector
Created in NX5.0.0.
 
void SetTraversePostCommands (NXOpen::TaggedObject *newValue)
 Sets the traverse post commands
Created in NX5.0.0.
 
void SetTraverseType (NXOpen::CAM::NcmTransferBuilder::TraverseTypes newValue)
 Sets the traverse types
Created in NX5.0.0.
 
NXOpen::CAM::UdeSetTraUdeSet ()
 Returns the Traverse UDE Set
Created in NX7.5.0.
 
NXOpen::CAM::NcmClearanceBuilderTraverseClearanceBuilder ()
 Returns the traverse clearance
Created in NX5.0.0.
 
NXOpen::CAM::InheritableToolDepBuilderTraverseDistanceBuilder ()
 Returns the traverse distance builder
Created in NX5.0.0.
 
NXOpen::TaggedObjectTraversePostCommands ()
 Returns the traverse post commands
Created in NX5.0.0.
 
NXOpen::CAM::NcmTransferBuilder::TraverseTypes TraverseType ()
 Returns the traverse types
Created in NX5.0.0.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a CAM::NcmTransferBuilder.


Created in NX5.0.0.

Member Enumeration Documentation

Available methods for approach and departure.

Enumerator:
AppDepMethodTypesSame 

use setting from transfer between regions

AppDepMethodTypesNone 

none

AppDepMethodTypesAlongToolAxis 

along tool axis

AppDepMethodTypesAlongVector 

along vector

AppDepMethodTypesToolAxisClearance 

along tool axis from/to clearance

AppDepMethodTypesShortestDistanceClearance 

shortest distance from/to clearance

AppDepMethodTypesVectorClearance 

along vector from/to clearance

AppDepMethodTypesTangentClearance 

tangent from/to clearance

AppDepMethodTypesAutomatic 

automatic

Available options for tool axis behavior.

Enumerator:
AppDepToolAxisOptionsNoChange 

tool axis remains unchanged

AppDepToolAxisOptionsSpecify 

tool axis as specified

Available motion types for smooth.

Enumerator:
LongMotionTypesStepover 

stepover smooth motion type

LongMotionTypesRetractTraverseEngage 

retract traverse engage smooth motion type

Available types for traverse.

Enumerator:
TraverseTypesSame 

traverse setting from between regions

TraverseTypesShortestToClearance 

traverse shortest to clearance

TraverseTypesLowestSafeZ 

traverse at lowest safe z

TraverseTypesDirect 

traverse direct

TraverseTypesSmooth 

traverse smooth spline

Member Function Documentation

NXOpen::CAM::NcmClearanceBuilder* NXOpen::CAM::NcmTransferBuilder::ApproachClearanceBuilder ( )

Returns the approach clearance builder
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmTransferBuilder::ApproachHeightBuilder ( )

Returns the approach height builder
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmTransferBuilder::ApproachLengthBuilder ( )

Returns the approach length builder
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::NcmTransferBuilder::AppDepMethodTypes NXOpen::CAM::NcmTransferBuilder::ApproachMethod ( )

Returns the approach method
Created in NX5.0.0.



License requirements : None

NXOpen::TaggedObject* NXOpen::CAM::NcmTransferBuilder::ApproachPostCommands ( )

Returns the approach post commands
Created in NX5.0.0.



License requirements : None

NXOpen::SmartObject* NXOpen::CAM::NcmTransferBuilder::ApproachToolAxis ( )

Returns the approach tool axis
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmTransferBuilder::AppDepToolAxisOptions NXOpen::CAM::NcmTransferBuilder::ApproachToolAxisOption ( )

Returns the tool axis option for approach
Created in NX5.0.0.



License requirements : None

NXOpen::SmartObject* NXOpen::CAM::NcmTransferBuilder::ApproachVector ( )

Returns the approach vector
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::UdeSet* NXOpen::CAM::NcmTransferBuilder::AppUdeSet ( )

Returns the Approach UDE Set
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::NcmClearanceBuilder* NXOpen::CAM::NcmTransferBuilder::DepartureClearanceBuilder ( )

Returns the departure clearance
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmTransferBuilder::DepartureHeightBuilder ( )

Returns the departure height builder
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmTransferBuilder::DepartureLengthBuilder ( )

Returns the departure length builder
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::NcmTransferBuilder::AppDepMethodTypes NXOpen::CAM::NcmTransferBuilder::DepartureMethod ( )

Returns the departure method
Created in NX5.0.0.



License requirements : None

NXOpen::TaggedObject* NXOpen::CAM::NcmTransferBuilder::DeparturePostCommands ( )

Returns the departure post commands
Created in NX5.0.0.



License requirements : None

NXOpen::SmartObject* NXOpen::CAM::NcmTransferBuilder::DepartureToolAxis ( )

Returns the departure tool axis
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmTransferBuilder::AppDepToolAxisOptions NXOpen::CAM::NcmTransferBuilder::DepartureToolAxisOption ( )

Returns the tool axis option for departure
Created in NX5.0.0.



License requirements : None

NXOpen::SmartObject* NXOpen::CAM::NcmTransferBuilder::DepartureVector ( )

Returns the departure vector
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::UdeSet* NXOpen::CAM::NcmTransferBuilder::DepUdeSet ( )

Returns the Depature UDE Set
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::NcmTransferBuilder::SetApproachMethod ( NXOpen::CAM::NcmTransferBuilder::AppDepMethodTypes  newValue)

Sets the approach method
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::NcmTransferBuilder::SetApproachPostCommands ( NXOpen::TaggedObject newValue)

Sets the approach post commands
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe approach post commands
void NXOpen::CAM::NcmTransferBuilder::SetApproachToolAxis ( NXOpen::SmartObject newValue)

Sets the approach tool axis
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe approach tool axis
void NXOpen::CAM::NcmTransferBuilder::SetApproachToolAxisOption ( NXOpen::CAM::NcmTransferBuilder::AppDepToolAxisOptions  newValue)

Sets the tool axis option for approach
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::NcmTransferBuilder::SetApproachVector ( NXOpen::SmartObject newValue)

Sets the approach vector
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe approach vector
void NXOpen::CAM::NcmTransferBuilder::SetDepartureMethod ( NXOpen::CAM::NcmTransferBuilder::AppDepMethodTypes  newValue)

Sets the departure method
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::NcmTransferBuilder::SetDeparturePostCommands ( NXOpen::TaggedObject newValue)

Sets the departure post commands
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe departure post commands
void NXOpen::CAM::NcmTransferBuilder::SetDepartureToolAxis ( NXOpen::SmartObject newValue)

Sets the departure tool axis
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe departure tool axis
void NXOpen::CAM::NcmTransferBuilder::SetDepartureToolAxisOption ( NXOpen::CAM::NcmTransferBuilder::AppDepToolAxisOptions  newValue)

Sets the tool axis option for departure
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::NcmTransferBuilder::SetDepartureVector ( NXOpen::SmartObject newValue)

Sets the departure vector
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe departure vector
void NXOpen::CAM::NcmTransferBuilder::SetTraversePostCommands ( NXOpen::TaggedObject newValue)

Sets the traverse post commands
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe traverse post commands
void NXOpen::CAM::NcmTransferBuilder::SetTraverseType ( NXOpen::CAM::NcmTransferBuilder::TraverseTypes  newValue)

Sets the traverse types
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
NXOpen::CAM::UdeSet* NXOpen::CAM::NcmTransferBuilder::TraUdeSet ( )

Returns the Traverse UDE Set
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::NcmClearanceBuilder* NXOpen::CAM::NcmTransferBuilder::TraverseClearanceBuilder ( )

Returns the traverse clearance
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmTransferBuilder::TraverseDistanceBuilder ( )

Returns the traverse distance builder
Created in NX5.0.0.



License requirements : None

NXOpen::TaggedObject* NXOpen::CAM::NcmTransferBuilder::TraversePostCommands ( )

Returns the traverse post commands
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmTransferBuilder::TraverseTypes NXOpen::CAM::NcmTransferBuilder::TraverseType ( )

Returns the traverse types
Created in NX5.0.0.



License requirements : None


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