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.Path Class Reference

Represets a Cam Tool Path More...

Inheritance diagram for NXOpen.CAM.Path:
NXOpen.TaggedObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  FindingTypes {
  Gouge = 1, Spike, Singularity = 5, SoftLimit,
  HardLimit, Unwind, Collision, ReachFailure,
  VariableLimit, HolderCollision, RapidCollision
}
 Valid finding types to query the path. More...
 

Public Member Functions

unsafe NXOpen.CAM.PathEvent AddCircularMotion (NXOpen.CAM.PathCircularMotion data, NXOpen.CAM.CamPathToolpathEventLocation location, NXOpen.CAM.PathEvent referenceEvent)
 Add a circular move at location, if location is end location(append) then the reference is not relevant More...
 
unsafe NXOpen.CAM.PathEvent AddHelixMotion (NXOpen.CAM.PathHelixMotion data, NXOpen.CAM.CamPathToolpathEventLocation location, NXOpen.CAM.PathEvent referenceEvent)
 Add a helix move at location, if location is end location(append) then the reference is not relevant More...
 
unsafe NXOpen.CAM.PathEvent AddLevelMarker (NXOpen.CAM.PathLevelMarker data, NXOpen.CAM.CamPathToolpathEventLocation location, NXOpen.CAM.PathEvent referenceEvent)
 Add a level marker event at location, if location is end location(append) then the reference is not relevant More...
 
unsafe NXOpen.CAM.PathEvent AddLinearMotion (NXOpen.CAM.PathLinearMotion data, NXOpen.CAM.CamPathToolpathEventLocation location, NXOpen.CAM.PathEvent referenceEvent)
 Add a linear move at location, if location is end location(append) then the reference is not relevant More...
 
unsafe NXOpen.CAM.PathEvent AddMarker (NXOpen.CAM.PathMarker data, NXOpen.CAM.CamPathToolpathEventLocation location, NXOpen.CAM.PathEvent referenceEvent)
 Add a marker event at location, if location is end location(append) then the reference is not relevant More...
 
unsafe NXOpen.CAM.PathEvent AddUde (string udeName, NXOpen.CAM.CamPathToolpathEventLocation location, NXOpen.CAM.PathEvent referenceEvent)
 Add a helix move at location, if location is end location(append) then the reference is not relevant More...
 
unsafe void AppendCircularMotion (NXOpen.CAM.PathCircularMotion data)
 Append a circular move More...
 
unsafe void AppendHelixMotion (NXOpen.CAM.PathHelixMotion data)
 Append a helical move More...
 
unsafe void AppendLevelMarker (NXOpen.CAM.PathLevelMarker data)
 Append a level marker More...
 
unsafe void AppendLinearMotion (NXOpen.CAM.PathLinearMotion data)
 Append a linear move More...
 
unsafe void AppendMarker (NXOpen.CAM.PathMarker data)
 Append a marker More...
 
unsafe void AppendUde (string udeName)
 Append an ude of name with default values More...
 
unsafe void DeleteAllUdesOfName (string udeName)
 Clean up by deleting all Udes that have the specified name ** More...
 
unsafe void DeleteOneEvent (int index)
 Delete one event More...
 
unsafe void DeleteOneEvent (NXOpen.CAM.PathEvent pathEvent)
 Delete one event More...
 
unsafe void EmptyPath ()
 Empty the path by deleteing all events More...
 
unsafe
NXOpen.CAM.PathCircularMotion 
GetCircularMotion (int index)
 Get the data of the circular motion at the given index More...
 
unsafe
NXOpen.CAM.PathCircularMotion 
GetCircularMotion (NXOpen.CAM.PathEvent eventOfInterest)
 Get the data of the circular motion at the given index More...
 
unsafe NXOpen.CAM.PathEvent GetFirstEvent ()
 Ask for the first path event ** More...
 
unsafe NXOpen.CAM.PathHelixMotion GetHelixMotion (int index)
 Get the data of the helix motion at the given index More...
 
unsafe NXOpen.CAM.PathHelixMotion GetHelixMotion (NXOpen.CAM.PathEvent eventOfInterest)
 Get the data of the helix motion event More...
 
unsafe
NXOpen.CAM.PathLaserOptimizationData 
GetLaserOptimizationData ()
 Get the laser optimization data More...
 
