CurveAnalysisPeaksBuilder Class¶
-
class
NXOpen.GeometricAnalysis.
CurveAnalysisPeaksBuilder
¶ Bases:
NXOpen.Builder
This class handles the options setting for the curve analysis information (Peaks) display.
To create a new instance of this class, use
NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateCurveAnalysisPeaksBuilder()
New in version NX6.0.0.
Deprecated since version NX8.5.0: Use
GeometricAnalysis.CurveCurvatureAnalysis
.
Properties¶
Property | Description |
---|---|
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. |
CreatePoints | Create points at the peaks of the curve @return |
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¶
CurveAnalysisPeaksBuilderDirectionOptionType Enumeration | Direction option types |
Property Detail¶
DirectionOption¶
-
CurveAnalysisPeaksBuilder.
DirectionOption
¶ Returns or sets the direction option
-------------------------------------
Getter Method
Signature
DirectionOption()
Returns: Return type: NXOpen.GeometricAnalysis.CurveAnalysisPeaksBuilderDirectionOptionType
New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
DirectionOption(option)
Parameters: option ( NXOpen.GeometricAnalysis.CurveAnalysisPeaksBuilderDirectionOptionType
) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SelectedCurves¶
-
CurveAnalysisPeaksBuilder.
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¶
-
CurveAnalysisPeaksBuilder.
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(vect)
Parameters: vect ( NXOpen.Direction
) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
CreatePoints¶
-
CurveAnalysisPeaksBuilder.
CreatePoints
¶ Create points at the peaks of the curve
Signature
CreatePoints()
Returns: Return type: list of NXOpen.Point
New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Validate¶
-
CurveAnalysisPeaksBuilder.
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.