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 |
---|---|
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 |
---|---|
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 |
DeleteOneEvent | Delete one event |
EmptyPath | Empty the path by deleteing all events |
GetCircularMotion | Get the data of the circular motion at the given index @return |
GetHelixMotion | Get the data of the helix motion at the given index @return |
GetLaserOptimizationData | Get the laser optimization data @return |
GetLevelMarker | Get the data of the level index at the given index @return |
GetLinearMotion | Get the data of the linear motion at the given index @return |
GetToolpathEventType | Get the tool path event type @return |
GetUde | Get the UDE event at the given index @return |
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. |
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¶
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¶
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.
DeleteOneEvent¶
-
Path.
DeleteOneEvent
¶ Delete one event
Signature
DeleteOneEvent(index)
Parameters: index (int) – New in version NX10.0.3.
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
¶ 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.
GetHelixMotion¶
-
Path.
GetHelixMotion
¶ 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.
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.
GetLevelMarker¶
-
Path.
GetLevelMarker
¶ 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.
GetLinearMotion¶
-
Path.
GetLinearMotion
¶ 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.
GetToolpathEventType¶
-
Path.
GetToolpathEventType
¶ 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.
GetUde¶
-
Path.
GetUde
¶ 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.
InsertCircularMotionAfter¶
-
Path.
InsertCircularMotionAfter
¶ Insert Circular Motion after indicated index
Signature
InsertCircularMotionAfter(data, index)
Parameters: - data (
NXOpen.CAM.PathCircularMotion
) – - index (int) –
New in version NX10.0.1.
License requirements: None.
- data (
InsertCircularMotionBefore¶
-
Path.
InsertCircularMotionBefore
¶ Insert Circular Motion before indicated index
Signature
InsertCircularMotionBefore(data, index)
Parameters: - data (
NXOpen.CAM.PathCircularMotion
) – - index (int) –
New in version NX10.0.1.
License requirements: None.
- data (
InsertHelixMotionAfter¶
-
Path.
InsertHelixMotionAfter
¶ Insert Helical Motion after indicated index
Signature
InsertHelixMotionAfter(data, index)
Parameters: - data (
NXOpen.CAM.PathHelixMotion
) – - index (int) –
New in version NX10.0.2.
License requirements: None.
- data (
InsertHelixMotionBefore¶
-
Path.
InsertHelixMotionBefore
¶ Insert Helical Motion before indicated index
Signature
InsertHelixMotionBefore(data, index)
Parameters: - data (
NXOpen.CAM.PathHelixMotion
) – - index (int) –
New in version NX10.0.2.
License requirements: None.
- data (
InsertLevelMarkerAfter¶
-
Path.
InsertLevelMarkerAfter
¶ Insert a level marker after the specified index
Signature
InsertLevelMarkerAfter(data, index)
Parameters: - data (
NXOpen.CAM.PathLevelMarker
) – - index (int) –
New in version NX10.0.3.
License requirements: None.
- data (
InsertLevelMarkerBefore¶
-
Path.
InsertLevelMarkerBefore
¶ Insert a level marker before the specified index
Signature
InsertLevelMarkerBefore(data, index)
Parameters: - data (
NXOpen.CAM.PathLevelMarker
) – - index (int) –
New in version NX10.0.3.
License requirements: None.
- data (
InsertLinearMotionAfter¶
-
Path.
InsertLinearMotionAfter
¶ Insert a linear move after the specified index*
Signature
InsertLinearMotionAfter(data, index)
Parameters: - data (
NXOpen.CAM.PathLinearMotion
) – - index (int) –
New in version NX10.0.1.
License requirements: None.
- data (
InsertLinearMotionBefore¶
-
Path.
InsertLinearMotionBefore
¶ Insert a linear move before the specified index
Signature
InsertLinearMotionBefore(data, index)
Parameters: - data (
NXOpen.CAM.PathLinearMotion
) – - index (int) –
New in version NX10.0.1.
License requirements: None.
- data (
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
¶ 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 aNXOpen.CAM.CamPathMotionShapeType
.New in version NX10.0.1.
License requirements: None.
MoveEvent¶
-
Path.
MoveEvent
¶ 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.
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
¶ Updates the data of the circular motion event at the given index
Signature
SetCircularMotion(index, data)
Parameters: - index (int) –
- data (
NXOpen.CAM.PathCircularMotion
) –
New in version NX10.0.1.
License requirements: None.
SetHelixMotion¶
-
Path.
SetHelixMotion
¶ Updates the data of the helix motion event at the given index
Signature
SetHelixMotion(index, data)
Parameters: - index (int) –
- data (
NXOpen.CAM.PathHelixMotion
) –
New in version NX10.0.1.
License requirements: None.
SetLevelMarker¶
-
Path.
SetLevelMarker
¶ Updates the data of the level marker event at the given index
Signature
SetLevelMarker(index, data)
Parameters: - index (int) –
- data (
NXOpen.CAM.PathLevelMarker
) –
New in version NX10.0.3.
License requirements: None.
SetLinearMotion¶
-
Path.
SetLinearMotion
¶ Updates the data of the linear motion event at the given index
Signature
SetLinearMotion(index, data)
Parameters: - index (int) –
- data (
NXOpen.CAM.PathLinearMotion
) –
New in version NX10.0.1.
License requirements: None.
SetUde¶
-
Path.
SetUde
¶ 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: - index (int) –
- data (
NXOpen.CAM.Ude
) –
New in version NX10.0.1.
License requirements: None.