Class Path
  
  
  
  
  
  
  Assembly: NXOpen.dll
  Syntax
  
    public class Path : TaggedObject, IMessageSink
   
  Constructors
  
  Path()
  
  
  Declaration
  
  Properties
  
  
  
  
  Declaration
  
    public CamPathContactType ContactType { get; set; }
   
  Property Value
  
  
  
  
  
  Declaration
  
    public int NumberOfToolpathEvents { get; }
   
  Property Value
  
  
  RobotRulesStatus
  
  
  Declaration
  
    public Path.RobotRulesStatusStates RobotRulesStatus { get; set; }
   
  Property Value
  
  
  
  
  
  Declaration
  
    public CamPathToolAxisType ToolAxisType { get; }
   
  Property Value
  
  Methods
  
  
  
  
  Declaration
  
    public PathEvent AddCircularMotion(PathCircularMotion data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public PathEvent AddHelixMotion(PathHelixMotion data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public PathEvent AddLevelMarker(PathLevelMarker data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public PathEvent AddLinearMotion(PathLinearMotion data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public PathEvent AddMarker(PathMarker data, CamPathToolpathEventLocation location, PathEvent referenceEvent)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public PathEvent AddUde(string udeName, CamPathToolpathEventLocation location, PathEvent referenceEvent)
   
  Parameters
  
  Returns
  
  
  AppendCircularMotion(PathCircularMotion)
  
  
  Declaration
  
    public void AppendCircularMotion(PathCircularMotion data)
   
  Parameters
  
  
  AppendHelixMotion(PathHelixMotion)
  
  
  Declaration
  
    public void AppendHelixMotion(PathHelixMotion data)
   
  Parameters
  
  
  AppendLevelMarker(PathLevelMarker)
  
  
  Declaration
  
    public void AppendLevelMarker(PathLevelMarker data)
   
  Parameters
  
  
  AppendLinearMotion(PathLinearMotion)
  
  
  Declaration
  
    public void AppendLinearMotion(PathLinearMotion data)
   
  Parameters
  
  
  AppendMarker(PathMarker)
  
  
  Declaration
  
    public void AppendMarker(PathMarker data)
   
  Parameters
  
  
  AppendUde(string)
  
  
  Declaration
  
    public void AppendUde(string udeName)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | string | udeName |  | 
    
  
  
  
  
  
  Declaration
  
    public PathEvent CopyEvent(PathEvent eventToCopy, CamPathToolpathEventLocation location, PathEvent referenceEvent)
   
  Parameters
  
  Returns
  
  
  DeleteAllUdesOfName(string)
  
  
  Declaration
  
    public void DeleteAllUdesOfName(string udeName)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | string | udeName |  | 
    
  
  
  DeleteOneEvent(PathEvent)
  
  
  Declaration
  
    public void DeleteOneEvent(PathEvent pathEvent)
   
  Parameters
  
  
  DeleteOneEvent(int)
  
  
  Declaration
  
    public void DeleteOneEvent(int index)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | index |  | 
    
  
  
  EmptyPath()
  
  
  Declaration
  
  
  GetCircularMotion(PathEvent)
  
  
  Declaration
  
    public PathCircularMotion GetCircularMotion(PathEvent eventOfInterest)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | PathEvent | eventOfInterest |  | 
    
  
  Returns
  
  
  GetCircularMotion(int)
  
  
  Declaration
  
    public PathCircularMotion GetCircularMotion(int index)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | index |  | 
    
  
  Returns
  
  
  GetFirstEvent()
  
  
  Declaration
  
    public PathEvent GetFirstEvent()
   
  Returns
  
  
  GetHelixMotion(PathEvent)
  
  
  Declaration
  
    public PathHelixMotion GetHelixMotion(PathEvent eventOfInterest)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | PathEvent | eventOfInterest |  | 
    
  
  Returns
  
  
  GetHelixMotion(int)
  
  
  Declaration
  
    public PathHelixMotion GetHelixMotion(int index)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | index |  | 
    
  
  Returns
  
  
  GetLaserOptimizationData()
  
  
  Declaration
  
    public PathLaserOptimizationData GetLaserOptimizationData()
   
  Returns
  
  
  GetLastEvent()
  
  
  Declaration
  
    public PathEvent GetLastEvent()
   
  Returns
  
  
  GetLevelMarker(PathEvent)
  
  
  Declaration
  
    public PathLevelMarker GetLevelMarker(PathEvent eventOfInterest)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | PathEvent | eventOfInterest |  | 
    
  
  Returns
  
  
  GetLevelMarker(int)
  
  
  Declaration
  
    public PathLevelMarker GetLevelMarker(int index)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | index |  | 
    
  
  Returns
  
  
  GetLinearMotion(PathEvent)
  
  
  Declaration
  
    public PathLinearMotion GetLinearMotion(PathEvent eventOfInterest)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | PathEvent | eventOfInterest |  | 
    
  
  Returns
  
  
  GetLinearMotion(int)
  
  
  Declaration
  
    public PathLinearMotion GetLinearMotion(int index)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | index |  | 
    
  
  Returns
  
  
  GetMarker(PathEvent)
  
  
  Declaration
  
    public PathMarker GetMarker(PathEvent eventOfInterest)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | PathEvent | eventOfInterest |  | 
    
  
  Returns
  
  
  GetMarker(int)
  
  
  Declaration
  
    public PathMarker GetMarker(int index)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | index |  | 
    
  
  Returns
  
  
  GetNumberOfFindings(FindingTypes)
  
  
  Declaration
  
    public int GetNumberOfFindings(Path.FindingTypes type)
   
  Parameters
  
  Returns
  
  
  GetReferenceData()
  
  
  Declaration
  
    public PathOwnerData GetReferenceData()
   
  Returns
  
  
  GetSubPathData(PathEvent)
  
  
  Declaration
  
    public PathOwnerData GetSubPathData(PathEvent forEvent)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public PathEvent GetToolpathEvent(int eventNumber)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | eventNumber |  | 
    
  
  Returns
  
  
  
  
  
  Declaration
  
    public CamPathToolpathEventType GetToolpathEventType(PathEvent pathEvent)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public CamPathToolpathEventType GetToolpathEventType(int eventNumber)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | eventNumber |  | 
    
  
  Returns
  
  
  GetUde(PathEvent)
  
  
  Declaration
  
    public Ude GetUde(PathEvent eventOfInterest)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | PathEvent | eventOfInterest |  | 
    
  
  Returns
  
  
  GetUde(int)
  
  
  Declaration
  
    public Ude GetUde(int index)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | index |  | 
    
  
  Returns
  
  
  GetWidthHeight(PathEvent, out double, out double)
  
  
  Declaration
  
    public void GetWidthHeight(PathEvent eventOfInterest, out double width, out double height)
   
  Parameters
  
  
  HasSubPath()
  
  
  Declaration
  
  Returns
  
  
  InsertCircularMotionAfter(PathCircularMotion, int)
  
  
  Declaration
  
    public void InsertCircularMotionAfter(PathCircularMotion data, int index)
   
  Parameters
  
  
  InsertCircularMotionBefore(PathCircularMotion, int)
  
  
  Declaration
  
    public void InsertCircularMotionBefore(PathCircularMotion data, int index)
   
  Parameters
  
  
  InsertHelixMotionAfter(PathHelixMotion, int)
  
  
  Declaration
  
    public void InsertHelixMotionAfter(PathHelixMotion data, int index)
   
  Parameters
  
  
  InsertHelixMotionBefore(PathHelixMotion, int)
  
  
  Declaration
  
    public void InsertHelixMotionBefore(PathHelixMotion data, int index)
   
  Parameters
  
  
  InsertLevelMarkerAfter(PathLevelMarker, int)
  
  
  Declaration
  
    public void InsertLevelMarkerAfter(PathLevelMarker data, int index)
   
  Parameters
  
  
  InsertLevelMarkerBefore(PathLevelMarker, int)
  
  
  Declaration
  
    public void InsertLevelMarkerBefore(PathLevelMarker data, int index)
   
  Parameters
  
  
  InsertLinearMotionAfter(PathLinearMotion, int)
  
  
  Declaration
  
    public void InsertLinearMotionAfter(PathLinearMotion data, int index)
   
  Parameters
  
  
  InsertLinearMotionBefore(PathLinearMotion, int)
  
  
  Declaration
  
    public void InsertLinearMotionBefore(PathLinearMotion data, int index)
   
  Parameters
  
  
  InsertMarkerAfter(PathMarker, int)
  
  
  Declaration
  
    public void InsertMarkerAfter(PathMarker data, int index)
   
  Parameters
  
  
  InsertMarkerBefore(PathMarker, int)
  
  
  Declaration
  
    public void InsertMarkerBefore(PathMarker data, int index)
   
  Parameters
  
  
  InsertUdeAfter(string, int)
  
  
  Declaration
  
    public void InsertUdeAfter(string udeName, int index)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | string | udeName |  | 
      
        | int | index |  | 
    
  
  
  InsertUdeBefore(string, int)
  
  
  Declaration
  
    public void InsertUdeBefore(string udeName, int index)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | string | udeName |  | 
      
        | int | index |  | 
    
  
  
  IsFirstEvent(PathEvent)
  
  
  Declaration
  
    public bool IsFirstEvent(PathEvent eventOfInterest)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | PathEvent | eventOfInterest |  | 
    
  
  Returns
  
  
  IsLastEvent(PathEvent)
  
  
  Declaration
  
    public bool IsLastEvent(PathEvent eventOfInterest)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | PathEvent | eventOfInterest |  | 
    
  
  Returns
  
  
  
  
  
  Declaration
  
    public bool IsToolpathEventAMotion(PathEvent eventOfInterest, out CamPathMotionType motionType, out CamPathMotionShapeType motionShape)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public bool IsToolpathEventAMotion(int eventNumber, out CamPathMotionType motionType, out CamPathMotionShapeType motionShape)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public bool IsToolpathEventUde(PathEvent eventOfInterest, out string udeName)
   
  Parameters
  
  Returns
  
  
  ModifyCircularMotion(PathCircularMotion, PathEvent)
  
  
  Declaration
  
    public PathEvent ModifyCircularMotion(PathCircularMotion data, PathEvent eventOfInterest)
   
  Parameters
  
  Returns
  
  
  ModifyHelixMotion(PathHelixMotion, PathEvent)
  
  
  Declaration
  
    public PathEvent ModifyHelixMotion(PathHelixMotion data, PathEvent eventOfInterest)
   
  Parameters
  
  Returns
  
  
  ModifyLinearMotion(PathLinearMotion, PathEvent)
  
  
  Declaration
  
    public PathEvent ModifyLinearMotion(PathLinearMotion data, PathEvent eventOfInterest)
   
  Parameters
  
  Returns
  
  
  
  
  
  Declaration
  
    public void MoveEvent(PathEvent eventToMove, CamPathToolpathEventLocation location, PathEvent referenceEvent)
   
  Parameters
  
  
  MoveEvent(int, int)
  
  
  Declaration
  
    public void MoveEvent(int fromIndex, int toIndex)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | fromIndex |  | 
      
        | int | toIndex |  | 
    
  
  
  NewPathCircularMotion()
  
  
  Declaration
  
    public PathCircularMotion NewPathCircularMotion()
   
  Returns
  
  
  NewPathHelixMotion()
  
  
  Declaration
  
    public PathHelixMotion NewPathHelixMotion()
   
  Returns
  
  
  NewPathLinearMotion()
  
  
  Declaration
  
    public PathLinearMotion NewPathLinearMotion()
   
  Returns
  
  
  NewPathMarker(Type)
  
  
  Declaration
  
    public PathMarker NewPathMarker(PathMarker.Type markerType)
   
  Parameters
  
  Returns
  
  
  SetCircularMotion(PathEvent, PathCircularMotion)
  
  
  Declaration
  
    [Obsolete("Deprecated in NX1872.0.0.  Use NXOpen.CAM.Path.ModifyCircularMotion instead.")]
public void SetCircularMotion(PathEvent eventOfInterest, PathCircularMotion data)
   
  Parameters
  
  
  SetCircularMotion(int, PathCircularMotion)
  
  
  Declaration
  
    public void SetCircularMotion(int index, PathCircularMotion data)
   
  Parameters
  
  
  SetHelixMotion(PathEvent, PathHelixMotion)
  
  
  Declaration
  
    [Obsolete("Deprecated in NX1872.0.0.  Use NXOpen.CAM.Path.ModifyHelixMotion instead.")]
public void SetHelixMotion(PathEvent eventOfInterest, PathHelixMotion data)
   
  Parameters
  
  
  SetHelixMotion(int, PathHelixMotion)
  
  
  Declaration
  
    public void SetHelixMotion(int index, PathHelixMotion data)
   
  Parameters
  
  
  SetLevelMarker(PathEvent, PathLevelMarker)
  
  
  Declaration
  
    public void SetLevelMarker(PathEvent eventOfInterest, PathLevelMarker data)
   
  Parameters
  
  
  SetLevelMarker(int, PathLevelMarker)
  
  
  Declaration
  
    public void SetLevelMarker(int index, PathLevelMarker data)
   
  Parameters
  
  
  SetLinearMotion(PathEvent, PathLinearMotion)
  
  
  Declaration
  
    [Obsolete("Deprecated in NX1872.0.0.  Use NXOpen.CAM.Path.ModifyLinearMotion instead.")]
public void SetLinearMotion(PathEvent eventOfInterest, PathLinearMotion data)
   
  Parameters
  
  
  SetLinearMotion(int, PathLinearMotion)
  
  
  Declaration
  
    public void SetLinearMotion(int index, PathLinearMotion data)
   
  Parameters
  
  
  SetMarker(PathEvent, PathMarker)
  
  
  Declaration
  
    public void SetMarker(PathEvent eventOfInterest, PathMarker data)
   
  Parameters
  
  
  SetMarker(int, PathMarker)
  
  
  Declaration
  
    public void SetMarker(int index, PathMarker data)
   
  Parameters
  
  
  SetUde(PathEvent, Ude)
  
  
  Declaration
  
    public void SetUde(PathEvent eventOfInterest, Ude data)
   
  Parameters
  
  
  SetUde(int, Ude)
  
  
  Declaration
  
    public void SetUde(int index, Ude data)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | index |  | 
      
        | Ude | data |  | 
    
  
  
  SetWidthHeight(PathEvent, double, double)
  
  
  Declaration
  
    public void SetWidthHeight(PathEvent eventOfInterest, double width, double height)
   
  Parameters
  
  Implements
  
      System.Runtime.Remoting.Messaging.IMessageSink