RunSimulationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# RunSimulationBuilder Class

class `NXOpen.Tooling.``RunSimulationBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Tooling.RunSimulationBuilder` to animate the model, analyze the collision and reference.

  None is returned To create a new instance of this class, use `NXOpen.Tooling.ProgressiveDieManager.CreateRunSimulationBuilder()`

  Default values.

  Property | Value
  --- | ---
  AngleExpression.Value | 0
  CheckCollision | 0
  ClearanceCollision | 1.0 (millimeters part), 0.04 (inches part)
  CollisionCheckOption | MeshTriangleIntersection
  GotoRun | 0
  HighlightCollision | 0
  IgnoreTouching | 0
  IntervalDimension.Value | 2
  StopCheckCollision | 0
  TimeExpression.Value | 0 (millimeters part), 0 (inches part)

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
AngleExpression | Returns the angle of the cycle position
CheckCollision | Returns or sets the check collision
ClearanceCollision | Returns or sets the clearance value of collision or interference
CollisionCheckOption | Returns or sets the collision check method option
GotoRun | Returns or sets the goto run angle stores the position in the cycle
HighlightCollision | Returns or sets the highlight collision bodies flag
IgnoreTouching | Returns or sets the ignore touching flag
IntervalDimension | Returns the interval value of refresh
StopCheckCollision | Returns or sets the stop check collision if find next collision
Tag | Returns the Tag for this object.
TimeExpression | Returns the time in the cycle

# Methods

Method | Description
--- | ---
CollisionConfiguration | Modify the collision by invoking collision configuration dialog
CollisionInformation | List collision changes information in the information window
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.
GotoEnd | Run goto end of the simulation
GotoStart | Goto the start of the simulation
Next | Next simulation result
Play | Play simulation forwards
PlayBackwards | Play simulation backwards
Previous | Previous simulation result
ResetIgnoredCollision | Reset all ignored settings of the collision
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Stop | Stop simulation
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

RunSimulationBuilderCollisionCheckOptions Enumeration | Specifies the collision check method

# Property Detail

## AngleExpression

`RunSimulationBuilder.``AngleExpression`

  Returns the angle of the cycle position

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

  Getter Method

  Signature `AngleExpression`

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

  New in version NX10.0.0.

  License requirements: None.

## CheckCollision

`RunSimulationBuilder.``CheckCollision`

  Returns or sets the check collision

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

  Getter Method

  Signature `CheckCollision`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CheckCollision`

  Parameters: | checkCollision (bool) –

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## ClearanceCollision

`RunSimulationBuilder.``ClearanceCollision`

  Returns or sets the clearance value of collision or interference

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

  Getter Method

  Signature `ClearanceCollision`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ClearanceCollision`

  Parameters: | clearanceCollision (float) –

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## CollisionCheckOption

`RunSimulationBuilder.``CollisionCheckOption`

  Returns or sets the collision check method option

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

  Getter Method

  Signature `CollisionCheckOption`

  Returns: |
  Return type: | `NXOpen.Tooling.RunSimulationBuilderCollisionCheckOptions`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CollisionCheckOption`

  Parameters: | collisionCheckMethod (`NXOpen.Tooling.RunSimulationBuilderCollisionCheckOptions`) –

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## GotoRun

`RunSimulationBuilder.``GotoRun`

  Returns or sets the goto run angle stores the position in the cycle

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

  Getter Method

  Signature `GotoRun`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `GotoRun`

  Parameters: | gotoRun (float) –

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## HighlightCollision

`RunSimulationBuilder.``HighlightCollision`

  Returns or sets the highlight collision bodies flag

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

  Getter Method

  Signature `HighlightCollision`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HighlightCollision`

  Parameters: | highlightCollision (bool) –

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## IgnoreTouching

`RunSimulationBuilder.``IgnoreTouching`

  Returns or sets the ignore touching flag

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

  Getter Method

  Signature `IgnoreTouching`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IgnoreTouching`

  Parameters: | ignoreTouching (bool) –

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## IntervalDimension

`RunSimulationBuilder.``IntervalDimension`

  Returns the interval value of refresh

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

  Getter Method

  Signature `IntervalDimension`

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

  New in version NX10.0.0.

  License requirements: None.

## StopCheckCollision

`RunSimulationBuilder.``StopCheckCollision`

  Returns or sets the stop check collision if find next collision

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

  Getter Method

  Signature `StopCheckCollision`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StopCheckCollision`

  Parameters: | stopCheckCollision (bool) –

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## TimeExpression

`RunSimulationBuilder.``TimeExpression`

  Returns the time in the cycle

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

  Getter Method

  Signature `TimeExpression`

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

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## CollisionConfiguration

`RunSimulationBuilder.``CollisionConfiguration`

  Modify the collision by invoking collision configuration dialog

  Signature `CollisionConfiguration()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## CollisionInformation

`RunSimulationBuilder.``CollisionInformation`

  List collision changes information in the information window

  Signature `CollisionInformation()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## GotoEnd

`RunSimulationBuilder.``GotoEnd`

  Run goto end of the simulation

  Signature `GotoEnd()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## GotoStart

`RunSimulationBuilder.``GotoStart`

  Goto the start of the simulation

  Signature `GotoStart()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## Next

`RunSimulationBuilder.``Next`

  Next simulation result

  Signature `Next()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## Play

`RunSimulationBuilder.``Play`

  Play simulation forwards

  Signature `Play()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## PlayBackwards

`RunSimulationBuilder.``PlayBackwards`

  Play simulation backwards

  Signature `PlayBackwards()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## Previous

`RunSimulationBuilder.``Previous`

  Previous simulation result

  Signature `Previous()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## ResetIgnoredCollision

`RunSimulationBuilder.``ResetIgnoredCollision`

  Reset all ignored settings of the collision

  Signature `ResetIgnoredCollision()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## Stop

`RunSimulationBuilder.``Stop`

  Stop simulation

  Signature `Stop()`

  New in version NX10.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## Validate

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