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

Represents a NXOpen::GeometricUtilities::EndHoleData
Created in NX5.0.2. More...

Inheritance diagram for NXOpen::GeometricUtilities::EndHoleData:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  FormOptions { FormOptionsScrewClearance, FormOptionsThreaded, FormOptionsThrough }
 Represents hole form options. More...
 
enum  HoleDepthLimitOptions { HoleDepthLimitOptionsValue, HoleDepthLimitOptionsUntilSelected, HoleDepthLimitOptionsUntilNext, HoleDepthLimitOptionsThroughBody }
 Represents hole depth limit options for threaded hole in end plate of hole series. More...
 
enum  HoleDepthOptions { HoleDepthOptionsToCylinderBottom, HoleDepthOptionsToConeTip }
 Represents hole depth specification options. More...
 
enum  ThreadLengthOptions {
  ThreadLengthOptionsDiameterx1, ThreadLengthOptionsDiameterx15, ThreadLengthOptionsDiameterx20, ThreadLengthOptionsDiameterx25,
  ThreadLengthOptionsDiameterx30, ThreadLengthOptionsStandard, ThreadLengthOptionsCustom, ThreadLengthOptionsFull
}
 Represents thread length options. More...
 
enum  ThreadRotationOptions { ThreadRotationOptionsRight, ThreadRotationOptionsLeft }
 Represents thread rotation options. More...
 

Public Member Functions

NXOpen::GeometricUtilities::BooleanOperationBooleanOperation ()
 Returns the boolean operation
Created in NX5.0.2. More...
 
NXOpen::GeometricUtilities::EndHoleData::HoleDepthOptions DepthOption ()
 Returns the hole depth option
Created in NX11.0.0. More...
 
NXString FitOption ()
 Returns the fit option
Created in NX5.0.2. More...
 
NXOpen::GeometricUtilities::EndHoleData::FormOptions FormOption ()
 Returns the form option
Created in NX5.0.2. More...
 
NXOpen::ExpressionHoleDepth ()
 Returns the hole depth
Created in NX5.0.2. More...
 
NXOpen::GeometricUtilities::EndHoleData::HoleDepthLimitOptions HoleDepthLimitOption ()
 Returns the hole depth limit
Created in NX5.0.2. More...
 
NXOpen::ExpressionHoleDiameter ()
 Returns the hole diameter
Created in NX5.0.2. More...
 
bool MatchDimOfStartHole ()
 Returns the match dim of start hole
Created in NX5.0.2. More...
 
NXString RadialEngageOption ()
 Returns the radial engage option
Created in NX5.0.2. More...
 
bool ReliefChamferEnabled ()
 Returns the threaded relief chamfer enabled - this is applicable for threaded hole type
Created in NX8.0.0. More...
 
NXOpen::ExpressionScrewClearanceEndChamferAngle ()
 Returns the screw clearance end chamfer angle
Created in NX5.0.2. More...
 
bool ScrewClearanceEndChamferEnabled ()
 Returns the screw clearance end chamfer enabled
Created in NX5.0.2. More...
 
NXOpen::ExpressionScrewClearanceEndChamferOffset ()
 Returns the screw clearance end chamfer offset
Created in NX5.0.2. More...
 
NXOpen::ExpressionScrewClearanceStartChamferAngle ()
 Returns the screw clearance start chamfer angle
Created in NX5.0.2. More...
 
bool ScrewClearanceStartChamferEnabled ()
 Returns the screw clearance start chamfer enabled
Created in NX5.0.2. More...
 
NXOpen::ExpressionScrewClearanceStartChamferOffset ()
 Returns the screw clearance start chamfer offset
Created in NX5.0.2. More...
 
void SetDepthOption (NXOpen::GeometricUtilities::EndHoleData::HoleDepthOptions depthOption)
 Sets the hole depth option
Created in NX11.0.0. More...
 
void SetFitOption (const NXString &fitOption)
 Sets the fit option
