public interface Path extends TaggedObject
Modifier and Type | Interface and Description |
---|---|
static class |
Path.IsToolpathEventAMotionData
This class holds the data returned from
isToolpathEventAMotion(int) |
static class |
Path.IsToolpathEventUdeData
This class holds the data returned from
isToolpathEventUde(nxopen.cam.PathEvent) |
Modifier and Type | Method and Description |
---|---|
PathEvent |
addCircularMotion(PathCircularMotion data,
CamPathToolpathEventLocation location,
PathEvent referenceEvent)
Add a circular move at location, if location is end location(append)
then the reference is not relevant
License requirements: None. |
PathEvent |
addHelixMotion(PathHelixMotion data,
CamPathToolpathEventLocation location,
PathEvent referenceEvent)
Add a helix move at location, if location is end location(append)
then the reference is not relevant
License requirements: None. |
PathEvent |
addLevelMarker(PathLevelMarker data,
CamPathToolpathEventLocation location,
PathEvent referenceEvent)
Add a level marker event at location, if location is end location(append)
then the reference is not relevant
License requirements: None. |
PathEvent |
addLinearMotion(PathLinearMotion data,
CamPathToolpathEventLocation location,
PathEvent referenceEvent)
Add a linear move at location, if location is end location(append)
then the reference is not relevant
License requirements: None. |
PathEvent |
addUde(String udeName,
CamPathToolpathEventLocation location,
PathEvent referenceEvent)
Add a helix move at location, if location is end location(append)
then the reference is not relevant
License requirements: None. |
void |
appendCircularMotion(PathCircularMotion data)
Append a circular move
License requirements: None. |
void |
appendHelixMotion(PathHelixMotion data)
Append a helical move
License requirements: None. |
void |
appendLevelMarker(PathLevelMarker data)
Append a level marker
License requirements: None. |
void |
appendLinearMotion(PathLinearMotion data)
Append a linear move
License requirements: None. |
void |
appendUde(String udeName)
Append an ude of name with default values
License requirements: None. |
CamPathContactType |
contactType()
Returns the contact type of the path
License requirements: None. |
void |
deleteAllUdesOfName(String udeName)
Clean up by deleting all Udes that have the specified name **
License requirements: None. |
void |
deleteOneEvent(int index)
Delete one event
License requirements: None. |
void |
deleteOneEvent(PathEvent pathEvent)
Delete one event
License requirements: None. |
void |
emptyPath()
Empty the path by deleteing all events
License requirements: None. |
PathCircularMotion |
getCircularMotion(int index)
Get the data of the circular motion at the given index
License requirements: None. |
PathCircularMotion |
getCircularMotion(PathEvent eventOfInterest)
Get the data of the circular motion at the given index
License requirements: None. |
PathEvent |
getFirstEvent()
Ask for the first path event **
License requirements: None. |
PathHelixMotion |
getHelixMotion(int index)
Get the data of the helix motion at the given index
License requirements: None. |
PathHelixMotion |
getHelixMotion(PathEvent eventOfInterest)
Get the data of the helix motion event
License requirements: None. |
PathLaserOptimizationData |
getLaserOptimizationData()
Get the laser optimization data
License requirements: None. |
PathEvent |
getLastEvent()
Ask for the last path event **
License requirements: None. |
PathLevelMarker |
getLevelMarker(int index)
Get the data of the level index at the given index
License requirements: None. |
PathLevelMarker |
getLevelMarker(PathEvent eventOfInterest)
Get the data of the level marker event
License requirements: None. |
PathLinearMotion |
getLinearMotion(int index)
Get the data of the linear motion at the given index
License requirements: None. |
PathLinearMotion |
getLinearMotion(PathEvent eventOfInterest)
Get the data of the linear motion
License requirements: None. |
PathEvent |
getToolpathEvent(int eventNumber)
Get the tool path event for a given index
License requirements: None. |
CamPathToolpathEventType |
getToolpathEventType(int eventNumber)
Get the tool path event type
License requirements: None. |
CamPathToolpathEventType |
getToolpathEventType(PathEvent pathEvent)
Get the tool path event type
License requirements: None. |
Ude |
getUde(int index)
Get the UDE event at the given index
License requirements: None. |
Ude |
getUde(PathEvent eventOfInterest)
Get the data of the Ude event
License requirements: None. |
void |
insertCircularMotionAfter(PathCircularMotion data,
int index)
Insert Circular Motion after indicated index
License requirements: None. |
void |
insertCircularMotionBefore(PathCircularMotion data,
int index)
Insert Circular Motion before indicated index
License requirements: None. |
void |
insertHelixMotionAfter(PathHelixMotion data,
int index)
Insert Helical Motion after indicated index
License requirements: None. |
void |
insertHelixMotionBefore(PathHelixMotion data,
int index)
Insert Helical Motion before indicated index
License requirements: None. |
void |
insertLevelMarkerAfter(PathLevelMarker data,
int index)
Insert a level marker after the specified index
License requirements: None. |
void |
insertLevelMarkerBefore(PathLevelMarker data,
int index)
Insert a level marker before the specified index
License requirements: None. |
void |
insertLinearMotionAfter(PathLinearMotion data,
int index)
Insert a linear move after the specified index*
License requirements: None. |
void |
insertLinearMotionBefore(PathLinearMotion data,
int index)
Insert a linear move before the specified index
License requirements: None. |
void |
insertUdeAfter(String udeName,
int index)
Insert an ude of name with default values after the given index
License requirements: None. |
void |
insertUdeBefore(String udeName,
int index)
Insert an ude of name with default values before the given index
License requirements: None. |
Path.IsToolpathEventAMotionData |
isToolpathEventAMotion(int eventNumber)
Tell if the event is a motion.
|
Path.IsToolpathEventAMotionData |
isToolpathEventAMotion(PathEvent eventOfInterest)
Tell if the event is a motion
License requirements: None. |
Path.IsToolpathEventUdeData |
isToolpathEventUde(PathEvent eventOfInterest)
Tell if the event is a ude
License requirements: None. |
void |
moveEvent(int fromIndex,
int toIndex)
Move the event at index fromIndex to index toIndex.
|
void |
moveEvent(PathEvent eventToMove,
CamPathToolpathEventLocation location,
PathEvent referenceEvent)
Move the event relative to the referenceEvent and the location.
|
PathCircularMotion |
newPathCircularMotion()
Constructs a new path circular motion object.
|
PathHelixMotion |
newPathHelixMotion()
Constructs a new path helix motion object.
|
PathLinearMotion |
newPathLinearMotion()
Constructs a new path linear motion object.
|
int |
numberOfToolpathEvents()
Returns the number of tool path events
License requirements: None. |
void |
setCircularMotion(int index,
PathCircularMotion data)
Updates the data of the circular motion event at the given index
License requirements: None. |
void |
setCircularMotion(PathEvent eventOfInterest,
PathCircularMotion data)
Updates the data of the circular motion event
License requirements: None. |
void |
setContactType(CamPathContactType contactType)
License requirements: cam_base ("CAM BASE") . |
void |
setHelixMotion(int index,
PathHelixMotion data)
Updates the data of the helix motion event at the given index
License requirements: None. |
void |
setHelixMotion(PathEvent eventOfInterest,
PathHelixMotion data)
Updates the data of the helix motion event
License requirements: None. |
void |
setLevelMarker(int index,
PathLevelMarker data)
Updates the data of the level marker event at the given index
License requirements: None. |
void |
setLevelMarker(PathEvent eventOfInterest,
PathLevelMarker data)
Updates the data of the level marker event
License requirements: None. |
void |
setLinearMotion(int index,
PathLinearMotion data)
Updates the data of the linear motion event at the given index
License requirements: None. |
void |
setLinearMotion(PathEvent eventOfInterest,
PathLinearMotion data)
Updates the data of the linear motion event
License requirements: None. |
void |
setUde(int index,
Ude data)
Set the UDE event at the given index; The CAM.Ude API object no longer is valid after this call
License requirements: None. |
void |
setUde(PathEvent eventOfInterest,
Ude data)
Updates the data of the ude event
License requirements: None. |
CamPathToolAxisType |
toolAxisType()
Returns the tool axis type of the path
License requirements: None. |
printTestData, printTestData, tag, tagValue
PathLinearMotion newPathLinearMotion() throws NXException, RemoteException
NXException
RemoteException
PathCircularMotion newPathCircularMotion() throws NXException, RemoteException
NXException
RemoteException
PathHelixMotion newPathHelixMotion() throws NXException, RemoteException
NXException
RemoteException
CamPathToolAxisType toolAxisType() throws NXException, RemoteException
NXException
RemoteException
int numberOfToolpathEvents() throws NXException, RemoteException
NXException
RemoteException
PathEvent getToolpathEvent(int eventNumber) throws NXException, RemoteException
eventNumber
- NXException
RemoteException
CamPathToolpathEventType getToolpathEventType(int eventNumber) throws NXException, RemoteException
eventNumber
- NXException
RemoteException
CamPathToolpathEventType getToolpathEventType(PathEvent pathEvent) throws NXException, RemoteException
pathEvent
- NXException
RemoteException
void moveEvent(int fromIndex, int toIndex) throws NXException, RemoteException
fromIndex
- toIndex
- NXException
RemoteException
void moveEvent(PathEvent eventToMove, CamPathToolpathEventLocation location, PathEvent referenceEvent) throws NXException, RemoteException
eventToMove
- location
- referenceEvent
- NXException
RemoteException
Path.IsToolpathEventAMotionData isToolpathEventAMotion(int eventNumber) throws NXException, RemoteException
eventNumber
- NXException
RemoteException
Path.IsToolpathEventAMotionData isToolpathEventAMotion(PathEvent eventOfInterest) throws NXException, RemoteException
eventOfInterest
- NXException
RemoteException
Path.IsToolpathEventUdeData isToolpathEventUde(PathEvent eventOfInterest) throws NXException, RemoteException
eventOfInterest
- NXException
RemoteException
PathLinearMotion getLinearMotion(int index) throws NXException, RemoteException
index
- NXException
RemoteException
void setLinearMotion(int index, PathLinearMotion data) throws NXException, RemoteException
index
- data
- NXException
RemoteException
void appendLinearMotion(PathLinearMotion data) throws NXException, RemoteException
data
- NXException
RemoteException
void insertLinearMotionBefore(PathLinearMotion data, int index) throws NXException, RemoteException
data
- index
- NXException
RemoteException
void insertLinearMotionAfter(PathLinearMotion data, int index) throws NXException, RemoteException
data
- index
- NXException
RemoteException
PathLinearMotion getLinearMotion(PathEvent eventOfInterest) throws NXException, RemoteException
eventOfInterest
- NXException
RemoteException
void setLinearMotion(PathEvent eventOfInterest, PathLinearMotion data) throws NXException, RemoteException
eventOfInterest
- data
- NXException
RemoteException
PathEvent addLinearMotion(PathLinearMotion data, CamPathToolpathEventLocation location, PathEvent referenceEvent) throws NXException, RemoteException
data
- location
- referenceEvent
- NXException
RemoteException
PathCircularMotion getCircularMotion(int index) throws NXException, RemoteException
index
- NXException
RemoteException
void setCircularMotion(int index, PathCircularMotion data) throws NXException, RemoteException
index
- data
- NXException
RemoteException
void appendCircularMotion(PathCircularMotion data) throws NXException, RemoteException
data
- NXException
RemoteException
void insertCircularMotionBefore(PathCircularMotion data, int index) throws NXException, RemoteException
data
- index
- NXException
RemoteException
void insertCircularMotionAfter(PathCircularMotion data, int index) throws NXException, RemoteException
data
- index
- NXException
RemoteException
PathCircularMotion getCircularMotion(PathEvent eventOfInterest) throws NXException, RemoteException
eventOfInterest
- NXException
RemoteException
void setCircularMotion(PathEvent eventOfInterest, PathCircularMotion data) throws NXException, RemoteException
eventOfInterest
- data
- NXException
RemoteException
PathEvent addCircularMotion(PathCircularMotion data, CamPathToolpathEventLocation location, PathEvent referenceEvent) throws NXException, RemoteException
data
- location
- referenceEvent
- NXException
RemoteException
PathHelixMotion getHelixMotion(int index) throws NXException, RemoteException
index
- NXException
RemoteException
void setHelixMotion(int index, PathHelixMotion data) throws NXException, RemoteException
index
- data
- NXException
RemoteException
void appendHelixMotion(PathHelixMotion data) throws NXException, RemoteException
data
- NXException
RemoteException
void insertHelixMotionBefore(PathHelixMotion data, int index) throws NXException, RemoteException
data
- index
- NXException
RemoteException
void insertHelixMotionAfter(PathHelixMotion data, int index) throws NXException, RemoteException
data
- index
- NXException
RemoteException
PathHelixMotion getHelixMotion(PathEvent eventOfInterest) throws NXException, RemoteException
eventOfInterest
- NXException
RemoteException
void setHelixMotion(PathEvent eventOfInterest, PathHelixMotion data) throws NXException, RemoteException
eventOfInterest
- data
- NXException
RemoteException
PathEvent addHelixMotion(PathHelixMotion data, CamPathToolpathEventLocation location, PathEvent referenceEvent) throws NXException, RemoteException
data
- location
- referenceEvent
- NXException
RemoteException
Ude getUde(int index) throws NXException, RemoteException
index
- NXException
RemoteException
void setUde(int index, Ude data) throws NXException, RemoteException
index
- data
- NXException
RemoteException
void appendUde(String udeName) throws NXException, RemoteException
udeName
- NXException
RemoteException
void insertUdeBefore(String udeName, int index) throws NXException, RemoteException
udeName
- index
- NXException
RemoteException
void insertUdeAfter(String udeName, int index) throws NXException, RemoteException
udeName
- index
- NXException
RemoteException
Ude getUde(PathEvent eventOfInterest) throws NXException, RemoteException
eventOfInterest
- NXException
RemoteException
void setUde(PathEvent eventOfInterest, Ude data) throws NXException, RemoteException
eventOfInterest
- data
- NXException
RemoteException
PathEvent addUde(String udeName, CamPathToolpathEventLocation location, PathEvent referenceEvent) throws NXException, RemoteException
udeName
- location
- referenceEvent
- NXException
RemoteException
void emptyPath() throws NXException, RemoteException
NXException
RemoteException
void deleteOneEvent(int index) throws NXException, RemoteException
index
- NXException
RemoteException
void deleteOneEvent(PathEvent pathEvent) throws NXException, RemoteException
pathEvent
- NXException
RemoteException
PathLaserOptimizationData getLaserOptimizationData() throws NXException, RemoteException
NXException
RemoteException
PathLevelMarker getLevelMarker(int index) throws NXException, RemoteException
index
- NXException
RemoteException
void setLevelMarker(int index, PathLevelMarker data) throws NXException, RemoteException
index
- data
- NXException
RemoteException
void appendLevelMarker(PathLevelMarker data) throws NXException, RemoteException
data
- NXException
RemoteException
void insertLevelMarkerBefore(PathLevelMarker data, int index) throws NXException, RemoteException
data
- index
- NXException
RemoteException
void insertLevelMarkerAfter(PathLevelMarker data, int index) throws NXException, RemoteException
data
- index
- NXException
RemoteException
PathLevelMarker getLevelMarker(PathEvent eventOfInterest) throws NXException, RemoteException
eventOfInterest
- NXException
RemoteException
void setLevelMarker(PathEvent eventOfInterest, PathLevelMarker data) throws NXException, RemoteException
eventOfInterest
- data
- NXException
RemoteException
PathEvent addLevelMarker(PathLevelMarker data, CamPathToolpathEventLocation location, PathEvent referenceEvent) throws NXException, RemoteException
data
- location
- referenceEvent
- NXException
RemoteException
PathEvent getFirstEvent() throws NXException, RemoteException
NXException
RemoteException
PathEvent getLastEvent() throws NXException, RemoteException
NXException
RemoteException
void deleteAllUdesOfName(String udeName) throws NXException, RemoteException
udeName
- NXException
RemoteException
CamPathContactType contactType() throws NXException, RemoteException
NXException
RemoteException
void setContactType(CamPathContactType contactType) throws NXException, RemoteException
contactType
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.