unsafe NXOpen.CAM.PathEvent GetLastEvent ()
 Ask for the last path event ** More...
 
unsafe NXOpen.CAM.PathLevelMarker GetLevelMarker (int index)
 Get the data of the level index at the given index More...
 
unsafe NXOpen.CAM.PathLevelMarker GetLevelMarker (NXOpen.CAM.PathEvent eventOfInterest)
 Get the data of the level marker event More...
 
unsafe NXOpen.CAM.PathLinearMotion GetLinearMotion (int index)
 Get the data of the linear motion at the given index More...
 
unsafe NXOpen.CAM.PathLinearMotion GetLinearMotion (NXOpen.CAM.PathEvent eventOfInterest)
 Get the data of the linear motion More...
 
unsafe NXOpen.CAM.PathMarker GetMarker (int index)
 Get the data of the marker at the given index More...
 
unsafe NXOpen.CAM.PathMarker GetMarker (NXOpen.CAM.PathEvent eventOfInterest)
 Get the data of the marker event More...
 
unsafe int GetNumberOfFindings (NXOpen.CAM.Path.FindingTypes type)
 Get the number of findings given a finding type More...
 
unsafe NXOpen.CAM.PathEvent GetToolpathEvent (int eventNumber)
 Get the tool path event for a given index More...
 
unsafe
NXOpen.CAM.CamPathToolpathEventType 
GetToolpathEventType (int eventNumber)
 Get the tool path event type More...
 
unsafe
NXOpen.CAM.CamPathToolpathEventType 
GetToolpathEventType (NXOpen.CAM.PathEvent pathEvent)
 Get the tool path event type More...
 
unsafe NXOpen.CAM.Ude GetUde (int index)
 Get the UDE event at the given index More...
 
unsafe NXOpen.CAM.Ude GetUde (NXOpen.CAM.PathEvent eventOfInterest)
 Get the data of the Ude event More...
 
unsafe void InsertCircularMotionAfter (NXOpen.CAM.PathCircularMotion data, int index)
 Insert Circular Motion after indicated index More...
 
unsafe void InsertCircularMotionBefore (NXOpen.CAM.PathCircularMotion data, int index)
 Insert Circular Motion before indicated index More...
 
unsafe void InsertHelixMotionAfter (NXOpen.CAM.PathHelixMotion data, int index)
 Insert Helical Motion after indicated index More...
 
unsafe void InsertHelixMotionBefore (NXOpen.CAM.PathHelixMotion data, int index)
 Insert Helical Motion before indicated index More...
 
unsafe void InsertLevelMarkerAfter (NXOpen.CAM.PathLevelMarker data, int index)
 Insert a level marker after the specified index More...
 
unsafe void InsertLevelMarkerBefore (NXOpen.CAM.PathLevelMarker data, int index)
 Insert a level marker before the specified index More...
 
unsafe void InsertLinearMotionAfter (NXOpen.CAM.PathLinearMotion data, int index)
 Insert a linear move after the specified index* More...
 
unsafe void InsertLinearMotionBefore (NXOpen.CAM.PathLinearMotion data, int index)
 Insert a linear move before the specified index More...
 
unsafe void InsertMarkerAfter (NXOpen.CAM.PathMarker data, int index)
 Insert a marker after the specified index More...
 
unsafe void InsertMarkerBefore (NXOpen.CAM.PathMarker data, int index)
 Insert a marker before the specified index More...
 
unsafe void InsertUdeAfter (string udeName, int index)
 Insert an ude of name with default values after the given index More...
 
unsafe void InsertUdeBefore (string udeName, int index)
 Insert an ude of name with default values before the given index More...
 
unsafe bool IsFirstEvent (NXOpen.CAM.PathEvent eventOfInterest)
 Return true if the event passed in is the first event in the path More...
 
unsafe bool IsLastEvent (NXOpen.CAM.PathEvent eventOfInterest)
 Return true if the event passed in is the first event in the path More...
 
unsafe bool IsToolpathEventAMotion (int eventNumber, out NXOpen.CAM.CamPathMotionType motionType, out NXOpen.CAM.CamPathMotionShapeType motionShape)
 Tell if the event is a motion. More...
 
unsafe bool IsToolpathEventAMotion (NXOpen.CAM.PathEvent eventOfInterest, out NXOpen.CAM.CamPathMotionType motionType, out NXOpen.CAM.CamPathMotionShapeType motionShape)
 Tell if the event is a motion More...
 
unsafe bool IsToolpathEventUde (NXOpen.CAM.PathEvent eventOfInterest, out string udeName)
 Tell if the event is a ude More...
 
unsafe NXOpen.CAM.PathEvent ModifyCircularMotion (NXOpen.CAM.PathCircularMotion data, NXOpen.CAM.PathEvent eventOfInterest)
 Updates the data of the circular motion event. More...
 
unsafe NXOpen.CAM.PathEvent ModifyHelixMotion (NXOpen.CAM.PathHelixMotion data, NXOpen.CAM.PathEvent eventOfInterest)
 Updates the data of the helix motion event. More...
 
unsafe NXOpen.CAM.PathEvent ModifyLinearMotion (NXOpen.CAM.PathLinearMotion data, NXOpen.CAM.PathEvent eventOfInterest)
 Updates the data of the linear motion event. More...
 
unsafe void MoveEvent (int fromIndex, int toIndex)
 Move the event at index fromIndex to index toIndex. More...
 
unsafe void MoveEvent (NXOpen.CAM.PathEvent eventToMove, NXOpen.CAM.CamPathToolpathEventLocation location, NXOpen.CAM.PathEvent referenceEvent)
 Move the event relative to the referenceEvent and the location. More...
 
unsafe
NXOpen.CAM.PathCircularMotion 
NewPathCircularMotion ()
 Constructs a new path circular motion object. More...
 
unsafe NXOpen.CAM.PathHelixMotion NewPathHelixMotion ()
 Constructs a new path helix motion object. More...
 
unsafe NXOpen.CAM.PathLinearMotion NewPathLinearMotion ()
 Constructs a new path linear motion object. More...
 
unsafe NXOpen.CAM.PathMarker NewPathMarker (NXOpen.CAM.PathMarker.Type markerType)
 Constructs a new path marker object. More...
 
unsafe void SetCircularMotion (int index, NXOpen.CAM.PathCircularMotion data)
 Updates the data of the circular motion event at the given index More...
 
unsafe void SetCircularMotion (NXOpen.CAM.PathEvent eventOfInterest, NXOpen.CAM.PathCircularMotion data)
 Updates the data of the circular motion event More...
 
unsafe void SetHelixMotion (int index, NXOpen.CAM.PathHelixMotion data)
 Updates the data of the helix motion event at the given index More...
 
unsafe void SetHelixMotion (NXOpen.CAM.PathEvent eventOfInterest, NXOpen.CAM.PathHelixMotion data)
 Updates the data of the helix motion event More...
 
unsafe void SetLevelMarker (int index, NXOpen.CAM.PathLevelMarker data)
 Updates the data of the level marker event at the given index More...
 
unsafe void SetLevelMarker (NXOpen.CAM.PathEvent eventOfInterest, NXOpen.CAM.PathLevelMarker data)
 Updates the data of the level marker event More...
 
unsafe void SetLinearMotion (int index, NXOpen.CAM.PathLinearMotion data)
 Updates the data of the linear motion event at the given index More...
 
unsafe void SetLinearMotion (NXOpen.CAM.PathEvent eventOfInterest, NXOpen.CAM.PathLinearMotion data)
 Updates the data of the linear motion event More...
 
unsafe void SetMarker (int index, NXOpen.CAM.PathMarker data)
 Updates the data of the marker event at the given index More...
 
unsafe void SetMarker (NXOpen.CAM.PathEvent eventOfInterest, NXOpen.CAM.PathMarker data)
 Updates the data of the marker event More...
 
unsafe void SetUde (int index, NXOpen.CAM.Ude data)
 Set the UDE event at the given index; The CAM. More...
 
unsafe void SetUde (NXOpen.CAM.PathEvent eventOfInterest, NXOpen.CAM.Ude data)
 Updates the data of the ude event 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.CAM.CamPathContactType 
ContactType [get, set]
 Returns or sets the contact type of the path More...
 
unsafe int NumberOfToolpathEvents [get]
 Returns the number of tool path events More...
 