Created in NX5.0.2. More...
 
void SetFitOption (const char *fitOption)
 Sets the fit option
Created in NX5.0.2. More...
 
void SetFormOption (NXOpen::GeometricUtilities::EndHoleData::FormOptions formOption)
 Sets the form option
Created in NX5.0.2. More...
 
void SetHoleDepthLimitOption (NXOpen::GeometricUtilities::EndHoleData::HoleDepthLimitOptions holeDepthLimitOption)
 Sets the hole depth limit
Created in NX5.0.2. More...
 
void SetMatchDimOfStartHole (bool matchDimOfStartHole)
 Sets the match dim of start hole
Created in NX5.0.2. More...
 
void SetRadialEngageOption (const NXString &radialEngageOption)
 Sets the radial engage option
Created in NX5.0.2. More...
 
void SetRadialEngageOption (const char *radialEngageOption)
 Sets the radial engage option
Created in NX5.0.2. More...
 
void SetReliefChamferEnabled (bool reliefChamferEnabled)
 Sets the threaded relief chamfer enabled - this is applicable for threaded hole type
Created in NX8.0.0. More...
 
void SetScrewClearanceEndChamferEnabled (bool screwClearanceEndChamferEnabled)
 Sets the screw clearance end chamfer enabled
Created in NX5.0.2. More...
 
void SetScrewClearanceStartChamferEnabled (bool screwClearenceStartChamferEnabled)
 Sets the screw clearance start chamfer enabled
Created in NX5.0.2. More...
 
void SetThreadedEndChamferEnabled (bool threadedEndChamferEnabled)
 Sets the threaded end chamfer enabled
Created in NX5.0.2. More...
 
void SetThreadedReliefEnabled (bool threadedReliefEnabled)
 Sets the threaded relief enabled - this is applicable for threaded hole type
Created in NX8.0.0. More...
 
void SetThreadedStartChamferEnabled (bool threadedStartChamferEnabled)
 Sets the threaded start chamfer enabled
Created in NX5.0.2. More...
 
void SetThreadLengthOption (NXOpen::GeometricUtilities::EndHoleData::ThreadLengthOptions threadLengthOption)
 Sets the thread length option
Created in NX5.0.2. More...
 
void SetThreadRotation (NXOpen::GeometricUtilities::EndHoleData::ThreadRotationOptions threadRotation)
 Sets the thread rotation
Created in NX5.0.2. More...
 
void SetThreadSize (const NXString &threadSize)
 Sets the thread size
Created in NX5.0.2. More...
 
void SetThreadSize (const char *threadSize)
 Sets the thread size
Created in NX5.0.2. More...
 
NXOpen::ExpressionTapDrillDiameter ()
 Returns the tap drill diameter
Created in NX5.0.2. More...
 
NXOpen::ExpressionThreadDepth ()
 Returns the thread depth
Created in NX5.0.2. More...
 
NXOpen::ExpressionThreadedEndChamferAngle ()
 Returns the threaded end chamfer angle
Created in NX5.0.2. More...
 
NXOpen::ExpressionThreadedEndChamferDiameter ()
 Returns the threaded end chamfer offset
Created in NX5.0.2. More...
 
bool ThreadedEndChamferEnabled ()
 Returns the threaded end chamfer enabled
Created in NX5.0.2. More...
 
NXOpen::ExpressionThreadedReliefAngle ()
 Returns the relief angle - this is applicable for threaded hole type
Created in NX8.0.0. More...
 
NXOpen::ExpressionThreadedReliefChamferAngle ()
 Returns the threaded relief chamfer angle - this is applicable for threaded hole type
Created in NX8.0.0. More...
 
NXOpen::ExpressionThreadedReliefChamferOffset ()
 Returns the threaded relief chamfer offset - this is applicable for threaded hole type
Created in NX8.0.0. More...
 
NXOpen::ExpressionThreadedReliefDepth ()
 Returns the threaded relief depth - this is applicable for threaded hole type
