MechanicalLoadSumBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MechanicalLoadSumBuilder Class

class `NXOpen.CAE.``MechanicalLoadSumBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.CAE.MechanicalLoadSumBuilder`

  To create a new instance of this class, use `NXOpen.CAE.ModelCheckManager.CreateMechanicalLoadSumBuilder()`

  New in version NX5.0.1.

# Properties

Property | Description
--- | ---
EvaluationFrequency | Returns the evaluation frequency
EvaluationTime | Returns the evaluation time
ReferenceCsys | Returns or sets the reference csys
Tag | Returns the Tag for this object.
UserSpecifiedUnit | Returns or sets the output result unit

# 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.
GetLoads | The load objects
GetObject | Returns the object currently being edited by this builder.
GetSolution | The solution object
GetSubcase | The subcase object
SetLoads | Sets the loads
SetSolution | The solution object
SetSubcase | The subcase object
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

MechanicalLoadSumBuilderUserUnit Enumeration | User Specified output unit

# Property Detail

## EvaluationFrequency

`MechanicalLoadSumBuilder.``EvaluationFrequency`

  Returns the evaluation frequency

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

  Getter Method

  Signature `EvaluationFrequency`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX5.0.0.

  License requirements: None.

## EvaluationTime

`MechanicalLoadSumBuilder.``EvaluationTime`

  Returns the evaluation time

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

  Getter Method

  Signature `EvaluationTime`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX5.0.0.

  License requirements: None.

## ReferenceCsys

`MechanicalLoadSumBuilder.``ReferenceCsys`

  Returns or sets the reference csys

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

  Getter Method

  Signature `ReferenceCsys`

  Returns: |
  Return type: | `NXOpen.CoordinateSystem`

  New in version NX5.0.1.

  License requirements: None.

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

  Setter Method

  Signature `ReferenceCsys`

  Parameters: | referenceCsys (`NXOpen.CoordinateSystem`) –

  New in version NX5.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## UserSpecifiedUnit

`MechanicalLoadSumBuilder.``UserSpecifiedUnit`

  Returns or sets the output result unit

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

  Getter Method

  Signature `UserSpecifiedUnit`

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

  New in version NX5.0.1.

  License requirements: None.

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

  Setter Method

  Signature `UserSpecifiedUnit`

  Parameters: | userSpecifiedUnit (`NXOpen.CAE.MechanicalLoadSumBuilderUserUnit`) –

  New in version NX5.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

# Method Detail

## GetLoads

`MechanicalLoadSumBuilder.``GetLoads`

  The load objects

  Signature `GetLoads()`

  Returns: |
  Return type: | list of `NXOpen.CAE.SimLoad`

  New in version NX5.0.1.

  License requirements: None.

## GetSolution

`MechanicalLoadSumBuilder.``GetSolution`

  The solution object

  Signature `GetSolution()`

  Returns: | Ask Solution
  Return type: | `NXOpen.CAE.SimSolution`

  New in version NX5.0.1.

  License requirements: None.

## GetSubcase

`MechanicalLoadSumBuilder.``GetSubcase`

  The subcase object

  Signature `GetSubcase()`

  Returns: | Ask Solutionstep
  Return type: | `NXOpen.CAE.SimSolutionStep`

  New in version NX5.0.1.

  License requirements: None.

## SetLoads

`MechanicalLoadSumBuilder.``SetLoads`

  Sets the loads

  Signature `SetLoads(loads)`

  Parameters: | loads (list of `NXOpen.CAE.SimLoad`) – sets the loads

  New in version NX5.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## SetSolution

`MechanicalLoadSumBuilder.``SetSolution`

  The solution object

  Signature `SetSolution(solution)`

  Parameters: | solution (`NXOpen.CAE.SimSolution`) – Set Solution

  New in version NX5.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## SetSubcase

`MechanicalLoadSumBuilder.``SetSubcase`

  The subcase object

  Signature `SetSubcase(subcase)`

  Parameters: | subcase (`NXOpen.CAE.SimSolutionStep`) – Get Solutionstep

  New in version NX5.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Validate

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