NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::DurabilityDamageEvaluationBuilder Class Reference

Represents the builder for evaluating durability damage. More...

Inheritance diagram for NXOpen::CAE::DurabilityDamageEvaluationBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BwiWeldClassEnum {
  BwiWeldClassEnumB, BwiWeldClassEnumC, BwiWeldClassEnumD, BwiWeldClassEnumE,
  BwiWeldClassEnumF, BwiWeldClassEnumF2, BwiWeldClassEnumG, BwiWeldClassEnumW
}
 the BWi Weld Class Enum. More...
 
enum  CyclicStressStrainModelEnum { CyclicStressStrainModelEnumLinear, CyclicStressStrainModelEnumPowerHardening, CyclicStressStrainModelEnumRambergOsgood }
 the cyclic stress strain model. More...
 
enum  EquivalentStressMethodEnum {
  EquivalentStressMethodEnumNone, EquivalentStressMethodEnumGoodman, EquivalentStressMethodEnumSoderberg, EquivalentStressMethodEnumGerberg,
  EquivalentStressMethodEnumMorrow
}
 the equivalent stress method. More...
 
enum  FatigueLifeCriterionEnum {
  FatigueLifeCriterionEnumSmithWatsonTopper, FatigueLifeCriterionEnumStrainLifeMaximumPrincipal, FatigueLifeCriterionEnumStrainLifeMaximumShear, FatigueLifeCriterionEnumStressLife,
  FatigueLifeCriterionEnumBwi, FatigueLifeCriterionEnumTwi
}
 the fatigue life criterion. More...
 
enum  ProbabilityOptionEnum { ProbabilityOptionEnumNumberOfStandardDeviations, ProbabilityOptionEnumProbabilityOfFailure }
 the Probability Option. More...
 

Public Member Functions

bool EnableDetailedOutput ()
 Returns the detailed output. More...
 
void ExportResultsToCsv (const NXString &csvFilename)
 Export damage results to a csv file. More...
 
void ExportResultsToCsv (const char *csvFilename)
 Export damage results to a csv file. More...
 
double GetNthMeanBin (int index)
 Gets the nth mean bin. More...
 
double GetNthNominalRangeBin (int index)
 Gets the nth nominal range bin. More...
 
bool HighlightDamageValues ()
 Returns the highlighting of non-zero damage values. More...
 
NXOpen::PhysicalMaterialMaterialTag ()
 Returns the material. More...
 
double MaxMeanRange ()
 Returns the max mean range
Created in NX8.0.0. More...
 
double MaxNominalRange ()
 Returns the max nominal range
Created in NX8.0.0. More...
 
double MinMeanRange ()
 Returns the min mean range
Created in NX8.0.0. More...
 
int NumberOfMaxBins ()
 Returns the number of max bins
Created in NX8.0.0. More...
 
int NumberOfMeanBins ()
 Returns the number of mean bins
Created in NX8.0.0. More...
 
double PeakValleyTolerance ()
 Returns the peak valley tolerance
Created in NX8.0.0. More...
 
void RemoveFunction (int rowIndex)
 Removes the function. More...
 
void SetEnableDetailedOutput (bool enableDetailedOutput)
 Sets the detailed output. More...
 
void SetFatigue (NXOpen::CAE::DurabilityFatigue *fatigue)
 The fatigue settings. More...
 
void SetFunctionData (NXOpen::TaggedObject *functionTag, int numberOfOccurrences, double lateralLoadingFactor, double scaleFactor)
 Sets the function data. More...
 
void SetHighlightDamageValues (bool highlightDamageValues)
 Sets the highlighting of non-zero damage values. More...
 
void SetLlr (int rowIndex, double lateralLoadingFactor)
 Sets the lateral loading ratio. More...
 
void SetMaterialTag (NXOpen::PhysicalMaterial *materialTag)
 Sets the material. More...
 
void SetMaxMeanRange (double maxMeanRange)
 Sets the max mean range
Created in NX8.0.0. More...
 
void SetMaxNominalRange (double maxNominalRange)
 Sets the max nominal range
Created in NX8.0.0. More...
 