unsafe
NXOpen.CAM.CamPathToolAxisType 
ToolAxisType [get]
 Returns the tool axis type of the path 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

Represets a Cam Tool Path

This is a Subobject and cannot be publicly instantiated.

Created in NX9.0.3

Member Enumeration Documentation

Valid finding types to query the path.

Enumerator
Gouge 

Finding type gouge

Spike 

Finding type spike

Singularity 

Finding type singularity

SoftLimit 

Finding type soft limit

HardLimit 

Finding type hard limit

Unwind 

Finding type unwind

Collision 

Finding type collision

ReachFailure 

Finding type reach failure

VariableLimit 

Finding type variable limit

HolderCollision 

Finding type tool holder collision

RapidCollision 

Finding type tool rapid collision

Member Function Documentation

unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.AddCircularMotion ( NXOpen.CAM.PathCircularMotion  data,
NXOpen.CAM.CamPathToolpathEventLocation  location,
NXOpen.CAM.PathEvent  referenceEvent 
)
inline

Add a circular move at location, if location is end location(append) then the reference is not relevant

Created in NX11.0.2

License requirements: None.

Parameters
data
location
referenceEvent
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.AddHelixMotion ( NXOpen.CAM.PathHelixMotion  data,
NXOpen.CAM.CamPathToolpathEventLocation  location,
NXOpen.CAM.PathEvent  referenceEvent 
)
inline

Add a helix move at location, if location is end location(append) then the reference is not relevant

Created in NX11.0.2

License requirements: None.

Parameters
data
location
referenceEvent
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.AddLevelMarker ( NXOpen.CAM.PathLevelMarker  data,
NXOpen.CAM.CamPathToolpathEventLocation  location,
NXOpen.CAM.PathEvent  referenceEvent 
)
inline

Add a level marker event at location, if location is end location(append) then the reference is not relevant

Created in NX11.0.2

License requirements: None.

Parameters
data
location
referenceEvent
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.AddLinearMotion ( NXOpen.CAM.PathLinearMotion  data,
NXOpen.CAM.CamPathToolpathEventLocation  location,
NXOpen.CAM.PathEvent  referenceEvent 
)
inline

Add a linear move at location, if location is end location(append) then the reference is not relevant

Created in NX11.0.2

License requirements: None.

Parameters
data
location
referenceEvent
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.AddMarker ( NXOpen.CAM.PathMarker  data,
NXOpen.CAM.CamPathToolpathEventLocation  location,
NXOpen.CAM.PathEvent  referenceEvent 
)
inline

Add a marker event at location, if location is end location(append) then the reference is not relevant

Created in NX12.0.1

License requirements: None.

Parameters
data
location
referenceEvent
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.AddUde ( string  udeName,
NXOpen.CAM.CamPathToolpathEventLocation  location,
NXOpen.CAM.PathEvent  referenceEvent 
)
inline

Add a helix move at location, if location is end location(append) then the reference is not relevant

Created in NX11.0.2

License requirements: None.

Parameters
udeName
location
referenceEvent
Returns
unsafe void NXOpen.CAM.Path.AppendCircularMotion ( NXOpen.CAM.PathCircularMotion  data)
inline

Append a circular move

Created in NX10.0.1

License requirements: None.

Parameters
data
unsafe void NXOpen.CAM.Path.AppendHelixMotion ( NXOpen.CAM.PathHelixMotion  data)
inline

Append a helical move

Created in NX10.0.2

License requirements: None.

Parameters
data
unsafe void NXOpen.CAM.Path.AppendLevelMarker ( NXOpen.CAM.PathLevelMarker  data)
inline

Append a level marker

Created in NX10.0.3

License requirements: None.

Parameters
data
unsafe void NXOpen.CAM.Path.AppendLinearMotion ( NXOpen.CAM.PathLinearMotion  data)
inline

Append a linear move

Created in NX10.0.1

License requirements: None.

Parameters
data
unsafe void NXOpen.CAM.Path.AppendMarker ( NXOpen.CAM.PathMarker  data)
inline

Append a marker

Created in NX12.0.1

License requirements: None.

Parameters
data
unsafe void NXOpen.CAM.Path.AppendUde ( string  udeName)
inline

