NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::ToolPathDivideBuilder Class Reference

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:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::NXObjectClearancePlane ()
 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::NXObjectUdeEndOfPath ()
 Returns the End of Path command
Created in NX5.0.0.
NXOpen::NXObjectUdeStartOfPath ()
 Returns the Start of Path command
Created in NX5.0.0.

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

Divide type options.

Enumerator:
PathDivideTypeByTime 

by time

PathDivideTypeByDistance 

by distance

PathDivideTypeByEvents 

by events


Member Function Documentation

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



License requirements : None

Parameters:
divideEventindex of the new divide event

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



License requirements : None

Returns the time limit value
Created in NX5.0.0.



License requirements : None

Returns the divide limit type
Created in NX5.0.0.



License requirements : None

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

Gets the divide event at the given index.

Returns:
the divide point
Created in NX6.0.0.

License requirements : None
Parameters:
indexposition of the event to get

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



License requirements : None

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



License requirements : None

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



License requirements : None

Parameters:
divideEventthe index to delete

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



License requirements : None

Parameters:
clearancePlanethe 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:
distanceLimitValuethe distance limit value

Sets the divide limit type
Created in NX5.0.0.



License requirements : None

Parameters:
divideTypeValuethe divide_type value
void NXOpen::CAM::ToolPathDivideBuilder::SetTimeLimit ( double  timeLimitValue)

Sets the time limit value
Created in NX5.0.0.



License requirements : None

Parameters:
timeLimitValuethe time limit value
void NXOpen::CAM::ToolPathDivideBuilder::SetTolerancePercent ( double  tolerancePercentValue)

Sets the time limit value
Created in NX5.0.0.



License requirements : None

Parameters:
tolerancePercentValuethe tolerance_percent value

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



License requirements : None

Parameters:
udeEndOfPaththe ude end of path

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



License requirements : None

Parameters:
udeStartOfPaththe ude start of path

Returns the time limit value
Created in NX5.0.0.



License requirements : None

Returns the time limit value
Created in NX5.0.0.



License requirements : None

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



License requirements : None

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.