NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAM::FBM::ThreadFeatureGeometry Class Reference

Represents a feature geometry builder
This is an abstract class and cannot be instantiated. More...

Inheritance diagram for NXOpen::CAM::FBM::ThreadFeatureGeometry:
NXOpen::CAM::FBM::FeatureGeometry NXOpen::CAM::Geometry NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Form {
  FormUnified, FormAcme, FormStubAcme, FormButtress = 4,
  FormMetric, FormTrapezoidal = 8, FormLowernherz, FormSparkPlug,
  FormNpt, FormHoseCoupling, FormFireHose, FormUnj,
  FormNps, FormBsp, FormBstp, FormHelicoil,
  FormNs, FormUserDefined
}
 Thread form standards
Created in NX9.0.2. More...
 
enum  Rotation { RotationRightHand, RotationLeftHand }
 the rotation types
Created in NX9.0.2. More...
 
enum  ThreadDataSource { ThreadDataSourceFromModel, ThreadDataSourceFromTable }
 thread data source types
Created in NX9.0.1. More...
 
- Public Types inherited from NXOpen::CAM::FBM::FeatureGeometry
enum  SequenceDirectionType { SequenceDirectionTypeXm, SequenceDirectionTypeYm, SequenceDirectionTypeZm, SequenceDirectionTypeVector }
 the direction types
Created in NX9.0.2. More...
 
enum  SequencePatternType { SequencePatternTypeZig, SequencePatternTypeZigZag }
 the pattern types
Created in NX9.0.2. More...
 
enum  SortOrder { SortOrderClosest, SortOrderShortestPath, SortOrderPrimaryDirection }
 the optimization types
Created in NX9.0.1. More...
 

Public Member Functions

NXOpen::CAM::FBM::ThreadFeatureGeometry::Form FormStandard ()
 Returns the form standard
Created in NX9.0.2. More...
 
NXString GetFormUserDefined ()
 Get the user defined form standard. More...
 
NXOpen::CAM::FBM::ThreadFeatureGeometry::ThreadDataSource GetThreadDataSource ()
 Gets the source type for retrieving thread data. More...
 
void SetFormStandard (NXOpen::CAM::FBM::ThreadFeatureGeometry::Form standard)
 Sets the form standard
Created in NX9.0.2. More...
 
void SetFormUserDefined (const NXString &userDefinedForm)
 Set the user defined form standard
Created in NX9.0.2. More...
 
void SetFormUserDefined (const char *userDefinedForm)
 Set the user defined form standard
Created in NX9.0.2. More...
 
void SetThreadDataSource (NXOpen::CAM::FBM::ThreadFeatureGeometry::ThreadDataSource source)
 Sets the source type for retrieving thread data
Created in NX9.0.1. More...
 
void SetThreadRotation (NXOpen::CAM::FBM::ThreadFeatureGeometry::Rotation rotation)
 Sets the thread rotation
Created in NX9.0.2. More...
 
NXOpen::CAM::FBM::ThreadFeatureGeometry::Rotation ThreadRotation ()
 Returns the thread rotation
Created in NX9.0.2. More...
 
void UpdateThreadParameters (NXOpen::CAM::FBM::Feature *tagFeature)
 Update the feature thread parameters
Created in NX9.0.2. More...
 
- Public Member Functions inherited from NXOpen::CAM::FBM::FeatureGeometry
NXOpen::CAM::FBM::FeatureSetAddFeatureSet (NXOpen::CAM::CAMFeature *tagMachiningFeature, const NXString &featureType)
 Creates a feature geometry set. More...
 
NXOpen::CAM::FBM::FeatureSetAddFeatureSet (NXOpen::CAM::CAMFeature *tagMachiningFeature, const char *featureType)
 Creates a feature geometry set. More...
 
std::vector
< NXOpen::CAM::FBM::Feature * > 
CreateFeatures (const std::vector< NXOpen::NXObject * > &objects, const NXString &featureType)
 Create a series of (in process) features. More...
 
std::vector
< NXOpen::CAM::FBM::Feature * > 
CreateFeatures (const std::vector< NXOpen::NXObject * > &objects, const char *featureType)
 Create a series of (in process) features. More...
 
NXOpen::CAM::FBM::FeatureSetCreateFeatureSet ()
 Create a new empty feature editor. More...
 
NXOpen::CAM::FBM::FeatureSetGetFeatureSet (int nIndex)
 Get the in process feature editor at the specified index. More...
 
NXString GetMachiningArea ()
 Returns the machining area. More...
 
void ReloadList ()
 Reload list from parent
Created in NX9.0.2. More...
 
void ReorderFeatures (NXOpen::CAM::FBM::FeatureGeometry::SortOrder sortType)
 Reorders the features according to a predefined algorithm
Created in NX9.0.1. More...
 
void ReorderFeaturesByDirection (NXOpen::CAM::FBM::FeatureGeometry::SequenceDirectionType direction, NXOpen::CAM::FBM::FeatureGeometry::SequencePatternType pattern, const NXOpen::Vector3d &vecValue)
 Reorders the features according to primary direction
Created in NX9.0.2. More...
 
void ReorderFeaturesByDirection (NXOpen::CAM::FBM::FeatureGeometry::SequenceDirectionType direction, NXOpen::CAM::FBM::FeatureGeometry::SequencePatternType pattern, const NXOpen::Vector3d &vecValue, double bandWidth)
 Reorders the features according to primary direction with band width
Created in NX9.0.3. More...
 
void ReverseFeatures ()
 Reverse the features
Created in NX9.0.2. More...
 
