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

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::ToolPathSplitBuilder:

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::ToolPathSplitItemBuilder *	CreateToolPathSplitItemBuilder ()
	The method to create the SplitToolPathItemBuilder.

NXOpen::CAM::InheritableToolDepBuilder *	HolderClearance ()
	Returns the Holder Clearance Created in NX9.0.0.

NXOpen::CAM::InheritableToolDepBuilder *	NeckClearance ()
	Returns the Neck Clearance Created in NX9.0.0.

NXOpen::CAM::ToolPathSplitItemBuilderList *	OperationList ()
	Returns the operation list Created in NX9.0.0.

void	SetSplitType (NXOpen::CAM::ToolPathSplitBuilder::SplitTypes splitTypeValue)
	Sets the type of split (by tranfer or collision) Created in NX6.0.0.

void	SetTransferHeight (double transferHeight)
	Sets the transfer height Created in NX6.0.0.

void	SetTransferType (NXOpen::CAM::ToolPathSplitBuilder::TransferTypes transferType)
	Sets the transfer type (direct, clearance, lowest safe z) Created in NX6.0.0.

void	SetTransferUsingMethod (NXOpen::CAM::ToolPathSplitBuilder::TransferUsingMethods transferUsingMethod)
	Sets the transfer using method (none, ramp on shape, lift and plunge) Created in NX6.0.0.

NXOpen::CAM::InheritableToolDepBuilder *	ShankClearance ()
	Returns the Shank Clearance Created in NX9.0.0.

NXOpen::CAM::ToolPathSplitBuilder::SplitTypes	SplitType ()
	Returns the type of split (by tranfer or collision) Created in NX6.0.0.

NXOpen::CAM::ToolPathSplitParametersBuilder *	ToolPathSplitParametersBuilder ()
	Returns the tool path split parameters Created in NX9.0.0.

double	TransferHeight ()
	Returns the transfer height Created in NX6.0.0.

NXOpen::CAM::ToolPathSplitBuilder::TransferTypes	TransferType ()
	Returns the transfer type (direct, clearance, lowest safe z) Created in NX6.0.0.

NXOpen::CAM::ToolPathSplitBuilder::TransferUsingMethods	TransferUsingMethod ()
	Returns the transfer using method (none, ramp on shape, lift and plunge) Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

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 Tool Path Split Builder
To create a new instance of this class, use CAM::CAMSetup::CreateToolPathSplitBuilder

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::ToolPathSplitBuilder::SplitTypes

Divide type options.

Enumerator:

SplitTypesByCollision	split at collisions
SplitTypesByTransfer	split between transfers

enum NXOpen::CAM::ToolPathSplitBuilder::TransferTypes

Transfer type options.

Enumerator:

TransferTypesDirect	direct transfer type
TransferTypesClearance	clearance transfer type
TransferTypesLowestSafeZ	lowest safe z transfer type

enum NXOpen::CAM::ToolPathSplitBuilder::TransferUsingMethods

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

splitTypeValue split type value

void NXOpen::CAM::ToolPathSplitBuilder::SetTransferHeight ( double transferHeight )

Sets the transfer height
Created in NX6.0.0.

License requirements : None

Parameters

transferHeight transfer 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

transferType transfer 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

transferUsingMethod transfer 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:

CAM_ToolPathSplitBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation