## On this page

  

 

 # Class TireAPI

 Last update: 16.07.2025 

Namespace: [VM.API.Pre](VM.API.Pre.md)  
Assembly: VM.API.Pre.dll

This class implements APIs for tire.

```csharp
public static class TireAPI

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [TireAPI](VM.API.Pre.TireAPI.md)

#### Extension Methods

[LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### CreateTire(SubSystemDocument, string, string, TMatrix, SideType, string, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, Color?, SymmetricType, bool)

Create

```csharp
[NotNull(new string[] { "subSystemDocument" })]
[ExistFile(new string[] { "roadFile", "tirePropertyFile" })]
public static Obj CreateTire(this SubSystemDocument subSystemDocument, string roadFile, string tirePropertyFile, TMatrix transform, WheelBodyBase.SideType side = SideType.Left, string name = "", ExpressionValueVariable? cmOffset = null, ExpressionValueVariable? mass = null, ExpressionValueVariable? lxxlyy = null, ExpressionValueVariable? lzz = null, ExpressionValueVariable? wheelCenterOffset = null, ExpressionValueVariable? longitudinalVelocity = null, ExpressionValueVariable? spinVelocity = null, Color? color = null, SymmetricType symmetricType = SymmetricType.None, bool isInterface = false)

```

#### Parameters

`subSystemDocument` SubSystemDocument

The  to create a tire force.

`roadFile` [string](https://learn.microsoft.com/dotnet/api/system.string)

The road file of a tire force.

`tirePropertyFile` [string](https://learn.microsoft.com/dotnet/api/system.string)

The tire property file of a tire force.

`transform` TMatrix

The transform of a tire force.

`side` WheelBodyBase.SideType

The side of a tire force.

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of a leaf spring.

`cmOffset` ExpressionValueVariable?

The CM Offset of a tire force.

`mass` ExpressionValueVariable?

The mass of a tire force.

`lxxlyy` ExpressionValueVariable?

The lxxlyy of a tire force.

`lzz` ExpressionValueVariable?

The lzz of a tire force.

`wheelCenterOffset` ExpressionValueVariable?

The wheel center offset of a tire force.

`longitudinalVelocity` ExpressionValueVariable?

The longitudinal velocity of a tire force.

`spinVelocity` ExpressionValueVariable?

The spin velocity of a tire force.

`color` [Color](https://learn.microsoft.com/dotnet/api/system.drawing.color)?

The color of a tire force.

`symmetricType` SymmetricType

The symmetric type of the new .

`isInterface` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

'true' if it is interface body. Otherwise, 'false'.

#### Returns

[Obj](VM.API.Pre.Obj.md)

the new  object created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'subSystemDocument' argument is null.

[FileNotFoundException](https://learn.microsoft.com/dotnet/api/system.io.filenotfoundexception)

Will be thrown if 'roadFile', 'tirePropertyFile' file does not exist.

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

Will be thrown if the extension of 'roadFile' is not 'rdf' or if the extension of 'tirePropertyFile' is not 'tir'.

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

Will be thrown if the magnitude of 'transform' X, Y, Z is equal to 0.

### Reload(Obj, string)

Reload.

```csharp
[NotNull(new string[] { "wheelBodyBase" })]
[MatchTypeObj(new object[] { "wheelBodyBase", typeof(WheelBodyBase) })]
public static void Reload(this Obj wheelBodyBase, string strBodyInfo)

```

#### Parameters

`wheelBodyBase` [Obj](VM.API.Pre.Obj.md)

The  to reload a wheel body info.

`strBodyInfo` [string](https://learn.microsoft.com/dotnet/api/system.string)

The string body information of a wheel.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'wheelBodyBase' is null.

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

Will be thrown if the type of 'wheelBodyBase' is not .