void SetMinMeanRange (double minMeanRange)
 Sets the min mean range
Created in NX8.0.0. More...
 
void SetNthMeanBin (int index, double nthMeanBin)
 Sets the nth mean bin. More...
 
void SetNthNominalRangeBin (int index, double nthNominalRangeBin)
 Sets the nth nominal range bin. More...
 
void SetNumberOfMaxBins (int numberOfMaxBins)
 Sets the number of max bins
Created in NX8.0.0. More...
 
void SetNumberOfMeanBins (int numberOfMeanBins)
 Sets the number of mean bins
Created in NX8.0.0. More...
 
void SetOccurrence (int rowIndex, int occurrence)
 Sets the number of Occurrences. More...
 
void SetPeakValleyTolerance (double peakValleyTolerance)
 Sets the peak valley tolerance
Created in NX8.0.0. More...
 
void SetScale (int rowIndex, double scale)
 Sets the scale. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


Created in NX8.0.0.

Member Enumeration Documentation

the BWi Weld Class Enum.

Enumerator
BwiWeldClassEnumB 

B.

BwiWeldClassEnumC 

C.

BwiWeldClassEnumD 

D.

BwiWeldClassEnumE 

E.

BwiWeldClassEnumF 

F.

BwiWeldClassEnumF2 

F2.

BwiWeldClassEnumG 

G.

BwiWeldClassEnumW 

W.

the cyclic stress strain model.

Enumerator
CyclicStressStrainModelEnumLinear 

linear

CyclicStressStrainModelEnumPowerHardening 

power hardening

CyclicStressStrainModelEnumRambergOsgood 

ramberg osgood

the equivalent stress method.

Enumerator
EquivalentStressMethodEnumNone 

none

EquivalentStressMethodEnumGoodman 

goodman

EquivalentStressMethodEnumSoderberg 

soderberg

EquivalentStressMethodEnumGerberg 

gerberg

EquivalentStressMethodEnumMorrow 

morrow

the fatigue life criterion.

Enumerator
FatigueLifeCriterionEnumSmithWatsonTopper 

smith watson topper

FatigueLifeCriterionEnumStrainLifeMaximumPrincipal 

strain life maximum principal

FatigueLifeCriterionEnumStrainLifeMaximumShear 

strain life maximum shear

FatigueLifeCriterionEnumStressLife 

stress life

FatigueLifeCriterionEnumBwi 

bwi

FatigueLifeCriterionEnumTwi 

twi

the Probability Option.

Enumerator
ProbabilityOptionEnumNumberOfStandardDeviations 

Number of Std.

Dev.

ProbabilityOptionEnumProbabilityOfFailure 

Prob.

Of Failure

Member Function Documentation

bool NXOpen::CAE::DurabilityDamageEvaluationBuilder::EnableDetailedOutput ( )

Returns the detailed output.


Created in NX8.5.1.

License requirements : nx_adv_durability ("NX Advanced Durability")

void NXOpen::CAE::DurabilityDamageEvaluationBuilder::ExportResultsToCsv ( const NXString csvFilename)

Export damage results to a csv file.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
csvFilenamedamage report will be written-out to this file.
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::ExportResultsToCsv ( const char *  csvFilename)

Export damage results to a csv file.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
csvFilenamedamage report will be written-out to this file.
double NXOpen::CAE::DurabilityDamageEvaluationBuilder::GetNthMeanBin ( int  index)

Gets the nth mean bin.

Returns

Created in NX8.0.0.

License requirements : None
Parameters
indexindex
double NXOpen::CAE::DurabilityDamageEvaluationBuilder::GetNthNominalRangeBin ( int  index)

Gets the nth nominal range bin.

Returns

Created in NX8.0.0.

License requirements : None
Parameters
indexindex
bool NXOpen::CAE::DurabilityDamageEvaluationBuilder::HighlightDamageValues ( )

Returns the highlighting of non-zero damage values.


Created in NX8.5.1.

License requirements : nx_adv_durability ("NX Advanced Durability")

NXOpen::PhysicalMaterial* NXOpen::CAE::DurabilityDamageEvaluationBuilder::MaterialTag ( )

Returns the material.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

