WorkInstructionBuilder Class¶

class NXOpen.CAM.WorkInstructionBuilder¶

Bases: NXOpen.Builder

Represents the builder for Work Instruction

To create a new instance of this class, use NXOpen.CAM.CAMSetup.CreateWorkInstructionBuilder()

New in version NX9.0.3.

Properties¶

Property	Description
CameraName	Returns or sets the selected camera
Drawing	Returns or sets the selected drawing
DrawingSheet	Returns or sets the selected drawing sheet
FontFace	Returns or sets the text font face
FontSize	Returns or sets the text font size
ImageFile	Returns or sets the selected image
ItemName	Returns or sets the work instruction item name
NoBackground	Returns or sets the no background option
OperListProgramGroup	Returns or sets the selected Program Group for Operation List
SheetNumber	Returns or sets the work instruction sheet number
SheetTitle	Returns or sets the user defined Sheet Title
Tag	Returns the Tag for this object.
TemplateName	Returns or sets the template name
TimeEstimate	Returns or sets the estimated time to execute these instructions
ToolListProgramGroup	Returns or sets the selected Program Group for Tool List
ToolSetupSheet	Returns or sets the selected tool setup sheet
VideoFile	Returns or sets the selected video
ViewTool	Returns or sets the show tool option

Methods¶

Method	Description
ActivateCapturedView	Activate the captured view for a view item
AddSheet	Add a Work Instruction sheet
CaptureCurrentView	Capture the current view using a new camera
Commit	Commits any edits that have been applied to the builder.
CommitItem	Commit the current item
CommitMaster	Commit the current master
DeleteSheet	Delete a Work Instruction sheet
DeleteViewCamera	Delete the view camera
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
GetRichText	Returns the multi line text
GetTextColor	Returns the text color
MoveSheet	Move a Work Instruction sheet
RestorePreviousView	Restore the previous view
SetRichText	Sets the multi line text
SetTextColor	Sets the text color
SetToolDisplayMotion	Sets the tool display path event type and index
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
SpecifyDrawingSheet	Specify a drawing sheet in a component
UpdateItemsInCurrentSheet	Update the items for the current sheet
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail¶

CameraName¶

WorkInstructionBuilder.CameraName¶

Returns or sets the selected camera

-------------------------------------

Getter Method

Signature CameraName

Returns:
Return type:	str

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature CameraName

