SectionAnalysisExBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SectionAnalysisExBuilder Class

class `NXOpen.GeometricAnalysis.SectionAnalysis.``SectionAnalysisExBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExObject` builder

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

  Default values.

  Property | Value
  --- | ---
  Alignment | XYZPlane
  CalculationMethod | Curvature
  CurveAligned.IsSpacingEnabled | 0
  CurveAligned.Number | 5
  CurveAligned.Offset | 0
  CurveAligned.Spacing | 25
  CurveAligned.SpecifiedPlane.Plane | View
  CurveAligned.UseProjectedCurve | 0
  Interactive.IsCutInfiniteEnabled | 0
  IsShowInflectionPointsEnabled | 0
  IsShowLengthEnabled | 0
  IsShowPeakPointsEnabled | 0
  Isoparametric.IsSpacingEnabled | 0
  Isoparametric.IsUEnabled | 1
  Isoparametric.IsVEnabled | 1
  Isoparametric.Number | 5
  Isoparametric.Spacing | 25
  NeedleDirection | Outside
  Output | AnalysisObject
  ParallelPlanes.IsNumberEnabled | 0
  ParallelPlanes.IsSpacingEnabled | 0
  ParallelPlanes.Number | 5
  ParallelPlanes.Offset | 0
  ParallelPlanes.Spacing | 50 (millimeters part), 2 (inches part)
  Placement | Uniform
  Radial.IsSpacingEnabled | 0
  Radial.Number | 5
  Radial.Offset | 0
  Radial.RotationAxis | View
  Radial.Spacing | 72
  ScalingMethod | Linear
  XYZPlane.IsNumberEnabled | 0
  XYZPlane.IsSpacingEnabled | 0
  XYZPlane.IsXEnabled | 1
  XYZPlane.IsYEnabled | 1
  XYZPlane.IsZEnabled | 1
  XYZPlane.Number | 5
  XYZPlane.Spacing | 50 (millimeters part), 2 (inches part)

  New in version NX7.0.0.

# Properties

Property | Description
--- | ---
Alignment | Returns or sets the alignment type
CalculationMethod | Returns or sets the calculation method
CombOptions | Returns the comb options specification
CurveAligned | Returns the Curve Aligned section specification.
Interactive | Returns the Interactive placement specification.
IsShowInflectionPointsEnabled | Returns or sets a value indicating whether to show the inflection points
IsShowLengthEnabled | Returns or sets a value indicating whether to show the length of each section curve
IsShowPeakPointsEnabled | Returns or sets a value indicating whether to show the peak points
Isoparametric | Returns the Isoparametric section specification.
NeedleDirection | Returns or sets the needle direction
Output | Returns or sets the output
ParallelPlanes | Returns the Parallel Planes section specification.
Placement | Returns or sets the placement
Radial | Returns the Radial section specification.
ScalingMethod | Returns or sets the scaling method
SelectObject | Returns the selected objects
SpecifyPoint | Returns the specified points
Tag | Returns the Tag for this object.
XYZPlane | Returns the XYZ Planes section specification.

# 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.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

SectionAnalysisExBuilderAlignmentType Enumeration | The section alignment type
SectionAnalysisExBuilderCalculationMethodType Enumeration | The calculation method
SectionAnalysisExBuilderNeedleDirectionType Enumeration | The needle direction
SectionAnalysisExBuilderOutputType Enumeration | The output options
SectionAnalysisExBuilderPlacementType Enumeration | The types of the section placement
SectionAnalysisExBuilderScalingMethodType Enumeration | The scaling method

# Property Detail

## Alignment

`SectionAnalysisExBuilder.``Alignment`

  Returns or sets the alignment type

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

  Getter Method

  Signature `Alignment`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderAlignmentType`

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Alignment`

  Parameters: | alignment (`NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderAlignmentType`) –

  New in version NX7.0.0.

  License requirements: studio_analyze (“STUDIO ANALYZE”)

## CalculationMethod

`SectionAnalysisExBuilder.``CalculationMethod`

  Returns or sets the calculation method

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

  Getter Method

  Signature `CalculationMethod`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderCalculationMethodType`

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CalculationMethod`

  Parameters: | calculationMethod (`NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderCalculationMethodType`) –

  New in version NX7.0.0.

  License requirements: studio_analyze (“STUDIO ANALYZE”)

## CombOptions

`SectionAnalysisExBuilder.``CombOptions`

  Returns the comb options specification

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

  Getter Method

  Signature `CombOptions`

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

  New in version NX7.0.0.

  License requirements: None.

## CurveAligned

`SectionAnalysisExBuilder.``CurveAligned`

  Returns the Curve Aligned section specification.

  Only used when type is `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderAlignmentType.CurveAligned`

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

  Getter Method

  Signature `CurveAligned`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.CurveAlignedBuilder`

  New in version NX7.0.0.

  License requirements: None.

## Interactive

`SectionAnalysisExBuilder.``Interactive`

  Returns the Interactive placement specification.

  Only used when type is `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderPlacementType.Interactive`

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

  Getter Method

  Signature `Interactive`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.InteractiveBuilder`

  New in version NX7.0.0.

  License requirements: None.