double NXOpen::CAE::DurabilityDamageEvaluationBuilder::MaxMeanRange ( )

Returns the max mean range
Created in NX8.0.0.



License requirements : None

double NXOpen::CAE::DurabilityDamageEvaluationBuilder::MaxNominalRange ( )

Returns the max nominal range
Created in NX8.0.0.



License requirements : None

double NXOpen::CAE::DurabilityDamageEvaluationBuilder::MinMeanRange ( )

Returns the min mean range
Created in NX8.0.0.



License requirements : None

int NXOpen::CAE::DurabilityDamageEvaluationBuilder::NumberOfMaxBins ( )

Returns the number of max bins
Created in NX8.0.0.



License requirements : None

int NXOpen::CAE::DurabilityDamageEvaluationBuilder::NumberOfMeanBins ( )

Returns the number of mean bins
Created in NX8.0.0.



License requirements : None

double NXOpen::CAE::DurabilityDamageEvaluationBuilder::PeakValleyTolerance ( )

Returns the peak valley tolerance
Created in NX8.0.0.



License requirements : None

void NXOpen::CAE::DurabilityDamageEvaluationBuilder::RemoveFunction ( int  rowIndex)

Removes the function.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
rowIndexrow index
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetEnableDetailedOutput ( bool  enableDetailedOutput)

Sets the detailed output.


Created in NX8.5.1.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
enableDetailedOutputenabledetailedoutput
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetFatigue ( NXOpen::CAE::DurabilityFatigue fatigue)

The fatigue settings.


Created in NX8.5.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
fatiguefatigue
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetFunctionData ( NXOpen::TaggedObject functionTag,
int  numberOfOccurrences,
double  lateralLoadingFactor,
double  scaleFactor 
)

Sets the function data.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
functionTagfunctiontag
numberOfOccurrencesnumberofoccurrences
lateralLoadingFactorlateralloadingfactor
scaleFactorscalefactor
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetHighlightDamageValues ( bool  highlightDamageValues)

Sets the highlighting of non-zero damage values.


Created in NX8.5.1.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
highlightDamageValueshighlightdamagevalues
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetLlr ( int  rowIndex,
double  lateralLoadingFactor 
)

Sets the lateral loading ratio.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
rowIndexrow index
lateralLoadingFactorlateralloadingfactor
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetMaterialTag ( NXOpen::PhysicalMaterial materialTag)

Sets the material.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
materialTagmaterialtag
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetMaxMeanRange ( double  maxMeanRange)

Sets the max mean range
Created in NX8.0.0.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
maxMeanRangemaxmeanrange
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetMaxNominalRange ( double  maxNominalRange)

Sets the max nominal range
Created in NX8.0.0.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
maxNominalRangemaxnominalrange
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetMinMeanRange ( double  minMeanRange)

Sets the min mean range
Created in NX8.0.0.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
minMeanRangeminmeanrange
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetNthMeanBin ( int  index,
double  nthMeanBin 
)

Sets the nth mean bin.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
indexindex
nthMeanBinnthmeanbin
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetNthNominalRangeBin ( int  index,
double  nthNominalRangeBin 
)

Sets the nth nominal range bin.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
indexindex
nthNominalRangeBinnthnominalrangebin
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetNumberOfMaxBins ( int  numberOfMaxBins)

Sets the number of max bins
Created in NX8.0.0.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
numberOfMaxBinsnumberofmaxbins
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetNumberOfMeanBins ( int  numberOfMeanBins)

Sets the number of mean bins
Created in NX8.0.0.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
numberOfMeanBinsnumberofmeanbins
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetOccurrence ( int  rowIndex,
int  occurrence 
)

Sets the number of Occurrences.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
rowIndexrow index
occurrenceoccurrence
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetPeakValleyTolerance ( double  peakValleyTolerance)

Sets the peak valley tolerance
Created in NX8.0.0.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
peakValleyTolerancepeakvalleytolerance
void NXOpen::CAE::DurabilityDamageEvaluationBuilder::SetScale ( int  rowIndex,
double  scale 
)

Sets the scale.


Created in NX8.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
rowIndexrow index
scalescale

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.