FunctionComponentData Class — NXOpen Python API Reference 12.0.0 documentation

# FunctionComponentData Class

class `NXOpen.CAE.ResponseSimulation.``FunctionComponentData`

  Bases: `NXOpen.TaggedObject`

  Represents a function component setting of `NXOpen.CAE.ResponseSimulation.NodalFunctionExcitation` on one direction

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
Enable | Returns or sets the option to enable the function component to be used while evaluating
Function | Returns or sets the function to be applied
PhaseAngle | Returns or sets the phase angle.
ScalarFactor | Returns or sets the scalar factor
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
GetComponentType | Returns the component type

# Property Detail

## Enable

`FunctionComponentData.``Enable`

  Returns or sets the option to enable the function component to be used while evaluating

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

  Getter Method

  Signature `Enable`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `Enable`

  Parameters: | enableOption (bool) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## Function

`FunctionComponentData.``Function`

  Returns or sets the function to be applied

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

  Getter Method

  Signature `Function`

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

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `Function`

  Parameters: | excitationFunction (`NXOpen.CAE.Function`) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## PhaseAngle

`FunctionComponentData.``PhaseAngle`

  Returns or sets the phase angle.

  Only available when the onwer event is `NXOpen.CAE.ResponseSimulation.RSEventType.Transient`

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

  Getter Method

  Signature `PhaseAngle`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `PhaseAngle`

  Parameters: | phaseAngle (float) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## ScalarFactor

`FunctionComponentData.``ScalarFactor`

  Returns or sets the scalar factor

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

  Getter Method

  Signature `ScalarFactor`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `ScalarFactor`

  Parameters: | scalarFactor (float) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

# Method Detail

## GetComponentType

`FunctionComponentData.``GetComponentType`

  Returns the component type

  Signature `GetComponentType()`

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

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)