Append an ude of name with default values

Created in NX10.0.1

License requirements: None.

Parameters
udeName
unsafe void NXOpen.CAM.Path.DeleteAllUdesOfName ( string  udeName)
inline

Clean up by deleting all Udes that have the specified name **

Created in NX11.0.2

License requirements: None.

Parameters
udeName
unsafe void NXOpen.CAM.Path.DeleteOneEvent ( int  index)
inline

Delete one event

Created in NX10.0.3

License requirements: None.

Parameters
index
unsafe void NXOpen.CAM.Path.DeleteOneEvent ( NXOpen.CAM.PathEvent  pathEvent)
inline

Delete one event

Created in NX11.0.2

License requirements: None.

Parameters
pathEvent
unsafe void NXOpen.CAM.Path.EmptyPath ( )
inline

Empty the path by deleteing all events

Created in NX10.0.3

License requirements: None.

unsafe NXOpen.CAM.PathCircularMotion NXOpen.CAM.Path.GetCircularMotion ( int  index)
inline

Get the data of the circular motion at the given index

Created in NX10.0.1

License requirements: None.

Parameters
index
Returns
unsafe NXOpen.CAM.PathCircularMotion NXOpen.CAM.Path.GetCircularMotion ( NXOpen.CAM.PathEvent  eventOfInterest)
inline

Get the data of the circular motion at the given index

Created in NX11.0.2

License requirements: None.

Parameters
eventOfInterest
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.GetFirstEvent ( )
inline

Ask for the first path event **

Created in NX11.0.2

License requirements: None.

Returns
unsafe NXOpen.CAM.PathHelixMotion NXOpen.CAM.Path.GetHelixMotion ( int  index)
inline

Get the data of the helix motion at the given index

Created in NX10.0.1

License requirements: None.

Parameters
index
Returns
unsafe NXOpen.CAM.PathHelixMotion NXOpen.CAM.Path.GetHelixMotion ( NXOpen.CAM.PathEvent  eventOfInterest)
inline

Get the data of the helix motion event

Created in NX11.0.2

License requirements: None.

Parameters
eventOfInterest
Returns
unsafe NXOpen.CAM.PathLaserOptimizationData NXOpen.CAM.Path.GetLaserOptimizationData ( )
inline

Get the laser optimization data

Created in NX9.0.3

License requirements: None.

Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.GetLastEvent ( )
inline

Ask for the last path event **

Created in NX11.0.2

License requirements: None.

Returns
unsafe NXOpen.CAM.PathLevelMarker NXOpen.CAM.Path.GetLevelMarker ( int  index)
inline

Get the data of the level index at the given index

Created in NX10.0.3

License requirements: None.

Parameters
index
Returns
unsafe NXOpen.CAM.PathLevelMarker NXOpen.CAM.Path.GetLevelMarker ( NXOpen.CAM.PathEvent  eventOfInterest)
inline

Get the data of the level marker event

Created in NX11.0.2

License requirements: None.

Parameters
eventOfInterest
Returns
unsafe NXOpen.CAM.PathLinearMotion NXOpen.CAM.Path.GetLinearMotion ( int  index)
inline

Get the data of the linear motion at the given index

Created in NX10.0.1

License requirements: None.

Parameters
index
Returns
unsafe NXOpen.CAM.PathLinearMotion NXOpen.CAM.Path.GetLinearMotion ( NXOpen.CAM.PathEvent  eventOfInterest)
inline

Get the data of the linear motion

Created in NX11.0.2

License requirements: None.

Parameters
eventOfInterest
Returns
unsafe NXOpen.CAM.PathMarker NXOpen.CAM.Path.GetMarker ( int  index)
inline

Get the data of the marker at the given index

Created in NX12.0.1

License requirements: None.

Parameters
index
Returns
unsafe NXOpen.CAM.PathMarker NXOpen.CAM.Path.GetMarker ( NXOpen.CAM.PathEvent  eventOfInterest)
inline

Get the data of the marker event

Created in NX12.0.1

License requirements: None.

Parameters
eventOfInterest
Returns
unsafe int NXOpen.CAM.Path.GetNumberOfFindings ( NXOpen.CAM.Path.FindingTypes  type)
inline

Get the number of findings given a finding type