Created in NX8.0.0. More...
 
NXOpen::ExpressionThreadedReliefDiameter ()
 Returns the relief diameter - this is applicable for threaded hole type
Created in NX8.0.0. More...
 
bool ThreadedReliefEnabled ()
 Returns the threaded relief enabled - this is applicable for threaded hole type
Created in NX8.0.0. More...
 
NXOpen::ExpressionThreadedStartChamferAngle ()
 Returns the threaded start chamfer angle
Created in NX5.0.2. More...
 
NXOpen::ExpressionThreadedStartChamferDiameter ()
 Returns the threaded start chamfer offset
Created in NX5.0.2. More...
 
bool ThreadedStartChamferEnabled ()
 Returns the threaded start chamfer enabled
Created in NX5.0.2. More...
 
NXOpen::GeometricUtilities::EndHoleData::ThreadLengthOptions ThreadLengthOption ()
 Returns the thread length option
Created in NX5.0.2. More...
 
NXOpen::GeometricUtilities::EndHoleData::ThreadRotationOptions ThreadRotation ()
 Returns the thread rotation
Created in NX5.0.2. More...
 
NXString ThreadSize ()
 Returns the thread size
Created in NX5.0.2. More...
 
NXOpen::ExpressionTipAngle ()
 Returns the tip angle
Created in NX5.0.2. More...
 
NXOpen::SelectFaceUntilSelectedTarget ()
 Returns the until selected target - this is applicable for general hole and threaded hole type
Created in NX6.0.0. 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::GeometricUtilities::EndHoleData
Created in NX5.0.2.


Member Enumeration Documentation

Represents hole form options.

Enumerator
FormOptionsScrewClearance 

Screw clearance.

FormOptionsThreaded 

Threaded hole.

FormOptionsThrough 

Through hole - This option should not be used in NX6 and later versions.

Instead of this screw_clearance option should be used

Represents hole depth limit options for threaded hole in end plate of hole series.

Enumerator
HoleDepthLimitOptionsValue 

Value limit options.

HoleDepthLimitOptionsUntilSelected 

Until selected limit options.

HoleDepthLimitOptionsUntilNext 

Until next limit options.

HoleDepthLimitOptionsThroughBody 

Through body limit options.

Represents hole depth specification options.

Enumerator
HoleDepthOptionsToCylinderBottom 

to cylinder bottom

HoleDepthOptionsToConeTip 

to cone tip

Represents thread length options.

Enumerator
ThreadLengthOptionsDiameterx1 

1 * (tap drill diameter)

ThreadLengthOptionsDiameterx15 

1.5 * (tap drill diameter)

ThreadLengthOptionsDiameterx20 

2 * (tap drill diameter)

ThreadLengthOptionsDiameterx25 

2.5 * (tap drill diameter)

ThreadLengthOptionsDiameterx30 

3 * (tap drill diameter)

ThreadLengthOptionsStandard 

Length is standard.

ThreadLengthOptionsCustom 

Length is custom.

ThreadLengthOptionsFull 

Length is full hole depth.

Represents thread rotation options.

Enumerator
ThreadRotationOptionsRight 

Right rotation.

ThreadRotationOptionsLeft 

Left rotation.

Member Function Documentation

NXOpen::GeometricUtilities::BooleanOperation* NXOpen::GeometricUtilities::EndHoleData::BooleanOperation ( )

Returns the boolean operation
Created in NX5.0.2.



License requirements : None

NXOpen::GeometricUtilities::EndHoleData::HoleDepthOptions NXOpen::GeometricUtilities::EndHoleData::DepthOption ( )

Returns the hole depth option
Created in NX11.0.0.



License requirements : None

NXString NXOpen::GeometricUtilities::EndHoleData::FitOption ( )

Returns the fit option
Created in NX5.0.2.



License requirements : None

NXOpen::GeometricUtilities::EndHoleData::FormOptions NXOpen::GeometricUtilities::EndHoleData::FormOption ( )

