NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAM.ToolPathDivideBuilder Class Reference

Represents a Tool Path Divide Builder More...

Inheritance diagram for NXOpen.CAM.ToolPathDivideBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  PathDivideType { ByTime, ByDistance, ByEvents }
 Divide type options More...
 

Public Member Functions

unsafe void AddDivideEvent (int divideEvent)
 Add a new divide event to the list More...
 
unsafe int[] GetAllDivideEvents ()
 Returns all events where to of divide the tool path More...
 
unsafe int GetDivideEvent (int index)
 Gets the divide event at the given index More...
 
unsafe void RemoveAllDivideEvents ()
 Delete all events where to of divide the tool path More...
 
unsafe void RemoveDivideEvent (int divideEvent)
 Deletes the divide event at the given index More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.NXObject ClearancePlane [get, set]
 Returns or sets the Clearance Plane tag,plane entity type covers Xform and Plane More...
 
unsafe double DistanceLimit [get, set]
 Returns or sets the time limit value More...
 
unsafe
NXOpen.CAM.ToolPathDivideBuilder.PathDivideType 
DivideType [get, set]
 Returns or sets the divide limit type More...
 
unsafe int NumberOfDivideEvents [get]
 Returns the number of defined divide event indices More...
 
unsafe double TimeLimit [get, set]
 Returns or sets the time limit value More...
 
unsafe double TolerancePercent [get, set]
 Returns or sets the time limit value More...
 
unsafe NXOpen.NXObject UdeEndOfPath [get, set]
 Returns or sets the End of Path command More...
 
unsafe NXOpen.NXObject UdeStartOfPath [get, set]
 Returns or sets the Start of Path command More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a Tool Path Divide Builder

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

Created in NX5.0.0

Member Enumeration Documentation

Divide type options

Enumerator
ByTime 
ByDistance 
ByEvents 

Member Function Documentation

unsafe void NXOpen.CAM.ToolPathDivideBuilder.AddDivideEvent ( int  divideEvent)
inline

Add a new divide event to the list

Created in NX6.0.0

License requirements: None.

Parameters
divideEventindex of the new divide event
unsafe int [] NXOpen.CAM.ToolPathDivideBuilder.GetAllDivideEvents ( )
inline

Returns all events where to of divide the tool path

Created in NX6.0.0

License requirements: None.

Returns
array with the divide event indices
unsafe int NXOpen.CAM.ToolPathDivideBuilder.GetDivideEvent ( int  index)
inline

Gets the divide event at the given index

Created in NX6.0.0

License requirements: None.

Parameters
indexposition of the event to get
Returns
the divide point
unsafe void NXOpen.CAM.ToolPathDivideBuilder.RemoveAllDivideEvents ( )
inline

Delete all events where to of divide the tool path

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.CAM.ToolPathDivideBuilder.RemoveDivideEvent ( int  divideEvent)
inline

Deletes the divide event at the given index

Created in NX6.0.0

License requirements: None.

Parameters
divideEventthe index to delete

Property Documentation

unsafe NXOpen.NXObject NXOpen.CAM.ToolPathDivideBuilder.ClearancePlane
getset

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.CAM.ToolPathDivideBuilder.DistanceLimit
getset

Returns or sets the time limit value

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAM.ToolPathDivideBuilder.PathDivideType NXOpen.CAM.ToolPathDivideBuilder.DivideType
getset

Returns or sets the divide limit type

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.CAM.ToolPathDivideBuilder.NumberOfDivideEvents
get

Returns the number of defined divide event indices

Created in NX6.0.0

License requirements: None.

unsafe double NXOpen.CAM.ToolPathDivideBuilder.TimeLimit
getset

Returns or sets the time limit value

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.CAM.ToolPathDivideBuilder.TolerancePercent
getset

Returns or sets the time limit value

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.NXObject NXOpen.CAM.ToolPathDivideBuilder.UdeEndOfPath
getset

Returns or sets the End of Path command

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.NXObject NXOpen.CAM.ToolPathDivideBuilder.UdeStartOfPath
getset

Returns or sets the Start of Path command

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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