Path Class

class NXOpen.CAM.Path

Bases: NXOpen.TaggedObject

Represets a Cam Tool Path

This is a Subobject and cannot be publicly instantiated.

New in version NX9.0.3.

Properties

Property Description
ContactType Returns or sets the contact type of the path
NumberOfToolpathEvents Returns the number of tool path events
Tag Returns the Tag for this object.
ToolAxisType Returns the tool axis type of the path

Methods

Method Description
AddCircularMotion Add a circular move at location, if location is end location(append) then the reference is not relevant
AddHelixMotion Add a helix move at location, if location is end location(append) then the reference is not relevant
AddLevelMarker Add a level marker event at location, if location is end location(append) then the reference is not relevant
AddLinearMotion Add a linear move at location, if location is end location(append) then the reference is not relevant
AddUde Add a helix move at location, if location is end location(append) then the reference is not relevant
AppendCircularMotion Append a circular move
AppendHelixMotion Append a helical move
AppendLevelMarker Append a level marker
AppendLinearMotion Append a linear move
AppendUde Append an ude of name with default values
DeleteAllUdesOfName Clean up by deleting all Udes that have the specified name **
DeleteOneEvent Delete one event
EmptyPath Empty the path by deleteing all events
GetCircularMotion Get the data of the circular motion at the given index
GetFirstEvent Ask for the first path event **
GetHelixMotion Get the data of the helix motion at the given index
GetLaserOptimizationData Get the laser optimization data
GetLastEvent Ask for the last path event **
GetLevelMarker Get the data of the level index at the given index
GetLinearMotion Get the data of the linear motion at the given index
GetToolpathEvent Get the tool path event for a given index
GetToolpathEventType Get the tool path event type
GetUde Get the UDE event at the given index
InsertCircularMotionAfter Insert Circular Motion after indicated index
InsertCircularMotionBefore Insert Circular Motion before indicated index
InsertHelixMotionAfter Insert Helical Motion after indicated index
InsertHelixMotionBefore Insert Helical Motion before indicated index
InsertLevelMarkerAfter Insert a level marker after the specified index
InsertLevelMarkerBefore Insert a level marker before the specified index
InsertLinearMotionAfter Insert a linear move after the specified index*
InsertLinearMotionBefore Insert a linear move before the specified index
InsertUdeAfter Insert an ude of name with default values after the given index
InsertUdeBefore Insert an ude of name with default values before the given index
IsToolpathEventAMotion Tell if the event is a motion.
IsToolpathEventUde Tell if the event is a ude
MoveEvent Move the event at index fromIndex to index toIndex.
NewPathCircularMotion Constructs a new path circular motion object.
NewPathHelixMotion Constructs a new path helix motion object.
NewPathLinearMotion Constructs a new path linear motion object.
SetCircularMotion Updates the data of the circular motion event at the given index
SetHelixMotion Updates the data of the helix motion event at the given index
SetLevelMarker Updates the data of the level marker event at the given index
SetLinearMotion Updates the data of the linear motion event at the given index
SetUde Set the UDE event at the given index; The CAM.

Property Detail

ContactType

Path.ContactType

Returns or sets the contact type of the path

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

Getter Method

Signature ContactType

Returns:
Return type:NXOpen.CAM.CamPathContactType

New in version NX11.0.2.

License requirements: None.

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

Setter Method

Signature ContactType

Parameters:contactType (NXOpen.CAM.CamPathContactType) –

New in version NX11.0.2.

License requirements: cam_base (“CAM BASE”)

NumberOfToolpathEvents

Path.NumberOfToolpathEvents

Returns the number of tool path events

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

Getter Method

Signature NumberOfToolpathEvents

Returns:
Return type:int

New in version NX10.0.1.

License requirements: None.

ToolAxisType

Path.ToolAxisType

Returns the tool axis type of the path

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

Getter Method

Signature ToolAxisType

Returns:
Return type:NXOpen.CAM.CamPathToolAxisType

New in version NX10.0.1.