Returns the form option
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::HoleDepth ( )

Returns the hole depth
Created in NX5.0.2.



License requirements : None

NXOpen::GeometricUtilities::EndHoleData::HoleDepthLimitOptions NXOpen::GeometricUtilities::EndHoleData::HoleDepthLimitOption ( )

Returns the hole depth limit
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::HoleDiameter ( )

Returns the hole diameter
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::EndHoleData::MatchDimOfStartHole ( )

Returns the match dim of start hole
Created in NX5.0.2.



License requirements : None

NXString NXOpen::GeometricUtilities::EndHoleData::RadialEngageOption ( )

Returns the radial engage option
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::EndHoleData::ReliefChamferEnabled ( )

Returns the threaded relief chamfer enabled - this is applicable for threaded hole type
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ScrewClearanceEndChamferAngle ( )

Returns the screw clearance end chamfer angle
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::EndHoleData::ScrewClearanceEndChamferEnabled ( )

Returns the screw clearance end chamfer enabled
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ScrewClearanceEndChamferOffset ( )

Returns the screw clearance end chamfer offset
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ScrewClearanceStartChamferAngle ( )

Returns the screw clearance start chamfer angle
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::EndHoleData::ScrewClearanceStartChamferEnabled ( )

Returns the screw clearance start chamfer enabled
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ScrewClearanceStartChamferOffset ( )

Returns the screw clearance start chamfer offset
Created in NX5.0.2.



License requirements : None

void NXOpen::GeometricUtilities::EndHoleData::SetDepthOption ( NXOpen::GeometricUtilities::EndHoleData::HoleDepthOptions  depthOption)

Sets the hole depth option
Created in NX11.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
depthOptiondepthoption
void NXOpen::GeometricUtilities::EndHoleData::SetFitOption ( const NXString fitOption)

Sets the fit option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
fitOptionfitoption
void NXOpen::GeometricUtilities::EndHoleData::SetFitOption ( const char *  fitOption)

Sets the fit option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
fitOptionfitoption
void NXOpen::GeometricUtilities::EndHoleData::SetFormOption ( NXOpen::GeometricUtilities::EndHoleData::FormOptions  formOption)

Sets the form option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
formOptionformoption
void NXOpen::GeometricUtilities::EndHoleData::SetHoleDepthLimitOption ( NXOpen::GeometricUtilities::EndHoleData::HoleDepthLimitOptions  holeDepthLimitOption)

Sets the hole depth limit
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
holeDepthLimitOptionholedepthlimitoption
void NXOpen::GeometricUtilities::EndHoleData::SetMatchDimOfStartHole ( bool  matchDimOfStartHole)

Sets the match dim of start hole
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
matchDimOfStartHolematchdimofstarthole
void NXOpen::GeometricUtilities::EndHoleData::SetRadialEngageOption ( const NXString radialEngageOption)

Sets the radial engage option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
radialEngageOptionradialengageoption
void NXOpen::GeometricUtilities::EndHoleData::SetRadialEngageOption ( const char *  radialEngageOption)

Sets the radial engage option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
radialEngageOptionradialengageoption
void NXOpen::GeometricUtilities::EndHoleData::SetReliefChamferEnabled ( bool  reliefChamferEnabled)

Sets the threaded relief chamfer enabled - this is applicable for threaded hole type
Created in NX8.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
reliefChamferEnabledreliefchamferenabled
void NXOpen::GeometricUtilities::EndHoleData::SetScrewClearanceEndChamferEnabled ( bool  screwClearanceEndChamferEnabled)

Sets the screw clearance end chamfer enabled
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
screwClearanceEndChamferEnabledscrewclearanceendchamferenabled
void NXOpen::GeometricUtilities::EndHoleData::SetScrewClearanceStartChamferEnabled ( bool  screwClearenceStartChamferEnabled)

