InspectionGraphicalReportOutputBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InspectionGraphicalReportOutputBuilder Class

class `NXOpen.CAM.``InspectionGraphicalReportOutputBuilder`

  Bases: `NXOpen.Builder`

  Represents the builder for Inspection Graphical Report Output.

  This class is used to publish Inspection graphical reports for the end user. When `Builder.Commit()` is called, None will be returned. To create a new instance of this class, use `NXOpen.CAM.InspectionOperationCollection.CreateGraphicalReportOutputBuilder()`

  New in version NX10.0.3.

# Properties

Property | Description
--- | ---
OpenFile | Returns or sets the open file option
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 | Output the graphical reports
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.

# Enumerations

InspectionGraphicalReportOutputBuilderOutputFormatType Enumeration | the output format type
InspectionGraphicalReportOutputBuilderPageOrientationType Enumeration | the page orientation type
InspectionGraphicalReportOutputBuilderPageSizeType Enumeration | the page size type

# Property Detail

## OpenFile

`InspectionGraphicalReportOutputBuilder.``OpenFile`

  Returns or sets the open file option

  `-------------------------------------`

  Getter Method

  Signature `OpenFile`

  Returns: |
  Return type: | bool

  New in version NX10.0.3.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OpenFile`

  Parameters: | openFile (bool) –

  New in version NX10.0.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## OutputFile

`InspectionGraphicalReportOutputBuilder.``OutputFile`

  Returns or sets the output file

  `-------------------------------------`

  Getter Method

  Signature `OutputFile`

  Returns: |
  Return type: | str

  New in version NX10.0.3.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OutputFile`

  Parameters: | filename (str) –

  New in version NX10.0.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## OutputFormat

`InspectionGraphicalReportOutputBuilder.``OutputFormat`

  Returns or sets the output format

  `-------------------------------------`

  Getter Method

  Signature `OutputFormat`

  Returns: |
  Return type: | `NXOpen.CAM.InspectionGraphicalReportOutputBuilderOutputFormatType`

  New in version NX10.0.3.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OutputFormat`

  Parameters: | format (`NXOpen.CAM.InspectionGraphicalReportOutputBuilderOutputFormatType`) –

  New in version NX10.0.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## PageOrientation

`InspectionGraphicalReportOutputBuilder.``PageOrientation`

  Returns or sets the page orientation

  `-------------------------------------`

  Getter Method

  Signature `PageOrientation`

  Returns: |
  Return type: | `NXOpen.CAM.InspectionGraphicalReportOutputBuilderPageOrientationType`

  New in version NX10.0.3.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PageOrientation`

  Parameters: | pageOrientation (`NXOpen.CAM.InspectionGraphicalReportOutputBuilderPageOrientationType`) –

  New in version NX10.0.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## PageSize

`InspectionGraphicalReportOutputBuilder.``PageSize`

  Returns or sets the page size

  `-------------------------------------`

  Getter Method

  Signature `PageSize`

  Returns: |
  Return type: | `NXOpen.CAM.InspectionGraphicalReportOutputBuilderPageSizeType`

  New in version NX10.0.3.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PageSize`

  Parameters: | pageSize (`NXOpen.CAM.InspectionGraphicalReportOutputBuilderPageSizeType`) –

  New in version NX10.0.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## ScaleFactor

`InspectionGraphicalReportOutputBuilder.``ScaleFactor`

  Returns or sets the scale factor

  `-------------------------------------`

  Getter Method

  Signature `ScaleFactor`

  Returns: |
  Return type: | float

  New in version NX10.0.3.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ScaleFactor`

  Parameters: | scaleFactor (float) –

  New in version NX10.0.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## Publish

`InspectionGraphicalReportOutputBuilder.``Publish`

  Output the graphical reports

  Signature `Publish()`

  New in version NX10.0.3.

  License requirements: insp_programming (“INSPECTION PROGRAMMING”)

## Validate

`InspectionGraphicalReportOutputBuilder.``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.