NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Tooling::HoleReportBuilder Class Reference

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

Inheritance diagram for NXOpen::Tooling::HoleReportBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  EnumQuadrantType {
  EnumQuadrantTypePositiveQuadrantI, EnumQuadrantTypePositiveQuadrantIi, EnumQuadrantTypePositiveQuadrantIii, EnumQuadrantTypePositiveQuadrantIv,
  EnumQuadrantTypePositiveQuadrantAll
}
 Specifies the option of which quadrant is positive. More...
 
enum  EnumSelectionType { EnumSelectionTypeViewSelection, EnumSelectionTypeWindowSelection }
 Specifies the option of selection type to create hole table. More...
 
enum  Types { TypesCreateTable, TypesUpdateTable }
 Specifies the option of hole table type. More...
 

Public Member Functions

NXOpen::TaggedObjectCreatedOrdinateOrigin ()
 Returns the created ordinate origin
Created in NX6.0.3. More...
 
NXOpen::TaggedObjectCreateOrdinateOrigin (int quadrant, NXOpen::TaggedObject *viewTag, const NXOpen::Point3d &pointData)
 Create Ordinate Origin. More...
 
NXOpen::SelectEdgeListHoleTable ()
 Returns the hole table to edit
Created in NX6.0.0. More...
 
NXOpen::SelectPointListOrdinateOrigin ()
 Returns the ordinate origin to get the coords in given ordinate
Created in NX6.0.0. More...
 
NXOpen::Tooling::HoleReportBuilder::EnumQuadrantType QuadrantType ()
 Returns the positive quadrant type
Created in NX6.0.0. More...
 
NXOpen::Tooling::HoleReportBuilder::EnumSelectionType SelectionType ()
 Returns the selection type to choose select view or holes in window to create hole report
Created in NX6.0.0. More...
 
void SetCreatedOrdinateOrigin (NXOpen::TaggedObject *ordinateOriginTag)
 Sets the created ordinate origin
Created in NX6.0.3. More...
 
void SetQuadrantType (NXOpen::Tooling::HoleReportBuilder::EnumQuadrantType quadrantType)
 Sets the positive quadrant type
Created in NX6.0.0. More...
 
void SetSelectionType (NXOpen::Tooling::HoleReportBuilder::EnumSelectionType selectionType)
 Sets the selection type to choose select view or holes in window to create hole report
Created in NX6.0.0. More...
 
void SetTableOrigin (NXOpen::Point *tableOrigin)
 Sets the table origin
Created in NX6.0.0. More...
 
void SetType (NXOpen::Tooling::HoleReportBuilder::Types type)
 Sets the type of hole table
Created in NX7.5.0. More...
 
NXOpen::SelectEdgeListTableAddHole ()
 Returns the holes to add to the table
Created in NX6.0.0. More...
 
NXOpen::SelectEdgeListTableHole ()
 Returns the holes in window to create hole report
Created in NX6.0.0. More...
 
NXOpen::PointTableOrigin ()
 Returns the table origin
Created in NX6.0.0. More...
 
NXOpen::Drawings::SelectDraftingViewListTableView ()
 Returns the view to create hole report
Created in NX6.0.0. More...
 
NXOpen::Tooling::HoleReportBuilder::Types Type ()
 Returns the type of hole table
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 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


Created in NX6.0.0.

Member Enumeration Documentation

Specifies the option of which quadrant is positive.

Enumerator
EnumQuadrantTypePositiveQuadrantI 

First quadrant is positive.

EnumQuadrantTypePositiveQuadrantIi 

Second quadrant is positive.

EnumQuadrantTypePositiveQuadrantIii 

Third quadrant is positive.

EnumQuadrantTypePositiveQuadrantIv 

Forth quadrant is positive.

EnumQuadrantTypePositiveQuadrantAll 

All quadrant is positive.

Specifies the option of selection type to create hole table.

Enumerator
EnumSelectionTypeViewSelection 