License requirements: None.

Method Detail

AddCircularMotion

Path.AddCircularMotion

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

Signature AddCircularMotion(data, location, referenceEvent)

Parameters:
Returns:
Return type:

NXOpen.CAM.PathEvent

New in version NX11.0.2.

License requirements: None.

AddHelixMotion

Path.AddHelixMotion

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

Signature AddHelixMotion(data, location, referenceEvent)

Parameters:
Returns:
Return type:

NXOpen.CAM.PathEvent

New in version NX11.0.2.

License requirements: None.

AddLevelMarker

Path.AddLevelMarker

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

Signature AddLevelMarker(data, location, referenceEvent)

Parameters:
Returns:
Return type:

NXOpen.CAM.PathEvent

New in version NX11.0.2.

License requirements: None.

AddLinearMotion

Path.AddLinearMotion

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

Signature AddLinearMotion(data, location, referenceEvent)

Parameters:
Returns:
Return type:

NXOpen.CAM.PathEvent

New in version NX11.0.2.

License requirements: None.

AddUde

Path.AddUde

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

Signature AddUde(udeName, location, referenceEvent)

Parameters:
Returns:
Return type:

NXOpen.CAM.PathEvent

New in version NX11.0.2.

License requirements: None.

AppendCircularMotion

Path.AppendCircularMotion

Append a circular move

Signature AppendCircularMotion(data)

Parameters:data (NXOpen.CAM.PathCircularMotion) –

New in version NX10.0.1.

License requirements: None.

AppendHelixMotion

Path.AppendHelixMotion

Append a helical move

Signature AppendHelixMotion(data)

Parameters:data (NXOpen.CAM.PathHelixMotion) –

New in version NX10.0.2.

License requirements: None.

AppendLevelMarker

Path.AppendLevelMarker

Append a level marker

Signature AppendLevelMarker(data)

Parameters:data (NXOpen.CAM.PathLevelMarker) –

New in version NX10.0.3.

License requirements: None.

AppendLinearMotion

Path.AppendLinearMotion

Append a linear move

Signature AppendLinearMotion(data)

Parameters:data (NXOpen.CAM.PathLinearMotion) –

New in version NX10.0.1.

License requirements: None.

AppendUde

Path.AppendUde

Append an ude of name with default values

Signature AppendUde(udeName)

Parameters:udeName (str) –

New in version NX10.0.1.

License requirements: None.

DeleteAllUdesOfName

Path.DeleteAllUdesOfName

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

Signature DeleteAllUdesOfName(udeName)

Parameters:udeName (str) –

New in version NX11.0.2.

License requirements: None.

DeleteOneEvent

Path.DeleteOneEvent

Overloaded method DeleteOneEvent

  • DeleteOneEvent(index)
  • DeleteOneEvent(pathEvent)

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

Delete one event

Signature DeleteOneEvent(index)

Parameters:index (int) –

New in version NX10.0.3.

License requirements: None.

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

Delete one event

Signature DeleteOneEvent(pathEvent)

Parameters:pathEvent (NXOpen.CAM.PathEvent) –

New in version NX11.0.2.

License requirements: None.

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

EmptyPath

Path.EmptyPath

Empty the path by deleteing all events

Signature EmptyPath()

New in version NX10.0.3.

License requirements: None.

GetCircularMotion

Path.GetCircularMotion

Overloaded method GetCircularMotion

  • GetCircularMotion(index)
  • GetCircularMotion(eventOfInterest)

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

Get the data of the circular motion at the given index

Signature GetCircularMotion(index)

Parameters:index (int) –
Returns:
Return type:NXOpen.CAM.PathCircularMotion

New in version NX10.0.1.

License requirements: None.

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

Get the data of the circular motion at the given index

Signature GetCircularMotion(eventOfInterest)

Parameters:eventOfInterest (NXOpen.CAM.PathEvent) –
Returns:
Return type:NXOpen.CAM.PathCircularMotion

New in version NX11.0.2.

License requirements: None.

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

