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

Tooling builder for HoleManufacturingNote
To create a new instance of this class, use NXOpen::Tooling::HoleManufacturingNoteCollection::CreateHoleManufacturingNoteBuilder
Default values. More...

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

Public Types

enum  DefineByViewOrHoles { DefineByViewOrHolesView, DefineByViewOrHolesHoles }
 the view selection or window selection type More...
 
enum  HoleIndexType { HoleIndexTypeUserDefinedAndNumber, HoleIndexTypeAlphabetic, HoleIndexTypeNumeric }
 the hole index type More...
 

Public Member Functions

NXOpen::NXObjectCreatedHoleManufacturingNote ()
 Returns the created hole manufacturing note
Created in NX9.0.0. More...
 
NXOpen::NXObjectCreateHoleIndexLabel (NXOpen::NXObject *viewTag, const NXString &holeTypeIndex, NXOpen::NXObject *faceTag, double holeDiameter, const NXOpen::Point3d &holePos, const NXString &holetype, bool reverseFlag)
 The method to create hole index. More...
 
NXOpen::NXObjectCreateHoleIndexLabel (NXOpen::NXObject *viewTag, const char *holeTypeIndex, NXOpen::NXObject *faceTag, double holeDiameter, const NXOpen::Point3d &holePos, const char *holetype, bool reverseFlag)
 The method to create hole index. More...
 
NXOpen::NXObjectCreateHoleManufacturingNoteAsNote (NXOpen::NXObject *viewTag, std::vector< NXString > &holeManufacturingNoteVector, const NXOpen::Point3d &point)
 The method to create manufaturing information as note. More...
 
NXOpen::NXObjectCycleObjectsInView (NXOpen::NXObject *viewTag, int vseqNumber, bool isDrawing, NXOpen::NXObject *inObject)
 The method to cycle objects in view. More...
 
NXOpen::Tooling::HoleManufacturingNoteBuilder::DefineByViewOrHoles DefineByViewOrHolesEnum ()
 Returns the selection type enumeration
Created in NX9.0.0. More...
 
NXOpen::NXColorHoleIndexColor ()
 Returns the hole index character color
Created in NX9.0.0. More...
 
double HoleIndexSize ()
 Returns the hole index character size
Created in NX9.0.0. More...
 
NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleIndexType HoleIndexTypeEnum ()
 Returns the hole index type enumeration
Created in NX9.0.0. More...
 
NXOpen::NXColorHoleManufacturingNoteColor ()
 Returns the manufaturing information character color
Created in NX9.0.0. More...
 
NXOpen::Annotations::OriginBuilderHoleManufacturingNoteOrigin ()
 Returns the manufacturing information origin
Created in NX9.0.0. More...
 
double HoleManufacturingNoteSize ()
 Returns the manufaturing information character size
Created in NX9.0.0. More...
 
NXOpen::Annotations::StyleBuilderHoleManufacturingNoteStyle ()
 Returns the hole manufacturing note style
Created in NX9.0.0. More...
 
void ModifyStyle ()
 The method to modify the style of the previewed note
Created in NX9.0.0. More...
 
NXOpen::SelectNXObjectListSelectHoles ()
 Returns the selected holes
Created in NX9.0.0. More...
 
NXOpen::SelectNXObjectSelectView ()
 Returns the selected view
Created in NX9.0.0. More...
 
void SetCreatedHoleManufacturingNote (NXOpen::NXObject *createdHoleManufacturingNote)
 Sets the created hole manufacturing note
Created in NX9.0.0. More...
 
void SetDefineByViewOrHolesEnum (NXOpen::Tooling::HoleManufacturingNoteBuilder::DefineByViewOrHoles defineByViewOrHoles)
 Sets the selection type enumeration
Created in NX9.0.0. More...
 
void SetHoleIndexColor (NXOpen::NXColor *holeIndexColor)
 Sets the hole index character color
Created in NX9.0.0. More...
 
void SetHoleIndexSize (double holeIndexSize)
 Sets the hole index character size
Created in NX9.0.0. More...
 
void SetHoleIndexTypeEnum (NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleIndexType holeIndexTypeEnum)
 Sets the hole index type enumeration
Created in NX9.0.0. More...
 
void SetHoleManufacturingNoteColor (NXOpen::NXColor *holeManufacturingNoteColor)
 Sets the manufaturing information character color
