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

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

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

Public Types

enum  HoleForms { HoleFormsSimple, HoleFormsCounterbored, HoleFormsCountersink }
 This enum represents hole form options in start plate of hole series. More...
 

Public Member Functions

NXOpen::GeometricUtilities::BooleanOperationBooleanOperation ()
 Returns the boolean operation
Created in NX5.0.2. More...
 
NXOpen::ExpressionCounterboreDepth ()
 Returns the counterbore depth
Created in NX5.0.2. More...
 
NXOpen::ExpressionCounterboreDiameter ()
 Returns the counterbore diameter
Created in NX5.0.2. More...
 
NXOpen::ExpressionCountersinkAngle ()
 Returns the countersink angle
Created in NX5.0.2. More...
 
NXOpen::ExpressionCountersinkDiameter ()
 Returns the countersink diameter
Created in NX5.0.2. More...
 
NXOpen::ExpressionEndChamferAngle ()
 Returns the end chamfer angle
Created in NX5.0.2. More...
 
bool EndChamferEnabled ()
 Returns the end chamfer enabled
Created in NX5.0.2. More...
 
NXOpen::ExpressionEndChamferOffset ()
 Returns the end chamfer offset
Created in NX5.0.2. More...
 
NXString FitOption ()
 Returns the fit option
Created in NX5.0.2. More...
 
NXOpen::ExpressionHoleDiameter ()
 Returns the hole diameter
Created in NX5.0.2. More...
 
NXOpen::GeometricUtilities::StartHoleData::HoleForms HoleForm ()
 Returns the hole form
Created in NX5.0.2. More...
 
NXOpen::ExpressionNeckChamferAngle ()
 Returns the neck chamfer angle
Created in NX5.0.2. More...
 
bool NeckChamferEnabled ()
 Returns the neck chamfer enabled
Created in NX5.0.2. More...
 
NXOpen::ExpressionNeckChamferOffset ()
 Returns the neck chamfer offset
Created in NX5.0.2. More...
 
NXOpen::ExpressionReliefDepth ()
 Returns the relief depth
Created in NX5.0.2. More...
 
bool ReliefEnabled ()
 Returns the relief enabled
Created in NX5.0.2. More...
 
NXString ScrewSize ()
 Returns the screw size
Created in NX5.0.2. More...
 
NXString ScrewType ()
 Returns the screw type
Created in NX5.0.2. More...
 
void SetEndChamferEnabled (bool endChamferEnabled)
 Sets the end chamfer enabled
Created in NX5.0.2. 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 SetHoleForm (NXOpen::GeometricUtilities::StartHoleData::HoleForms holeForm)
 Sets the hole form
Created in NX5.0.2. More...
 
void SetNeckChamferEnabled (bool neckChamferEnabled)
 Sets the neck chamfer enabled
Created in NX5.0.2. More...
 
void SetReliefEnabled (bool reliefEnabled)
 Sets the relief enabled
Created in NX5.0.2. More...
 
void SetScrewSize (const NXString &screwSize)
 Sets the screw size
Created in NX5.0.2. More...
 
void SetScrewSize (const char *screwSize)
 Sets the screw size
Created in NX5.0.2. More...
 
void SetScrewType (const NXString &screwType)
 Sets the screw type
Created in NX5.0.2. More...
 
void SetScrewType (const char *screwType)
 Sets the screw type
Created in NX5.0.2. More...
 
void SetStartChamferEnabled (bool startChamferEnabled)
 Sets the start chamfer enabled
Created in NX5.0.2. More...
 
NXOpen::ExpressionStartChamferAngle ()
 Returns the start chamfer angle
Created in NX5.0.2. More...
 
bool StartChamferEnabled ()
 Returns the start chamfer enabled
Created in NX5.0.2. More...
 
NXOpen::ExpressionStartChamferOffset ()
 Returns the start chamfer offset
Created in NX5.0.2. 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::StartHoleData
Created in NX5.0.2.


Member Enumeration Documentation

This enum represents hole form options in start plate of hole series.

Enumerator
HoleFormsSimple 

Simple hole form.

HoleFormsCounterbored 

Counterbored hole form.

HoleFormsCountersink 

Countersink hole form.

Member Function Documentation

NXOpen::GeometricUtilities::BooleanOperation* NXOpen::GeometricUtilities::StartHoleData::BooleanOperation ( )

Returns the boolean operation
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::CounterboreDepth ( )

Returns the counterbore depth
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::CounterboreDiameter ( )

Returns the counterbore diameter
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::CountersinkAngle ( )

Returns the countersink angle
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::CountersinkDiameter ( )

Returns the countersink diameter
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::EndChamferAngle ( )

Returns the end chamfer angle
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::StartHoleData::EndChamferEnabled ( )

Returns the end chamfer enabled
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::EndChamferOffset ( )

Returns the end chamfer offset
Created in NX5.0.2.



License requirements : None

NXString NXOpen::GeometricUtilities::StartHoleData::FitOption ( )

Returns the fit option
Created in NX5.0.2.



License requirements : None

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

Returns the hole diameter
Created in NX5.0.2.



License requirements : None

NXOpen::GeometricUtilities::StartHoleData::HoleForms NXOpen::GeometricUtilities::StartHoleData::HoleForm ( )

Returns the hole form
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::NeckChamferAngle ( )

Returns the neck chamfer angle
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::StartHoleData::NeckChamferEnabled ( )

Returns the neck chamfer enabled
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::NeckChamferOffset ( )

Returns the neck chamfer offset
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::ReliefDepth ( )

Returns the relief depth
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::StartHoleData::ReliefEnabled ( )

Returns the relief enabled
Created in NX5.0.2.



License requirements : None

NXString NXOpen::GeometricUtilities::StartHoleData::ScrewSize ( )

Returns the screw size
Created in NX5.0.2.



License requirements : None

NXString NXOpen::GeometricUtilities::StartHoleData::ScrewType ( )

Returns the screw type
Created in NX5.0.2.



License requirements : None

void NXOpen::GeometricUtilities::StartHoleData::SetEndChamferEnabled ( bool  endChamferEnabled)

Sets the end chamfer enabled
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
endChamferEnabledendchamferenabled
void NXOpen::GeometricUtilities::StartHoleData::SetFitOption ( const NXString fitOption)

Sets the fit option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

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

Sets the fit option
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
fitOptionfitoption
void NXOpen::GeometricUtilities::StartHoleData::SetHoleForm ( NXOpen::GeometricUtilities::StartHoleData::HoleForms  holeForm)

Sets the hole form
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
holeFormholeform
void NXOpen::GeometricUtilities::StartHoleData::SetNeckChamferEnabled ( bool  neckChamferEnabled)

Sets the neck chamfer enabled
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
neckChamferEnabledneckchamferenabled
void NXOpen::GeometricUtilities::StartHoleData::SetReliefEnabled ( bool  reliefEnabled)

Sets the relief enabled
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
reliefEnabledreliefenabled
void NXOpen::GeometricUtilities::StartHoleData::SetScrewSize ( const NXString screwSize)

Sets the screw size
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
screwSizescrewsize
void NXOpen::GeometricUtilities::StartHoleData::SetScrewSize ( const char *  screwSize)

Sets the screw size
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
screwSizescrewsize
void NXOpen::GeometricUtilities::StartHoleData::SetScrewType ( const NXString screwType)

Sets the screw type
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
screwTypescrewtype
void NXOpen::GeometricUtilities::StartHoleData::SetScrewType ( const char *  screwType)

Sets the screw type
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
screwTypescrewtype
void NXOpen::GeometricUtilities::StartHoleData::SetStartChamferEnabled ( bool  startChamferEnabled)

Sets the start chamfer enabled
Created in NX5.0.2.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
startChamferEnabledstartchamferenabled
NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::StartChamferAngle ( )

Returns the start chamfer angle
Created in NX5.0.2.



License requirements : None

bool NXOpen::GeometricUtilities::StartHoleData::StartChamferEnabled ( )

Returns the start chamfer enabled
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::StartHoleData::StartChamferOffset ( )

Returns the start chamfer offset
Created in NX5.0.2.



License requirements : None

virtual bool NXOpen::GeometricUtilities::StartHoleData::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.