Sets the screw clearance start chamfer enabled
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
screwClearenceStartChamferEnabledscrewclearencestartchamferenabled
void NXOpen::GeometricUtilities::EndHoleData::SetThreadedEndChamferEnabled ( bool  threadedEndChamferEnabled)

Sets the threaded end chamfer enabled
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
threadedEndChamferEnabledthreadedendchamferenabled
void NXOpen::GeometricUtilities::EndHoleData::SetThreadedReliefEnabled ( bool  threadedReliefEnabled)

Sets the threaded relief enabled - this is applicable for threaded hole type
Created in NX8.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
threadedReliefEnabledthreadedreliefenabled
void NXOpen::GeometricUtilities::EndHoleData::SetThreadedStartChamferEnabled ( bool  threadedStartChamferEnabled)

Sets the threaded start chamfer enabled
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
threadedStartChamferEnabledthreadedstartchamferenabled
void NXOpen::GeometricUtilities::EndHoleData::SetThreadLengthOption ( NXOpen::GeometricUtilities::EndHoleData::ThreadLengthOptions  threadLengthOption)

Sets the thread length option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
threadLengthOptionthreadlengthoption
void NXOpen::GeometricUtilities::EndHoleData::SetThreadRotation ( NXOpen::GeometricUtilities::EndHoleData::ThreadRotationOptions  threadRotation)

Sets the thread rotation
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
threadRotationthreadrotation
void NXOpen::GeometricUtilities::EndHoleData::SetThreadSize ( const NXString threadSize)

Sets the thread size
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
threadSizethreadsize
void NXOpen::GeometricUtilities::EndHoleData::SetThreadSize ( const char *  threadSize)

Sets the thread size
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
threadSizethreadsize
NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::TapDrillDiameter ( )

Returns the tap drill diameter
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadDepth ( )

Returns the thread depth
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadedEndChamferAngle ( )

Returns the threaded end chamfer angle
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadedEndChamferDiameter ( )

Returns the threaded end chamfer offset
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::EndHoleData::ThreadedEndChamferEnabled ( )

Returns the threaded end chamfer enabled
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadedReliefAngle ( )

Returns the relief angle - this is applicable for threaded hole type
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadedReliefChamferAngle ( )

Returns the threaded relief chamfer angle - this is applicable for threaded hole type
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadedReliefChamferOffset ( )

Returns the threaded relief chamfer offset - this is applicable for threaded hole type
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadedReliefDepth ( )

Returns the threaded relief depth - this is applicable for threaded hole type
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadedReliefDiameter ( )

Returns the relief diameter - this is applicable for threaded hole type
Created in NX8.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::EndHoleData::ThreadedReliefEnabled ( )

Returns the threaded relief enabled - this is applicable for threaded hole type
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadedStartChamferAngle ( )

Returns the threaded start chamfer angle
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::ThreadedStartChamferDiameter ( )

Returns the threaded start chamfer offset
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::EndHoleData::ThreadedStartChamferEnabled ( )

Returns the threaded start chamfer enabled
Created in NX5.0.2.



License requirements : None

NXOpen::GeometricUtilities::EndHoleData::ThreadLengthOptions NXOpen::GeometricUtilities::EndHoleData::ThreadLengthOption ( )

Returns the thread length option
Created in NX5.0.2.



License requirements : None

NXOpen::GeometricUtilities::EndHoleData::ThreadRotationOptions NXOpen::GeometricUtilities::EndHoleData::ThreadRotation ( )

Returns the thread rotation
Created in NX5.0.2.



License requirements : None

NXString NXOpen::GeometricUtilities::EndHoleData::ThreadSize ( )

Returns the thread size
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::EndHoleData::TipAngle ( )

Returns the tip angle
Created in NX5.0.2.



License requirements : None

NXOpen::SelectFace* NXOpen::GeometricUtilities::EndHoleData::UntilSelectedTarget ( )

Returns the until selected target - this is applicable for general hole and threaded hole type
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::GeometricUtilities::EndHoleData::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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