Selects view to create hole table.

EnumSelectionTypeWindowSelection 

Selects holes in window to create hole table.

Specifies the option of hole table type.

Enumerator
TypesCreateTable 

the hole table type of create hole table

TypesUpdateTable 

the hole table type of update hole table

Member Function Documentation

NXOpen::TaggedObject* NXOpen::Tooling::HoleReportBuilder::CreatedOrdinateOrigin ( )

Returns the created ordinate origin
Created in NX6.0.3.



License requirements : None

NXOpen::TaggedObject* NXOpen::Tooling::HoleReportBuilder::CreateOrdinateOrigin ( int  quadrant,
NXOpen::TaggedObject viewTag,
const NXOpen::Point3d pointData 
)

Create Ordinate Origin.

Returns
the new ordinate
Created in NX6.0.3.

License requirements : None
Parameters
quadrantvalue of the positive quadrant
viewTagthe view
pointDatadata of the cursor point
NXOpen::SelectEdgeList* NXOpen::Tooling::HoleReportBuilder::HoleTable ( )

Returns the hole table to edit
Created in NX6.0.0.



License requirements : None

NXOpen::SelectPointList* NXOpen::Tooling::HoleReportBuilder::OrdinateOrigin ( )

Returns the ordinate origin to get the coords in given ordinate
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::HoleReportBuilder::EnumQuadrantType NXOpen::Tooling::HoleReportBuilder::QuadrantType ( )

Returns the positive quadrant type
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::HoleReportBuilder::EnumSelectionType NXOpen::Tooling::HoleReportBuilder::SelectionType ( )

Returns the selection type to choose select view or holes in window to create hole report
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::HoleReportBuilder::SetCreatedOrdinateOrigin ( NXOpen::TaggedObject ordinateOriginTag)

Sets the created ordinate origin
Created in NX6.0.3.



License requirements : None

Parameters
ordinateOriginTagSets the created ordinate origin
void NXOpen::Tooling::HoleReportBuilder::SetQuadrantType ( NXOpen::Tooling::HoleReportBuilder::EnumQuadrantType  quadrantType)

Sets the positive quadrant type
Created in NX6.0.0.



License requirements : None

Parameters
quadrantTypeSets the positive quadrant type
void NXOpen::Tooling::HoleReportBuilder::SetSelectionType ( NXOpen::Tooling::HoleReportBuilder::EnumSelectionType  selectionType)

Sets the selection type to choose select view or holes in window to create hole report
Created in NX6.0.0.



License requirements : None

Parameters
selectionTypeSets the selection type value
void NXOpen::Tooling::HoleReportBuilder::SetTableOrigin ( NXOpen::Point tableOrigin)

Sets the table origin
Created in NX6.0.0.



License requirements : None

Parameters
tableOriginSets the table origin to create hole table
void NXOpen::Tooling::HoleReportBuilder::SetType ( NXOpen::Tooling::HoleReportBuilder::Types  type)

Sets the type of hole table
Created in NX7.5.0.



License requirements : None

Parameters
typetype
NXOpen::SelectEdgeList* NXOpen::Tooling::HoleReportBuilder::TableAddHole ( )

Returns the holes to add to the table
Created in NX6.0.0.



License requirements : None

NXOpen::SelectEdgeList* NXOpen::Tooling::HoleReportBuilder::TableHole ( )

Returns the holes in window to create hole report
Created in NX6.0.0.



License requirements : None

NXOpen::Point* NXOpen::Tooling::HoleReportBuilder::TableOrigin ( )

Returns the table origin
Created in NX6.0.0.



License requirements : None

NXOpen::Drawings::SelectDraftingViewList* NXOpen::Tooling::HoleReportBuilder::TableView ( )

Returns the view to create hole report
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::HoleReportBuilder::Types NXOpen::Tooling::HoleReportBuilder::Type ( )

Returns the type of hole table
Created in NX7.5.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.