TirePropertyHighOrderParameters Class — NXOpen Python API Reference 12.0.0 documentation

# TirePropertyHighOrderParameters Class

class `NXOpen.Motion.``TirePropertyHighOrderParameters`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a Tire Property builder for the High Order parameters used in Motorcycle and Basic properties.

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
CarcassMass | Returns the carcass mass
LateralDamping | Returns the lateral damping.
LateralEffects | Returns or sets the lateral effects
LateralStiffness | Returns the lateral stiffness.
LongDamping | Returns the longitudinal damping
LongStiffness | Returns the longitudinal stiffness
LongitudinalEffects | Returns or sets the longitudinal effects
RollMoment | Returns or sets the roll moment.
Tag | Returns the Tag for this object.
UnloadingVerticalStiffness | Returns or sets the unloading vertical stiffness.
UnloadingVerticalStiffnessProfile | Returns the Profile.
UnloadingVerticalStiffnessType | Returns or sets the type.
VerticalCarcassEffects | Returns or sets the vertical carcass effects
VerticalStiffnessTransVelocity | Returns the vertical stiffness transitional velocity stiffness This parameter is only used in the `Motion.TirePropertyBasic`.

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

TirePropertyHighOrderParametersUnloadingVertStiffType Enumeration | The block type can be Function when a spline curve is used or Profile when a profile is used.

# Property Detail

## CarcassMass

`TirePropertyHighOrderParameters.``CarcassMass`

  Returns the carcass mass

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

  Getter Method

  Signature `CarcassMass`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## LateralDamping

`TirePropertyHighOrderParameters.``LateralDamping`

  Returns the lateral damping.

  This parameter is only used in the `Motion.TirePropertyBasic`.

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

  Getter Method

  Signature `LateralDamping`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## LateralEffects

`TirePropertyHighOrderParameters.``LateralEffects`

  Returns or sets the lateral effects

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

  Getter Method

  Signature `LateralEffects`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `LateralEffects`

  Parameters: | inValue (bool) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## LateralStiffness

`TirePropertyHighOrderParameters.``LateralStiffness`

  Returns the lateral stiffness.

  This parameter is only used in the `Motion.TirePropertyBasic`.

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

  Getter Method

  Signature `LateralStiffness`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## LongDamping

`TirePropertyHighOrderParameters.``LongDamping`

  Returns the longitudinal damping

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

  Getter Method

  Signature `LongDamping`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## LongStiffness

`TirePropertyHighOrderParameters.``LongStiffness`

  Returns the longitudinal stiffness

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

  Getter Method

  Signature `LongStiffness`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## LongitudinalEffects

`TirePropertyHighOrderParameters.``LongitudinalEffects`

  Returns or sets the longitudinal effects

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

  Getter Method

  Signature `LongitudinalEffects`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `LongitudinalEffects`

  Parameters: | inValue (bool) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## RollMoment

`TirePropertyHighOrderParameters.``RollMoment`

  Returns or sets the roll moment.

  This parameter is only used in the `Motion.TirePropertyBasic`. It is a flag that indicates whether or not the roll moment term introduced by the lateral spring-damper should be calculated. This roll moment is caused by the lateral displacement of the tire patch when a lateral spring-damper (lateral stiff) is included in the tire model. If cornering table or cornering stiffness are used, and roll moment is set to “True”, lateral stiffness is used to determine a lateral deflection that in turn is used to calculate a roll moment.

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

  Getter Method

  Signature `RollMoment`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `RollMoment`

  Parameters: | inValue (bool) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## UnloadingVerticalStiffness

`TirePropertyHighOrderParameters.``UnloadingVerticalStiffness`

  Returns or sets the unloading vertical stiffness.

  This parameter is only used in the `Motion.TirePropertyBasic`.

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

  Getter Method

  Signature `UnloadingVerticalStiffness`

  Returns: |
  Return type: | `NXOpen.Motion.MotionFunction`

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `UnloadingVerticalStiffness`

  Parameters: | func (`NXOpen.Motion.MotionFunction`) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## UnloadingVerticalStiffnessProfile

`TirePropertyHighOrderParameters.``UnloadingVerticalStiffnessProfile`

  Returns the Profile.

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

  Getter Method

  Signature `UnloadingVerticalStiffnessProfile`

  Returns: |
  Return type: | `NXOpen.Motion.SelectFieldData`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## UnloadingVerticalStiffnessType

`TirePropertyHighOrderParameters.``UnloadingVerticalStiffnessType`

  Returns or sets the type.

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

  Getter Method

  Signature `UnloadingVerticalStiffnessType`

  Returns: |
  Return type: | `NXOpen.Motion.TirePropertyHighOrderParametersUnloadingVertStiffType`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `UnloadingVerticalStiffnessType`

  Parameters: | type (`NXOpen.Motion.TirePropertyHighOrderParametersUnloadingVertStiffType`) –

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## VerticalCarcassEffects

`TirePropertyHighOrderParameters.``VerticalCarcassEffects`

  Returns or sets the vertical carcass effects

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

  Getter Method

  Signature `VerticalCarcassEffects`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `VerticalCarcassEffects`

  Parameters: | inValue (bool) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## VerticalStiffnessTransVelocity

`TirePropertyHighOrderParameters.``VerticalStiffnessTransVelocity`

  Returns the vertical stiffness transitional velocity stiffness This parameter is only used in the `Motion.TirePropertyBasic`.

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

  Getter Method

  Signature `VerticalStiffnessTransVelocity`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

# Method Detail

## Validate

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