VelocityImpactExcitationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# VelocityImpactExcitationBuilder Class

class `NXOpen.CAE.ResponseSimulation.``VelocityImpactExcitationBuilder`

  Bases: `NXOpen.CAE.ResponseSimulation.ExcitationBuilder`

  Represents a `NXOpen.CAE.ResponseSimulation.VelocityImpactExcitationBuilder`

  To create a new instance of this class, use `NXOpen.CAE.ResponseSimulation.ExcitationCollection.CreateVelocityImpactExcitationBuilder()`

  Default values.

  Property | Value
  --- | ---
  ImpactDirection.DirectionOption | NodalComponent
  ImpactDirection.NodalComponent | Dof1
  ImpactMethod | ConstantVelocity
  ImpactParameters.DropHeight.Value | 1.0 (millimeters part), 1.0 (inches part)
  ImpactParameters.PulseDuration.Value | 1.0 (millimeters part), 1.0 (inches part)
  ImpactParameters.StartPosition | AtDrop
  ImpactParameters.TimeStep.Value | 1.0 (millimeters part), 1.0 (inches part)
  ImpactParameters.Velocity.Value | 1.0 (millimeters part), 1.0 (inches part)

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
DynamicEvent | Returns the parent dynamic event object
ExcitationLocationDefinition | Returns the excitation location definition
ImpactDirection | Returns the impact direction setting
ImpactMethod | Returns or sets the impact method
ImpactParameters | Returns the impact parameters setting
ObjectLabel | Returns the object label
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

VelocityImpactExcitationBuilderImpactMethodType Enumeration | the impact definiton methods

# Property Detail

## ImpactDirection

`VelocityImpactExcitationBuilder.``ImpactDirection`

  Returns the impact direction setting

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

  Getter Method

  Signature `ImpactDirection`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.VelocityImpactDirection`

  New in version NX6.0.0.

  License requirements: None.

## ImpactMethod

`VelocityImpactExcitationBuilder.``ImpactMethod`

  Returns or sets the impact method

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

  Getter Method

  Signature `ImpactMethod`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.VelocityImpactExcitationBuilderImpactMethodType`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ImpactMethod`

  Parameters: | impactMethod (`NXOpen.CAE.ResponseSimulation.VelocityImpactExcitationBuilderImpactMethodType`) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## ImpactParameters

`VelocityImpactExcitationBuilder.``ImpactParameters`

  Returns the impact parameters setting

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

  Getter Method

  Signature `ImpactParameters`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.VelocityImpactParameters`

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

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