GetFirstEvent

Path.GetFirstEvent

Ask for the first path event **

Signature GetFirstEvent()

Returns:
Return type:NXOpen.CAM.PathEvent

New in version NX11.0.2.

License requirements: None.

GetHelixMotion

Path.GetHelixMotion

Overloaded method GetHelixMotion

  • GetHelixMotion(index)
  • GetHelixMotion(eventOfInterest)

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

Get the data of the helix motion at the given index

Signature GetHelixMotion(index)

Parameters:index (int) –
Returns:
Return type:NXOpen.CAM.PathHelixMotion

New in version NX10.0.1.

License requirements: None.

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

Get the data of the helix motion event

Signature GetHelixMotion(eventOfInterest)

Parameters:eventOfInterest (NXOpen.CAM.PathEvent) –
Returns:
Return type:NXOpen.CAM.PathHelixMotion

New in version NX11.0.2.

License requirements: None.

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

GetLaserOptimizationData

Path.GetLaserOptimizationData

Get the laser optimization data

Signature GetLaserOptimizationData()

Returns:
Return type:NXOpen.CAM.PathLaserOptimizationData

New in version NX9.0.3.

License requirements: None.

GetLastEvent

Path.GetLastEvent

Ask for the last path event **

Signature GetLastEvent()

Returns:
Return type:NXOpen.CAM.PathEvent

New in version NX11.0.2.

License requirements: None.

GetLevelMarker

Path.GetLevelMarker

Overloaded method GetLevelMarker

  • GetLevelMarker(index)
  • GetLevelMarker(eventOfInterest)

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

Get the data of the level index at the given index

Signature GetLevelMarker(index)

Parameters:index (int) –
Returns:
Return type:NXOpen.CAM.PathLevelMarker

New in version NX10.0.3.

License requirements: None.

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

Get the data of the level marker event

Signature GetLevelMarker(eventOfInterest)

Parameters:eventOfInterest (NXOpen.CAM.PathEvent) –
Returns:
Return type:NXOpen.CAM.PathLevelMarker

New in version NX11.0.2.

License requirements: None.

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

GetLinearMotion

Path.GetLinearMotion

Overloaded method GetLinearMotion

  • GetLinearMotion(index)
  • GetLinearMotion(eventOfInterest)

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

Get the data of the linear motion at the given index

Signature GetLinearMotion(index)

Parameters:index (int) –
Returns:
Return type:NXOpen.CAM.PathLinearMotion

New in version NX10.0.1.

License requirements: None.

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

Get the data of the linear motion

Signature GetLinearMotion(eventOfInterest)

Parameters:eventOfInterest (NXOpen.CAM.PathEvent) –
Returns:
Return type:NXOpen.CAM.PathLinearMotion

New in version NX11.0.2.

License requirements: None.

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

GetToolpathEvent

Path.GetToolpathEvent

Get the tool path event for a given index

Signature GetToolpathEvent(eventNumber)

Parameters:eventNumber (int) –
Returns:
Return type:NXOpen.CAM.PathEvent

New in version NX11.0.2.

License requirements: None.

GetToolpathEventType

Path.GetToolpathEventType

Overloaded method GetToolpathEventType

  • GetToolpathEventType(eventNumber)
  • GetToolpathEventType(pathEvent)

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

Get the tool path event type

Signature GetToolpathEventType(eventNumber)

Parameters:eventNumber (int) –
Returns:
Return type:NXOpen.CAM.CamPathToolpathEventType

New in version NX10.0.1.

License requirements: None.

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

Get the tool path event type

Signature GetToolpathEventType(pathEvent)

Parameters:pathEvent (NXOpen.CAM.PathEvent) –
Returns:
Return type:NXOpen.CAM.CamPathToolpathEventType

New in version NX11.0.2.

License requirements: None.

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

GetUde

Path.GetUde

Overloaded method GetUde

  • GetUde(index)
  • GetUde(eventOfInterest)

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

Get the UDE event at the given index

Signature GetUde(index)

