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

Represents a Tool Path Split Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateToolPathSplitBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::ToolPathSplitBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SplitTypes { SplitTypesByCollision, SplitTypesByTransfer }
 Divide type options. More...
 
enum  TransferTypes { TransferTypesDirect, TransferTypesClearance, TransferTypesLowestSafeZ }
 Transfer type options. More...
 
enum  TransferUsingMethods { TransferUsingMethodsNone, TransferUsingMethodsRampOnShape, TransferUsingMethodsLiftAndPlunge }
 Transfer using options. More...
 

Public Member Functions

NXOpen::CAM::ToolPathSplitItemBuilderCreateToolPathSplitItemBuilder ()
 The method to create the SplitToolPathItemBuilder. More...
 
NXOpen::CAM::InheritableToolDepBuilderHolderClearance ()
 Returns the Holder Clearance
Created in NX9.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderNeckClearance ()
 Returns the Neck Clearance
Created in NX9.0.0. More...
 
NXOpen::CAM::ToolPathSplitItemBuilderListOperationList ()
 Returns the operation list
Created in NX9.0.0. More...
 
void SetSplitType (NXOpen::CAM::ToolPathSplitBuilder::SplitTypes splitTypeValue)
 Sets the type of split (by tranfer or collision)
Created in NX6.0.0. More...
 
void SetTransferHeight (double transferHeight)
 Sets the transfer height
Created in NX6.0.0. More...
 
void SetTransferType (NXOpen::CAM::ToolPathSplitBuilder::TransferTypes transferType)
 Sets the transfer type (direct, clearance, lowest safe z)
Created in NX6.0.0. More...
 
void SetTransferUsingMethod (NXOpen::CAM::ToolPathSplitBuilder::TransferUsingMethods transferUsingMethod)
 Sets the transfer using method (none, ramp on shape, lift and plunge)
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderShankClearance ()
 Returns the Shank Clearance
Created in NX9.0.0. More...
 
NXOpen::CAM::ToolPathSplitBuilder::SplitTypes SplitType ()
 Returns the type of split (by tranfer or collision)
Created in NX6.0.0. More...
 
NXOpen::CAM::ToolPathSplitParametersBuilderToolPathSplitParametersBuilder ()
 Returns the tool path split parameters
Created in NX9.0.0. More...
 
double TransferHeight ()
 Returns the transfer height
Created in NX6.0.0. More...
 
NXOpen::CAM::ToolPathSplitBuilder::TransferTypes TransferType ()
 Returns the transfer type (direct, clearance, lowest safe z)
Created in NX6.0.0. More...
 
NXOpen::CAM::ToolPathSplitBuilder::TransferUsingMethods TransferUsingMethod ()
 Returns the transfer using method (none, ramp on shape, lift and plunge)
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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 Tool Path Split Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateToolPathSplitBuilder

Created in NX6.0.0.


Member Enumeration Documentation

Divide type options.

Enumerator
SplitTypesByCollision 

split at collisions

SplitTypesByTransfer 

split between transfers

Transfer type options.

Enumerator
TransferTypesDirect 

direct transfer type

TransferTypesClearance 

clearance transfer type

TransferTypesLowestSafeZ 

lowest safe z transfer type

Transfer using options.

Enumerator
TransferUsingMethodsNone 

no transfer type

TransferUsingMethodsRampOnShape 

ramp on shape

TransferUsingMethodsLiftAndPlunge 

lift and plunge

Member Function Documentation

NXOpen::CAM::ToolPathSplitItemBuilder* NXOpen::CAM::ToolPathSplitBuilder::CreateToolPathSplitItemBuilder ( )

The method to create the SplitToolPathItemBuilder.

Returns

Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")
NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::ToolPathSplitBuilder::HolderClearance ( )

Returns the Holder Clearance
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::ToolPathSplitBuilder::NeckClearance ( )

Returns the Neck Clearance
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::ToolPathSplitItemBuilderList* NXOpen::CAM::ToolPathSplitBuilder::OperationList ( )

Returns the operation list
Created in NX9.0.0.



License requirements : None

void NXOpen::CAM::ToolPathSplitBuilder::SetSplitType ( NXOpen::CAM::ToolPathSplitBuilder::SplitTypes  splitTypeValue)

Sets the type of split (by tranfer or collision)
Created in NX6.0.0.



License requirements : None

Parameters
splitTypeValuesplit type value
void NXOpen::CAM::ToolPathSplitBuilder::SetTransferHeight ( double  transferHeight)

Sets the transfer height
Created in NX6.0.0.



License requirements : None

Parameters
transferHeighttransfer height
void NXOpen::CAM::ToolPathSplitBuilder::SetTransferType ( NXOpen::CAM::ToolPathSplitBuilder::TransferTypes  transferType)

Sets the transfer type (direct, clearance, lowest safe z)
Created in NX6.0.0.



License requirements : None

Parameters
transferTypetransfer type
void NXOpen::CAM::ToolPathSplitBuilder::SetTransferUsingMethod ( NXOpen::CAM::ToolPathSplitBuilder::TransferUsingMethods  transferUsingMethod)

Sets the transfer using method (none, ramp on shape, lift and plunge)
Created in NX6.0.0.



License requirements : None

Parameters
transferUsingMethodtransfer using method
NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::ToolPathSplitBuilder::ShankClearance ( )

Returns the Shank Clearance
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::ToolPathSplitBuilder::SplitTypes NXOpen::CAM::ToolPathSplitBuilder::SplitType ( )

Returns the type of split (by tranfer or collision)
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::ToolPathSplitParametersBuilder* NXOpen::CAM::ToolPathSplitBuilder::ToolPathSplitParametersBuilder ( )

Returns the tool path split parameters
Created in NX9.0.0.



License requirements : None

double NXOpen::CAM::ToolPathSplitBuilder::TransferHeight ( )

Returns the transfer height
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::ToolPathSplitBuilder::TransferTypes NXOpen::CAM::ToolPathSplitBuilder::TransferType ( )

Returns the transfer type (direct, clearance, lowest safe z)
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::ToolPathSplitBuilder::TransferUsingMethods NXOpen::CAM::ToolPathSplitBuilder::TransferUsingMethod ( )

Returns the transfer using method (none, ramp on shape, lift and plunge)
Created in NX6.0.0.



License requirements : None


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