Created in NX12.0.2

License requirements: None.

Parameters
type
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.GetToolpathEvent ( int  eventNumber)
inline

Get the tool path event for a given index

Created in NX11.0.2

License requirements: None.

Parameters
eventNumber
Returns
unsafe NXOpen.CAM.CamPathToolpathEventType NXOpen.CAM.Path.GetToolpathEventType ( int  eventNumber)
inline

Get the tool path event type

Created in NX10.0.1

License requirements: None.

Parameters
eventNumber
Returns
unsafe NXOpen.CAM.CamPathToolpathEventType NXOpen.CAM.Path.GetToolpathEventType ( NXOpen.CAM.PathEvent  pathEvent)
inline

Get the tool path event type

Created in NX11.0.2

License requirements: None.

Parameters
pathEvent
Returns
unsafe NXOpen.CAM.Ude NXOpen.CAM.Path.GetUde ( int  index)
inline

Get the UDE event at the given index

Created in NX10.0.1

License requirements: None.

Parameters
index
Returns
unsafe NXOpen.CAM.Ude NXOpen.CAM.Path.GetUde ( NXOpen.CAM.PathEvent  eventOfInterest)
inline

Get the data of the Ude event

Created in NX11.0.2

License requirements: None.

Parameters
eventOfInterest
Returns
unsafe void NXOpen.CAM.Path.InsertCircularMotionAfter ( NXOpen.CAM.PathCircularMotion  data,
int  index 
)
inline

Insert Circular Motion after indicated index

Created in NX10.0.1

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertCircularMotionBefore ( NXOpen.CAM.PathCircularMotion  data,
int  index 
)
inline

Insert Circular Motion before indicated index

Created in NX10.0.1

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertHelixMotionAfter ( NXOpen.CAM.PathHelixMotion  data,
int  index 
)
inline

Insert Helical Motion after indicated index

Created in NX10.0.2

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertHelixMotionBefore ( NXOpen.CAM.PathHelixMotion  data,
int  index 
)
inline

Insert Helical Motion before indicated index

Created in NX10.0.2

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertLevelMarkerAfter ( NXOpen.CAM.PathLevelMarker  data,
int  index 
)
inline

Insert a level marker after the specified index

Created in NX10.0.3

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertLevelMarkerBefore ( NXOpen.CAM.PathLevelMarker  data,
int  index 
)
inline

Insert a level marker before the specified index

Created in NX10.0.3

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertLinearMotionAfter ( NXOpen.CAM.PathLinearMotion  data,
int  index 
)
inline

Insert a linear move after the specified index*

Created in NX10.0.1

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertLinearMotionBefore ( NXOpen.CAM.PathLinearMotion  data,
int  index 
)
inline

Insert a linear move before the specified index

Created in NX10.0.1

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertMarkerAfter ( NXOpen.CAM.PathMarker  data,
int  index 
)
inline

Insert a marker after the specified index

Created in NX12.0.1

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertMarkerBefore ( NXOpen.CAM.PathMarker  data,
int  index 
)
inline

Insert a marker before the specified index

Created in NX12.0.1

License requirements: None.

Parameters
data
index
unsafe void NXOpen.CAM.Path.InsertUdeAfter ( string  udeName,
int  index 
)
inline

Insert an ude of name with default values after the given index

Created in NX10.0.1

License requirements: None.

Parameters
udeName
index
unsafe void NXOpen.CAM.Path.InsertUdeBefore ( string  udeName,
int  index 
)
inline

Insert an ude of name with default values before the given index

Created in NX10.0.1

License requirements: None.

Parameters
udeName
index
unsafe bool NXOpen.CAM.Path.IsFirstEvent ( NXOpen.CAM.PathEvent  eventOfInterest)
inline

Return true if the event passed in is the first event in the path

Created in NX1872.0.0

License requirements: None.

Parameters
eventOfInterest
Returns
unsafe bool NXOpen.CAM.Path.IsLastEvent ( NXOpen.CAM.PathEvent  eventOfInterest)
inline

Return true if the event passed in is the first event in the path

Created in NX1872.0.0

License requirements: None.

