public interface WorkInstructionBuilder extends Builder
CAMSetup.createWorkInstructionBuilder(nxopen.cam.CAMObject)
Modifier and Type | Method and Description |
---|---|
void |
activateCapturedView()
Activate the captured view for a view item
License requirements: None. |
int |
addSheet()
Add a Work Instruction sheet
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
String |
cameraName()
Returns the selected camera
License requirements: None. |
void |
captureCurrentView()
Capture the current view using a new camera
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
commitItem()
Commit the current item
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
commitMaster()
Commit the current master
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
deleteSheet(int sheetNum)
Delete a Work Instruction sheet
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
deleteViewCamera()
Delete the view camera
License requirements: None. |
String |
drawing()
Deprecated.
Deprecated in NX11.0.1. Use
setDrawingSheet(nxopen.NXObject) instead.
|
NXObject |
drawingSheet()
Returns the selected drawing sheet
License requirements: None. |
String |
fontFace()
Returns the text font face
License requirements: None. |
int |
fontSize()
Returns the text font size
License requirements: None. |
String[] |
getRichText()
Returns the multi line text
License requirements: None. |
double[] |
getTextColor()
Returns the text color
License requirements: None. |
String |
imageFile()
Returns the selected image
License requirements: None. |
String |
itemName()
Returns the work instruction item name
License requirements: None. |
void |
moveSheet(int sheetNum,
boolean up)
Move a Work Instruction sheet
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
boolean |
noBackground()
Returns the no background option
License requirements: None. |
String |
operListProgramGroup()
Returns the selected Program Group for Operation List
License requirements: None. |
void |
restorePreviousView()
Restore the previous view
License requirements: None. |
void |
setCameraName(String cameraName)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setDrawing(String drawing)
Deprecated.
Deprecated in NX11.0.1. Use
setDrawingSheet(nxopen.NXObject) instead.
|
void |
setDrawingSheet(NXObject drawingSheet)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setFontFace(String fontFace)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setFontSize(int fontSize)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setImageFile(String imageFile)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setItemName(String itemName)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setNoBackground(boolean noBackground)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setOperListProgramGroup(String programGroupName)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setRichText(String[] multiLineText)
Sets the multi line text
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setSheetNumber(int sheetNumber)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setSheetTitle(String sheetTitle)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setTemplateName(String templateName)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setTextColor(double[] textColor)
Sets the text color
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setTimeEstimate(double timeEstimate)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setToolDisplayMotion(int eventType,
int eventIndex)
Sets the tool display path event type and index
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setToolListProgramGroup(String programGroupName)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setToolSetupSheet(String toolSetupSheet)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setVideoFile(String videoFile)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
void |
setViewTool(boolean show)
License requirements: nx_wi_authoring (" NX Work Instruction Authoring") . |
int |
sheetNumber()
Returns the work instruction sheet number
License requirements: None. |
String |
sheetTitle()
Returns the user defined Sheet Title
License requirements: None. |
void |
specifyDrawingSheet(String partName,
String drawingName)
Specify a drawing sheet in a component
License requirements: None. |
String |
templateName()
Returns the template name
License requirements: None. |
double |
timeEstimate()
Returns the estimated time to execute these instructions
License requirements: None. |
String |
toolListProgramGroup()
Returns the selected Program Group for Tool List
License requirements: None. |
String |
toolSetupSheet()
Returns the selected tool setup sheet
License requirements: None. |
void |
updateItemsInCurrentSheet(String[] itemNames)
Update the items for the current sheet
License requirements: cam_base ("CAM BASE") . |
String |
videoFile()
Returns the selected video
License requirements: None. |
boolean |
viewTool()
Returns the show tool option
License requirements: None. |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
int sheetNumber() throws NXException, RemoteException
NXException
RemoteException
void setSheetNumber(int sheetNumber) throws NXException, RemoteException
sheetNumber
- NXException
RemoteException
String itemName() throws NXException, RemoteException
NXException
RemoteException
void setItemName(String itemName) throws NXException, RemoteException
itemName
- NXException
RemoteException
String templateName() throws NXException, RemoteException
NXException
RemoteException
void setTemplateName(String templateName) throws NXException, RemoteException
templateName
- NXException
RemoteException
String cameraName() throws NXException, RemoteException
NXException
RemoteException
void setCameraName(String cameraName) throws NXException, RemoteException
cameraName
- NXException
RemoteException
void captureCurrentView() throws NXException, RemoteException
NXException
RemoteException
String imageFile() throws NXException, RemoteException
NXException
RemoteException
void setImageFile(String imageFile) throws NXException, RemoteException
imageFile
- NXException
RemoteException
String[] getRichText() throws NXException, RemoteException
NXException
RemoteException
void setRichText(String[] multiLineText) throws NXException, RemoteException
multiLineText
- NXException
RemoteException
double[] getTextColor() throws NXException, RemoteException
NXException
RemoteException
void setTextColor(double[] textColor) throws NXException, RemoteException
textColor
- Array of 3 RGB values, each between 0 and 1NXException
RemoteException
String fontFace() throws NXException, RemoteException
NXException
RemoteException
void setFontFace(String fontFace) throws NXException, RemoteException
fontFace
- NXException
RemoteException
int fontSize() throws NXException, RemoteException
NXException
RemoteException
void setFontSize(int fontSize) throws NXException, RemoteException
fontSize
- NXException
RemoteException
String videoFile() throws NXException, RemoteException
NXException
RemoteException
void setVideoFile(String videoFile) throws NXException, RemoteException
videoFile
- NXException
RemoteException
String drawing() throws NXException, RemoteException
setDrawingSheet(nxopen.NXObject)
instead.
NXException
RemoteException
void setDrawing(String drawing) throws NXException, RemoteException
setDrawingSheet(nxopen.NXObject)
instead.
drawing
- NXException
RemoteException
double timeEstimate() throws NXException, RemoteException
NXException
RemoteException
void setTimeEstimate(double timeEstimate) throws NXException, RemoteException
timeEstimate
- NXException
RemoteException
int addSheet() throws NXException, RemoteException
NXException
RemoteException
void deleteSheet(int sheetNum) throws NXException, RemoteException
sheetNum
- NXException
RemoteException
String operListProgramGroup() throws NXException, RemoteException
NXException
RemoteException
void setOperListProgramGroup(String programGroupName) throws NXException, RemoteException
programGroupName
- NXException
RemoteException
String toolListProgramGroup() throws NXException, RemoteException
NXException
RemoteException
void setToolListProgramGroup(String programGroupName) throws NXException, RemoteException
programGroupName
- NXException
RemoteException
String sheetTitle() throws NXException, RemoteException
NXException
RemoteException
void setSheetTitle(String sheetTitle) throws NXException, RemoteException
sheetTitle
- NXException
RemoteException
void moveSheet(int sheetNum, boolean up) throws NXException, RemoteException
sheetNum
- up
- NXException
RemoteException
void commitMaster() throws NXException, RemoteException
NXException
RemoteException
void commitItem() throws NXException, RemoteException
NXException
RemoteException
void updateItemsInCurrentSheet(String[] itemNames) throws NXException, RemoteException
itemNames
- the string arrayNXException
RemoteException
void activateCapturedView() throws NXException, RemoteException
NXException
RemoteException
void restorePreviousView() throws NXException, RemoteException
NXException
RemoteException
void deleteViewCamera() throws NXException, RemoteException
NXException
RemoteException
boolean viewTool() throws NXException, RemoteException
NXException
RemoteException
void setViewTool(boolean show) throws NXException, RemoteException
show
- NXException
RemoteException
void setToolDisplayMotion(int eventType, int eventIndex) throws NXException, RemoteException
eventType
- the path event typeeventIndex
- the path event indexNXException
RemoteException
boolean noBackground() throws NXException, RemoteException
NXException
RemoteException
void setNoBackground(boolean noBackground) throws NXException, RemoteException
noBackground
- NXException
RemoteException
void specifyDrawingSheet(String partName, String drawingName) throws NXException, RemoteException
partName
- drawingName
- NXException
RemoteException
NXObject drawingSheet() throws NXException, RemoteException
NXException
RemoteException
void setDrawingSheet(NXObject drawingSheet) throws NXException, RemoteException
drawingSheet
- the drawing sheetNXException
RemoteException
String toolSetupSheet() throws NXException, RemoteException
NXException
RemoteException
void setToolSetupSheet(String toolSetupSheet) throws NXException, RemoteException
toolSetupSheet
- the tool setup sheetNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.