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

Represents the builder for reporting the durability results. More...

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

Public Types

enum  UseEventsEnum { UseEventsEnumActive, UseEventsEnumAll }
 the event report options enum. More...
 

Public Member Functions

bool EventDamage ()
 Returns the event damage toggle
Created in NX8.0.1. More...
 
bool EventLife ()
 Returns the event life toggle
Created in NX8.0.1. More...
 
void ExportResultsToCsv (const NXString &csvFilename)
 Export durability results to a csv file. More...
 
void ExportResultsToCsv (const char *csvFilename)
 Export durability results to a csv file. More...
 
bool FailureIndex ()
 Returns the failure index toggle
Created in NX8.0.1. More...
 
bool FatigueSafetyFactor ()
 Returns the fatigue safety factor toggle
Created in NX8.0.1. More...
 
bool FreeFaceIndicator ()
 Returns the free face indicator. More...
 
bool LoadProportionality ()
 Returns the load proportionality. More...
 
bool MarginSafety ()
 Returns the margin safety toggle
Created in NX8.0.1. More...
 
bool PrincipalAxisStability ()
 Returns the principal axis stability. More...
 
void SetEventDamage (bool eventDamage)
 Sets the event damage toggle
Created in NX8.0.1. More...
 
void SetEventLife (bool eventLife)
 Sets the event life toggle
Created in NX8.0.1. More...
 
void SetFailureIndex (bool failureIndex)
 Sets the failure index toggle
Created in NX8.0.1. More...
 
void SetFatigueSafetyFactor (bool fatigueSafetyFactor)
 Sets the fatigue safety factor toggle
Created in NX8.0.1. More...
 
void SetFreeFaceIndicator (bool freeFaceIndicator)
 Sets the free face indicator. More...
 
void SetLoadProportionality (bool loadProportionality)
 Sets the load proportionality. More...
 
void SetMarginSafety (bool marginSafety)
 Sets the margin safety toggle
Created in NX8.0.1. More...
 
void SetPrincipalAxisStability (bool principalAxisStability)
 Sets the principal axis stability. More...
 
void SetStrengthSafetyFactor (bool strengthSafetyFactor)
 Sets the strength safety factor toggle
Created in NX8.0.1. More...
 
void SetUseEvents (NXOpen::CAE::DurabilityResultsReportBuilder::UseEventsEnum useEvents)
 Sets the use events pop-up menu
Created in NX8.0.1. More...
 
void SetUseHighlight (bool useHighlight)
 Sets the use highlight toggle
Created in NX8.0.1. More...
 
bool StrengthSafetyFactor ()
 Returns the strength safety factor toggle
Created in NX8.0.1. More...
 
NXOpen::CAE::DurabilityResultsReportBuilder::UseEventsEnum UseEvents ()
 Returns the use events pop-up menu
Created in NX8.0.1. More...
 
bool UseHighlight ()
 Returns the use highlight toggle
Created in NX8.0.1. 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 reporting the durability results.


To create a new instance of this class, use NXOpen::CAE::DurabilityManager::CreateDurabilityResultsReportBuilder
Default values.

Property Value

EventDamage

1

EventLife

0

FailureIndex

0

FatigueSafetyFactor

0

MarginSafety

0

StrengthSafetyFactor

0

UseEvents

Active

UseHighlight

0


Created in NX8.0.1.

Member Enumeration Documentation

the event report options enum.

Enumerator
UseEventsEnumActive 

active

UseEventsEnumAll 

all

Member Function Documentation

bool NXOpen::CAE::DurabilityResultsReportBuilder::EventDamage ( )

Returns the event damage toggle
Created in NX8.0.1.



License requirements : None

bool NXOpen::CAE::DurabilityResultsReportBuilder::EventLife ( )

Returns the event life toggle
Created in NX8.0.1.



License requirements : None

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

Export durability results to a csv file.


Created in NX8.0.1.

License requirements : nx_adv_durability ("NX Advanced Durability")

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

Export durability results to a csv file.


Created in NX8.0.1.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
csvFilenamedurability report will be written-out to this file.
bool NXOpen::CAE::DurabilityResultsReportBuilder::FailureIndex ( )

