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

Inheritance diagram for NXOpen::CAE::DurabilityResultsReportBuilder:

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.

bool	EventLife ()
	Returns the event life toggle Created in NX8.0.1.

void	ExportResultsToCsv (const NXString &csvFilename)
	Export durability results to a csv file.

void	ExportResultsToCsv (const char *csvFilename)
	Export durability results to a csv file.

bool	FailureIndex ()
	Returns the failure index toggle Created in NX8.0.1.

bool	FatigueSafetyFactor ()
	Returns the fatigue safety factor toggle Created in NX8.0.1.

bool	FreeFaceIndicator ()
	Returns the free face indicator.

bool	LoadProportionality ()
	Returns the load proportionality.

bool	MarginSafety ()
	Returns the margin safety toggle Created in NX8.0.1.

bool	PrincipalAxisStability ()
	Returns the principal axis stability.

void	SetEventDamage (bool eventDamage)
	Sets the event damage toggle Created in NX8.0.1.

void	SetEventLife (bool eventLife)
	Sets the event life toggle Created in NX8.0.1.

void	SetFailureIndex (bool failureIndex)
	Sets the failure index toggle Created in NX8.0.1.

void	SetFatigueSafetyFactor (bool fatigueSafetyFactor)
	Sets the fatigue safety factor toggle Created in NX8.0.1.

void	SetFreeFaceIndicator (bool freeFaceIndicator)
	Sets the free face indicator.

void	SetLoadProportionality (bool loadProportionality)
	Sets the load proportionality.

void	SetMarginSafety (bool marginSafety)
	Sets the margin safety toggle Created in NX8.0.1.

void	SetPrincipalAxisStability (bool principalAxisStability)
	Sets the principal axis stability.

void	SetStrengthSafetyFactor (bool strengthSafetyFactor)
	Sets the strength safety factor toggle Created in NX8.0.1.

void	SetUseEvents (NXOpen::CAE::DurabilityResultsReportBuilder::UseEventsEnum useEvents)
	Sets the use events pop-up menu Created in NX8.0.1.

void	SetUseHighlight (bool useHighlight)
	Sets the use highlight toggle Created in NX8.0.1.

bool	StrengthSafetyFactor ()
	Returns the strength safety factor toggle Created in NX8.0.1.

NXOpen::CAE::DurabilityResultsReportBuilder::UseEventsEnum	UseEvents ()
	Returns the use events pop-up menu Created in NX8.0.1.

bool	UseHighlight ()
	Returns the use highlight toggle Created in NX8.0.1.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents the builder for reporting the durability results.

To create a new instance of this class, use 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

enum NXOpen::CAE::DurabilityResultsReportBuilder::UseEventsEnum

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

csvFilename durability report will be written-out to this file.
NOTE: The full Unicode character set is not supported for this parameter.

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

csvFilename durability report will be written-out to this file.
NOTE: The full Unicode character set is not supported for this parameter.

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

eventDamage eventdamage

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

eventLife eventlife

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

failureIndex failureindex

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

fatigueSafetyFactor fatiguesafetyfactor

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

freeFaceIndicator freefaceindicator

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

loadProportionality loadproportionality

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

marginSafety marginsafety

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

principalAxisStability principalaxisstability

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

strengthSafetyFactor strengthsafetyfactor

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

useEvents useevents

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

useHighlight usehighlight

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:

CAE_DurabilityResultsReportBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation