Represents the builder for Work Instruction
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateWorkInstructionBuilder

Created in NX9.0.3. More...

Inheritance diagram for NXOpen::CAM::WorkInstructionBuilder:

Public Member Functions
void	ActivateCapturedView ()
	Activate the captured view for a view item Created in NX9.0.3. More...

int	AddSheet ()
	Add a Work Instruction sheet. More...

NXString	CameraName ()
	Returns the selected camera Created in NX9.0.3. More...

void	CaptureCurrentView ()
	Capture the current view using a new camera Created in NX9.0.3. More...

void	CommitItem ()
	Commit the current item Created in NX9.0.3. More...

void	CommitMaster ()
	Commit the current master Created in NX9.0.3. More...

void	DeleteSheet (int sheetNum)
	Delete a Work Instruction sheet Created in NX9.0.3. More...

void	DeleteViewCamera ()
	Delete the view camera Created in NX9.0.3. More...

NXString	Drawing ()
	Returns the selected drawing More...

NXOpen::NXObject *	DrawingSheet ()
	Returns the selected drawing sheet Created in NX11.0.1. More...

NXString	FontFace ()
	Returns the text font face Created in NX9.0.3. More...

int	FontSize ()
	Returns the text font size Created in NX9.0.3. More...

std::vector< NXString >	GetRichText ()
	Returns the multi line text. More...

std::vector< double >	GetTextColor ()
	Returns the text color. More...

NXString	ImageFile ()
	Returns the selected image Created in NX9.0.3. More...

NXString	ItemName ()
	Returns the work instruction item name Created in NX9.0.3. More...

void	MoveSheet (int sheetNum, bool up)
	Move a Work Instruction sheet Created in NX9.0.3. More...

bool	NoBackground ()
	Returns the no background option Created in NX11.0.1. More...

NXString	OperListProgramGroup ()
	Returns the selected Program Group for Operation List Created in NX9.0.3. More...

void	RestorePreviousView ()
	Restore the previous view Created in NX9.0.3. More...

void	SetCameraName (const NXString &cameraName)
	Sets the selected camera Created in NX9.0.3. More...

void	SetCameraName (const char *cameraName)
	Sets the selected camera Created in NX9.0.3. More...

void	SetDrawing (const NXString &drawing)
	Sets the selected drawing More...

void	SetDrawing (const char *drawing)
	Sets the selected drawing More...

void	SetDrawingSheet (NXOpen::NXObject *drawingSheet)
	Sets the selected drawing sheet Created in NX11.0.1. More...

void	SetFontFace (const NXString &fontFace)
	Sets the text font face Created in NX9.0.3. More...

void	SetFontFace (const char *fontFace)
	Sets the text font face Created in NX9.0.3. More...

void	SetFontSize (int fontSize)
	Sets the text font size Created in NX9.0.3. More...

void	SetImageFile (const NXString &imageFile)
	Sets the selected image Created in NX9.0.3. More...

void	SetImageFile (const char *imageFile)
	Sets the selected image Created in NX9.0.3. More...

void	SetItemName (const NXString &itemName)
	Sets the work instruction item name Created in NX9.0.3. More...

void	SetItemName (const char *itemName)
	Sets the work instruction item name Created in NX9.0.3. More...

void	SetNoBackground (bool noBackground)
	Sets the no background option Created in NX11.0.1. More...

void	SetOperListProgramGroup (const NXString &programGroupName)
	Sets the selected Program Group for Operation List Created in NX9.0.3. More...

void	SetOperListProgramGroup (const char *programGroupName)
	Sets the selected Program Group for Operation List Created in NX9.0.3. More...

void	SetRichText (const std::vector< NXString > &multiLineText)
	Sets the multi line text Created in NX9.0.3. More...

void	SetSheetNumber (int sheetNumber)
	Sets the work instruction sheet number Created in NX9.0.3. More...