Returns the failure index toggle
Created in NX8.0.1.



License requirements : None

bool NXOpen::CAE::DurabilityResultsReportBuilder::FatigueSafetyFactor ( )

Returns the fatigue safety factor toggle
Created in NX8.0.1.



License requirements : None

bool NXOpen::CAE::DurabilityResultsReportBuilder::FreeFaceIndicator ( )

Returns the free face indicator.


Created in NX9.0.0.

License requirements : None

bool NXOpen::CAE::DurabilityResultsReportBuilder::LoadProportionality ( )

Returns the load proportionality.


Created in NX9.0.0.

License requirements : None

bool NXOpen::CAE::DurabilityResultsReportBuilder::MarginSafety ( )

Returns the margin safety toggle
Created in NX8.0.1.



License requirements : None

bool NXOpen::CAE::DurabilityResultsReportBuilder::PrincipalAxisStability ( )

Returns the principal axis stability.


Created in NX9.0.0.

License requirements : None

void NXOpen::CAE::DurabilityResultsReportBuilder::SetEventDamage ( bool  eventDamage)

Sets the event damage toggle
Created in NX8.0.1.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
eventDamageeventdamage
void NXOpen::CAE::DurabilityResultsReportBuilder::SetEventLife ( bool  eventLife)

Sets the event life toggle
Created in NX8.0.1.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
eventLifeeventlife
void NXOpen::CAE::DurabilityResultsReportBuilder::SetFailureIndex ( bool  failureIndex)

Sets the failure index toggle
Created in NX8.0.1.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
failureIndexfailureindex
void NXOpen::CAE::DurabilityResultsReportBuilder::SetFatigueSafetyFactor ( bool  fatigueSafetyFactor)

Sets the fatigue safety factor toggle
Created in NX8.0.1.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
fatigueSafetyFactorfatiguesafetyfactor
void NXOpen::CAE::DurabilityResultsReportBuilder::SetFreeFaceIndicator ( bool  freeFaceIndicator)

Sets the free face indicator.


Created in NX9.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
freeFaceIndicatorfreefaceindicator
void NXOpen::CAE::DurabilityResultsReportBuilder::SetLoadProportionality ( bool  loadProportionality)

Sets the load proportionality.


Created in NX9.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
loadProportionalityloadproportionality
void NXOpen::CAE::DurabilityResultsReportBuilder::SetMarginSafety ( bool  marginSafety)

Sets the margin safety toggle
Created in NX8.0.1.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
marginSafetymarginsafety
void NXOpen::CAE::DurabilityResultsReportBuilder::SetPrincipalAxisStability ( bool  principalAxisStability)

Sets the principal axis stability.


Created in NX9.0.0.

License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
principalAxisStabilityprincipalaxisstability
void NXOpen::CAE::DurabilityResultsReportBuilder::SetStrengthSafetyFactor ( bool  strengthSafetyFactor)

Sets the strength safety factor toggle
Created in NX8.0.1.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
strengthSafetyFactorstrengthsafetyfactor
void NXOpen::CAE::DurabilityResultsReportBuilder::SetUseEvents ( NXOpen::CAE::DurabilityResultsReportBuilder::UseEventsEnum  useEvents)

Sets the use events pop-up menu
Created in NX8.0.1.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
useEventsuseevents
void NXOpen::CAE::DurabilityResultsReportBuilder::SetUseHighlight ( bool  useHighlight)

Sets the use highlight toggle
Created in NX8.0.1.



License requirements : nx_adv_durability ("NX Advanced Durability")

Parameters
useHighlightusehighlight
bool NXOpen::CAE::DurabilityResultsReportBuilder::StrengthSafetyFactor ( )

Returns the strength safety factor toggle
Created in NX8.0.1.



License requirements : None

NXOpen::CAE::DurabilityResultsReportBuilder::UseEventsEnum NXOpen::CAE::DurabilityResultsReportBuilder::UseEvents ( )

Returns the use events pop-up menu
Created in NX8.0.1.



License requirements : None

bool NXOpen::CAE::DurabilityResultsReportBuilder::UseHighlight ( )

Returns the use highlight toggle
Created in NX8.0.1.



License requirements : None


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