## IsShowInflectionPointsEnabled

`SectionAnalysisExBuilder.``IsShowInflectionPointsEnabled`

  Returns or sets a value indicating whether to show the inflection points

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

  Getter Method

  Signature `IsShowInflectionPointsEnabled`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsShowInflectionPointsEnabled`

  Parameters: | inflection (bool) –

  New in version NX7.0.0.

  License requirements: studio_analyze (“STUDIO ANALYZE”)

## IsShowLengthEnabled

`SectionAnalysisExBuilder.``IsShowLengthEnabled`

  Returns or sets a value indicating whether to show the length of each section curve

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

  Getter Method

  Signature `IsShowLengthEnabled`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsShowLengthEnabled`

  Parameters: | length (bool) –

  New in version NX7.0.0.

  License requirements: studio_analyze (“STUDIO ANALYZE”)

## IsShowPeakPointsEnabled

`SectionAnalysisExBuilder.``IsShowPeakPointsEnabled`

  Returns or sets a value indicating whether to show the peak points

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

  Getter Method

  Signature `IsShowPeakPointsEnabled`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsShowPeakPointsEnabled`

  Parameters: | peak (bool) –

  New in version NX7.0.0.

  License requirements: studio_analyze (“STUDIO ANALYZE”)

## Isoparametric

`SectionAnalysisExBuilder.``Isoparametric`

  Returns the Isoparametric section specification.

  Only used when type is `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderAlignmentType.Isoparametric`

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

  Getter Method

  Signature `Isoparametric`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.IsoparametricBuilder`

  New in version NX7.0.0.

  License requirements: None.

## NeedleDirection

`SectionAnalysisExBuilder.``NeedleDirection`

  Returns or sets the needle direction

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

  Getter Method

  Signature `NeedleDirection`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderNeedleDirectionType`

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NeedleDirection`

  Parameters: | needleDirection (`NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderNeedleDirectionType`) –

  New in version NX7.0.0.

  License requirements: studio_analyze (“STUDIO ANALYZE”)

## Output

`SectionAnalysisExBuilder.``Output`

  Returns or sets the output

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

  Getter Method

  Signature `Output`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderOutputType`

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Output`

  Parameters: | output (`NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderOutputType`) –

  New in version NX7.0.0.

  License requirements: studio_analyze (“STUDIO ANALYZE”)

## ParallelPlanes

`SectionAnalysisExBuilder.``ParallelPlanes`

  Returns the Parallel Planes section specification.

  Only used when type is `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderAlignmentType.ParallelPlanes`

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

  Getter Method

  Signature `ParallelPlanes`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.ParallelPlanesExBuilder`

  New in version NX7.0.0.

  License requirements: None.

## Placement

`SectionAnalysisExBuilder.``Placement`

  Returns or sets the placement

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

  Getter Method

  Signature `Placement`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderPlacementType`

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Placement`

  Parameters: | placement (`NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderPlacementType`) –

  New in version NX7.0.0.

  License requirements: studio_analyze (“STUDIO ANALYZE”)

## Radial

`SectionAnalysisExBuilder.``Radial`

  Returns the Radial section specification.

  Only used when type is `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderAlignmentType.CurveAligned`

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

  Getter Method

  Signature `Radial`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.RadialBuilder`

  New in version NX7.0.0.

  License requirements: None.

## ScalingMethod

`SectionAnalysisExBuilder.``ScalingMethod`

  Returns or sets the scaling method

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

  Getter Method

  Signature `ScalingMethod`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderScalingMethodType`

  New in version NX7.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ScalingMethod`

  Parameters: | scalingMethod (`NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderScalingMethodType`) –

  New in version NX7.0.0.

  License requirements: studio_analyze (“STUDIO ANALYZE”)

## SelectObject

`SectionAnalysisExBuilder.``SelectObject`

  Returns the selected objects

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

  Getter Method

  Signature `SelectObject`

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

  New in version NX7.0.0.

  License requirements: None.

## SpecifyPoint

`SectionAnalysisExBuilder.``SpecifyPoint`

  Returns the specified points

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

  Getter Method

  Signature `SpecifyPoint`

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

  New in version NX7.0.0.

  License requirements: None.

## XYZPlane

`SectionAnalysisExBuilder.``XYZPlane`

  Returns the XYZ Planes section specification.

  Only used when type is `NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilderAlignmentType.XYZPlane`

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

  Getter Method

  Signature `XYZPlane`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SectionAnalysis.XYZPlaneBuilder`

  New in version NX7.0.0.

  License requirements: None.

# Method Detail

## Validate

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