Parameters
eventOfInterest
Returns
unsafe bool NXOpen.CAM.Path.IsToolpathEventAMotion ( int  eventNumber,
out NXOpen.CAM.CamPathMotionType  motionType,
out NXOpen.CAM.CamPathMotionShapeType  motionShape 
)
inline

Tell if the event is a motion.

EventNumber is 1 through n

Created in NX10.0.1

License requirements: None.

Parameters
eventNumber
motionType
motionShape
Returns
unsafe bool NXOpen.CAM.Path.IsToolpathEventAMotion ( NXOpen.CAM.PathEvent  eventOfInterest,
out NXOpen.CAM.CamPathMotionType  motionType,
out NXOpen.CAM.CamPathMotionShapeType  motionShape 
)
inline

Tell if the event is a motion

Created in NX11.0.2

License requirements: None.

Parameters
eventOfInterest
motionType
motionShape
Returns
unsafe bool NXOpen.CAM.Path.IsToolpathEventUde ( NXOpen.CAM.PathEvent  eventOfInterest,
out string  udeName 
)
inline

Tell if the event is a ude

Created in NX11.0.2

License requirements: None.

Parameters
eventOfInterest
udeName
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.ModifyCircularMotion ( NXOpen.CAM.PathCircularMotion  data,
NXOpen.CAM.PathEvent  eventOfInterest 
)
inline

Updates the data of the circular motion event.

In the process of updating the input PathEvent could also be modified and so the modified(or in some cases the original itself) will be returned

Created in NX1872.0.0

License requirements: None.

Parameters
data
eventOfInterest
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.ModifyHelixMotion ( NXOpen.CAM.PathHelixMotion  data,
NXOpen.CAM.PathEvent  eventOfInterest 
)
inline

Updates the data of the helix motion event.

In the process of updating the input PathEvent could also be modified and so the modified(or in some cases the original itself) will be returned

Created in NX1872.0.0

License requirements: None.

Parameters
data
eventOfInterest
Returns
unsafe NXOpen.CAM.PathEvent NXOpen.CAM.Path.ModifyLinearMotion ( NXOpen.CAM.PathLinearMotion  data,
NXOpen.CAM.PathEvent  eventOfInterest 
)
inline

Updates the data of the linear motion event.

In the process of updating the input PathEvent could also be modified and so the modified(or in some cases the original itself) will be returned

Created in NX1872.0.0

License requirements: None.

Parameters
data
eventOfInterest
Returns
unsafe void NXOpen.CAM.Path.MoveEvent ( int  fromIndex,
int  toIndex 
)
inline

Move the event at index fromIndex to index toIndex.

Events toIndex, toIndex+1, toIndex+2, ... are shifted one position. I.e., toIndex i is shifted to toIndex i+1

Created in NX10.0.1

License requirements: None.

Parameters
fromIndex
toIndex
unsafe void NXOpen.CAM.Path.MoveEvent ( NXOpen.CAM.PathEvent  eventToMove,
NXOpen.CAM.CamPathToolpathEventLocation  location,
NXOpen.CAM.PathEvent  referenceEvent 
)
inline

Move the event relative to the referenceEvent and the location.

If location is end location(append) then reference event is not relevant

Created in NX11.0.2

License requirements: None.

Parameters
eventToMove
location
referenceEvent
unsafe NXOpen.CAM.PathCircularMotion NXOpen.CAM.Path.NewPathCircularMotion ( )
inline

Constructs a new path circular motion object.

Created in NX10.0.1

License requirements: None.

Returns
unsafe NXOpen.CAM.PathHelixMotion NXOpen.CAM.Path.NewPathHelixMotion ( )
inline

Constructs a new path helix motion object.

Created in NX10.0.1

License requirements: None.

Returns
unsafe NXOpen.CAM.PathLinearMotion NXOpen.CAM.Path.NewPathLinearMotion ( )
inline

Constructs a new path linear motion object.

Created in NX10.0.1

License requirements: None.

Returns
unsafe NXOpen.CAM.PathMarker NXOpen.CAM.Path.NewPathMarker ( NXOpen.CAM.PathMarker.Type  markerType)
inline

Constructs a new path marker object.

Created in NX12.0.1

License requirements: None.

Parameters
markerType
Returns
unsafe void NXOpen.CAM.Path.SetCircularMotion ( int  index,
NXOpen.CAM.PathCircularMotion  data 
)
inline