void	SetSheetTitle (const NXString &sheetTitle)
	Sets the user defined Sheet Title Created in NX9.0.3. More...

void	SetSheetTitle (const char *sheetTitle)
	Sets the user defined Sheet Title Created in NX9.0.3. More...

void	SetTemplateName (const NXString &templateName)
	Sets the template name Created in NX9.0.3. More...

void	SetTemplateName (const char *templateName)
	Sets the template name Created in NX9.0.3. More...

void	SetTextColor (const std::vector< double > &textColor)
	Sets the text color Created in NX9.0.3. More...

void	SetTimeEstimate (double timeEstimate)
	Sets the estimated time to execute these instructions Created in NX9.0.3. More...

void	SetToolDisplayMotion (int eventType, int eventIndex)
	Sets the tool display path event type and index Created in NX11.0.1. More...

void	SetToolListProgramGroup (const NXString &programGroupName)
	Sets the selected Program Group for Tool List Created in NX9.0.3. More...

void	SetToolListProgramGroup (const char *programGroupName)
	Sets the selected Program Group for Tool List Created in NX9.0.3. More...

void	SetToolSetupSheet (const NXString &toolSetupSheet)
	Sets the selected tool setup sheet Created in NX11.0.1. More...

void	SetToolSetupSheet (const char *toolSetupSheet)
	Sets the selected tool setup sheet Created in NX11.0.1. More...

void	SetVideoFile (const NXString &videoFile)
	Sets the selected video Created in NX9.0.3. More...

void	SetVideoFile (const char *videoFile)
	Sets the selected video Created in NX9.0.3. More...

void	SetViewTool (bool show)
	Sets the show tool option Created in NX11.0.1. More...

int	SheetNumber ()
	Returns the work instruction sheet number Created in NX9.0.3. More...

NXString	SheetTitle ()
	Returns the user defined Sheet Title Created in NX9.0.3. More...

void	SpecifyDrawingSheet (const NXString &partName, const NXString &drawingName)
	Specify a drawing sheet in a component Created in NX11.0.1. More...

void	SpecifyDrawingSheet (const char partName, const char drawingName)
	Specify a drawing sheet in a component Created in NX11.0.1. More...

NXString	TemplateName ()
	Returns the template name Created in NX9.0.3. More...

double	TimeEstimate ()
	Returns the estimated time to execute these instructions Created in NX9.0.3. More...

NXString	ToolListProgramGroup ()
	Returns the selected Program Group for Tool List Created in NX9.0.3. More...

NXString	ToolSetupSheet ()
	Returns the selected tool setup sheet Created in NX11.0.1. More...

void	UpdateItemsInCurrentSheet (std::vector< NXString > &itemNames)
	Update the items for the current sheet Created in NX9.0.3. More...

NXString	VideoFile ()
	Returns the selected video Created in NX9.0.3. More...

bool	ViewTool ()
	Returns the show tool option Created in NX11.0.1. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents the builder for Work Instruction
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateWorkInstructionBuilder

Created in NX9.0.3.

Member Function Documentation

void NXOpen::CAM::WorkInstructionBuilder::ActivateCapturedView ( )

Activate the captured view for a view item
Created in NX9.0.3.

License requirements : None

int NXOpen::CAM::WorkInstructionBuilder::AddSheet ( )

Add a Work Instruction sheet.

Returns: Created in NX9.0.3.

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

NXString NXOpen::CAM::WorkInstructionBuilder::CameraName ( )

Returns the selected camera
Created in NX9.0.3.

License requirements : None

void NXOpen::CAM::WorkInstructionBuilder::CaptureCurrentView ( )

Capture the current view using a new camera
Created in NX9.0.3.

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

void NXOpen::CAM::WorkInstructionBuilder::CommitItem ( )

Commit the current item
Created in NX9.0.3.

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

void NXOpen::CAM::WorkInstructionBuilder::CommitMaster ( )

Commit the current master
Created in NX9.0.3.

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

