DurabilityLoadPatternBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DurabilityLoadPatternBuilder Class

class `NXOpen.CAE.``DurabilityLoadPatternBuilder`

  Bases: `NXOpen.CAE.DurabilityExcitationBuilder`

  Represents a `CAE.DurabilityLoadPattern` builder.

  There is no kf creator for this.

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
ExcitationName | Returns or sets the excitation name.
Iteration | Returns or sets the iteration.
Loadcase | Returns or sets the load case.
Offset | Returns or sets the offset.
PatternType | Returns or sets the pattern type.
Scale | Returns or sets the scale.
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.
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

DurabilityLoadPatternBuilderPatternTypeEnum Enumeration | the pattern type.

# Property Detail

## Iteration

`DurabilityLoadPatternBuilder.``Iteration`

  Returns or sets the iteration.

  `-------------------------------------`

  Getter Method

  Signature `Iteration`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

  `-------------------------------------`

  Setter Method

  Signature `Iteration`

  Parameters: | iteration (int) –

  New in version NX9.0.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

## Loadcase

`DurabilityLoadPatternBuilder.``Loadcase`

  Returns or sets the load case.

  `-------------------------------------`

  Getter Method

  Signature `Loadcase`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

  `-------------------------------------`

  Setter Method

  Signature `Loadcase`

  Parameters: | loadcase (int) –

  New in version NX7.5.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

## Offset

`DurabilityLoadPatternBuilder.``Offset`

  Returns or sets the offset.

  `-------------------------------------`

  Getter Method

  Signature `Offset`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

  `-------------------------------------`

  Setter Method

  Signature `Offset`

  Parameters: | offset (float) –

  New in version NX7.5.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

## PatternType

`DurabilityLoadPatternBuilder.``PatternType`

  Returns or sets the pattern type.

  `-------------------------------------`

  Getter Method

  Signature `PatternType`

  Returns: |
  Return type: | `NXOpen.CAE.DurabilityLoadPatternBuilderPatternTypeEnum`

  New in version NX7.5.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

  `-------------------------------------`

  Setter Method

  Signature `PatternType`

  Parameters: | patternType (`NXOpen.CAE.DurabilityLoadPatternBuilderPatternTypeEnum`) –

  New in version NX7.5.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

## Scale

`DurabilityLoadPatternBuilder.``Scale`

  Returns or sets the scale.

  `-------------------------------------`

  Getter Method

  Signature `Scale`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

  `-------------------------------------`

  Setter Method

  Signature `Scale`

  Parameters: | scale (float) –

  New in version NX7.5.0.

  License requirements: nx_adv_durability (“NX Advanced Durability”)

# Method Detail

## Validate

`DurabilityLoadPatternBuilder.``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.