ThreadFeatureGeometry Class — NXOpen Python API Reference 12.0.0 documentation

# ThreadFeatureGeometry Class

class `NXOpen.CAM.FBM.``ThreadFeatureGeometry`

  Bases: `NXOpen.CAM.FBM.FeatureGeometry`

  Represents a feature geometry builder

  This is an abstract class and cannot be instantiated.

  New in version NX9.0.1.

# Properties

Property | Description
--- | ---
FormStandard | Returns or sets the form standard
GeometryList | Returns the geometry list
Tag | Returns the Tag for this object.
ThreadRotation | Returns or sets the thread rotation
Topology | Returns the topology builder
UseModelDepth | Returns or sets the use model depth flag

# Methods

Method | Description
--- | ---
AddFeatureSet | Creates a feature geometry set
AppendGeometrySet | Append an geometry set with dumb rules
AppendNamedGeometry | Append named geometry
CreateFeatureSet | Create a new empty feature editor
CreateFeatures | Create a series of (in process) features.
CreateGeometrySet | Create an empty geometry set
ExpandSets | Expanding the geometry sets
GetFeatureSet | Get the in process feature editor at the specified index
GetFormUserDefined | Get the user defined form standard
GetMachiningArea | Returns the machining area
GetThreadDataSource | Gets the source type for retrieving thread data
InitializeData | Prepare and update geometry data
PreselectGeometry | Pre-select the wall geometry
ReloadList | Reload list from parent
ReorderFeatures | Reorders the features according to a predefined algorithm
ReorderFeaturesByDirection | Reorders the features according to primary direction
ReverseFeatures | Reverse the features
SetDefaultAttribute | Sets a default attribute value
SetFormUserDefined | Set the user defined form standard
SetMachiningArea | Change machining area
SetThreadDataSource | Sets the source type for retrieving thread data
UpdateThreadParameters | Update the feature thread parameters
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

ThreadFeatureGeometryForm Enumeration | Thread form standards
ThreadFeatureGeometryRotation Enumeration | the rotation types
ThreadFeatureGeometryThreadDataSource Enumeration | thread data source types

# Property Detail

## FormStandard

`ThreadFeatureGeometry.``FormStandard`

  Returns or sets the form standard

  `-------------------------------------`

  Getter Method

  Signature `FormStandard`

  Returns: | form standard
  Return type: | `NXOpen.CAM.FBM.ThreadFeatureGeometryForm`

  New in version NX9.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FormStandard`

  Parameters: | standard (`NXOpen.CAM.FBM.ThreadFeatureGeometryForm`) – form standard

  New in version NX9.0.2.

  License requirements: cam_base (“CAM BASE”)

## ThreadRotation

`ThreadFeatureGeometry.``ThreadRotation`

  Returns or sets the thread rotation

  `-------------------------------------`

  Getter Method

  Signature `ThreadRotation`

  Returns: | thread rotation
  Return type: | `NXOpen.CAM.FBM.ThreadFeatureGeometryRotation`

  New in version NX9.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ThreadRotation`

  Parameters: | rotation (`NXOpen.CAM.FBM.ThreadFeatureGeometryRotation`) – thread rotation

  New in version NX9.0.2.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## GetFormUserDefined

`ThreadFeatureGeometry.``GetFormUserDefined`

  Get the user defined form standard

  Signature `GetFormUserDefined()`

  Returns: |
  Return type: | str

  New in version NX9.0.2.

  License requirements: None.

## GetThreadDataSource

`ThreadFeatureGeometry.``GetThreadDataSource`

  Gets the source type for retrieving thread data

  Signature `GetThreadDataSource()`

  Returns: | thread data source type
  Return type: | `NXOpen.CAM.FBM.ThreadFeatureGeometryThreadDataSource`

  New in version NX9.0.1.

  License requirements: None.

## SetFormUserDefined

`ThreadFeatureGeometry.``SetFormUserDefined`

  Set the user defined form standard

  Signature `SetFormUserDefined(userDefinedForm)`

  Parameters: | userDefinedForm (str) –

  New in version NX9.0.2.

  License requirements: cam_base (“CAM BASE”)

## SetThreadDataSource

`ThreadFeatureGeometry.``SetThreadDataSource`

  Sets the source type for retrieving thread data

  Signature `SetThreadDataSource(source)`

  Parameters: | source (`NXOpen.CAM.FBM.ThreadFeatureGeometryThreadDataSource`) – thread data source type

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

## UpdateThreadParameters

`ThreadFeatureGeometry.``UpdateThreadParameters`

  Update the feature thread parameters

  Signature `UpdateThreadParameters(tagFeature)`

  Parameters: | tagFeature (`NXOpen.CAM.FBM.Feature`) –

  New in version NX9.0.2.

  License requirements: cam_base (“CAM BASE”)

## Validate

`ThreadFeatureGeometry.``Validate`

  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.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.