Created in NX9.0.0. More...
 
void SetHoleManufacturingNoteSize (double holeManufacturingNoteSize)
 Sets the manufaturing information character size
Created in NX9.0.0. More...
 
void SetUseDifferentSubIndexForSameDiameterHoles (bool useDifferentSubIndexForSameDiameterHoles)
 Sets the use different sub index for same diameter holes
Created in NX11.0.0. More...
 
void SetWizardType (int wizardType)
 Sets the wizard type
Created in NX9.0.0. More...
 
bool UseDifferentSubIndexForSameDiameterHoles ()
 Returns the use different sub index for same diameter holes
Created in NX11.0.0. More...
 
int WizardType ()
 Returns the wizard type
Created in NX9.0.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

Tooling builder for HoleManufacturingNote
To create a new instance of this class, use NXOpen::Tooling::HoleManufacturingNoteCollection::CreateHoleManufacturingNoteBuilder
Default values.

Property Value

DefineByViewOrHolesEnum

View

HoleIndexSize

3.5

HoleIndexTypeEnum

UserDefinedAndNumber

HoleManufacturingNoteSize

3.5

UseDifferentSubIndexForSameDiameterHoles

0


Created in NX9.0.0.

Member Enumeration Documentation

the view selection or window selection type

Enumerator
DefineByViewOrHolesView 

view

DefineByViewOrHolesHoles 

holes

the hole index type

Enumerator
HoleIndexTypeUserDefinedAndNumber 

user defined and number

HoleIndexTypeAlphabetic 

alphabetic

HoleIndexTypeNumeric 

numeric

Member Function Documentation

NXOpen::NXObject* NXOpen::Tooling::HoleManufacturingNoteBuilder::CreatedHoleManufacturingNote ( )

Returns the created hole manufacturing note
Created in NX9.0.0.



License requirements : None

NXOpen::NXObject* NXOpen::Tooling::HoleManufacturingNoteBuilder::CreateHoleIndexLabel ( NXOpen::NXObject viewTag,
const NXString holeTypeIndex,
NXOpen::NXObject faceTag,
double  holeDiameter,
const NXOpen::Point3d holePos,
const NXString holetype,
bool  reverseFlag 
)

The method to create hole index.

Returns
The hole index label tag
Created in NX9.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")
Parameters
viewTagThe view to create hole index label
holeTypeIndexThe hole hole index label string
faceTagThe hole face data
holeDiameterThe hole diameter
holePosThe hole position
holetypeThe hole type string
reverseFlagThe hole reversed flag
NXOpen::NXObject* NXOpen::Tooling::HoleManufacturingNoteBuilder::CreateHoleIndexLabel ( NXOpen::NXObject viewTag,
const char *  holeTypeIndex,
NXOpen::NXObject faceTag,
double  holeDiameter,
const NXOpen::Point3d holePos,
const char *  holetype,
bool  reverseFlag 
)

The method to create hole index.

Returns
The hole index label tag
Created in NX9.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")
Parameters
viewTagThe view to create hole index label
holeTypeIndexThe hole hole index label string
faceTagThe hole face data
holeDiameterThe hole diameter
holePosThe hole position
holetypeThe hole type string
reverseFlagThe hole reversed flag
NXOpen::NXObject* NXOpen::Tooling::HoleManufacturingNoteBuilder::CreateHoleManufacturingNoteAsNote ( NXOpen::NXObject viewTag,
std::vector< NXString > &  holeManufacturingNoteVector,
const NXOpen::Point3d point 
)

The method to create manufaturing information as note.

Returns
The manufaturing information note tag
Created in NX9.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")
Parameters
viewTagThe view to create hole index label
holeManufacturingNoteVectorThe hole index label string
pointThe location point data
NXOpen::NXObject* NXOpen::Tooling::HoleManufacturingNoteBuilder::CycleObjectsInView ( NXOpen::NXObject viewTag,
int  vseqNumber,
bool  isDrawing,
NXOpen::NXObject inObject 
)

The method to cycle objects in view.

Returns
Output object
Created in NX9.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")
Parameters
viewTagThe view to cycle
vseqNumberThe View Sequence Number of the View must NOT be DSS_ALL_VIEWS or DSS_NO_VIEWS
isDrawingIs this view a drawing
inObjectInput object
NXOpen::Tooling::HoleManufacturingNoteBuilder::DefineByViewOrHoles NXOpen::Tooling::HoleManufacturingNoteBuilder::DefineByViewOrHolesEnum ( )

