Class TireAPI

Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll

This class implements APIs for tire.

public static class TireAPI

Inheritance

object ← TireAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

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

Create

[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

The road file of a tire force.

tirePropertyFile 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

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?

The color of a tire force.

symmetricType SymmetricType

The symmetric type of the new .

isInterface bool

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

Returns

Obj

the new object created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'subSystemDocument' argument is null.

FileNotFoundException

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

ArgumentException

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

ArgumentException

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

Reload(Obj, string)

Reload.

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

Parameters

wheelBodyBase Obj

The to reload a wheel body info.

strBodyInfo string

The string body information of a wheel.

Exceptions

ArgumentNullException

Will be thrown if 'wheelBodyBase' is null.

ArgumentException

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