Parameters:index (int) –
Returns:
Return type:NXOpen.CAM.Ude

New in version NX10.0.1.

License requirements: None.

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

Get the data of the Ude event

Signature GetUde(eventOfInterest)

Parameters:eventOfInterest (NXOpen.CAM.PathEvent) –
Returns:
Return type:NXOpen.CAM.Ude

New in version NX11.0.2.

License requirements: None.

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

InsertCircularMotionAfter

Path.InsertCircularMotionAfter

Insert Circular Motion after indicated index

Signature InsertCircularMotionAfter(data, index)

Parameters:

New in version NX10.0.1.

License requirements: None.

InsertCircularMotionBefore

Path.InsertCircularMotionBefore

Insert Circular Motion before indicated index

Signature InsertCircularMotionBefore(data, index)

Parameters:

New in version NX10.0.1.

License requirements: None.

InsertHelixMotionAfter

Path.InsertHelixMotionAfter

Insert Helical Motion after indicated index

Signature InsertHelixMotionAfter(data, index)

Parameters:

New in version NX10.0.2.

License requirements: None.

InsertHelixMotionBefore

Path.InsertHelixMotionBefore

Insert Helical Motion before indicated index

Signature InsertHelixMotionBefore(data, index)

Parameters:

New in version NX10.0.2.

License requirements: None.

InsertLevelMarkerAfter

Path.InsertLevelMarkerAfter

Insert a level marker after the specified index

Signature InsertLevelMarkerAfter(data, index)

Parameters:

New in version NX10.0.3.

License requirements: None.

InsertLevelMarkerBefore

Path.InsertLevelMarkerBefore

Insert a level marker before the specified index

Signature InsertLevelMarkerBefore(data, index)

Parameters:

New in version NX10.0.3.

License requirements: None.

InsertLinearMotionAfter

Path.InsertLinearMotionAfter

Insert a linear move after the specified index*

Signature InsertLinearMotionAfter(data, index)

Parameters:

New in version NX10.0.1.

License requirements: None.

InsertLinearMotionBefore

Path.InsertLinearMotionBefore

Insert a linear move before the specified index

Signature InsertLinearMotionBefore(data, index)

Parameters:

New in version NX10.0.1.

License requirements: None.

InsertUdeAfter

Path.InsertUdeAfter

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

Signature InsertUdeAfter(udeName, index)

Parameters:
  • udeName (str) –
  • index (int) –

New in version NX10.0.1.

License requirements: None.

InsertUdeBefore

Path.InsertUdeBefore

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

Signature InsertUdeBefore(udeName, index)

Parameters:
  • udeName (str) –
  • index (int) –

New in version NX10.0.1.

License requirements: None.

IsToolpathEventAMotion

Path.IsToolpathEventAMotion

Overloaded method IsToolpathEventAMotion

  • IsToolpathEventAMotion(eventNumber)
  • IsToolpathEventAMotion(eventOfInterest)

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

Tell if the event is a motion. EventNumber is 1 through n

Signature IsToolpathEventAMotion(eventNumber)

Parameters:eventNumber (int) –
Returns:a tuple
Return type:A tuple consisting of (answer, motionType, motionShape). answer is a bool. motionType is a NXOpen.CAM.CamPathMotionType. motionShape is a NXOpen.CAM.CamPathMotionShapeType.

New in version NX10.0.1.

License requirements: None.

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

Tell if the event is a motion

Signature IsToolpathEventAMotion(eventOfInterest)

Parameters:eventOfInterest (NXOpen.CAM.PathEvent) –
Returns:a tuple
Return type:A tuple consisting of (answer, motionType, motionShape). answer is a bool. motionType is a NXOpen.CAM.CamPathMotionType. motionShape is a NXOpen.CAM.CamPathMotionShapeType.

New in version NX11.0.2.

License requirements: None.

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

IsToolpathEventUde

Path.IsToolpathEventUde

Tell if the event is a ude

Signature IsToolpathEventUde(eventOfInterest)

