TirePropertyTnoBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# TirePropertyTnoBuilder Class

class `NXOpen.Motion.``TirePropertyTnoBuilder`

  Bases: `NXOpen.Motion.TirePropertyBuilder`

  Represents a Builder for Motion TNO Tire Property.

  To create a new instance of this class, use `NXOpen.Motion.TirePropertyTnoCollection.CreateTirePropertyTnoBuilder()`

  Default values.

  Property | Value
  --- | ---
  ContactMethod | SmoothRoad
  Dynamics | SteadyState
  Iswitch.Value | 0 (millimeters part), 0 (inches part)
  IswitchDefinition | Detailed
  Lkx.Value | 1.0 (millimeters part), 1.0 (inches part)
  Lky.Value | 1.0 (millimeters part), 1.0 (inches part)
  Lkyc.Value | 1.0 (millimeters part), 1.0 (inches part)
  Lkzc.Value | 1.0 (millimeters part), 1.0 (inches part)
  Lmux.Value | 1.0 (millimeters part), 1.0 (inches part)
  Lmuy.Value | 1.0 (millimeters part), 1.0 (inches part)
  Ltr.Value | 1.0 (millimeters part), 1.0 (inches part)
  SlipForces | NoMagicFormula
  StaticHold | 1
  StaticRadius.Value | 0.0 (millimeters part), 0.0 (inches part)
  StaticVerticalStiffness.Value | 0.0 (millimeters part), 0.0 (inches part)
  TireSide | Left
  TrackSide | Left
  VerticalDamping.Value | 1.0 (millimeters part), 1.0 (inches part)
  VerticalStiffness.Value | 1.0 (millimeters part), 1.0 (inches part)

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
ContactMethod | Returns or sets the contact method.
DisplayScale | Returns or sets the icon display scale
Dynamics | Returns or sets the dynamics type.
GroupName | Returns or sets the group name
GroupType | Returns or sets the group type
Iswitch | Returns the Iswitch.
IswitchDefinition | Returns or sets the iswitch definition.
Lkx | Returns the LKX scaling coefficient.
Lky | Returns the LKY scaling coefficient.
Lkyc | Returns the LKYC scaling coefficient.
Lkzc | Returns the LKZC scaling coefficient.
Lmux | Returns the LMUX scaling coefficient.
Lmuy | Returns the LMUY scaling coefficient.
Ltr | Returns the LTR scaling coefficient.
Name | Returns or sets the name.
SlipForces | Returns or sets the slip forces type.
StaticHold | Returns or sets the static hold.
StaticRadius | Returns the Static Radius.
StaticVerticalStiffness | Returns the static vertical stiffness.
Tag | Returns the Tag for this object.
TireSide | Returns or sets the tire side.
TnoFile | Returns or sets the TNO file.
TrackSide | Returns or sets the track side.
VerticalDamping | Returns the Vertical Damping scaling coefficient.
VerticalStiffness | Returns the Vertical Stiffness scaling coefficient.

# 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

TirePropertyTnoBuilderContactMethodType Enumeration | The Contact Method type.
TirePropertyTnoBuilderDynamicsType Enumeration | The Dynamics type.
TirePropertyTnoBuilderIswitchDefinitionType Enumeration | The Iswitch Definition type.
TirePropertyTnoBuilderSlipForcesType Enumeration | The Slip Forces type.
TirePropertyTnoBuilderTireSideType Enumeration | The Tire Side type.
TirePropertyTnoBuilderTrackSideType Enumeration | The Track Side type.

# Property Detail

## ContactMethod

`TirePropertyTnoBuilder.``ContactMethod`

  Returns or sets the contact method.

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

  Getter Method

  Signature `ContactMethod`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `ContactMethod`

  Parameters: | contactMethod (`NXOpen.Motion.TirePropertyTnoBuilderContactMethodType`) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Dynamics

`TirePropertyTnoBuilder.``Dynamics`

  Returns or sets the dynamics type.

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

  Getter Method

  Signature `Dynamics`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `Dynamics`

  Parameters: | dynamics (`NXOpen.Motion.TirePropertyTnoBuilderDynamicsType`) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Iswitch

`TirePropertyTnoBuilder.``Iswitch`

  Returns the Iswitch.

  It is a Tire model usage flag.

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

  Getter Method

  Signature `Iswitch`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## IswitchDefinition