void SetDefaultAttribute (const NXString &attributeName, double dValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const char *attributeName, double dValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const NXString &attributeName, const NXString &strValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const char *attributeName, const char *strValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const NXString &attributeName, int nValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const char *attributeName, int nValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const NXString &attributeName, bool bValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const char *attributeName, bool bValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetMachiningArea (const NXString &machiningArea)
 Change machining area
Created in NX9.0.2. More...
 
void SetMachiningArea (const char *machiningArea)
 Change machining area
Created in NX9.0.2. More...
 
void SetUseModelDepth (bool flag)
 Sets the use model depth flag
Created in NX11.0.2. More...
 
bool UseModelDepth ()
 Returns the use model depth flag
Created in NX11.0.2. More...
 
- Public Member Functions inherited from NXOpen::CAM::Geometry
NXOpen::CAM::GeometrySetAppendGeometrySet (NXOpen::CAM::GeometrySet *templateSet, const std::vector< NXOpen::DisplayableObject * > &entities)
 Append an geometry set with dumb rules. More...
 
void AppendNamedGeometry (const std::vector< NXOpen::ScCollector * > &namedGeometry)
 Append named geometry
Created in NX9.0.3. More...
 
NXOpen::CAM::GeometrySetCreateGeometrySet ()
 Create an empty geometry set. More...
 
void ExpandSets (const std::vector< NXOpen::CAM::GeometrySet * > &sets)
 Expanding the geometry sets
Created in NX8.0.0. More...
 
NXOpen::CAM::GeometrySetListGeometryList ()
 Returns the geometry list
Created in NX8.0.0. More...
 
void InitializeData (bool reloadGeometry)
 Prepare and update geometry data
Created in NX8.0.0. More...
 
void PreselectGeometry ()
 Pre-select the wall geometry
Created in NX8.0.0. More...
 
NXOpen::CAM::TopologyTopology ()
 Returns the topology builder
Created in NX8.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 feature geometry builder
This is an abstract class and cannot be instantiated.



Created in NX9.0.1.

Member Enumeration Documentation

Thread form standards
Created in NX9.0.2.


Enumerator
FormUnified 

Form: Unified.

FormAcme 

Form: Acme.

FormStubAcme 

Form: Stub Acme.

FormButtress 

Form: Buttress.

FormMetric 

Form: Metric.

FormTrapezoidal 

Form: Trapezoidal.

FormLowernherz 

Form: Lowenherz.

FormSparkPlug 

Form: Spark Plug.

FormNpt 

Form: NPT.

FormHoseCoupling 

Form: Hose Coupling.

FormFireHose 

Form: Fire Hose.

FormUnj 

Form: UNJ.

FormNps 

Form: NPS.

FormBsp 

Form: BSP.

FormBstp 

Form: BSTP.

FormHelicoil 

Form: Helicoil.

FormNs 

Form: NS.

FormUserDefined 

Form: User defined.

the rotation types
Created in NX9.0.2.


Enumerator
RotationRightHand 

Rotation: Right-hand.

RotationLeftHand 

Rotation: Left-hand.

thread data source types
Created in NX9.0.1.


Enumerator
ThreadDataSourceFromModel 

From Model.

ThreadDataSourceFromTable 

From Table.

Member Function Documentation

NXOpen::CAM::FBM::ThreadFeatureGeometry::Form NXOpen::CAM::FBM::ThreadFeatureGeometry::FormStandard ( )

Returns the form standard
Created in NX9.0.2.



License requirements : None

NXString NXOpen::CAM::FBM::ThreadFeatureGeometry::GetFormUserDefined ( )

Get the user defined form standard.

Returns

Created in NX9.0.2.

License requirements : None
NXOpen::CAM::FBM::ThreadFeatureGeometry::ThreadDataSource NXOpen::CAM::FBM::ThreadFeatureGeometry::GetThreadDataSource ( )

Gets the source type for retrieving thread data.

Returns
thread data source type
Created in NX9.0.1.

License requirements : None
void NXOpen::CAM::FBM::ThreadFeatureGeometry::SetFormStandard ( NXOpen::CAM::FBM::ThreadFeatureGeometry::Form  standard)

Sets the form standard
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
standardform standard
void NXOpen::CAM::FBM::ThreadFeatureGeometry::SetFormUserDefined ( const NXString userDefinedForm)

Set the user defined form standard
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
userDefinedFormuserdefinedform
void NXOpen::CAM::FBM::ThreadFeatureGeometry::SetFormUserDefined ( const char *  userDefinedForm)

Set the user defined form standard
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
userDefinedFormuserdefinedform
void NXOpen::CAM::FBM::ThreadFeatureGeometry::SetThreadDataSource ( NXOpen::CAM::FBM::ThreadFeatureGeometry::ThreadDataSource  source)

Sets the source type for retrieving thread data
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
sourcethread data source type
void NXOpen::CAM::FBM::ThreadFeatureGeometry::SetThreadRotation ( NXOpen::CAM::FBM::ThreadFeatureGeometry::Rotation  rotation)

Sets the thread rotation
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
rotationthread rotation
NXOpen::CAM::FBM::ThreadFeatureGeometry::Rotation NXOpen::CAM::FBM::ThreadFeatureGeometry::ThreadRotation ( )

Returns the thread rotation
Created in NX9.0.2.



License requirements : None

void NXOpen::CAM::FBM::ThreadFeatureGeometry::UpdateThreadParameters ( NXOpen::CAM::FBM::Feature tagFeature)

Update the feature thread parameters
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
tagFeaturetagfeature

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