CurveAnalysisCombsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CurveAnalysisCombsBuilder Class

class `NXOpen.GeometricAnalysis.``CurveAnalysisCombsBuilder`

  Bases: `NXOpen.Builder`

  This class handles the options setting for the curve analysis information (Curvature Combs) display.

  To create a new instance of this class, use `NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateCurveAnalysisCombsBuilder()`

  Default values.

  Property | Value
  --- | ---
  CurveRange.AnchorPosition | Start

  New in version NX6.0.0.

  Deprecated since version NX8.5.0: Use `NXOpen.GeometricAnalysis.CurveCurvatureAnalysis`.

# Properties

Property | Description
--- | ---
CombOptions | Returns the comb options
CurveRange | Returns the curve range
DirectionOption | Returns or sets the direction option
SelectedCurves | Returns the selected curves
Tag | Returns the Tag for this object.
Vector | Returns or sets the vector

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateCurves | This method should be called after the selected curves have changed
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

CurveAnalysisCombsBuilderDirectionOptionType Enumeration | Direction option types

# Property Detail

## CombOptions

`CurveAnalysisCombsBuilder.``CombOptions`

  Returns the comb options

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

  Getter Method

  Signature `CombOptions`

  Returns: | comb options
  Return type: | `NXOpen.GeometricUtilities.CombOptionsBuilder`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CurveRange

`CurveAnalysisCombsBuilder.``CurveRange`

  Returns the curve range

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

  Getter Method

  Signature `CurveRange`

  Returns: | curve range
  Return type: | `NXOpen.GeometricUtilities.CurveRangeBuilder`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## DirectionOption

`CurveAnalysisCombsBuilder.``DirectionOption`

  Returns or sets the direction option

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

  Getter Method

  Signature `DirectionOption`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.CurveAnalysisCombsBuilderDirectionOptionType`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

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

  Setter Method

  Signature `DirectionOption`

  Parameters: | option (`NXOpen.GeometricAnalysis.CurveAnalysisCombsBuilderDirectionOptionType`) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SelectedCurves

`CurveAnalysisCombsBuilder.``SelectedCurves`

  Returns the selected curves

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

  Getter Method

  Signature `SelectedCurves`

  Returns: |
  Return type: | `NXOpen.ScCollector`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Vector

`CurveAnalysisCombsBuilder.``Vector`

  Returns or sets the vector

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

  Getter Method

  Signature `Vector`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

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

  Setter Method

  Signature `Vector`

  Parameters: | vect (`NXOpen.Direction`) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## UpdateCurves

`CurveAnalysisCombsBuilder.``UpdateCurves`

  This method should be called after the selected curves have changed

  Signature `UpdateCurves()`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

`CurveAnalysisCombsBuilder.``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.