Parameters:	cameraName (str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

Drawing¶

WorkInstructionBuilder.Drawing¶

Returns or sets the selected drawing

-------------------------------------

Getter Method

Signature Drawing

Returns:
Return type:	str

New in version NX9.0.3.

Deprecated since version NX11.0.1: Use CAM.WorkInstructionBuilder.DrawingSheet() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature Drawing

Parameters:	drawing (str) –

New in version NX9.0.3.

Deprecated since version NX11.0.1: Use CAM.WorkInstructionBuilder.DrawingSheet() instead.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

DrawingSheet¶

WorkInstructionBuilder.DrawingSheet¶

Returns or sets the selected drawing sheet

-------------------------------------

Getter Method

Signature DrawingSheet

Returns:	the drawing sheet
Return type:	`NXOpen.NXObject`

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature DrawingSheet

Parameters:	drawingSheet (`NXOpen.NXObject`) – the drawing sheet

New in version NX11.0.1.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

FontFace¶

WorkInstructionBuilder.FontFace¶

Returns or sets the text font face

-------------------------------------

Getter Method

Signature FontFace

Returns:
Return type:	str

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature FontFace

Parameters:	fontFace (str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

FontSize¶

WorkInstructionBuilder.FontSize¶

Returns or sets the text font size

-------------------------------------

Getter Method

Signature FontSize

Returns:
Return type:	int

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature FontSize

Parameters:	fontSize (int) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

ImageFile¶

WorkInstructionBuilder.ImageFile¶

Returns or sets the selected image

-------------------------------------

Getter Method

Signature ImageFile

Returns:
Return type:	str

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature ImageFile

Parameters:	imageFile (str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

ItemName¶

WorkInstructionBuilder.ItemName¶

Returns or sets the work instruction item name

-------------------------------------

Getter Method

Signature ItemName

Returns:
Return type:	str

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature ItemName

Parameters:	itemName (str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

NoBackground¶

WorkInstructionBuilder.NoBackground¶

Returns or sets the no background option

-------------------------------------

Getter Method

Signature NoBackground

Returns:
Return type:	bool

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature NoBackground

Parameters:	noBackground (bool) –

New in version NX11.0.1.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

OperListProgramGroup¶

WorkInstructionBuilder.OperListProgramGroup¶

Returns or sets the selected Program Group for Operation List

-------------------------------------

Getter Method

Signature OperListProgramGroup

Returns:
Return type:	str

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature OperListProgramGroup

Parameters:	programGroupName (str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

SheetNumber¶

WorkInstructionBuilder.SheetNumber¶

Returns or sets the work instruction sheet number

-------------------------------------

Getter Method

Signature SheetNumber

Returns:
Return type:	int

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature SheetNumber

Parameters:	sheetNumber (int) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

SheetTitle¶

WorkInstructionBuilder.SheetTitle¶

Returns or sets the user defined Sheet Title

-------------------------------------

Getter Method

Signature SheetTitle

Returns:
Return type:	str

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature SheetTitle

Parameters:	sheetTitle (str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

TemplateName¶

WorkInstructionBuilder.TemplateName¶

Returns or sets the template name

-------------------------------------

Getter Method

Signature TemplateName

Returns:
Return type:	str

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature TemplateName

Parameters:	templateName (str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

TimeEstimate¶

WorkInstructionBuilder.TimeEstimate¶

Returns or sets the estimated time to execute these instructions

-------------------------------------

Getter Method

Signature TimeEstimate

Returns:
Return type:	float

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature TimeEstimate

Parameters:	timeEstimate (float) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

ToolListProgramGroup¶

WorkInstructionBuilder.ToolListProgramGroup¶

Returns or sets the selected Program Group for Tool List

-------------------------------------

Getter Method

Signature ToolListProgramGroup

Returns:
Return type:	str

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature ToolListProgramGroup

Parameters:	programGroupName (str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

ToolSetupSheet¶

WorkInstructionBuilder.ToolSetupSheet¶

Returns or sets the selected tool setup sheet

-------------------------------------

Getter Method

Signature ToolSetupSheet

Returns:	the tool setup sheet
Return type:	str

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature ToolSetupSheet

Parameters:	toolSetupSheet (str) – the tool setup sheet

New in version NX11.0.1.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

VideoFile¶

WorkInstructionBuilder.VideoFile¶

Returns or sets the selected video

-------------------------------------

Getter Method

Signature VideoFile

Returns:
Return type:	str

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature VideoFile

Parameters:	videoFile (str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

ViewTool¶

WorkInstructionBuilder.ViewTool¶

Returns or sets the show tool option

-------------------------------------

Getter Method

Signature ViewTool

Returns:
Return type:	bool

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature ViewTool

Parameters:	show (bool) –

New in version NX11.0.1.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

Method Detail¶

ActivateCapturedView¶

WorkInstructionBuilder.ActivateCapturedView¶

Activate the captured view for a view item

Signature ActivateCapturedView()

New in version NX9.0.3.

License requirements: None.

AddSheet¶

WorkInstructionBuilder.AddSheet¶

Add a Work Instruction sheet

Signature AddSheet()

Returns:
Return type:	int

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

CaptureCurrentView¶

WorkInstructionBuilder.CaptureCurrentView¶

Capture the current view using a new camera

Signature CaptureCurrentView()

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

CommitItem¶

WorkInstructionBuilder.CommitItem¶

Commit the current item

Signature CommitItem()

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

CommitMaster¶

WorkInstructionBuilder.CommitMaster¶

Commit the current master

Signature CommitMaster()

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

DeleteSheet¶

WorkInstructionBuilder.DeleteSheet¶

Delete a Work Instruction sheet

Signature DeleteSheet(sheetNum)

Parameters:	sheetNum (int) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

DeleteViewCamera¶

WorkInstructionBuilder.DeleteViewCamera¶

Delete the view camera

Signature DeleteViewCamera()

New in version NX9.0.3.

License requirements: None.

GetRichText¶

WorkInstructionBuilder.GetRichText¶

Returns the multi line text

Signature GetRichText()

Returns:
Return type:	list of str

New in version NX9.0.3.

License requirements: None.

GetTextColor¶

WorkInstructionBuilder.GetTextColor¶

Returns the text color

Signature GetTextColor()

Returns:	Array of 3 RGB values, each between 0 and 1
Return type:	list of float

New in version NX9.0.3.

License requirements: None.

MoveSheet¶

WorkInstructionBuilder.MoveSheet¶

Move a Work Instruction sheet

Signature MoveSheet(sheetNum, up)

Parameters:	sheetNum (int) – up (bool) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

RestorePreviousView¶

WorkInstructionBuilder.RestorePreviousView¶

Restore the previous view

Signature RestorePreviousView()

New in version NX9.0.3.

License requirements: None.

SetRichText¶

WorkInstructionBuilder.SetRichText¶

Sets the multi line text

Signature SetRichText(multiLineText)

Parameters:	multiLineText (list of str) –

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

SetTextColor¶

WorkInstructionBuilder.SetTextColor¶

Sets the text color

Signature SetTextColor(textColor)

Parameters:	textColor (list of float) – Array of 3 RGB values, each between 0 and 1

New in version NX9.0.3.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

SetToolDisplayMotion¶

WorkInstructionBuilder.SetToolDisplayMotion¶

Sets the tool display path event type and index

Signature SetToolDisplayMotion(eventType, eventIndex)

Parameters:	eventType (int) – the path event type eventIndex (int) – the path event index

New in version NX11.0.1.

License requirements: nx_wi_authoring (” NX Work Instruction Authoring”)

SpecifyDrawingSheet¶

WorkInstructionBuilder.SpecifyDrawingSheet¶

Specify a drawing sheet in a component

Signature SpecifyDrawingSheet(partName, drawingName)

Parameters:	partName (str) – drawingName (str) –

New in version NX11.0.1.

License requirements: None.

UpdateItemsInCurrentSheet¶

WorkInstructionBuilder.UpdateItemsInCurrentSheet¶

Update the items for the current sheet

Signature UpdateItemsInCurrentSheet(itemNames)

Parameters:	itemNames (list of str) – the string array

New in version NX9.0.3.

License requirements: cam_base (“CAM BASE”)

Validate¶

WorkInstructionBuilder.Validate¶

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:	Was self validation successful
Return type:	bool

New in version NX3.0.1.

License requirements: None.