SectionInertiaAnalysisBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SectionInertiaAnalysisBuilder Class

class `NXOpen.Features.``SectionInertiaAnalysisBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.SectionInertiaAnalysis` builder

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateSectionInertiaAnalysisBuilder()`

  Default values.

  Property | Value
  --- | ---
  AnnoLayer | 101
  CenterOfGravity | True
  DatumPlaneLayer | 101
  DatumPlanes | False
  NSection | 5
  PrincipalAxes | False
  RectangleLayer | 101
  RectangularSection | False
  SecondPrincipleMi | True
  SectionArea | True
  SectionLayer | 101
  SectionLength | True
  Sections | False
  ShearCenter | False

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AnnoLayer | Returns or sets the anno layer
CSys | Returns or sets the c sys
CenterOfGravity | Returns or sets the center of gravity
CurveCollector | Returns the curve collector
DatumPlaneLayer | Returns or sets the datum plane layer
DatumPlanes | Returns or sets the datum planes
Distance | Returns the distance
FaceCollector | Returns the face collector
MassPropertyType | Returns or sets the mass property type
NSection | Returns or sets the n section
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
PathCollector | Returns the path collector
PrincipalAxes | Returns or sets the principal axes
RectangleLayer | Returns or sets the rectangle layer
RectangularSection | Returns or sets the rectangular section
SecondPrincipleMi | Returns or sets the second principle mi
SectionArea | Returns or sets the section area
SectionLayer | Returns or sets the section layer
SectionLength | Returns or sets the section length
SectionNormal | Returns or sets the section normal
SectioningMethod | Returns or sets the sectioning method
Sections | Returns or sets the sections
ShearCenter | Returns or sets the shear center
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Thickness | Returns the thickness.
Type | Returns or sets the analysis
Units | Returns or sets the units for calculations
ValidityFlag | Returns or sets the validity flag.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAnnotation | The annotations generated can be accessed using this method.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
IsTempGraphics | The function checks if temporary graphics was generated.
RefreshScreen | The function refreshes the graphic screen if any temporary graphics was previously generated by this command.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInfo | The function displays the information box with information about the section intertia analysis performed.
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

SectionInertiaAnalysisBuilderCoordSys Enumeration | The coordinate system associated with the analysis.
SectionInertiaAnalysisBuilderPropertyType Enumeration | Type of Analysis property.
SectionInertiaAnalysisBuilderSampleMethod Enumeration | Type of sampling method to be used in sections along curve type of analysis.
SectionInertiaAnalysisBuilderSectionAxisNormal Enumeration | Slice direction in case of parallel section type of analysis.
SectionInertiaAnalysisBuilderTypes Enumeration | The type of Section Inertia Analysis to be performed.

# Property Detail

## AnnoLayer

`SectionInertiaAnalysisBuilder.``AnnoLayer`

  Returns or sets the anno layer

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

  Getter Method

  Signature `AnnoLayer`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AnnoLayer`

  Parameters: | annoLayer (int) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CSys