Returns the selection type enumeration
Created in NX9.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleIndexColor ( )

Returns the hole index character color
Created in NX9.0.0.



License requirements : None

double NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleIndexSize ( )

Returns the hole index character size
Created in NX9.0.0.



License requirements : None

NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleIndexType NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleIndexTypeEnum ( )

Returns the hole index type enumeration
Created in NX9.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleManufacturingNoteColor ( )

Returns the manufaturing information character color
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleManufacturingNoteOrigin ( )

Returns the manufacturing information origin
Created in NX9.0.0.



License requirements : None

double NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleManufacturingNoteSize ( )

Returns the manufaturing information character size
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::StyleBuilder* NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleManufacturingNoteStyle ( )

Returns the hole manufacturing note style
Created in NX9.0.0.



License requirements : None

void NXOpen::Tooling::HoleManufacturingNoteBuilder::ModifyStyle ( )

The method to modify the style of the previewed note
Created in NX9.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

NXOpen::SelectNXObjectList* NXOpen::Tooling::HoleManufacturingNoteBuilder::SelectHoles ( )

Returns the selected holes
Created in NX9.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Tooling::HoleManufacturingNoteBuilder::SelectView ( )

Returns the selected view
Created in NX9.0.0.



License requirements : None

void NXOpen::Tooling::HoleManufacturingNoteBuilder::SetCreatedHoleManufacturingNote ( NXOpen::NXObject createdHoleManufacturingNote)

Sets the created hole manufacturing note
Created in NX9.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
createdHoleManufacturingNotecreatedholemanufacturingnote
void NXOpen::Tooling::HoleManufacturingNoteBuilder::SetDefineByViewOrHolesEnum ( NXOpen::Tooling::HoleManufacturingNoteBuilder::DefineByViewOrHoles  defineByViewOrHoles)

Sets the selection type enumeration
Created in NX9.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
defineByViewOrHolesdefinebyvieworholes
void NXOpen::Tooling::HoleManufacturingNoteBuilder::SetHoleIndexColor ( NXOpen::NXColor holeIndexColor)

Sets the hole index character color
Created in NX9.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
holeIndexColorholeindexcolor
void NXOpen::Tooling::HoleManufacturingNoteBuilder::SetHoleIndexSize ( double  holeIndexSize)

Sets the hole index character size
Created in NX9.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
holeIndexSizeholeindexsize
void NXOpen::Tooling::HoleManufacturingNoteBuilder::SetHoleIndexTypeEnum ( NXOpen::Tooling::HoleManufacturingNoteBuilder::HoleIndexType  holeIndexTypeEnum)

Sets the hole index type enumeration
Created in NX9.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
holeIndexTypeEnumholeindextypeenum
void NXOpen::Tooling::HoleManufacturingNoteBuilder::SetHoleManufacturingNoteColor ( NXOpen::NXColor holeManufacturingNoteColor)

Sets the manufaturing information character color
Created in NX9.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
holeManufacturingNoteColorholemanufacturingnotecolor
void NXOpen::Tooling::HoleManufacturingNoteBuilder::SetHoleManufacturingNoteSize ( double  holeManufacturingNoteSize)

Sets the manufaturing information character size
Created in NX9.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
holeManufacturingNoteSizeholemanufacturingnotesize
void NXOpen::Tooling::HoleManufacturingNoteBuilder::SetUseDifferentSubIndexForSameDiameterHoles ( bool  useDifferentSubIndexForSameDiameterHoles)

Sets the use different sub index for same diameter holes
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
useDifferentSubIndexForSameDiameterHolesusedifferentsubindexforsamediameterholes
void NXOpen::Tooling::HoleManufacturingNoteBuilder::SetWizardType ( int  wizardType)

Sets the wizard type
Created in NX9.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
wizardTypewizardtype
bool NXOpen::Tooling::HoleManufacturingNoteBuilder::UseDifferentSubIndexForSameDiameterHoles ( )

Returns the use different sub index for same diameter holes
Created in NX11.0.0.



License requirements : None

int NXOpen::Tooling::HoleManufacturingNoteBuilder::WizardType ( )

Returns the wizard type
Created in NX9.0.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.