HoleReportBuilder Class

class NXOpen.Tooling.HoleReportBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Tooling.HoleReportBuilder This class is for Hole Report Design UI

To create a new instance of this class, use NXOpen.Tooling.HoleReportCollection.CreateHoleReportBuilder()

Default values.

Property Value
QuadrantType PositiveQuadrantI
SelectionType ViewSelection

New in version NX6.0.0.

Properties

Property Description
CreatedOrdinateOrigin Returns or sets the created ordinate origin
HoleTable Returns the hole table to edit
OrdinateOrigin Returns the ordinate origin to get the coords in given ordinate
QuadrantType Returns or sets the positive quadrant type
SelectionType Returns or sets the selection type to choose select view or holes in window to create hole report
TableAddHole Returns the holes to add to the table
TableHole Returns the holes in window to create hole report
TableOrigin Returns or sets the table origin
TableView Returns the view to create hole report
Tag Returns the Tag for this object.
Type Returns or sets the type of hole table

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CreateOrdinateOrigin Create Ordinate Origin
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.
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

HoleReportBuilderEnumQuadrantType Enumeration Specifies the option of which quadrant is positive
HoleReportBuilderEnumSelectionType Enumeration Specifies the option of selection type to create hole table
HoleReportBuilderTypes Enumeration Specifies the option of hole table type

Property Detail

CreatedOrdinateOrigin

HoleReportBuilder.CreatedOrdinateOrigin

Returns or sets the created ordinate origin

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

Getter Method

Signature CreatedOrdinateOrigin

Returns:Returns the created ordinate origin
Return type:NXOpen.TaggedObject

New in version NX6.0.3.

License requirements: None.

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

Setter Method

Signature CreatedOrdinateOrigin

Parameters:ordinateOriginTag (NXOpen.TaggedObject) – Sets the created ordinate origin

New in version NX6.0.3.

License requirements: None.

HoleTable

HoleReportBuilder.HoleTable

Returns the hole table to edit

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

Getter Method

Signature HoleTable

Returns:Returns the hole table to edit
Return type:NXOpen.SelectEdgeList

New in version NX6.0.0.

License requirements: None.

OrdinateOrigin

HoleReportBuilder.OrdinateOrigin

Returns the ordinate origin to get the coords in given ordinate

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

Getter Method

Signature OrdinateOrigin

Returns:Returns the edge in which the ordinate origin is
Return type:NXOpen.SelectPointList

New in version NX6.0.0.

License requirements: None.

QuadrantType

HoleReportBuilder.QuadrantType

Returns or sets the positive quadrant type

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

Getter Method

Signature QuadrantType

Returns:Returns the positive quadrant type
Return type:NXOpen.Tooling.HoleReportBuilderEnumQuadrantType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature QuadrantType

Parameters:quadrantType (NXOpen.Tooling.HoleReportBuilderEnumQuadrantType) – Sets the positive quadrant type

New in version NX6.0.0.

License requirements: None.

SelectionType

HoleReportBuilder.SelectionType

Returns or sets the selection type to choose select view or holes in window to create hole report

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

Getter Method

Signature SelectionType

Returns:Returns the selection type value
Return type:NXOpen.Tooling.HoleReportBuilderEnumSelectionType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature SelectionType

Parameters:selectionType (NXOpen.Tooling.HoleReportBuilderEnumSelectionType) – Sets the selection type value

New in version NX6.0.0.

License requirements: None.

TableAddHole

HoleReportBuilder.TableAddHole

Returns the holes to add to the table

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

Getter Method

Signature TableAddHole

Returns:Returns the holes to add to the table
Return type:NXOpen.SelectEdgeList

New in version NX6.0.0.

License requirements: None.

TableHole

HoleReportBuilder.TableHole

Returns the holes in window to create hole report

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

Getter Method

Signature TableHole

Returns:Returns the holes in window to create hole table
Return type:NXOpen.SelectEdgeList

New in version NX6.0.0.

License requirements: None.

TableOrigin

HoleReportBuilder.TableOrigin

Returns or sets the table origin

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

Getter Method

Signature TableOrigin

Returns:Returns the table origin to create hole table
Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature TableOrigin

Parameters:tableOrigin (NXOpen.Point) – Sets the table origin to create hole table

New in version NX6.0.0.

License requirements: None.

TableView

HoleReportBuilder.TableView

Returns the view to create hole report

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

Getter Method

Signature TableView

Returns:Returns the view to create hole table
Return type:NXOpen.Drawings.SelectDraftingViewList

New in version NX6.0.0.

License requirements: None.

Type

HoleReportBuilder.Type

Returns or sets the type of hole table

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

Getter Method

Signature Type

Returns:
Return type:NXOpen.Tooling.HoleReportBuilderTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:type (NXOpen.Tooling.HoleReportBuilderTypes) –

New in version NX7.5.0.

License requirements: None.

Method Detail

CreateOrdinateOrigin

HoleReportBuilder.CreateOrdinateOrigin

Create Ordinate Origin

Signature CreateOrdinateOrigin(quadrant, viewTag, pointData)

Parameters:
Returns:

the new ordinate

Return type:

NXOpen.TaggedObject

New in version NX6.0.3.

License requirements: None.

Validate

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