void NXOpen::CAM::WorkInstructionBuilder::DeleteSheet ( int sheetNum )

Delete a Work Instruction sheet
Created in NX9.0.3.

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

Parameters

sheetNum sheetnum

void NXOpen::CAM::WorkInstructionBuilder::DeleteViewCamera ( )

Delete the view camera
Created in NX9.0.3.

License requirements : None

NXString NXOpen::CAM::WorkInstructionBuilder::Drawing ( )

Returns the selected drawing

Deprecated:: Deprecated in NX11.0.1.

Use CAM::WorkInstructionBuilder::SetDrawingSheet instead.

Created in NX9.0.3.

License requirements : None

NXOpen::NXObject* NXOpen::CAM::WorkInstructionBuilder::DrawingSheet ( )

Returns the selected drawing sheet
Created in NX11.0.1.

License requirements : None

NXString NXOpen::CAM::WorkInstructionBuilder::FontFace ( )

Returns the text font face
Created in NX9.0.3.

License requirements : None

int NXOpen::CAM::WorkInstructionBuilder::FontSize ( )

Returns the text font size
Created in NX9.0.3.

License requirements : None

std::vector<NXString> NXOpen::CAM::WorkInstructionBuilder::GetRichText ( )

Returns the multi line text.

Returns: Created in NX9.0.3.

License requirements : None

std::vector<double> NXOpen::CAM::WorkInstructionBuilder::GetTextColor ( )

Returns the text color.

Returns: Array of 3 RGB values, each between 0 and 1
Created in NX9.0.3.

License requirements : None

NXString NXOpen::CAM::WorkInstructionBuilder::ImageFile ( )

Returns the selected image
Created in NX9.0.3.

License requirements : None

NXString NXOpen::CAM::WorkInstructionBuilder::ItemName ( )

Returns the work instruction item name
Created in NX9.0.3.

License requirements : None

void NXOpen::CAM::WorkInstructionBuilder::MoveSheet	(	int	sheetNum,
		bool	up
	)

Move a Work Instruction sheet
Created in NX9.0.3.

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

Parameters

sheetNum	sheetnum
up	up

bool NXOpen::CAM::WorkInstructionBuilder::NoBackground ( )

Returns the no background option
Created in NX11.0.1.

License requirements : None

NXString NXOpen::CAM::WorkInstructionBuilder::OperListProgramGroup ( )

Returns the selected Program Group for Operation List
Created in NX9.0.3.

License requirements : None

void NXOpen::CAM::WorkInstructionBuilder::RestorePreviousView ( )

Restore the previous view
Created in NX9.0.3.

License requirements : None

void NXOpen::CAM::WorkInstructionBuilder::SetCameraName ( const NXString & cameraName )

Sets the selected camera
Created in NX9.0.3.

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

Parameters

cameraName cameraname

void NXOpen::CAM::WorkInstructionBuilder::SetCameraName ( const char * cameraName )

Sets the selected camera
Created in NX9.0.3.

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

Parameters

cameraName cameraname

void NXOpen::CAM::WorkInstructionBuilder::SetDrawing ( const NXString & drawing )

Sets the selected drawing

Deprecated:: Deprecated in NX11.0.1.

Use CAM::WorkInstructionBuilder::SetDrawingSheet instead.

Created in NX9.0.3.

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

Parameters

drawing drawing

void NXOpen::CAM::WorkInstructionBuilder::SetDrawing ( const char * drawing )

Sets the selected drawing

Deprecated:: Deprecated in NX11.0.1.

Use CAM::WorkInstructionBuilder::SetDrawingSheet instead.

Created in NX9.0.3.

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

Parameters

drawing drawing

void NXOpen::CAM::WorkInstructionBuilder::SetDrawingSheet ( NXOpen::NXObject * drawingSheet )

Sets the selected drawing sheet
Created in NX11.0.1.

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

Parameters

drawingSheet the drawing sheet

void NXOpen::CAM::WorkInstructionBuilder::SetFontFace ( const NXString & fontFace )

Sets the text font face
Created in NX9.0.3.

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

Parameters

fontFace fontface

void NXOpen::CAM::WorkInstructionBuilder::SetFontFace ( const char * fontFace )

Sets the text font face
Created in NX9.0.3.

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

Parameters

fontFace fontface

void NXOpen::CAM::WorkInstructionBuilder::SetFontSize ( int fontSize )

Sets the text font size
Created in NX9.0.3.

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

Parameters

fontSize fontsize

void NXOpen::CAM::WorkInstructionBuilder::SetImageFile ( const NXString & imageFile )

Sets the selected image
Created in NX9.0.3.

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

Parameters

imageFile imagefile

void NXOpen::CAM::WorkInstructionBuilder::SetImageFile ( const char * imageFile )

Sets the selected image
Created in NX9.0.3.

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

Parameters

imageFile imagefile

void NXOpen::CAM::WorkInstructionBuilder::SetItemName ( const NXString & itemName )

Sets the work instruction item name
Created in NX9.0.3.

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

Parameters

itemName itemname

void NXOpen::CAM::WorkInstructionBuilder::SetItemName ( const char * itemName )

Sets the work instruction item name
Created in NX9.0.3.

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

Parameters

itemName itemname

void NXOpen::CAM::WorkInstructionBuilder::SetNoBackground ( bool noBackground )

Sets the no background option
Created in NX11.0.1.

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

Parameters

noBackground nobackground

void NXOpen::CAM::WorkInstructionBuilder::SetOperListProgramGroup ( const NXString & programGroupName )

Sets the selected Program Group for Operation List
Created in NX9.0.3.

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

Parameters

programGroupName programgroupname

void NXOpen::CAM::WorkInstructionBuilder::SetOperListProgramGroup ( const char * programGroupName )

Sets the selected Program Group for Operation List
Created in NX9.0.3.

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

Parameters

programGroupName programgroupname

void NXOpen::CAM::WorkInstructionBuilder::SetRichText ( const std::vector< NXString > & multiLineText )

Sets the multi line text
Created in NX9.0.3.

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

Parameters

multiLineText multilinetext

void NXOpen::CAM::WorkInstructionBuilder::SetSheetNumber ( int sheetNumber )

Sets the work instruction sheet number
Created in NX9.0.3.

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

Parameters

sheetNumber sheetnumber

void NXOpen::CAM::WorkInstructionBuilder::SetSheetTitle ( const NXString & sheetTitle )

Sets the user defined Sheet Title
Created in NX9.0.3.

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

Parameters

sheetTitle sheettitle

void NXOpen::CAM::WorkInstructionBuilder::SetSheetTitle ( const char * sheetTitle )

Sets the user defined Sheet Title
Created in NX9.0.3.

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

Parameters

sheetTitle sheettitle

void NXOpen::CAM::WorkInstructionBuilder::SetTemplateName ( const NXString & templateName )

Sets the template name
Created in NX9.0.3.

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

Parameters

templateName templatename

void NXOpen::CAM::WorkInstructionBuilder::SetTemplateName ( const char * templateName )

Sets the template name
Created in NX9.0.3.

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

Parameters

templateName templatename

void NXOpen::CAM::WorkInstructionBuilder::SetTextColor ( const std::vector< double > & textColor )

Sets the text color
Created in NX9.0.3.

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

Parameters

textColor Array of 3 RGB values, each between 0 and 1

void NXOpen::CAM::WorkInstructionBuilder::SetTimeEstimate ( double timeEstimate )

Sets the estimated time to execute these instructions
Created in NX9.0.3.

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

Parameters

timeEstimate timeestimate

void NXOpen::CAM::WorkInstructionBuilder::SetToolDisplayMotion	(	int	eventType,
		int	eventIndex
	)

Sets the tool display path event type and index
Created in NX11.0.1.

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

Parameters

eventType	the path event type
eventIndex	the path event index

void NXOpen::CAM::WorkInstructionBuilder::SetToolListProgramGroup ( const NXString & programGroupName )

Sets the selected Program Group for Tool List
Created in NX9.0.3.

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

Parameters

programGroupName programgroupname

void NXOpen::CAM::WorkInstructionBuilder::SetToolListProgramGroup ( const char * programGroupName )

Sets the selected Program Group for Tool List
Created in NX9.0.3.

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

Parameters

programGroupName programgroupname

void NXOpen::CAM::WorkInstructionBuilder::SetToolSetupSheet ( const NXString & toolSetupSheet )

Sets the selected tool setup sheet
Created in NX11.0.1.

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

Parameters

toolSetupSheet the tool setup sheet

void NXOpen::CAM::WorkInstructionBuilder::SetToolSetupSheet ( const char * toolSetupSheet )

Sets the selected tool setup sheet
Created in NX11.0.1.

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

Parameters

toolSetupSheet the tool setup sheet

void NXOpen::CAM::WorkInstructionBuilder::SetVideoFile ( const NXString & videoFile )

Sets the selected video
Created in NX9.0.3.

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

Parameters

videoFile videofile

void NXOpen::CAM::WorkInstructionBuilder::SetVideoFile ( const char * videoFile )

Sets the selected video
Created in NX9.0.3.

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

Parameters

videoFile videofile

void NXOpen::CAM::WorkInstructionBuilder::SetViewTool ( bool show )

Sets the show tool option
Created in NX11.0.1.

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

Parameters

show show

int NXOpen::CAM::WorkInstructionBuilder::SheetNumber ( )

Returns the work instruction sheet number
Created in NX9.0.3.

License requirements : None

NXString NXOpen::CAM::WorkInstructionBuilder::SheetTitle ( )

Returns the user defined Sheet Title
Created in NX9.0.3.

License requirements : None

void NXOpen::CAM::WorkInstructionBuilder::SpecifyDrawingSheet	(	const NXString &	partName,
		const NXString &	drawingName
	)

Specify a drawing sheet in a component
Created in NX11.0.1.

License requirements : None

Parameters

partName	partname
drawingName	drawingname

void NXOpen::CAM::WorkInstructionBuilder::SpecifyDrawingSheet	(	const char *	partName,
		const char *	drawingName
	)

Specify a drawing sheet in a component
Created in NX11.0.1.

License requirements : None

Parameters

partName	partname
drawingName	drawingname

NXString NXOpen::CAM::WorkInstructionBuilder::TemplateName ( )

Returns the template name
Created in NX9.0.3.

License requirements : None

double NXOpen::CAM::WorkInstructionBuilder::TimeEstimate ( )

Returns the estimated time to execute these instructions
Created in NX9.0.3.

License requirements : None

NXString NXOpen::CAM::WorkInstructionBuilder::ToolListProgramGroup ( )

Returns the selected Program Group for Tool List
Created in NX9.0.3.

License requirements : None

NXString NXOpen::CAM::WorkInstructionBuilder::ToolSetupSheet ( )

Returns the selected tool setup sheet
Created in NX11.0.1.

License requirements : None

void NXOpen::CAM::WorkInstructionBuilder::UpdateItemsInCurrentSheet ( std::vector< NXString > & itemNames )

Update the items for the current sheet
Created in NX9.0.3.

License requirements : cam_base ("CAM BASE")

Parameters

itemNames the string array

NXString NXOpen::CAM::WorkInstructionBuilder::VideoFile ( )

Returns the selected video
Created in NX9.0.3.

License requirements : None

bool NXOpen::CAM::WorkInstructionBuilder::ViewTool ( )

Returns the show tool option
Created in NX11.0.1.

License requirements : None

The documentation for this class was generated from the following file:

CAM_WorkInstructionBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation