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

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

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

List of all members.

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

Detailed Description

Represents a 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 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

Returns the boolean operation
Created in NX5.0.2.



License requirements : None

Returns the fit option
Created in NX5.0.2.



License requirements : None

Returns the form option
Created in NX5.0.2.



License requirements : None

Returns the hole depth
Created in NX5.0.2.



License requirements : None

Returns the hole depth limit
Created in NX5.0.2.



License requirements : None

Returns the hole diameter
Created in NX5.0.2.



License requirements : None

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



License requirements : None

Returns the radial engage option
Created in NX5.0.2.



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Sets the fit option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
fitOptionfitoption

Sets the form option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
formOptionformoption

Sets the hole depth limit
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
holeDepthLimitOptionholedepthlimitoption

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
matchDimOfStartHolematchdimofstarthole

Sets the radial engage option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
radialEngageOptionradialengageoption

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

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
screwClearanceEndChamferEnabledscrewclearanceendchamferenabled

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
screwClearenceStartChamferEnabledscrewclearencestartchamferenabled

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
threadedEndChamferEnabledthreadedendchamferenabled

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

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
threadedStartChamferEnabledthreadedstartchamferenabled

Sets the thread length option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
threadLengthOptionthreadlengthoption

Sets the thread rotation
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
threadRotationthreadrotation

Sets the thread size
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
threadSizethreadsize

Returns the tap drill diameter
Created in NX5.0.2.



License requirements : None

Returns the thread depth
Created in NX5.0.2.



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the thread length option
Created in NX5.0.2.



License requirements : None

Returns the thread rotation
Created in NX5.0.2.



License requirements : None

Returns the thread size
Created in NX5.0.2.



License requirements : None

Returns the tip angle
Created in NX5.0.2.



License requirements : None

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



License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.