ToolPathDivideBuilder Class

class NXOpen.CAM.ToolPathDivideBuilder

Bases: NXOpen.Builder

Represents a Tool Path Divide Builder

To create a new instance of this class, use NXOpen.CAM.CAMSetup.CreateToolPathDivideBuilder()

New in version NX5.0.0.

Properties

Property	Description
ClearancePlane	Returns or sets the Clearance Plane tag,plane entity type covers Xform and Plane
DistanceLimit	Returns or sets the time limit value
DivideType	Returns or sets the divide limit type
NumberOfDivideEvents	Returns the number of defined divide event indices
Tag	Returns the Tag for this object.
TimeLimit	Returns or sets the time limit value
TolerancePercent	Returns or sets the time limit value
UdeEndOfPath	Returns or sets the End of Path command
UdeStartOfPath	Returns or sets the Start of Path command

Methods

Method	Description
AddDivideEvent	Add a new divide event to the list
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetAllDivideEvents	Returns all events where to of divide the tool path
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetDivideEvent	Gets the divide event at the given index
GetObject	Returns the object currently being edited by this builder.
RemoveAllDivideEvents	Delete all events where to of divide the tool path
RemoveDivideEvent	Deletes the divide event at the given index
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

ToolPathDivideBuilderPathDivideType Enumeration

Divide type options

Property Detail

ClearancePlane

ToolPathDivideBuilder.ClearancePlane

Returns or sets the Clearance Plane tag,plane entity type covers Xform and Plane

-------------------------------------

Getter Method

Signature ClearancePlane

Returns:the clearance plane tag,entity type can be XFORM or PLANE Return type:NXOpen.NXObject

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ClearancePlane

Parameters:clearancePlane (NXOpen.NXObject) – the clearance plane tag,entity type can be XFORM or PLANE

New in version NX5.0.0.

License requirements: None.

DistanceLimit

ToolPathDivideBuilder.DistanceLimit

Returns or sets the time limit value

-------------------------------------

Getter Method

Signature DistanceLimit

Returns:the distance_limit value Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DistanceLimit

Parameters:distanceLimitValue (float) – the distance limit value

New in version NX5.0.0.

License requirements: None.

DivideType

ToolPathDivideBuilder.DivideType

Returns or sets the divide limit type

-------------------------------------

Getter Method

Signature DivideType

Returns:the divide type value Return type:NXOpen.CAM.ToolPathDivideBuilderPathDivideType

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DivideType

Parameters:divideTypeValue (NXOpen.CAM.ToolPathDivideBuilderPathDivideType) – the divide_type value

New in version NX5.0.0.

License requirements: None.

NumberOfDivideEvents

ToolPathDivideBuilder.NumberOfDivideEvents

Returns the number of defined divide event indices

-------------------------------------

Getter Method

Signature NumberOfDivideEvents

Returns: Return type:int

New in version NX6.0.0.

License requirements: None.

TimeLimit

ToolPathDivideBuilder.TimeLimit

Returns or sets the time limit value

-------------------------------------

Getter Method

Signature TimeLimit

Returns:the time_limit value Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TimeLimit

Parameters:timeLimitValue (float) – the time limit value

New in version NX5.0.0.

License requirements: None.

TolerancePercent

ToolPathDivideBuilder.TolerancePercent

Returns or sets the time limit value

-------------------------------------

Getter Method

Signature TolerancePercent

Returns:the tolerance_percent value Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TolerancePercent

Parameters:tolerancePercentValue (float) – the tolerance_percent value

New in version NX5.0.0.

License requirements: None.

UdeEndOfPath

ToolPathDivideBuilder.UdeEndOfPath

Returns or sets the End of Path command

-------------------------------------

Getter Method

Signature UdeEndOfPath

Returns:the ude end of path Return type:NXOpen.NXObject

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UdeEndOfPath

Parameters:udeEndOfPath (NXOpen.NXObject) – the ude end of path

New in version NX5.0.0.

License requirements: None.

UdeStartOfPath

ToolPathDivideBuilder.UdeStartOfPath

Returns or sets the Start of Path command

-------------------------------------

Getter Method

Signature UdeStartOfPath

Returns:the ude start of path Return type:NXOpen.NXObject

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UdeStartOfPath

Parameters:udeStartOfPath (NXOpen.NXObject) – the ude start of path

New in version NX5.0.0.

License requirements: None.

Method Detail

AddDivideEvent

ToolPathDivideBuilder.AddDivideEvent

Add a new divide event to the list

Signature AddDivideEvent(divideEvent)

Parameters:divideEvent (int) – index of the new divide event

New in version NX6.0.0.

License requirements: None.

GetAllDivideEvents

ToolPathDivideBuilder.GetAllDivideEvents

Returns all events where to of divide the tool path

Signature GetAllDivideEvents()

Returns:array with the divide event indices Return type:list of int

New in version NX6.0.0.

License requirements: None.

GetDivideEvent

ToolPathDivideBuilder.GetDivideEvent

Gets the divide event at the given index

Signature GetDivideEvent(index)

Parameters:index (int) – position of the event to get Returns:the divide point Return type:int

New in version NX6.0.0.

License requirements: None.

RemoveAllDivideEvents

ToolPathDivideBuilder.RemoveAllDivideEvents

Delete all events where to of divide the tool path

Signature RemoveAllDivideEvents()

New in version NX6.0.0.

License requirements: None.

RemoveDivideEvent

ToolPathDivideBuilder.RemoveDivideEvent

Deletes the divide event at the given index

Signature RemoveDivideEvent(divideEvent)

Parameters:divideEvent (int) – the index to delete

New in version NX6.0.0.

License requirements: None.

Validate

ToolPathDivideBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.