WorkInstructionOutputBuilder Class

class NXOpen.CAM.WorkInstructionOutputBuilder

Bases: NXOpen.Builder

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()

New in version NX9.0.3.

Properties

Property Description
OpenFile Returns or sets the open file
OutputFile Returns or sets the output file
OutputFormat Returns or sets the output format
PageOrientation Returns or sets the page orientation
PageSize Returns or sets the page size
ScaleFactor Returns or sets the scale factor
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
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.
Publish Publish the Work Instructions
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

OpenFile

WorkInstructionOutputBuilder.OpenFile

Returns or sets the open file

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

Getter Method

Signature OpenFile

Returns:
Return type:bool

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature OpenFile

Parameters:openFile (bool) –

New in version NX9.0.3.

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

OutputFile

WorkInstructionOutputBuilder.OutputFile

Returns or sets the output file

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

Getter Method

Signature OutputFile

Returns:
Return type:str

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature OutputFile

Parameters:filename (str) –

New in version NX9.0.3.

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

OutputFormat

WorkInstructionOutputBuilder.OutputFormat

Returns or sets the output format

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

Getter Method

Signature OutputFormat

Returns:
Return type:NXOpen.CAM.WorkInstructionOutputBuilderOutputFormatType

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature OutputFormat

Parameters:format (NXOpen.CAM.WorkInstructionOutputBuilderOutputFormatType) –

New in version NX9.0.3.

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

PageOrientation

WorkInstructionOutputBuilder.PageOrientation

Returns or sets the page orientation

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

Getter Method

Signature PageOrientation

Returns:
Return type:NXOpen.CAM.WorkInstructionOutputBuilderPageOrientationType

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature PageOrientation

Parameters:pageOrientation (NXOpen.CAM.WorkInstructionOutputBuilderPageOrientationType) –

New in version NX9.0.3.

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

PageSize

WorkInstructionOutputBuilder.PageSize

Returns or sets the page size

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

Getter Method

Signature PageSize

Returns:
Return type:NXOpen.CAM.WorkInstructionOutputBuilderPageSizeType

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature PageSize

Parameters:pageSize (NXOpen.CAM.WorkInstructionOutputBuilderPageSizeType) –

New in version NX9.0.3.

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

ScaleFactor

WorkInstructionOutputBuilder.ScaleFactor

Returns or sets the scale factor

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

Getter Method

Signature ScaleFactor

Returns:
Return type:float

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature ScaleFactor

Parameters:scaleFactor (float) –

New in version NX9.0.3.

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

Method Detail

Publish

WorkInstructionOutputBuilder.Publish

Publish the Work Instructions

Signature Publish(objects, firstSelObj, currentView)

Parameters:

New in version NX9.0.3.

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

Validate

WorkInstructionOutputBuilder.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.