Updates the data of the circular motion event at the given index

Created in NX10.0.1

License requirements: None.

Parameters
index
data
unsafe void NXOpen.CAM.Path.SetCircularMotion ( NXOpen.CAM.PathEvent  eventOfInterest,
NXOpen.CAM.PathCircularMotion  data 
)
inline

Updates the data of the circular motion event

Created in NX11.0.2

Deprecated in NX1872.0.0. Use NXOpen.CAM.Path.ModifyCircularMotion instead.

License requirements: None.

Parameters
eventOfInterest
data
unsafe void NXOpen.CAM.Path.SetHelixMotion ( int  index,
NXOpen.CAM.PathHelixMotion  data 
)
inline

Updates the data of the helix motion event at the given index

Created in NX10.0.1

License requirements: None.

Parameters
index
data
unsafe void NXOpen.CAM.Path.SetHelixMotion ( NXOpen.CAM.PathEvent  eventOfInterest,
NXOpen.CAM.PathHelixMotion  data 
)
inline

Updates the data of the helix motion event

Created in NX11.0.2

Deprecated in NX1872.0.0. Use NXOpen.CAM.Path.ModifyHelixMotion instead.

License requirements: None.

Parameters
eventOfInterest
data
unsafe void NXOpen.CAM.Path.SetLevelMarker ( int  index,
NXOpen.CAM.PathLevelMarker  data 
)
inline

Updates the data of the level marker event at the given index

Created in NX10.0.3

License requirements: None.

Parameters
index
data
unsafe void NXOpen.CAM.Path.SetLevelMarker ( NXOpen.CAM.PathEvent  eventOfInterest,
NXOpen.CAM.PathLevelMarker  data 
)
inline

Updates the data of the level marker event

Created in NX11.0.2

License requirements: None.

Parameters
eventOfInterest
data
unsafe void NXOpen.CAM.Path.SetLinearMotion ( int  index,
NXOpen.CAM.PathLinearMotion  data 
)
inline

Updates the data of the linear motion event at the given index

Created in NX10.0.1

License requirements: None.

Parameters
index
data
unsafe void NXOpen.CAM.Path.SetLinearMotion ( NXOpen.CAM.PathEvent  eventOfInterest,
NXOpen.CAM.PathLinearMotion  data 
)
inline

Updates the data of the linear motion event

Created in NX11.0.2

Deprecated in NX1872.0.0. Use NXOpen.CAM.Path.ModifyLinearMotion instead.

License requirements: None.

Parameters
eventOfInterest
data
unsafe void NXOpen.CAM.Path.SetMarker ( int  index,
NXOpen.CAM.PathMarker  data 
)
inline

Updates the data of the marker event at the given index

Created in NX12.0.1

License requirements: None.

Parameters
index
data
unsafe void NXOpen.CAM.Path.SetMarker ( NXOpen.CAM.PathEvent  eventOfInterest,
NXOpen.CAM.PathMarker  data 
)
inline

Updates the data of the marker event

Created in NX12.0.1

License requirements: None.

Parameters
eventOfInterest
data
unsafe void NXOpen.CAM.Path.SetUde ( int  index,
NXOpen.CAM.Ude  data 
)
inline

Set the UDE event at the given index; The CAM.

Ude API object no longer is valid after this call

Created in NX10.0.1

License requirements: None.

Parameters
index
data
unsafe void NXOpen.CAM.Path.SetUde ( NXOpen.CAM.PathEvent  eventOfInterest,
NXOpen.CAM.Ude  data 
)
inline

Updates the data of the ude event

Created in NX11.0.2

License requirements: None.

Parameters
eventOfInterest
data

Property Documentation

unsafe NXOpen.CAM.CamPathContactType NXOpen.CAM.Path.ContactType
getset

Returns or sets the contact type of the path

Created in NX11.0.2

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe int NXOpen.CAM.Path.NumberOfToolpathEvents
get

Returns the number of tool path events

Created in NX10.0.1

License requirements: None.

unsafe NXOpen.CAM.CamPathToolAxisType NXOpen.CAM.Path.ToolAxisType
get

Returns the tool axis type of the path

Created in NX10.0.1

License requirements: None.


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