SectionAnalysisBuilder Class¶
-
class
NXOpen.GeometricAnalysis.SectionAnalysis.
SectionAnalysisBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.GeometricAnalysis.SectionAnalysisObject
builder.To create a new instance of this class, use
NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateSectionAnalysisBuilder()
Default values.
Property Value CalculationMethod Curvature CircularGrid.CircularFrame.AnchorAttachment None CircularGrid.CircularFrame.Subtype Arbitrary CircularGrid.Spacing.BoundSections1 True CircularGrid.Spacing.BoundSections2 True CircularGrid.Spacing.Interval1 45.0 CircularGrid.Spacing.Interval2 50.0 (millimeters part), 2.0 (inches part) CircularGrid.Spacing.LockInterval1 False CircularGrid.Spacing.LockInterval2 False CircularGrid.Spacing.SectionNumber1 5 CircularGrid.Spacing.SectionNumber2 5 CircularGrid.SpecifiedPlane.Plane View NeedleDirection Outside Output AnalysisObject QuadrilateralGrid.QuadrilateralFrame.AnchorAttachment None QuadrilateralGrid.QuadrilateralFrame.Subtype Arbitrary ScalingMethod Linear ShowInflectionPoints False ShowPeakPoints False ShowSectionLength False TriangularGrid.TriangularFrame.AnchorAttachment None TriangularGrid.TriangularFrame.Subtype Arbitrary Type Parallel New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
CalculationMethod | Returns or sets the calculation method |
CircularGrid | Returns the circular grid. |
CombOptions | Returns the comb options |
NeedleDirection | Returns or sets the needle direction |
Output | Returns or sets the output |
QuadrilateralGrid | Returns the quadrilateral grid. |
References | Returns the references (faces or faceted bodies) |
ScalingMethod | Returns or sets the scaling method |
ShowInflectionPoints | Returns or sets the flag to show the inflection points of planar sections |
ShowPeakPoints | Returns or sets the flag to show the peak points of the sections |
ShowSectionLength | Returns or sets the flag to show the section length labels |
Tag | Returns the Tag for this object. |
TriangularGrid | Returns the triangular grid. |
Type | Returns or sets the sectioning type |
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¶
SectionAnalysisBuilderCalculationMethodType Enumeration | The calculation method |
SectionAnalysisBuilderNeedleDirectionType Enumeration | The needle direction |
SectionAnalysisBuilderOutputType Enumeration | The output options |
SectionAnalysisBuilderScalingMethodType Enumeration | The scaling method |
SectionAnalysisBuilderTypes Enumeration | Represents the sectioning types |
Property Detail¶
CalculationMethod¶
-
SectionAnalysisBuilder.
CalculationMethod
¶ Returns or sets the calculation method
-------------------------------------
Getter Method
Signature
CalculationMethod
Returns: Return type: NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderCalculationMethodType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CalculationMethod
Parameters: calculationMethod ( NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderCalculationMethodType
) –New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
CircularGrid¶
-
SectionAnalysisBuilder.
CircularGrid
¶ Returns the circular grid.
Only used when type is
NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderTypes.Circular
-------------------------------------
Getter Method
Signature
CircularGrid
Returns: Return type: NXOpen.GeometricAnalysis.SectionAnalysis.CircularGridBuilder
New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
CombOptions¶
-
SectionAnalysisBuilder.
CombOptions
¶ Returns the comb options
-------------------------------------
Getter Method
Signature
CombOptions
Returns: Return type: NXOpen.GeometricUtilities.CombOptionsBuilder
New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
NeedleDirection¶
-
SectionAnalysisBuilder.
NeedleDirection
¶ Returns or sets the needle direction
-------------------------------------
Getter Method
Signature
NeedleDirection
Returns: Return type: NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderNeedleDirectionType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NeedleDirection
Parameters: needleDirection ( NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderNeedleDirectionType
) –New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Output¶
-
SectionAnalysisBuilder.
Output
¶ Returns or sets the output
-------------------------------------
Getter Method
Signature
Output
Returns: Return type: NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderOutputType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Output
Parameters: output ( NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderOutputType
) –New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
QuadrilateralGrid¶
-
SectionAnalysisBuilder.
QuadrilateralGrid
¶ Returns the quadrilateral grid.
Only used when type is
NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderTypes.Quadrilateral
-------------------------------------
Getter Method
Signature
QuadrilateralGrid
Returns: Return type: NXOpen.GeometricAnalysis.SectionAnalysis.QuadrilateralGridBuilder
New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
References¶
-
SectionAnalysisBuilder.
References
¶ Returns the references (faces or faceted bodies)
-------------------------------------
Getter Method
Signature
References
Returns: Return type: NXOpen.SelectTaggedObjectList
New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ScalingMethod¶
-
SectionAnalysisBuilder.
ScalingMethod
¶ Returns or sets the scaling method
-------------------------------------
Getter Method
Signature
ScalingMethod
Returns: Return type: NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderScalingMethodType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScalingMethod
Parameters: scalingMethod ( NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderScalingMethodType
) –New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ShowInflectionPoints¶
-
SectionAnalysisBuilder.
ShowInflectionPoints
¶ Returns or sets the flag to show the inflection points of planar sections
-------------------------------------
Getter Method
Signature
ShowInflectionPoints
Returns: Return type: bool New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
-------------------------------------
Setter Method
Signature
ShowInflectionPoints
Parameters: showInflectionPoints (bool) – New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ShowPeakPoints¶
-
SectionAnalysisBuilder.
ShowPeakPoints
¶ Returns or sets the flag to show the peak points of the sections
-------------------------------------
Getter Method
Signature
ShowPeakPoints
Returns: Return type: bool New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
-------------------------------------
Setter Method
Signature
ShowPeakPoints
Parameters: showPeakPoints (bool) – New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ShowSectionLength¶
-
SectionAnalysisBuilder.
ShowSectionLength
¶ Returns or sets the flag to show the section length labels
-------------------------------------
Getter Method
Signature
ShowSectionLength
Returns: Return type: bool New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
-------------------------------------
Setter Method
Signature
ShowSectionLength
Parameters: showSectionLength (bool) – New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
TriangularGrid¶
-
SectionAnalysisBuilder.
TriangularGrid
¶ Returns the triangular grid.
Only used when type is
NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderTypes.Triangular
-------------------------------------
Getter Method
Signature
TriangularGrid
Returns: Return type: NXOpen.GeometricAnalysis.SectionAnalysis.TriangularGridBuilder
New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Type¶
-
SectionAnalysisBuilder.
Type
¶ Returns or sets the sectioning type
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderTypes
New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.GeometricAnalysis.SectionAnalysis.SectionAnalysisBuilderTypes
) –New in version NX6.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Method Detail¶
Validate¶
-
SectionAnalysisBuilder.
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.