NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::CAM::Path Class Reference

Represets a Cam Tool Path
This is a Subobject and cannot be publicly instantiated. More...

Inheritance diagram for NXOpen::CAM::Path:
NXOpen::TaggedObject

Public Types

enum  FindingTypes {
  FindingTypesGouge = 1, FindingTypesSpike, FindingTypesSingularity = 5, FindingTypesSoftLimit,
  FindingTypesHardLimit, FindingTypesUnwind, FindingTypesCollision, FindingTypesReachFailure,
  FindingTypesVariableLimit, FindingTypesHolderCollision, FindingTypesRapidCollision
}
 Valid finding types to query the path. More...
 

Public Member Functions

NXOpen::CAM::PathEventAddCircularMotion (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
Created in NX11.0.2. More...
 
NXOpen::CAM::PathEventAddHelixMotion (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
Created in NX11.0.2. More...
 
NXOpen::CAM::PathEventAddLevelMarker (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
Created in NX11.0.2. More...
 
NXOpen::CAM::PathEventAddLinearMotion (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
Created in NX11.0.2. More...
 
NXOpen::CAM::PathEventAddMarker (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
Created in NX12.0.1. More...
 
NXOpen::CAM::PathEventAddUde (const NXString &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
Created in NX11.0.2. More...
 
NXOpen::CAM::PathEventAddUde (const char *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
Created in NX11.0.2. More...
 
void AppendCircularMotion (NXOpen::CAM::PathCircularMotion *data)
 Append a circular move
Created in NX10.0.1. More...
 
void AppendHelixMotion (NXOpen::CAM::PathHelixMotion *data)
 Append a helical move
Created in NX10.0.2. More...
 
void AppendLevelMarker (NXOpen::CAM::PathLevelMarker *data)
 Append a level marker
Created in NX10.0.3. More...
 
void AppendLinearMotion (NXOpen::CAM::PathLinearMotion *data)
 Append a linear move
Created in NX10.0.1. More...
 
void AppendMarker (NXOpen::CAM::PathMarker *data)
 Append a marker
Created in NX12.0.1. More...
 
void AppendUde (const NXString &udeName)
 Append an ude of name with default values
Created in NX10.0.1. More...
 
void AppendUde (const char *udeName)
 Append an ude of name with default values
Created in NX10.0.1. More...
 
NXOpen::CAM::CamPathContactType ContactType ()
 Returns the contact type of the path
Created in NX11.0.2. More...
 
void DeleteAllUdesOfName (const NXString &udeName)
 Clean up by deleting all Udes that have the specified name **
Created in NX11.0.2. More...
 
void DeleteAllUdesOfName (const char *udeName)
 Clean up by deleting all Udes that have the specified name **
Created in NX11.0.2. More...
 
void DeleteOneEvent (int index)
 Delete one event
Created in NX10.0.3. More...
 
void DeleteOneEvent (NXOpen::CAM::PathEvent *pathEvent)
 Delete one event
Created in NX11.0.2. More...
 
void EmptyPath ()
 Empty the path by deleteing all events
Created in NX10.0.3. More...
 
NXOpen::CAM::PathCircularMotionGetCircularMotion (int index)
 Get the data of the circular motion at the given index
Created in NX10.0.1. More...
 
NXOpen::CAM::PathCircularMotionGetCircularMotion (NXOpen::CAM::PathEvent *eventOfInterest)
 Get the data of the circular motion at the given index
Created in NX11.0.2. More...
 
NXOpen::CAM::PathEventGetFirstEvent ()
 Ask for the first path event **
Created in NX11.0.2. More...
 
NXOpen::CAM::PathHelixMotionGetHelixMotion (int index)
 Get the data of the helix motion at the given index
Created in NX10.0.1. More...
 
NXOpen::CAM::PathHelixMotionGetHelixMotion (NXOpen::CAM::PathEvent *eventOfInterest)
 Get the data of the helix motion event
Created in NX11.0.2. More...
 
NXOpen::CAM::PathLaserOptimizationDataGetLaserOptimizationData ()
 Get the laser optimization data
Created in NX9.0.3. More...
 
NXOpen::CAM::PathEventGetLastEvent ()
 Ask for the last path event **
Created in NX11.0.2. More...
 
NXOpen::CAM::PathLevelMarkerGetLevelMarker (int index)
 Get the data of the level index at the given index
Created in NX10.0.3. More...
 
NXOpen::CAM::PathLevelMarkerGetLevelMarker (NXOpen::CAM::PathEvent *eventOfInterest)
 Get the data of the level marker event
Created in NX11.0.2. More...
 
NXOpen::CAM::PathLinearMotionGetLinearMotion (int index)
 Get the data of the linear motion at the given index
Created in NX10.0.1. More...
 
NXOpen::CAM::PathLinearMotionGetLinearMotion (NXOpen::CAM::PathEvent *eventOfInterest)
 Get the data of the linear motion
Created in NX11.0.2. More...
 
NXOpen::CAM::PathMarkerGetMarker (int index)
 Get the data of the marker at the given index
Created in NX12.0.1. More...
 
NXOpen::CAM::PathMarkerGetMarker (NXOpen::CAM::PathEvent *eventOfInterest)
 Get the data of the marker event
Created in NX12.0.1. More...
 
int GetNumberOfFindings (NXOpen::CAM::Path::FindingTypes type)
 Get the number of findings given a finding type
Created in NX12.0.2. More...
 
NXOpen::CAM::PathEventGetToolpathEvent (int eventNumber)
 Get the tool path event for a given index
Created in NX11.0.2. More...
 
NXOpen::CAM::CamPathToolpathEventType GetToolpathEventType (int eventNumber)
 Get the tool path event type
Created in NX10.0.1. More...
 
NXOpen::CAM::CamPathToolpathEventType GetToolpathEventType (NXOpen::CAM::PathEvent *pathEvent)
 Get the tool path event type
Created in NX11.0.2. More...
 
NXOpen::CAM::UdeGetUde (int index)
 Get the UDE event at the given index
Created in NX10.0.1. More...
 
NXOpen::CAM::UdeGetUde (NXOpen::CAM::PathEvent *eventOfInterest)
 Get the data of the Ude event
Created in NX11.0.2. More...
 
void InsertCircularMotionAfter (NXOpen::CAM::PathCircularMotion *data, int index)
 Insert Circular Motion after indicated index
Created in NX10.0.1. More...
 
void InsertCircularMotionBefore (NXOpen::CAM::PathCircularMotion *data, int index)
 Insert Circular Motion before indicated index
Created in NX10.0.1. More...
 
void InsertHelixMotionAfter (NXOpen::CAM::PathHelixMotion *data, int index)
 Insert Helical Motion after indicated index
Created in NX10.0.2. More...
 
void InsertHelixMotionBefore (NXOpen::CAM::PathHelixMotion *data, int index)
 Insert Helical Motion before indicated index
Created in NX10.0.2. More...
 
void InsertLevelMarkerAfter (NXOpen::CAM::PathLevelMarker *data, int index)
 Insert a level marker after the specified index
Created in NX10.0.3. More...
 
void InsertLevelMarkerBefore (NXOpen::CAM::PathLevelMarker *data, int index)
 Insert a level marker before the specified index
Created in NX10.0.3. More...
 
void InsertLinearMotionAfter (NXOpen::CAM::PathLinearMotion *data, int index)
 Insert a linear move after the specified index*
Created in NX10.0.1. More...
 
void InsertLinearMotionBefore (NXOpen::CAM::PathLinearMotion *data, int index)
 Insert a linear move before the specified index
Created in NX10.0.1. More...
 
void InsertMarkerAfter (NXOpen::CAM::PathMarker *data, int index)
 Insert a marker after the specified index
Created in NX12.0.1. More...
 
void InsertMarkerBefore (NXOpen::CAM::PathMarker *data, int index)
 Insert a marker before the specified index
Created in NX12.0.1. More...
 
void InsertUdeAfter (const NXString &udeName, int index)
 Insert an ude of name with default values after the given index
Created in NX10.0.1. More...
 
void InsertUdeAfter (const char *udeName, int index)
 Insert an ude of name with default values after the given index
Created in NX10.0.1. More...
 
void InsertUdeBefore (const NXString &udeName, int index)
 Insert an ude of name with default values before the given index
Created in NX10.0.1. More...
 
void InsertUdeBefore (const char *udeName, int index)
 Insert an ude of name with default values before the given index
Created in NX10.0.1. More...
 
bool IsToolpathEventAMotion (int eventNumber, NXOpen::CAM::CamPathMotionType *motionType, NXOpen::CAM::CamPathMotionShapeType *motionShape)
 Tell if the event is a motion. More...
 
bool IsToolpathEventAMotion (NXOpen::CAM::PathEvent *eventOfInterest, NXOpen::CAM::CamPathMotionType *motionType, NXOpen::CAM::CamPathMotionShapeType *motionShape)
 Tell if the event is a motion
Created in NX11.0.2. More...
 
bool IsToolpathEventUde (NXOpen::CAM::PathEvent *eventOfInterest, NXString *udeName)
 Tell if the event is a ude
Created in NX11.0.2. More...
 
void MoveEvent (int fromIndex, int toIndex)
 Move the event at index fromIndex to index toIndex. More...
 
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...
 
NXOpen::CAM::PathCircularMotionNewPathCircularMotion ()
 Constructs a new path circular motion object. More...
 
NXOpen::CAM::PathHelixMotionNewPathHelixMotion ()
 Constructs a new path helix motion object. More...
 
NXOpen::CAM::PathLinearMotionNewPathLinearMotion ()
 Constructs a new path linear motion object. More...
 
NXOpen::CAM::PathMarkerNewPathMarker (NXOpen::CAM::PathMarker::Type markerType)
 Constructs a new path marker object. More...
 
int NumberOfToolpathEvents ()
 Returns the number of tool path events
Created in NX10.0.1. More...
 
void SetCircularMotion (int index, NXOpen::CAM::PathCircularMotion *data)
 Updates the data of the circular motion event at the given index
Created in NX10.0.1. More...
 
void SetCircularMotion (NXOpen::CAM::PathEvent *eventOfInterest, NXOpen::CAM::PathCircularMotion *data)
 Updates the data of the circular motion event
Created in NX11.0.2. More...
 
void SetContactType (NXOpen::CAM::CamPathContactType contactType)
 Sets the contact type of the path
Created in NX11.0.2. More...
 
void SetHelixMotion (int index, NXOpen::CAM::PathHelixMotion *data)
 Updates the data of the helix motion event at the given index
Created in NX10.0.1. More...
 
void SetHelixMotion (NXOpen::CAM::PathEvent *eventOfInterest, NXOpen::CAM::PathHelixMotion *data)
 Updates the data of the helix motion event
Created in NX11.0.2. More...
 
void SetLevelMarker (int index, NXOpen::CAM::PathLevelMarker *data)
 Updates the data of the level marker event at the given index
Created in NX10.0.3. More...
 
void SetLevelMarker (NXOpen::CAM::PathEvent *eventOfInterest, NXOpen::CAM::PathLevelMarker *data)
 Updates the data of the level marker event
Created in NX11.0.2. More...
 
void SetLinearMotion (int index, NXOpen::CAM::PathLinearMotion *data)
 Updates the data of the linear motion event at the given index
Created in NX10.0.1. More...
 
void SetLinearMotion (NXOpen::CAM::PathEvent *eventOfInterest, NXOpen::CAM::PathLinearMotion *data)
 Updates the data of the linear motion event
Created in NX11.0.2. More...
 
void SetMarker (int index, NXOpen::CAM::PathMarker *data)
 Updates the data of the marker event at the given index
Created in NX12.0.1. More...
 
void SetMarker (NXOpen::CAM::PathEvent *eventOfInterest, NXOpen::CAM::PathMarker *data)
 Updates the data of the marker event
Created in NX12.0.1. More...
 
void SetUde (int index, NXOpen::CAM::Ude *data)
 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. More...
 
void SetUde (NXOpen::CAM::PathEvent *eventOfInterest, NXOpen::CAM::Ude *data)
 Updates the data of the ude event
Created in NX11.0.2. More...
 
NXOpen::CAM::CamPathToolAxisType ToolAxisType ()
 Returns the tool axis type of the path
Created in NX10.0.1. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. 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
FindingTypesGouge 

Finding type gouge.

FindingTypesSpike 

Finding type spike.

FindingTypesSingularity 

Finding type singularity.

FindingTypesSoftLimit 

Finding type soft limit.

FindingTypesHardLimit 

Finding type hard limit.

FindingTypesUnwind 

Finding type unwind.

FindingTypesCollision 

Finding type collision.

FindingTypesReachFailure 

Finding type reach failure.

FindingTypesVariableLimit 

Finding type variable limit.

FindingTypesHolderCollision 

Finding type tool holder collision.

FindingTypesRapidCollision 

Finding type tool rapid collision.

Member Function Documentation

NXOpen::CAM::PathEvent* NXOpen::CAM::Path::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
Created in NX11.0.2.



License requirements : None

Parameters
datadata
locationlocation
referenceEventreferenceevent
NXOpen::CAM::PathEvent* NXOpen::CAM::Path::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
Created in NX11.0.2.



License requirements : None

Parameters
datadata
locationlocation
referenceEventreferenceevent
NXOpen::CAM::PathEvent* NXOpen::CAM::Path::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
Created in NX11.0.2.



License requirements : None

Parameters
datadata
locationlocation
referenceEventreferenceevent
NXOpen::CAM::PathEvent* NXOpen::CAM::Path::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
Created in NX11.0.2.



License requirements : None

Parameters
datadata
locationlocation
referenceEventreferenceevent
NXOpen::CAM::PathEvent* NXOpen::CAM::Path::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
Created in NX12.0.1.



License requirements : None

Parameters
datadata
locationlocation
referenceEventreferenceevent
NXOpen::CAM::PathEvent* NXOpen::CAM::Path::AddUde ( const NXString 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
Created in NX11.0.2.



License requirements : None

Parameters
udeNameude name
locationlocation
referenceEventreferenceevent
NXOpen::CAM::PathEvent* NXOpen::CAM::Path::AddUde ( const char *  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
Created in NX11.0.2.



License requirements : None

Parameters
udeNameude name
locationlocation
referenceEventreferenceevent
void NXOpen::CAM::Path::AppendCircularMotion ( NXOpen::CAM::PathCircularMotion data)

Append a circular move
Created in NX10.0.1.



License requirements : None

Parameters
datadata
void NXOpen::CAM::Path::AppendHelixMotion ( NXOpen::CAM::PathHelixMotion data)

Append a helical move
Created in NX10.0.2.



License requirements : None

Parameters
datadata
void NXOpen::CAM::Path::AppendLevelMarker ( NXOpen::CAM::PathLevelMarker data)

Append a level marker
Created in NX10.0.3.



License requirements : None

Parameters
datadata
void NXOpen::CAM::Path::AppendLinearMotion ( NXOpen::CAM::PathLinearMotion data)

Append a linear move
Created in NX10.0.1.



License requirements : None

Parameters
datadata
void NXOpen::CAM::Path::AppendMarker ( NXOpen::CAM::PathMarker data)

Append a marker
Created in NX12.0.1.



License requirements : None

Parameters
datadata
void NXOpen::CAM::Path::AppendUde ( const NXString udeName)

Append an ude of name with default values
Created in NX10.0.1.



License requirements : None

Parameters
udeNameude name
void NXOpen::CAM::Path::AppendUde ( const char *  udeName)

Append an ude of name with default values
Created in NX10.0.1.



License requirements : None

Parameters
udeNameude name
NXOpen::CAM::CamPathContactType NXOpen::CAM::Path::ContactType ( )

Returns the contact type of the path
Created in NX11.0.2.



License requirements : None

void NXOpen::CAM::Path::DeleteAllUdesOfName ( const NXString udeName)

Clean up by deleting all Udes that have the specified name **
Created in NX11.0.2.



License requirements : None

Parameters
udeNameudename
void NXOpen::CAM::Path::DeleteAllUdesOfName ( const char *  udeName)

Clean up by deleting all Udes that have the specified name **
Created in NX11.0.2.



License requirements : None

Parameters
udeNameudename
void NXOpen::CAM::Path::DeleteOneEvent ( int  index)

Delete one event
Created in NX10.0.3.



License requirements : None

Parameters
indexindex
void NXOpen::CAM::Path::DeleteOneEvent ( NXOpen::CAM::PathEvent pathEvent)

Delete one event
Created in NX11.0.2.



License requirements : None

Parameters
pathEventpathevent
void NXOpen::CAM::Path::EmptyPath ( )

Empty the path by deleteing all events
Created in NX10.0.3.



License requirements : None

NXOpen::CAM::PathCircularMotion* NXOpen::CAM::Path::GetCircularMotion ( int  index)

Get the data of the circular motion at the given index
Created in NX10.0.1.



License requirements : None

Parameters
indexindex
NXOpen::CAM::PathCircularMotion* NXOpen::CAM::Path::GetCircularMotion ( NXOpen::CAM::PathEvent eventOfInterest)

Get the data of the circular motion at the given index
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
NXOpen::CAM::PathEvent* NXOpen::CAM::Path::GetFirstEvent ( )

Ask for the first path event **
Created in NX11.0.2.



License requirements : None

NXOpen::CAM::PathHelixMotion* NXOpen::CAM::Path::GetHelixMotion ( int  index)

Get the data of the helix motion at the given index
Created in NX10.0.1.



License requirements : None

Parameters
indexindex
NXOpen::CAM::PathHelixMotion* NXOpen::CAM::Path::GetHelixMotion ( NXOpen::CAM::PathEvent eventOfInterest)

Get the data of the helix motion event
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
NXOpen::CAM::PathLaserOptimizationData* NXOpen::CAM::Path::GetLaserOptimizationData ( )

Get the laser optimization data
Created in NX9.0.3.



License requirements : None

NXOpen::CAM::PathEvent* NXOpen::CAM::Path::GetLastEvent ( )

Ask for the last path event **
Created in NX11.0.2.



License requirements : None

NXOpen::CAM::PathLevelMarker* NXOpen::CAM::Path::GetLevelMarker ( int  index)

Get the data of the level index at the given index
Created in NX10.0.3.



License requirements : None

Parameters
indexindex
NXOpen::CAM::PathLevelMarker* NXOpen::CAM::Path::GetLevelMarker ( NXOpen::CAM::PathEvent eventOfInterest)

Get the data of the level marker event
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
NXOpen::CAM::PathLinearMotion* NXOpen::CAM::Path::GetLinearMotion ( int  index)

Get the data of the linear motion at the given index
Created in NX10.0.1.



License requirements : None

Parameters
indexindex
NXOpen::CAM::PathLinearMotion* NXOpen::CAM::Path::GetLinearMotion ( NXOpen::CAM::PathEvent eventOfInterest)

Get the data of the linear motion
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
NXOpen::CAM::PathMarker* NXOpen::CAM::Path::GetMarker ( int  index)

Get the data of the marker at the given index
Created in NX12.0.1.



License requirements : None

Parameters
indexindex
NXOpen::CAM::PathMarker* NXOpen::CAM::Path::GetMarker ( NXOpen::CAM::PathEvent eventOfInterest)

Get the data of the marker event
Created in NX12.0.1.



License requirements : None

Parameters
eventOfInteresteventofinterest
int NXOpen::CAM::Path::GetNumberOfFindings ( NXOpen::CAM::Path::FindingTypes  type)

Get the number of findings given a finding type
Created in NX12.0.2.



License requirements : None

Parameters
typetype
NXOpen::CAM::PathEvent* NXOpen::CAM::Path::GetToolpathEvent ( int  eventNumber)

Get the tool path event for a given index
Created in NX11.0.2.



License requirements : None

Parameters
eventNumbereventnumber
NXOpen::CAM::CamPathToolpathEventType NXOpen::CAM::Path::GetToolpathEventType ( int  eventNumber)

Get the tool path event type
Created in NX10.0.1.



License requirements : None

Parameters
eventNumbereventnumber
NXOpen::CAM::CamPathToolpathEventType NXOpen::CAM::Path::GetToolpathEventType ( NXOpen::CAM::PathEvent pathEvent)

Get the tool path event type
Created in NX11.0.2.



License requirements : None

Parameters
pathEventpathevent
NXOpen::CAM::Ude* NXOpen::CAM::Path::GetUde ( int  index)

Get the UDE event at the given index
Created in NX10.0.1.



License requirements : None

Parameters
indexindex
NXOpen::CAM::Ude* NXOpen::CAM::Path::GetUde ( NXOpen::CAM::PathEvent eventOfInterest)

Get the data of the Ude event
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
void NXOpen::CAM::Path::InsertCircularMotionAfter ( NXOpen::CAM::PathCircularMotion data,
int  index 
)

Insert Circular Motion after indicated index
Created in NX10.0.1.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertCircularMotionBefore ( NXOpen::CAM::PathCircularMotion data,
int  index 
)

Insert Circular Motion before indicated index
Created in NX10.0.1.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertHelixMotionAfter ( NXOpen::CAM::PathHelixMotion data,
int  index 
)

Insert Helical Motion after indicated index
Created in NX10.0.2.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertHelixMotionBefore ( NXOpen::CAM::PathHelixMotion data,
int  index 
)

Insert Helical Motion before indicated index
Created in NX10.0.2.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertLevelMarkerAfter ( NXOpen::CAM::PathLevelMarker data,
int  index 
)

Insert a level marker after the specified index
Created in NX10.0.3.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertLevelMarkerBefore ( NXOpen::CAM::PathLevelMarker data,
int  index 
)

Insert a level marker before the specified index
Created in NX10.0.3.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertLinearMotionAfter ( NXOpen::CAM::PathLinearMotion data,
int  index 
)

Insert a linear move after the specified index*
Created in NX10.0.1.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertLinearMotionBefore ( NXOpen::CAM::PathLinearMotion data,
int  index 
)

Insert a linear move before the specified index
Created in NX10.0.1.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertMarkerAfter ( NXOpen::CAM::PathMarker data,
int  index 
)

Insert a marker after the specified index
Created in NX12.0.1.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertMarkerBefore ( NXOpen::CAM::PathMarker data,
int  index 
)

Insert a marker before the specified index
Created in NX12.0.1.



License requirements : None

Parameters
datadata
indexindex
void NXOpen::CAM::Path::InsertUdeAfter ( const NXString udeName,
int  index 
)

Insert an ude of name with default values after the given index
Created in NX10.0.1.



License requirements : None

Parameters
udeNameude name
indexindex
void NXOpen::CAM::Path::InsertUdeAfter ( const char *  udeName,
int  index 
)

Insert an ude of name with default values after the given index
Created in NX10.0.1.



License requirements : None

Parameters
udeNameude name
indexindex
void NXOpen::CAM::Path::InsertUdeBefore ( const NXString udeName,
int  index 
)

Insert an ude of name with default values before the given index
Created in NX10.0.1.



License requirements : None

Parameters
udeNameude name
indexindex
void NXOpen::CAM::Path::InsertUdeBefore ( const char *  udeName,
int  index 
)

Insert an ude of name with default values before the given index
Created in NX10.0.1.



License requirements : None

Parameters
udeNameude name
indexindex
bool NXOpen::CAM::Path::IsToolpathEventAMotion ( int  eventNumber,
NXOpen::CAM::CamPathMotionType motionType,
NXOpen::CAM::CamPathMotionShapeType motionShape 
)

Tell if the event is a motion.

EventNumber is 1 through n
Created in NX10.0.1.

License requirements : None

Parameters
eventNumbereventnumber
motionTypemotiontype
motionShapemotionshape
bool NXOpen::CAM::Path::IsToolpathEventAMotion ( NXOpen::CAM::PathEvent eventOfInterest,
NXOpen::CAM::CamPathMotionType motionType,
NXOpen::CAM::CamPathMotionShapeType motionShape 
)

Tell if the event is a motion
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
motionTypemotiontype
motionShapemotionshape
bool NXOpen::CAM::Path::IsToolpathEventUde ( NXOpen::CAM::PathEvent eventOfInterest,
NXString udeName 
)

Tell if the event is a ude
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
udeNameudename
void NXOpen::CAM::Path::MoveEvent ( int  fromIndex,
int  toIndex 
)

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
fromIndexfromindex
toIndextoindex
void NXOpen::CAM::Path::MoveEvent ( NXOpen::CAM::PathEvent eventToMove,
NXOpen::CAM::CamPathToolpathEventLocation  location,
NXOpen::CAM::PathEvent referenceEvent 
)

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
eventToMoveeventtomove
locationlocation
referenceEventreferenceevent
NXOpen::CAM::PathCircularMotion* NXOpen::CAM::Path::NewPathCircularMotion ( )

Constructs a new path circular motion object.

Returns

Created in NX10.0.1.

License requirements : None
NXOpen::CAM::PathHelixMotion* NXOpen::CAM::Path::NewPathHelixMotion ( )

Constructs a new path helix motion object.

Returns

Created in NX10.0.1.

License requirements : None
NXOpen::CAM::PathLinearMotion* NXOpen::CAM::Path::NewPathLinearMotion ( )

Constructs a new path linear motion object.

Returns

Created in NX10.0.1.

License requirements : None
NXOpen::CAM::PathMarker* NXOpen::CAM::Path::NewPathMarker ( NXOpen::CAM::PathMarker::Type  markerType)

Constructs a new path marker object.

Returns

Created in NX12.0.1.

License requirements : None
Parameters
markerTypemarkertype
int NXOpen::CAM::Path::NumberOfToolpathEvents ( )

Returns the number of tool path events
Created in NX10.0.1.



License requirements : None

void NXOpen::CAM::Path::SetCircularMotion ( int  index,
NXOpen::CAM::PathCircularMotion data 
)

Updates the data of the circular motion event at the given index
Created in NX10.0.1.



License requirements : None

Parameters
indexindex
datadata
void NXOpen::CAM::Path::SetCircularMotion ( NXOpen::CAM::PathEvent eventOfInterest,
NXOpen::CAM::PathCircularMotion data 
)

Updates the data of the circular motion event
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
datadata
void NXOpen::CAM::Path::SetContactType ( NXOpen::CAM::CamPathContactType  contactType)

Sets the contact type of the path
Created in NX11.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
contactTypecontacttype
void NXOpen::CAM::Path::SetHelixMotion ( int  index,
NXOpen::CAM::PathHelixMotion data 
)

Updates the data of the helix motion event at the given index
Created in NX10.0.1.



License requirements : None

Parameters
indexindex
datadata
void NXOpen::CAM::Path::SetHelixMotion ( NXOpen::CAM::PathEvent eventOfInterest,
NXOpen::CAM::PathHelixMotion data 
)

Updates the data of the helix motion event
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
datadata
void NXOpen::CAM::Path::SetLevelMarker ( int  index,
NXOpen::CAM::PathLevelMarker data 
)

Updates the data of the level marker event at the given index
Created in NX10.0.3.



License requirements : None

Parameters
indexindex
datadata
void NXOpen::CAM::Path::SetLevelMarker ( NXOpen::CAM::PathEvent eventOfInterest,
NXOpen::CAM::PathLevelMarker data 
)

Updates the data of the level marker event
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
datadata
void NXOpen::CAM::Path::SetLinearMotion ( int  index,
NXOpen::CAM::PathLinearMotion data 
)

Updates the data of the linear motion event at the given index
Created in NX10.0.1.



License requirements : None

Parameters
indexindex
datadata
void NXOpen::CAM::Path::SetLinearMotion ( NXOpen::CAM::PathEvent eventOfInterest,
NXOpen::CAM::PathLinearMotion data 
)

Updates the data of the linear motion event
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
datadata
void NXOpen::CAM::Path::SetMarker ( int  index,
NXOpen::CAM::PathMarker data 
)

Updates the data of the marker event at the given index
Created in NX12.0.1.



License requirements : None

Parameters
indexindex
datadata
void NXOpen::CAM::Path::SetMarker ( NXOpen::CAM::PathEvent eventOfInterest,
NXOpen::CAM::PathMarker data 
)

Updates the data of the marker event
Created in NX12.0.1.



License requirements : None

Parameters
eventOfInteresteventofinterest
datadata
void NXOpen::CAM::Path::SetUde ( int  index,
NXOpen::CAM::Ude data 
)

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
indexindex
datadata
void NXOpen::CAM::Path::SetUde ( NXOpen::CAM::PathEvent eventOfInterest,
NXOpen::CAM::Ude data 
)

Updates the data of the ude event
Created in NX11.0.2.



License requirements : None

Parameters
eventOfInteresteventofinterest
datadata
NXOpen::CAM::CamPathToolAxisType NXOpen::CAM::Path::ToolAxisType ( )

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.