`SectionInertiaAnalysisBuilder.``CSys`

  Returns or sets the c sys

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

  Getter Method

  Signature `CSys`

  Returns: |
  Return type: | `NXOpen.Features.SectionInertiaAnalysisBuilderCoordSys`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CSys`

  Parameters: | csys (`NXOpen.Features.SectionInertiaAnalysisBuilderCoordSys`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CenterOfGravity

`SectionInertiaAnalysisBuilder.``CenterOfGravity`

  Returns or sets the center of gravity

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

  Getter Method

  Signature `CenterOfGravity`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CenterOfGravity`

  Parameters: | centerOfGravity (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CurveCollector

`SectionInertiaAnalysisBuilder.``CurveCollector`

  Returns the curve collector

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

  Getter Method

  Signature `CurveCollector`

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

  New in version NX5.0.0.

  License requirements: None.

## DatumPlaneLayer

`SectionInertiaAnalysisBuilder.``DatumPlaneLayer`

  Returns or sets the datum plane layer

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

  Getter Method

  Signature `DatumPlaneLayer`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DatumPlaneLayer`

  Parameters: | datumPlaneLayer (int) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## DatumPlanes

`SectionInertiaAnalysisBuilder.``DatumPlanes`

  Returns or sets the datum planes

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

  Getter Method

  Signature `DatumPlanes`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DatumPlanes`

  Parameters: | datumPlanes (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Distance

`SectionInertiaAnalysisBuilder.``Distance`

  Returns the distance

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

  Getter Method

  Signature `Distance`

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

  New in version NX5.0.0.

  License requirements: None.

## FaceCollector

`SectionInertiaAnalysisBuilder.``FaceCollector`

  Returns the face collector

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

  Getter Method

  Signature `FaceCollector`

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

  New in version NX5.0.0.

  License requirements: None.

## MassPropertyType

`SectionInertiaAnalysisBuilder.``MassPropertyType`

  Returns or sets the mass property type

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

  Getter Method

  Signature `MassPropertyType`

  Returns: |
  Return type: | `NXOpen.Features.SectionInertiaAnalysisBuilderPropertyType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MassPropertyType`

  Parameters: | massPropertyType (`NXOpen.Features.SectionInertiaAnalysisBuilderPropertyType`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## NSection

`SectionInertiaAnalysisBuilder.``NSection`

  Returns or sets the n section

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

  Getter Method

  Signature `NSection`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NSection`

  Parameters: | nSection (int) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## PathCollector

`SectionInertiaAnalysisBuilder.``PathCollector`

  Returns the path collector

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

  Getter Method

  Signature `PathCollector`

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

  New in version NX5.0.0.

  License requirements: None.

## PrincipalAxes

`SectionInertiaAnalysisBuilder.``PrincipalAxes`

  Returns or sets the principal axes

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

  Getter Method

  Signature `PrincipalAxes`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PrincipalAxes`

  Parameters: | principalAxes (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## RectangleLayer

`SectionInertiaAnalysisBuilder.``RectangleLayer`

  Returns or sets the rectangle layer

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

  Getter Method

  Signature `RectangleLayer`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RectangleLayer`

  Parameters: | rectangleLayer (int) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## RectangularSection

`SectionInertiaAnalysisBuilder.``RectangularSection`

  Returns or sets the rectangular section

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

  Getter Method

  Signature `RectangularSection`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RectangularSection`

  Parameters: | rectangularSection (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SecondPrincipleMi

`SectionInertiaAnalysisBuilder.``SecondPrincipleMi`

  Returns or sets the second principle mi

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

  Getter Method

  Signature `SecondPrincipleMi`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SecondPrincipleMi`

  Parameters: | secondPrincipleMI (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SectionArea

`SectionInertiaAnalysisBuilder.``SectionArea`

  Returns or sets the section area

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

  Getter Method

  Signature `SectionArea`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionArea`

  Parameters: | sectionArea (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SectionLayer

`SectionInertiaAnalysisBuilder.``SectionLayer`

  Returns or sets the section layer

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

  Getter Method

  Signature `SectionLayer`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionLayer`

  Parameters: | sectionLayer (int) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SectionLength

`SectionInertiaAnalysisBuilder.``SectionLength`

  Returns or sets the section length

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

  Getter Method

  Signature `SectionLength`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionLength`

  Parameters: | sectionLength (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SectionNormal

`SectionInertiaAnalysisBuilder.``SectionNormal`

  Returns or sets the section normal

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

  Getter Method

  Signature `SectionNormal`

  Returns: |
  Return type: | `NXOpen.Features.SectionInertiaAnalysisBuilderSectionAxisNormal`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionNormal`

  Parameters: | sectionNormal (`NXOpen.Features.SectionInertiaAnalysisBuilderSectionAxisNormal`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SectioningMethod

`SectionInertiaAnalysisBuilder.``SectioningMethod`

  Returns or sets the sectioning method

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

  Getter Method

  Signature `SectioningMethod`

  Returns: |
  Return type: | `NXOpen.Features.SectionInertiaAnalysisBuilderSampleMethod`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SectioningMethod`

  Parameters: | sectioningMethod (`NXOpen.Features.SectionInertiaAnalysisBuilderSampleMethod`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Sections

`SectionInertiaAnalysisBuilder.``Sections`

  Returns or sets the sections

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

  Getter Method

  Signature `Sections`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Sections`

  Parameters: | sections (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ShearCenter

`SectionInertiaAnalysisBuilder.``ShearCenter`

  Returns or sets the shear center

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

  Getter Method

  Signature `ShearCenter`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShearCenter`

  Parameters: | shearCenter (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Thickness

`SectionInertiaAnalysisBuilder.``Thickness`

  Returns the thickness.

  This attribute is always used in hollow analysis while it is used in solid analysis if any of the loops is open.

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

  Getter Method

  Signature `Thickness`

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

  New in version NX5.0.0.

  License requirements: None.

## Type

`SectionInertiaAnalysisBuilder.``Type`

  Returns or sets the analysis

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

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Features.SectionInertiaAnalysisBuilderTypes`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.SectionInertiaAnalysisBuilderTypes`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Units

`SectionInertiaAnalysisBuilder.``Units`

  Returns or sets the units for calculations

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

  Getter Method

  Signature `Units`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Units`

  Parameters: | units (int) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ValidityFlag

`SectionInertiaAnalysisBuilder.``ValidityFlag`

  Returns or sets the validity flag.

  If the flag is set to false, properties will be recomputed.

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

  Getter Method

  Signature `ValidityFlag`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ValidityFlag`

  Parameters: | validityFlag (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## GetAnnotation

`SectionInertiaAnalysisBuilder.``GetAnnotation`

  The annotations generated can be accessed using this method.

  Signature `GetAnnotation()`

  Returns: | The annotation notes created. Pass NULL to get only the number.
  Return type: | list of `NXOpen.Annotations.PmiNote`

  New in version NX5.0.0.

  License requirements: None.

## IsTempGraphics

`SectionInertiaAnalysisBuilder.``IsTempGraphics`

  The function checks if temporary graphics was generated.

  Signature `IsTempGraphics()`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## RefreshScreen

`SectionInertiaAnalysisBuilder.``RefreshScreen`

  The function refreshes the graphic screen if any temporary graphics was previously generated by this command.

  Signature `RefreshScreen()`

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ShowInfo

`SectionInertiaAnalysisBuilder.``ShowInfo`

  The function displays the information box with information about the section intertia analysis performed.

  Signature `ShowInfo()`

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

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