DurabilityResultsReportBuilder Class

class NXOpen.CAE.DurabilityResultsReportBuilder

Bases: NXOpen.Builder

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

New in version NX8.0.1.

Properties

Property	Description
EventDamage	Returns or sets the event damage toggle
EventLife	Returns or sets the event life toggle
FailureIndex	Returns or sets the failure index toggle
FatigueSafetyFactor	Returns or sets the fatigue safety factor toggle
FreeFaceIndicator	Returns or sets the free face indicator.
LoadProportionality	Returns or sets the load proportionality.
MarginSafety	Returns or sets the margin safety toggle
PrincipalAxisStability	Returns or sets the principal axis stability.
StrengthSafetyFactor	Returns or sets the strength safety factor toggle
Tag	Returns the Tag for this object.
UseEvents	Returns or sets the use events pop-up menu
UseHighlight	Returns or sets the use highlight toggle

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 durability results to a csv file.
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

DurabilityResultsReportBuilderUseEventsEnum Enumeration

the event report options enum.

Property Detail

EventDamage

DurabilityResultsReportBuilder.EventDamage

Returns or sets the event damage toggle

-------------------------------------

Getter Method

Signature EventDamage

Returns: Return type:bool

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature EventDamage

Parameters:eventDamage (bool) –

New in version NX8.0.1.

License requirements: nx_adv_durability (“NX Advanced Durability”)

EventLife

DurabilityResultsReportBuilder.EventLife

Returns or sets the event life toggle

-------------------------------------

Getter Method

Signature EventLife

Returns: Return type:bool

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature EventLife

Parameters:eventLife (bool) –

New in version NX8.0.1.

License requirements: nx_adv_durability (“NX Advanced Durability”)

FailureIndex

DurabilityResultsReportBuilder.FailureIndex

Returns or sets the failure index toggle

-------------------------------------

Getter Method

Signature FailureIndex

Returns: Return type:bool

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature FailureIndex

Parameters:failureIndex (bool) –

New in version NX8.0.1.

License requirements: nx_adv_durability (“NX Advanced Durability”)

FatigueSafetyFactor

DurabilityResultsReportBuilder.FatigueSafetyFactor

Returns or sets the fatigue safety factor toggle

-------------------------------------

Getter Method

Signature FatigueSafetyFactor

Returns: Return type:bool

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature FatigueSafetyFactor

Parameters:fatigueSafetyFactor (bool) –

New in version NX8.0.1.

License requirements: nx_adv_durability (“NX Advanced Durability”)

FreeFaceIndicator

DurabilityResultsReportBuilder.FreeFaceIndicator

Returns or sets the free face indicator.

-------------------------------------

Getter Method

Signature FreeFaceIndicator

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FreeFaceIndicator

Parameters:freeFaceIndicator (bool) –

New in version NX9.0.0.

License requirements: nx_adv_durability (“NX Advanced Durability”)

LoadProportionality

DurabilityResultsReportBuilder.LoadProportionality

Returns or sets the load proportionality.

-------------------------------------

Getter Method

Signature LoadProportionality

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LoadProportionality

Parameters:loadProportionality (bool) –

New in version NX9.0.0.

License requirements: nx_adv_durability (“NX Advanced Durability”)

MarginSafety

DurabilityResultsReportBuilder.MarginSafety

Returns or sets the margin safety toggle

-------------------------------------

Getter Method

Signature MarginSafety

Returns: Return type:bool

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature MarginSafety

Parameters:marginSafety (bool) –

New in version NX8.0.1.

License requirements: nx_adv_durability (“NX Advanced Durability”)

PrincipalAxisStability

DurabilityResultsReportBuilder.PrincipalAxisStability

Returns or sets the principal axis stability.

-------------------------------------

Getter Method

Signature PrincipalAxisStability

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PrincipalAxisStability

Parameters:principalAxisStability (bool) –

New in version NX9.0.0.

License requirements: nx_adv_durability (“NX Advanced Durability”)

StrengthSafetyFactor

DurabilityResultsReportBuilder.StrengthSafetyFactor

Returns or sets the strength safety factor toggle

-------------------------------------

Getter Method

Signature StrengthSafetyFactor

Returns: Return type:bool

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature StrengthSafetyFactor

Parameters:strengthSafetyFactor (bool) –

New in version NX8.0.1.

License requirements: nx_adv_durability (“NX Advanced Durability”)

UseEvents

DurabilityResultsReportBuilder.UseEvents

Returns or sets the use events pop-up menu

-------------------------------------

Getter Method

Signature UseEvents

Returns: Return type:NXOpen.CAE.DurabilityResultsReportBuilderUseEventsEnum

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature UseEvents

Parameters:useEvents (NXOpen.CAE.DurabilityResultsReportBuilderUseEventsEnum) –

New in version NX8.0.1.

License requirements: nx_adv_durability (“NX Advanced Durability”)

UseHighlight

DurabilityResultsReportBuilder.UseHighlight

Returns or sets the use highlight toggle

-------------------------------------

Getter Method

Signature UseHighlight

Returns: Return type:bool

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature UseHighlight

Parameters:useHighlight (bool) –

New in version NX8.0.1.

License requirements: nx_adv_durability (“NX Advanced Durability”)

Method Detail

ExportResultsToCsv

DurabilityResultsReportBuilder.ExportResultsToCsv

Export durability results to a csv file.

Signature ExportResultsToCsv(csvFilename)

Parameters:csvFilename (str) – durability report will be written-out to this file.

New in version NX8.0.1.

License requirements: nx_adv_durability (“NX Advanced Durability”)

Validate

DurabilityResultsReportBuilder.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.