Parameters:eventOfInterest (NXOpen.CAM.PathEvent) –
Returns:a tuple
Return type:A tuple consisting of (answer, udeName) answer is a bool. udeName is a str.

New in version NX11.0.2.

License requirements: None.

MoveEvent

Path.MoveEvent

Overloaded method MoveEvent

  • MoveEvent(fromIndex, toIndex)
  • MoveEvent(eventToMove, location, referenceEvent)

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

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

Signature MoveEvent(fromIndex, toIndex)

Parameters:
  • fromIndex (int) –
  • toIndex (int) –

New in version NX10.0.1.

License requirements: None.

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

Move the event relative to the referenceEvent and the location. If location is end location(append) then reference event is not relevant

Signature MoveEvent(eventToMove, location, referenceEvent)

Parameters:

New in version NX11.0.2.

License requirements: None.

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

NewPathCircularMotion

Path.NewPathCircularMotion

Constructs a new path circular motion object.

Signature NewPathCircularMotion()

Returns:
Return type:NXOpen.CAM.PathCircularMotion

New in version NX10.0.1.

License requirements: None.

NewPathHelixMotion

Path.NewPathHelixMotion

Constructs a new path helix motion object.

Signature NewPathHelixMotion()

Returns:
Return type:NXOpen.CAM.PathHelixMotion

New in version NX10.0.1.

License requirements: None.

NewPathLinearMotion

Path.NewPathLinearMotion

Constructs a new path linear motion object.

Signature NewPathLinearMotion()

Returns:
Return type:NXOpen.CAM.PathLinearMotion

New in version NX10.0.1.

License requirements: None.

SetCircularMotion

Path.SetCircularMotion

Overloaded method SetCircularMotion

  • SetCircularMotion(index, data)
  • SetCircularMotion(eventOfInterest, data)

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

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

Signature SetCircularMotion(index, data)

Parameters:

New in version NX10.0.1.

License requirements: None.

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

Updates the data of the circular motion event

Signature SetCircularMotion(eventOfInterest, data)

Parameters:

New in version NX11.0.2.

License requirements: None.

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

SetHelixMotion

Path.SetHelixMotion

Overloaded method SetHelixMotion

  • SetHelixMotion(index, data)
  • SetHelixMotion(eventOfInterest, data)

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

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

Signature SetHelixMotion(index, data)

Parameters:

New in version NX10.0.1.

License requirements: None.

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

Updates the data of the helix motion event

Signature SetHelixMotion(eventOfInterest, data)

Parameters:

New in version NX11.0.2.

License requirements: None.

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

SetLevelMarker

Path.SetLevelMarker

Overloaded method SetLevelMarker

  • SetLevelMarker(index, data)
  • SetLevelMarker(eventOfInterest, data)

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

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

Signature SetLevelMarker(index, data)

Parameters:

New in version NX10.0.3.

License requirements: None.

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

Updates the data of the level marker event

Signature SetLevelMarker(eventOfInterest, data)

Parameters:

New in version NX11.0.2.

License requirements: None.

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

SetLinearMotion

Path.SetLinearMotion

Overloaded method SetLinearMotion

  • SetLinearMotion(index, data)
  • SetLinearMotion(eventOfInterest, data)

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

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

Signature SetLinearMotion(index, data)

Parameters:

New in version NX10.0.1.

License requirements: None.

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

Updates the data of the linear motion event

Signature SetLinearMotion(eventOfInterest, data)

Parameters:

New in version NX11.0.2.

License requirements: None.

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

SetUde

Path.SetUde

Overloaded method SetUde

  • SetUde(index, data)
  • SetUde(eventOfInterest, data)

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

Set the UDE event at the given index; The CAM.Ude API object no longer is valid after this call

Signature SetUde(index, data)

Parameters:

New in version NX10.0.1.

License requirements: None.

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

Updates the data of the ude event

Signature SetUde(eventOfInterest, data)

Parameters:

New in version NX11.0.2.

License requirements: None.

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