DurabilityDamageEvaluationBuilder Class¶
-
class
NXOpen.CAE.
DurabilityDamageEvaluationBuilder
¶ Bases:
NXOpen.Builder
Represents the builder for evaluating durability damage.
This mechanism takes a stress/strain history and computes a damage histogram based on the history. This could either be on a spreadsheet or in a comma separated file.
To create a new instance of this class, use
NXOpen.CAE.DurabilityManager.CreateDamageEvaluationBuilder()
Default values.
Property Value EnableDetailedOutput 0 HighlightDamageValues 0 MaxMeanRange 0 MaxNominalRange 0 MinMeanRange 0 NumberOfMaxBins 10 NumberOfMeanBins 10 PeakValleyTolerance 0 New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
EnableDetailedOutput | Returns or sets the detailed output. |
HighlightDamageValues | Returns or sets the highlighting of non-zero damage values. |
MaterialTag | Returns or sets the material. |
MaxMeanRange | Returns or sets the max mean range |
MaxNominalRange | Returns or sets the max nominal range |
MinMeanRange | Returns or sets the min mean range |
NumberOfMaxBins | Returns or sets the number of max bins |
NumberOfMeanBins | Returns or sets the number of mean bins |
PeakValleyTolerance | Returns or sets the peak valley tolerance |
Tag | Returns the Tag for this object. |
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. |
ExportResultsToCsv | Export damage results to a csv file. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetNthMeanBin | Gets the nth mean bin. |
GetNthNominalRangeBin | Gets the nth nominal range bin. |
GetObject | Returns the object currently being edited by this builder. |
RemoveFunction | Removes the function. |
SetFatigue | The fatigue settings. |
SetFunctionData | Sets the function data. |
SetLlr | Sets the lateral loading ratio. |
SetNthMeanBin | Sets the nth mean bin. |
SetNthNominalRangeBin | Sets the nth nominal range bin. |
SetOccurrence | Sets the number of Occurrences. |
SetScale | Sets the scale. |
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¶
DurabilityDamageEvaluationBuilderBwiWeldClassEnum Enumeration | the BWi Weld Class Enum. |
DurabilityDamageEvaluationBuilderCyclicStressStrainModelEnum Enumeration | the cyclic stress strain model. |
DurabilityDamageEvaluationBuilderEquivalentStressMethodEnum Enumeration | the equivalent stress method. |
DurabilityDamageEvaluationBuilderFatigueLifeCriterionEnum Enumeration | the fatigue life criterion. |
DurabilityDamageEvaluationBuilderProbabilityOptionEnum Enumeration | the Probability Option. |
Property Detail¶
EnableDetailedOutput¶
-
DurabilityDamageEvaluationBuilder.
EnableDetailedOutput
¶ Returns or sets the detailed output.
-------------------------------------
Getter Method
Signature
EnableDetailedOutput
Returns: Return type: bool New in version NX8.5.1.
License requirements: nx_adv_durability (“NX Advanced Durability”)
-------------------------------------
Setter Method
Signature
EnableDetailedOutput
Parameters: enableDetailedOutput (bool) – New in version NX8.5.1.
License requirements: nx_adv_durability (“NX Advanced Durability”)
HighlightDamageValues¶
-
DurabilityDamageEvaluationBuilder.
HighlightDamageValues
¶ Returns or sets the highlighting of non-zero damage values.
-------------------------------------
Getter Method
Signature
HighlightDamageValues
Returns: Return type: bool New in version NX8.5.1.
License requirements: nx_adv_durability (“NX Advanced Durability”)
-------------------------------------
Setter Method
Signature
HighlightDamageValues
Parameters: highlightDamageValues (bool) – New in version NX8.5.1.
License requirements: nx_adv_durability (“NX Advanced Durability”)
MaterialTag¶
-
DurabilityDamageEvaluationBuilder.
MaterialTag
¶ Returns or sets the material.
-------------------------------------
Getter Method
Signature
MaterialTag
Returns: Return type: NXOpen.PhysicalMaterial
New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
-------------------------------------
Setter Method
Signature
MaterialTag
Parameters: materialTag ( NXOpen.PhysicalMaterial
) –New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
MaxMeanRange¶
-
DurabilityDamageEvaluationBuilder.
MaxMeanRange
¶ Returns or sets the max mean range
-------------------------------------
Getter Method
Signature
MaxMeanRange
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaxMeanRange
Parameters: maxMeanRange (float) – New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
MaxNominalRange¶
-
DurabilityDamageEvaluationBuilder.
MaxNominalRange
¶ Returns or sets the max nominal range
-------------------------------------
Getter Method
Signature
MaxNominalRange
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaxNominalRange
Parameters: maxNominalRange (float) – New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
MinMeanRange¶
-
DurabilityDamageEvaluationBuilder.
MinMeanRange
¶ Returns or sets the min mean range
-------------------------------------
Getter Method
Signature
MinMeanRange
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinMeanRange
Parameters: minMeanRange (float) – New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
NumberOfMaxBins¶
-
DurabilityDamageEvaluationBuilder.
NumberOfMaxBins
¶ Returns or sets the number of max bins
-------------------------------------
Getter Method
Signature
NumberOfMaxBins
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfMaxBins
Parameters: numberOfMaxBins (int) – New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
NumberOfMeanBins¶
-
DurabilityDamageEvaluationBuilder.
NumberOfMeanBins
¶ Returns or sets the number of mean bins
-------------------------------------
Getter Method
Signature
NumberOfMeanBins
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfMeanBins
Parameters: numberOfMeanBins (int) – New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
PeakValleyTolerance¶
-
DurabilityDamageEvaluationBuilder.
PeakValleyTolerance
¶ Returns or sets the peak valley tolerance
-------------------------------------
Getter Method
Signature
PeakValleyTolerance
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PeakValleyTolerance
Parameters: peakValleyTolerance (float) – New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
Method Detail¶
ExportResultsToCsv¶
-
DurabilityDamageEvaluationBuilder.
ExportResultsToCsv
¶ Export damage results to a csv file.
Signature
ExportResultsToCsv(csvFilename)
Parameters: csvFilename (str) – damage report will be written-out to this file. New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
GetNthMeanBin¶
-
DurabilityDamageEvaluationBuilder.
GetNthMeanBin
¶ Gets the nth mean bin.
Signature
GetNthMeanBin(index)
Parameters: index (int) – Returns: Return type: float New in version NX8.0.0.
License requirements: None.
GetNthNominalRangeBin¶
-
DurabilityDamageEvaluationBuilder.
GetNthNominalRangeBin
¶ Gets the nth nominal range bin.
Signature
GetNthNominalRangeBin(index)
Parameters: index (int) – Returns: Return type: float New in version NX8.0.0.
License requirements: None.
RemoveFunction¶
-
DurabilityDamageEvaluationBuilder.
RemoveFunction
¶ Removes the function.
Signature
RemoveFunction(rowIndex)
Parameters: rowIndex (int) – New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
SetFatigue¶
-
DurabilityDamageEvaluationBuilder.
SetFatigue
¶ The fatigue settings.
Signature
SetFatigue(fatigue)
Parameters: fatigue ( NXOpen.CAE.DurabilityFatigue
) –New in version NX8.5.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
SetFunctionData¶
-
DurabilityDamageEvaluationBuilder.
SetFunctionData
¶ Sets the function data.
Signature
SetFunctionData(functionTag, numberOfOccurrences, lateralLoadingFactor, scaleFactor)
Parameters: - functionTag (
NXOpen.TaggedObject
) – - numberOfOccurrences (int) –
- lateralLoadingFactor (float) –
- scaleFactor (float) –
New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
- functionTag (
SetLlr¶
-
DurabilityDamageEvaluationBuilder.
SetLlr
¶ Sets the lateral loading ratio.
Signature
SetLlr(rowIndex, lateralLoadingFactor)
Parameters: - rowIndex (int) –
- lateralLoadingFactor (float) –
New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
SetNthMeanBin¶
-
DurabilityDamageEvaluationBuilder.
SetNthMeanBin
¶ Sets the nth mean bin.
Signature
SetNthMeanBin(index, nthMeanBin)
Parameters: - index (int) –
- nthMeanBin (float) –
New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
SetNthNominalRangeBin¶
-
DurabilityDamageEvaluationBuilder.
SetNthNominalRangeBin
¶ Sets the nth nominal range bin.
Signature
SetNthNominalRangeBin(index, nthNominalRangeBin)
Parameters: - index (int) –
- nthNominalRangeBin (float) –
New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
SetOccurrence¶
-
DurabilityDamageEvaluationBuilder.
SetOccurrence
¶ Sets the number of Occurrences.
Signature
SetOccurrence(rowIndex, occurrence)
Parameters: - rowIndex (int) –
- occurrence (int) –
New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
SetScale¶
-
DurabilityDamageEvaluationBuilder.
SetScale
¶ Sets the scale.
Signature
SetScale(rowIndex, scale)
Parameters: - rowIndex (int) –
- scale (float) –
New in version NX8.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
Validate¶
-
DurabilityDamageEvaluationBuilder.
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.