`TirePropertyTnoBuilder.``IswitchDefinition`

  Returns or sets the iswitch definition.

  If set to Detailed, 4 parameters are used to specify iswitch: Tire Side, Slip Forces, Dynamics, and Contact Method. Otherwise it is specified as an integer value.

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

  Getter Method

  Signature `IswitchDefinition`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `IswitchDefinition`

  Parameters: | iswitchDef (`NXOpen.Motion.TirePropertyTnoBuilderIswitchDefinitionType`) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Lkx

`TirePropertyTnoBuilder.``Lkx`

  Returns the LKX scaling coefficient.

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

  Getter Method

  Signature `Lkx`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Lky

`TirePropertyTnoBuilder.``Lky`

  Returns the LKY scaling coefficient.

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

  Getter Method

  Signature `Lky`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Lkyc

`TirePropertyTnoBuilder.``Lkyc`

  Returns the LKYC scaling coefficient.

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

  Getter Method

  Signature `Lkyc`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Lkzc

`TirePropertyTnoBuilder.``Lkzc`

  Returns the LKZC scaling coefficient.

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

  Getter Method

  Signature `Lkzc`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Lmux

`TirePropertyTnoBuilder.``Lmux`

  Returns the LMUX scaling coefficient.

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

  Getter Method

  Signature `Lmux`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Lmuy

`TirePropertyTnoBuilder.``Lmuy`

  Returns the LMUY scaling coefficient.

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

  Getter Method

  Signature `Lmuy`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Ltr

`TirePropertyTnoBuilder.``Ltr`

  Returns the LTR scaling coefficient.

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

  Getter Method

  Signature `Ltr`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Name

`TirePropertyTnoBuilder.``Name`

  Returns or sets the name.

  It is a uniqe name within tire properties.

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

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `Name`

  Parameters: | name (str) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## SlipForces

`TirePropertyTnoBuilder.``SlipForces`

  Returns or sets the slip forces type.

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

  Getter Method

  Signature `SlipForces`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `SlipForces`

  Parameters: | slipForces (`NXOpen.Motion.TirePropertyTnoBuilderSlipForcesType`) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## StaticHold

`TirePropertyTnoBuilder.``StaticHold`

  Returns or sets the static hold.

  It is ussed for static analysis only. If set to true, holds the tire in position.

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

  Getter Method

  Signature `StaticHold`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `StaticHold`

  Parameters: | staticHold (bool) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## StaticRadius

`TirePropertyTnoBuilder.``StaticRadius`

  Returns the Static Radius.

  It is used for static analysis only. Specifies the tire radius only used in static equilibrating force calculations.

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

  Getter Method

  Signature `StaticRadius`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## StaticVerticalStiffness

`TirePropertyTnoBuilder.``StaticVerticalStiffness`

  Returns the static vertical stiffness.

  It specifies the vertical stiffness only used in static equilibrating force calculations.

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

  Getter Method

  Signature `StaticVerticalStiffness`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## TireSide

`TirePropertyTnoBuilder.``TireSide`

  Returns or sets the tire side.

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

  Getter Method

  Signature `TireSide`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `TireSide`

  Parameters: | tireSide (`NXOpen.Motion.TirePropertyTnoBuilderTireSideType`) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## TnoFile

`TirePropertyTnoBuilder.``TnoFile`

  Returns or sets the TNO file.

  This is a file containing information describing the TNO tire.

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

  Getter Method

  Signature `TnoFile`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `TnoFile`

  Parameters: | fileName (str) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## TrackSide

`TirePropertyTnoBuilder.``TrackSide`

  Returns or sets the track side.

  Only used in combination with a ‘Road Profile’ Road Element that specifies road height vs. traveled distance. The *.rdf road profile file contains 2 tracks, a left track for left wheels and a right track for right wheels.

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

  Getter Method

  Signature `TrackSide`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

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

  Setter Method

  Signature `TrackSide`

  Parameters: | trackSide (`NXOpen.Motion.TirePropertyTnoBuilderTrackSideType`) –

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## VerticalDamping

`TirePropertyTnoBuilder.``VerticalDamping`

  Returns the Vertical Damping scaling coefficient.

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

  Getter Method

  Signature `VerticalDamping`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## VerticalStiffness

`TirePropertyTnoBuilder.``VerticalStiffness`

  Returns the Vertical Stiffness scaling coefficient.

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

  Getter Method

  Signature `VerticalStiffness`

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

  New in version NX11.0.0.

  License requirements: mechanisms (“MECHANISMS”)

# Method Detail

## Validate

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