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

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::ToolPathDivideBuilder:

Public Types
enum	PathDivideType { PathDivideTypeByTime, PathDivideTypeByDistance, PathDivideTypeByEvents }
	Divide type options. More...

Public Member Functions
void	AddDivideEvent (int divideEvent)
	Add a new divide event to the list Created in NX6.0.0.

NXOpen::NXObject *	ClearancePlane ()
	Returns the Clearance Plane tag,plane entity type covers Xform and Plane Created in NX5.0.0.

double	DistanceLimit ()
	Returns the time limit value Created in NX5.0.0.

NXOpen::CAM::ToolPathDivideBuilder::PathDivideType	DivideType ()
	Returns the divide limit type Created in NX5.0.0.

std::vector< int >	GetAllDivideEvents ()
	Returns all events where to of divide the tool path.

int	GetDivideEvent (int index)
	Gets the divide event at the given index.

int	NumberOfDivideEvents ()
	Returns the number of defined divide event indices Created in NX6.0.0.

void	RemoveAllDivideEvents ()
	Delete all events where to of divide the tool path Created in NX6.0.0.

void	RemoveDivideEvent (int divideEvent)
	Deletes the divide event at the given index Created in NX6.0.0.

void	SetClearancePlane (NXOpen::NXObject *clearancePlane)
	Sets the Clearance Plane tag,plane entity type covers Xform and Plane Created in NX5.0.0.

void	SetDistanceLimit (double distanceLimitValue)
	Sets the time limit value Created in NX5.0.0.

void	SetDivideType (NXOpen::CAM::ToolPathDivideBuilder::PathDivideType divideTypeValue)
	Sets the divide limit type Created in NX5.0.0.

void	SetTimeLimit (double timeLimitValue)
	Sets the time limit value Created in NX5.0.0.

void	SetTolerancePercent (double tolerancePercentValue)
	Sets the time limit value Created in NX5.0.0.

void	SetUdeEndOfPath (NXOpen::NXObject *udeEndOfPath)
	Sets the End of Path command Created in NX5.0.0.

void	SetUdeStartOfPath (NXOpen::NXObject *udeStartOfPath)
	Sets the Start of Path command Created in NX5.0.0.

double	TimeLimit ()
	Returns the time limit value Created in NX5.0.0.

double	TolerancePercent ()
	Returns the time limit value Created in NX5.0.0.

NXOpen::NXObject *	UdeEndOfPath ()
	Returns the End of Path command Created in NX5.0.0.

NXOpen::NXObject *	UdeStartOfPath ()
	Returns the Start of Path command Created in NX5.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 Divide Builder
To create a new instance of this class, use CAM::CAMSetup::CreateToolPathDivideBuilder

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::ToolPathDivideBuilder::PathDivideType

Divide type options.

Enumerator:

PathDivideTypeByTime	by time
PathDivideTypeByDistance	by distance
PathDivideTypeByEvents	by events

Member Function Documentation

void NXOpen::CAM::ToolPathDivideBuilder::AddDivideEvent ( int divideEvent )

Add a new divide event to the list
Created in NX6.0.0.

License requirements : None

Parameters

divideEvent index of the new divide event

NXOpen::NXObject* NXOpen::CAM::ToolPathDivideBuilder::ClearancePlane ( )

Returns the Clearance Plane tag,plane entity type covers Xform and Plane
Created in NX5.0.0.

License requirements : None

double NXOpen::CAM::ToolPathDivideBuilder::DistanceLimit ( )

Returns the time limit value
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::ToolPathDivideBuilder::PathDivideType NXOpen::CAM::ToolPathDivideBuilder::DivideType ( )

Returns the divide limit type
Created in NX5.0.0.

License requirements : None

std::vector<int> NXOpen::CAM::ToolPathDivideBuilder::GetAllDivideEvents ( )

Returns all events where to of divide the tool path.

Returns: array with the divide event indices
Created in NX6.0.0.

License requirements : None

int NXOpen::CAM::ToolPathDivideBuilder::GetDivideEvent ( int index )

Gets the divide event at the given index.

Returns: the divide point
Created in NX6.0.0.

License requirements : None

Parameters

index position of the event to get

int NXOpen::CAM::ToolPathDivideBuilder::NumberOfDivideEvents ( )

Returns the number of defined divide event indices
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::ToolPathDivideBuilder::RemoveAllDivideEvents ( )

Delete all events where to of divide the tool path
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::ToolPathDivideBuilder::RemoveDivideEvent ( int divideEvent )

Deletes the divide event at the given index
Created in NX6.0.0.

License requirements : None

Parameters

divideEvent the index to delete

void NXOpen::CAM::ToolPathDivideBuilder::SetClearancePlane ( NXOpen::NXObject * clearancePlane )

Sets the Clearance Plane tag,plane entity type covers Xform and Plane
Created in NX5.0.0.

License requirements : None

Parameters

clearancePlane the clearance plane tag,entity type can be XFORM or PLANE

void NXOpen::CAM::ToolPathDivideBuilder::SetDistanceLimit ( double distanceLimitValue )

Sets the time limit value
Created in NX5.0.0.

License requirements : None

Parameters

distanceLimitValue the distance limit value

void NXOpen::CAM::ToolPathDivideBuilder::SetDivideType ( NXOpen::CAM::ToolPathDivideBuilder::PathDivideType divideTypeValue )

Sets the divide limit type
Created in NX5.0.0.

License requirements : None

Parameters

divideTypeValue the divide_type value

void NXOpen::CAM::ToolPathDivideBuilder::SetTimeLimit ( double timeLimitValue )

Sets the time limit value
Created in NX5.0.0.

License requirements : None

Parameters

timeLimitValue the time limit value

void NXOpen::CAM::ToolPathDivideBuilder::SetTolerancePercent ( double tolerancePercentValue )

Sets the time limit value
Created in NX5.0.0.

License requirements : None

Parameters

tolerancePercentValue the tolerance_percent value

void NXOpen::CAM::ToolPathDivideBuilder::SetUdeEndOfPath ( NXOpen::NXObject * udeEndOfPath )

Sets the End of Path command
Created in NX5.0.0.

License requirements : None

Parameters

udeEndOfPath the ude end of path

void NXOpen::CAM::ToolPathDivideBuilder::SetUdeStartOfPath ( NXOpen::NXObject * udeStartOfPath )

Sets the Start of Path command
Created in NX5.0.0.

License requirements : None

Parameters

udeStartOfPath the ude start of path

double NXOpen::CAM::ToolPathDivideBuilder::TimeLimit ( )

Returns the time limit value
Created in NX5.0.0.

License requirements : None

double NXOpen::CAM::ToolPathDivideBuilder::TolerancePercent ( )

Returns the time limit value
Created in NX5.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::CAM::ToolPathDivideBuilder::UdeEndOfPath ( )

Returns the End of Path command
Created in NX5.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::CAM::ToolPathDivideBuilder::UdeStartOfPath ( )

Returns the Start of Path command
Created in NX5.0.0.

License requirements : None

The documentation for this class was generated from the following file:

CAM_ToolPathDivideBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation