Represents the builder for Work Instruction Output. More...

Inheritance diagram for NXOpen::CAM::WorkInstructionOutputBuilder:

Public Types
enum	OutputFormatType { OutputFormatTypeHtml, OutputFormatTypePdf, OutputFormatTypeCsv, OutputFormatTypeXml }
	the output format type More...

enum	PageOrientationType { PageOrientationTypeLandscape, PageOrientationTypePortrait }
	the page orientation type More...

enum	PageSizeType { PageSizeTypeA0, PageSizeTypeA1, PageSizeTypeA2, PageSizeTypeA3, PageSizeTypeA4, PageSizeTypeB1, PageSizeTypeB2, PageSizeTypeB3, PageSizeTypeB4, PageSizeTypeB5, PageSizeTypeExecutive, PageSizeTypeFolio, PageSizeTypeLegal, PageSizeTypeLetter, PageSizeTypeTabloid }
	the page size type More...

Public Member Functions
bool	OpenFile ()
	Returns the open file Created in NX9.0.3. More...

NXString	OutputFile ()
	Returns the output file Created in NX9.0.3. More...

NXOpen::CAM::WorkInstructionOutputBuilder::OutputFormatType	OutputFormat ()
	Returns the output format Created in NX9.0.3. More...

NXOpen::CAM::WorkInstructionOutputBuilder::PageOrientationType	PageOrientation ()
	Returns the page orientation Created in NX9.0.3. More...

NXOpen::CAM::WorkInstructionOutputBuilder::PageSizeType	PageSize ()
	Returns the page size Created in NX9.0.3. More...

void	Publish (const std::vector< NXOpen::CAM::CAMObject * > &objects, NXOpen::CAM::CAMObject *firstSelObj, int currentView)
	Publish the Work Instructions Created in NX9.0.3. More...

double	ScaleFactor ()
	Returns the scale factor Created in NX9.0.3. More...

void	SetOpenFile (bool openFile)
	Sets the open file Created in NX9.0.3. More...

void	SetOutputFile (const NXString &filename)
	Sets the output file Created in NX9.0.3. More...

void	SetOutputFile (const char *filename)
	Sets the output file Created in NX9.0.3. More...

void	SetOutputFormat (NXOpen::CAM::WorkInstructionOutputBuilder::OutputFormatType format)
	Sets the output format Created in NX9.0.3. More...

void	SetPageOrientation (NXOpen::CAM::WorkInstructionOutputBuilder::PageOrientationType pageOrientation)
	Sets the page orientation Created in NX9.0.3. More...

void	SetPageSize (NXOpen::CAM::WorkInstructionOutputBuilder::PageSizeType pageSize)
	Sets the page size Created in NX9.0.3. More...

void	SetScaleFactor (double scaleFactor)
	Sets the scale factor Created in NX9.0.3. 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 Output.

This class is used to publish work instructions for the end user.
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateWorkInstructionOutputBuilder

Created in NX9.0.3.

Member Enumeration Documentation

enum NXOpen::CAM::WorkInstructionOutputBuilder::OutputFormatType

the output format type

Enumerator
OutputFormatTypeHtml	html
OutputFormatTypePdf	pdf
OutputFormatTypeCsv	csv
OutputFormatTypeXml	xml

enum NXOpen::CAM::WorkInstructionOutputBuilder::PageOrientationType

the page orientation type

Enumerator
PageOrientationTypeLandscape	landscape
PageOrientationTypePortrait	portrait

enum NXOpen::CAM::WorkInstructionOutputBuilder::PageSizeType

the page size type

Enumerator
PageSizeTypeA0	a0
PageSizeTypeA1	a1
PageSizeTypeA2	a2
PageSizeTypeA3	a3
PageSizeTypeA4	a4
PageSizeTypeB1	b1
PageSizeTypeB2	b2
PageSizeTypeB3	b3
PageSizeTypeB4	b4
PageSizeTypeB5	b5
PageSizeTypeExecutive	executive
PageSizeTypeFolio	folio
PageSizeTypeLegal	legal
PageSizeTypeLetter	letter
PageSizeTypeTabloid	tabloid

Member Function Documentation

bool NXOpen::CAM::WorkInstructionOutputBuilder::OpenFile ( )

Returns the open file
Created in NX9.0.3.

License requirements : None

NXString NXOpen::CAM::WorkInstructionOutputBuilder::OutputFile ( )

Returns the output file
Created in NX9.0.3.

License requirements : None

NXOpen::CAM::WorkInstructionOutputBuilder::OutputFormatType NXOpen::CAM::WorkInstructionOutputBuilder::OutputFormat ( )

Returns the output format
Created in NX9.0.3.

License requirements : None

NXOpen::CAM::WorkInstructionOutputBuilder::PageOrientationType NXOpen::CAM::WorkInstructionOutputBuilder::PageOrientation ( )

Returns the page orientation
Created in NX9.0.3.

License requirements : None

NXOpen::CAM::WorkInstructionOutputBuilder::PageSizeType NXOpen::CAM::WorkInstructionOutputBuilder::PageSize ( )

Returns the page size
Created in NX9.0.3.

License requirements : None

void NXOpen::CAM::WorkInstructionOutputBuilder::Publish	(	const std::vector< NXOpen::CAM::CAMObject * > &	objects,
		NXOpen::CAM::CAMObject *	firstSelObj,
		int	currentView
	)

Publish the Work Instructions
Created in NX9.0.3.

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

Parameters

objects	array of objects
firstSelObj	firstselobj
currentView	CAM_SETUP_view

double NXOpen::CAM::WorkInstructionOutputBuilder::ScaleFactor ( )

Returns the scale factor
Created in NX9.0.3.

License requirements : None

void NXOpen::CAM::WorkInstructionOutputBuilder::SetOpenFile ( bool openFile )

Sets the open file
Created in NX9.0.3.

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

Parameters

openFile openfile

void NXOpen::CAM::WorkInstructionOutputBuilder::SetOutputFile ( const NXString & filename )

Sets the output file
Created in NX9.0.3.

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

Parameters

filename filename

void NXOpen::CAM::WorkInstructionOutputBuilder::SetOutputFile ( const char * filename )

Sets the output file
Created in NX9.0.3.

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

Parameters

filename filename

void NXOpen::CAM::WorkInstructionOutputBuilder::SetOutputFormat ( NXOpen::CAM::WorkInstructionOutputBuilder::OutputFormatType format )

Sets the output format
Created in NX9.0.3.

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

Parameters

format format

void NXOpen::CAM::WorkInstructionOutputBuilder::SetPageOrientation ( NXOpen::CAM::WorkInstructionOutputBuilder::PageOrientationType pageOrientation )

Sets the page orientation
Created in NX9.0.3.

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

Parameters

pageOrientation pageorientation

void NXOpen::CAM::WorkInstructionOutputBuilder::SetPageSize ( NXOpen::CAM::WorkInstructionOutputBuilder::PageSizeType pageSize )

Sets the page size
Created in NX9.0.3.

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

Parameters

pageSize pagesize

void NXOpen::CAM::WorkInstructionOutputBuilder::SetScaleFactor ( double scaleFactor )

Sets the scale factor
Created in NX9.0.3.

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

Parameters

scaleFactor scalefactor

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

CAM_WorkInstructionOutputBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation