Class Path

Inheritance
System.Object
System.MarshalByRefObject
NXRemotableObject
TaggedObject
Path
Implements
System.Runtime.Remoting.Messaging.IMessageSink
Inherited Members
System.MarshalByRefObject.CreateObjRef(System.Type)
System.MarshalByRefObject.GetLifetimeService()
System.MarshalByRefObject.InitializeLifetimeService()
System.MarshalByRefObject.MemberwiseClone(System.Boolean)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: NXOpen.CAM
Assembly: NXOpen.dll
Syntax
public class Path : TaggedObject, IMessageSink

Constructors

Path()

Declaration
protected Path()

Properties

ContactType

Declaration
public CamPathContactType ContactType { get; set; }
Property Value
Type Description
CamPathContactType

NumberOfToolpathEvents

Declaration
public int NumberOfToolpathEvents { get; }
Property Value
Type Description
System.Int32

RobotRulesStatus

Declaration
public Path.RobotRulesStatusStates RobotRulesStatus { get; set; }
Property Value
Type Description
Path.RobotRulesStatusStates

ToolAxisType

Declaration
public CamPathToolAxisType ToolAxisType { get; }
Property Value
Type Description
CamPathToolAxisType

Methods

AddCircularMotion(PathCircularMotion, CamPathToolpathEventLocation, PathEvent)

Declaration
public PathEvent AddCircularMotion(PathCircularMotion data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
Parameters
Type Name Description
PathCircularMotion data
CamPathToolpathEventLocation location
PathEvent referenceEvent
Returns
Type Description
PathEvent

AddHelixMotion(PathHelixMotion, CamPathToolpathEventLocation, PathEvent)

Declaration
public PathEvent AddHelixMotion(PathHelixMotion data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
Parameters
Type Name Description
PathHelixMotion data
CamPathToolpathEventLocation location
PathEvent referenceEvent
Returns
Type Description
PathEvent

AddLevelMarker(PathLevelMarker, CamPathToolpathEventLocation, PathEvent)

Declaration
public PathEvent AddLevelMarker(PathLevelMarker data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
Parameters
Type Name Description
PathLevelMarker data
CamPathToolpathEventLocation location
PathEvent referenceEvent
Returns
Type Description
PathEvent

AddLinearMotion(PathLinearMotion, CamPathToolpathEventLocation, PathEvent)

Declaration
public PathEvent AddLinearMotion(PathLinearMotion data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
Parameters
Type Name Description
PathLinearMotion data
CamPathToolpathEventLocation location
PathEvent referenceEvent
Returns
Type Description
PathEvent

AddMarker(PathMarker, CamPathToolpathEventLocation, PathEvent)

Declaration
public PathEvent AddMarker(PathMarker data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
Parameters
Type Name Description
PathMarker data
CamPathToolpathEventLocation location
PathEvent referenceEvent
Returns
Type Description
PathEvent

AddUde(String, CamPathToolpathEventLocation, PathEvent)

Declaration
public PathEvent AddUde(string udeName, CamPathToolpathEventLocation location, PathEvent referenceEvent)
Parameters
Type Name Description
System.String udeName
CamPathToolpathEventLocation location
PathEvent referenceEvent
Returns
Type Description
PathEvent

AppendCircularMotion(PathCircularMotion)

Declaration
public void AppendCircularMotion(PathCircularMotion data)
Parameters
Type Name Description
PathCircularMotion data

AppendHelixMotion(PathHelixMotion)

Declaration
public void AppendHelixMotion(PathHelixMotion data)
Parameters
Type Name Description
PathHelixMotion data

AppendLevelMarker(PathLevelMarker)

Declaration
public void AppendLevelMarker(PathLevelMarker data)
Parameters
Type Name Description
PathLevelMarker data

AppendLinearMotion(PathLinearMotion)

Declaration
public void AppendLinearMotion(PathLinearMotion data)
Parameters
Type Name Description
PathLinearMotion data

AppendMarker(PathMarker)

Declaration
public void AppendMarker(PathMarker data)
Parameters
Type Name Description
PathMarker data

AppendUde(String)

Declaration
public void AppendUde(string udeName)
Parameters
Type Name Description
System.String udeName

CopyEvent(PathEvent, CamPathToolpathEventLocation, PathEvent)

Declaration
public PathEvent CopyEvent(PathEvent eventToCopy, CamPathToolpathEventLocation location, PathEvent referenceEvent)
Parameters
Type Name Description
PathEvent eventToCopy
CamPathToolpathEventLocation location
PathEvent referenceEvent
Returns
Type Description
PathEvent

DeleteAllUdesOfName(String)

Declaration
public void DeleteAllUdesOfName(string udeName)
Parameters
Type Name Description
System.String udeName

DeleteOneEvent(PathEvent)

Declaration
public void DeleteOneEvent(PathEvent pathEvent)
Parameters
Type Name Description
PathEvent pathEvent

DeleteOneEvent(Int32)

Declaration
public void DeleteOneEvent(int index)
Parameters
Type Name Description
System.Int32 index

EmptyPath()

Declaration
public void EmptyPath()

GetCircularMotion(PathEvent)

Declaration
public PathCircularMotion GetCircularMotion(PathEvent eventOfInterest)
Parameters
Type Name Description
PathEvent eventOfInterest
Returns
Type Description
PathCircularMotion

GetCircularMotion(Int32)

Declaration
public PathCircularMotion GetCircularMotion(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
PathCircularMotion

GetFirstEvent()

Declaration
public PathEvent GetFirstEvent()
Returns
Type Description
PathEvent

GetHelixMotion(PathEvent)

Declaration
public PathHelixMotion GetHelixMotion(PathEvent eventOfInterest)
Parameters
Type Name Description
PathEvent eventOfInterest
Returns
Type Description
PathHelixMotion

GetHelixMotion(Int32)

Declaration
public PathHelixMotion GetHelixMotion(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
PathHelixMotion

GetLaserOptimizationData()

Declaration
public PathLaserOptimizationData GetLaserOptimizationData()
Returns
Type Description
PathLaserOptimizationData

GetLastEvent()

Declaration
public PathEvent GetLastEvent()
Returns
Type Description
PathEvent

GetLevelMarker(PathEvent)

Declaration
public PathLevelMarker GetLevelMarker(PathEvent eventOfInterest)
Parameters
Type Name Description
PathEvent eventOfInterest
Returns
Type Description
PathLevelMarker

GetLevelMarker(Int32)

Declaration
public PathLevelMarker GetLevelMarker(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
PathLevelMarker

GetLinearMotion(PathEvent)

Declaration
public PathLinearMotion GetLinearMotion(PathEvent eventOfInterest)
Parameters
Type Name Description
PathEvent eventOfInterest
Returns
Type Description
PathLinearMotion

GetLinearMotion(Int32)

Declaration
public PathLinearMotion GetLinearMotion(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
PathLinearMotion

GetMarker(PathEvent)

Declaration
public PathMarker GetMarker(PathEvent eventOfInterest)
Parameters
Type Name Description
PathEvent eventOfInterest
Returns
Type Description
PathMarker

GetMarker(Int32)

Declaration
public PathMarker GetMarker(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
PathMarker

GetNumberOfFindings(Path.FindingTypes)

Declaration
public int GetNumberOfFindings(Path.FindingTypes type)
Parameters
Type Name Description
Path.FindingTypes type
Returns
Type Description
System.Int32

GetReferenceData()

Declaration
public PathOwnerData GetReferenceData()
Returns
Type Description
PathOwnerData

GetSubPathData(PathEvent)

Declaration
public PathOwnerData GetSubPathData(PathEvent forEvent)
Parameters
Type Name Description
PathEvent forEvent
Returns
Type Description
PathOwnerData

GetToolpathEvent(Int32)

Declaration
public PathEvent GetToolpathEvent(int eventNumber)
Parameters
Type Name Description
System.Int32 eventNumber
Returns
Type Description
PathEvent

GetToolpathEventType(PathEvent)

Declaration
public CamPathToolpathEventType GetToolpathEventType(PathEvent pathEvent)
Parameters
Type Name Description
PathEvent pathEvent
Returns
Type Description
CamPathToolpathEventType

GetToolpathEventType(Int32)

Declaration
public CamPathToolpathEventType GetToolpathEventType(int eventNumber)
Parameters
Type Name Description
System.Int32 eventNumber
Returns
Type Description
CamPathToolpathEventType

GetUde(PathEvent)

Declaration
public Ude GetUde(PathEvent eventOfInterest)
Parameters
Type Name Description
PathEvent eventOfInterest
Returns
Type Description
Ude

GetUde(Int32)

Declaration
public Ude GetUde(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
Ude

GetWidthHeight(PathEvent, out Double, out Double)

Declaration
public void GetWidthHeight(PathEvent eventOfInterest, out double width, out double height)
Parameters
Type Name Description
PathEvent eventOfInterest
System.Double width
System.Double height

HasSubPath()

Declaration
public bool HasSubPath()
Returns
Type Description
System.Boolean

InsertCircularMotionAfter(PathCircularMotion, Int32)

Declaration
public void InsertCircularMotionAfter(PathCircularMotion data, int index)
Parameters
Type Name Description
PathCircularMotion data
System.Int32 index

InsertCircularMotionBefore(PathCircularMotion, Int32)

Declaration
public void InsertCircularMotionBefore(PathCircularMotion data, int index)
Parameters
Type Name Description
PathCircularMotion data
System.Int32 index

InsertHelixMotionAfter(PathHelixMotion, Int32)

Declaration
public void InsertHelixMotionAfter(PathHelixMotion data, int index)
Parameters
Type Name Description
PathHelixMotion data
System.Int32 index

InsertHelixMotionBefore(PathHelixMotion, Int32)

Declaration
public void InsertHelixMotionBefore(PathHelixMotion data, int index)
Parameters
Type Name Description
PathHelixMotion data
System.Int32 index

InsertLevelMarkerAfter(PathLevelMarker, Int32)

Declaration
public void InsertLevelMarkerAfter(PathLevelMarker data, int index)
Parameters
Type Name Description
PathLevelMarker data
System.Int32 index

InsertLevelMarkerBefore(PathLevelMarker, Int32)

Declaration
public void InsertLevelMarkerBefore(PathLevelMarker data, int index)
Parameters
Type Name Description
PathLevelMarker data
System.Int32 index

InsertLinearMotionAfter(PathLinearMotion, Int32)

Declaration
public void InsertLinearMotionAfter(PathLinearMotion data, int index)
Parameters
Type Name Description
PathLinearMotion data
System.Int32 index

InsertLinearMotionBefore(PathLinearMotion, Int32)

Declaration
public void InsertLinearMotionBefore(PathLinearMotion data, int index)
Parameters
Type Name Description
PathLinearMotion data
System.Int32 index

InsertMarkerAfter(PathMarker, Int32)

Declaration
public void InsertMarkerAfter(PathMarker data, int index)
Parameters
Type Name Description
PathMarker data
System.Int32 index

InsertMarkerBefore(PathMarker, Int32)

Declaration
public void InsertMarkerBefore(PathMarker data, int index)
Parameters
Type Name Description
PathMarker data
System.Int32 index

InsertUdeAfter(String, Int32)

Declaration
public void InsertUdeAfter(string udeName, int index)
Parameters
Type Name Description
System.String udeName
System.Int32 index

InsertUdeBefore(String, Int32)

Declaration
public void InsertUdeBefore(string udeName, int index)
Parameters
Type Name Description
System.String udeName
System.Int32 index

IsFirstEvent(PathEvent)

Declaration
public bool IsFirstEvent(PathEvent eventOfInterest)
Parameters
Type Name Description
PathEvent eventOfInterest
Returns
Type Description
System.Boolean

IsLastEvent(PathEvent)

Declaration
public bool IsLastEvent(PathEvent eventOfInterest)
Parameters
Type Name Description
PathEvent eventOfInterest
Returns
Type Description
System.Boolean

IsToolpathEventAMotion(PathEvent, out CamPathMotionType, out CamPathMotionShapeType)

Declaration
public bool IsToolpathEventAMotion(PathEvent eventOfInterest, out CamPathMotionType motionType, out CamPathMotionShapeType motionShape)
Parameters
Type Name Description
PathEvent eventOfInterest
CamPathMotionType motionType
CamPathMotionShapeType motionShape
Returns
Type Description
System.Boolean

IsToolpathEventAMotion(Int32, out CamPathMotionType, out CamPathMotionShapeType)

Declaration
public bool IsToolpathEventAMotion(int eventNumber, out CamPathMotionType motionType, out CamPathMotionShapeType motionShape)
Parameters
Type Name Description
System.Int32 eventNumber
CamPathMotionType motionType
CamPathMotionShapeType motionShape
Returns
Type Description
System.Boolean

IsToolpathEventUde(PathEvent, out String)

Declaration
public bool IsToolpathEventUde(PathEvent eventOfInterest, out string udeName)
Parameters
Type Name Description
PathEvent eventOfInterest
System.String udeName
Returns
Type Description
System.Boolean

ModifyCircularMotion(PathCircularMotion, PathEvent)

Declaration
public PathEvent ModifyCircularMotion(PathCircularMotion data, PathEvent eventOfInterest)
Parameters
Type Name Description
PathCircularMotion data
PathEvent eventOfInterest
Returns
Type Description
PathEvent

ModifyHelixMotion(PathHelixMotion, PathEvent)

Declaration
public PathEvent ModifyHelixMotion(PathHelixMotion data, PathEvent eventOfInterest)
Parameters
Type Name Description
PathHelixMotion data
PathEvent eventOfInterest
Returns
Type Description
PathEvent

ModifyLinearMotion(PathLinearMotion, PathEvent)

Declaration
public PathEvent ModifyLinearMotion(PathLinearMotion data, PathEvent eventOfInterest)
Parameters
Type Name Description
PathLinearMotion data
PathEvent eventOfInterest
Returns
Type Description
PathEvent

MoveEvent(PathEvent, CamPathToolpathEventLocation, PathEvent)

Declaration
public void MoveEvent(PathEvent eventToMove, CamPathToolpathEventLocation location, PathEvent referenceEvent)
Parameters
Type Name Description
PathEvent eventToMove
CamPathToolpathEventLocation location
PathEvent referenceEvent

MoveEvent(Int32, Int32)

Declaration
public void MoveEvent(int fromIndex, int toIndex)
Parameters
Type Name Description
System.Int32 fromIndex
System.Int32 toIndex

NewPathCircularMotion()

Declaration
public PathCircularMotion NewPathCircularMotion()
Returns
Type Description
PathCircularMotion

NewPathHelixMotion()

Declaration
public PathHelixMotion NewPathHelixMotion()
Returns
Type Description
PathHelixMotion

NewPathLinearMotion()

Declaration
public PathLinearMotion NewPathLinearMotion()
Returns
Type Description
PathLinearMotion

NewPathMarker(PathMarker.Type)

Declaration
public PathMarker NewPathMarker(PathMarker.Type markerType)
Parameters
Type Name Description
PathMarker.Type markerType
Returns
Type Description
PathMarker

SetCircularMotion(PathEvent, PathCircularMotion)

Declaration
[Obsolete("Deprecated in NX1872.0.0.  Use NXOpen.CAM.Path.ModifyCircularMotion instead.")]
public void SetCircularMotion(PathEvent eventOfInterest, PathCircularMotion data)
Parameters
Type Name Description
PathEvent eventOfInterest
PathCircularMotion data

SetCircularMotion(Int32, PathCircularMotion)

Declaration
public void SetCircularMotion(int index, PathCircularMotion data)
Parameters
Type Name Description
System.Int32 index
PathCircularMotion data

SetHelixMotion(PathEvent, PathHelixMotion)

Declaration
[Obsolete("Deprecated in NX1872.0.0.  Use NXOpen.CAM.Path.ModifyHelixMotion instead.")]
public void SetHelixMotion(PathEvent eventOfInterest, PathHelixMotion data)
Parameters
Type Name Description
PathEvent eventOfInterest
PathHelixMotion data

SetHelixMotion(Int32, PathHelixMotion)

Declaration
public void SetHelixMotion(int index, PathHelixMotion data)
Parameters
Type Name Description
System.Int32 index
PathHelixMotion data

SetLevelMarker(PathEvent, PathLevelMarker)

Declaration
public void SetLevelMarker(PathEvent eventOfInterest, PathLevelMarker data)
Parameters
Type Name Description
PathEvent eventOfInterest
PathLevelMarker data

SetLevelMarker(Int32, PathLevelMarker)

Declaration
public void SetLevelMarker(int index, PathLevelMarker data)
Parameters
Type Name Description
System.Int32 index
PathLevelMarker data

SetLinearMotion(PathEvent, PathLinearMotion)

Declaration
[Obsolete("Deprecated in NX1872.0.0.  Use NXOpen.CAM.Path.ModifyLinearMotion instead.")]
public void SetLinearMotion(PathEvent eventOfInterest, PathLinearMotion data)
Parameters
Type Name Description
PathEvent eventOfInterest
PathLinearMotion data

SetLinearMotion(Int32, PathLinearMotion)

Declaration
public void SetLinearMotion(int index, PathLinearMotion data)
Parameters
Type Name Description
System.Int32 index
PathLinearMotion data

SetMarker(PathEvent, PathMarker)

Declaration
public void SetMarker(PathEvent eventOfInterest, PathMarker data)
Parameters
Type Name Description
PathEvent eventOfInterest
PathMarker data

SetMarker(Int32, PathMarker)

Declaration
public void SetMarker(int index, PathMarker data)
Parameters
Type Name Description
System.Int32 index
PathMarker data

SetUde(PathEvent, Ude)

Declaration
public void SetUde(PathEvent eventOfInterest, Ude data)
Parameters
Type Name Description
PathEvent eventOfInterest
Ude data

SetUde(Int32, Ude)

Declaration
public void SetUde(int index, Ude data)
Parameters
Type Name Description
System.Int32 index
Ude data

SetWidthHeight(PathEvent, Double, Double)

Declaration
public void SetWidthHeight(PathEvent eventOfInterest, double width, double height)
Parameters
Type Name Description
PathEvent eventOfInterest
System.Double width
System.Double height

Implements

System.Runtime.Remoting.Messaging.IMessageSink