## On this page

  

 

 # Class CarSimulationAPI

 Last update: 16.07.2025 

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

This class implements APIs for simulation in car.

```csharp
public static class CarSimulationAPI

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [CarSimulationAPI](VM.API.Pre.Car.CarSimulationAPI.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(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFG_VM_Managed_DAFUL_Car_TestRigDocument_System_String_"></a> ExportDFG(TestRigDocument, string)

Export DFG file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFG(this TestRigDocument document, string targetPath)

```

#### Parameters

`document` TestRigDocument

The  for exporting DFG file. If null, the active document will be used.

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

The file path to export DFG file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFG_VM_Managed_DAFUL_Car_VehicleTestRigDocument_System_String_"></a> ExportDFG(VehicleTestRigDocument, string)

Export DFG file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFG(this VehicleTestRigDocument document, string targetPath)

```

#### Parameters

`document` VehicleTestRigDocument

The  for exporting DFG file. If null, the active document will be used.

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

The file path to export DFG file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFG_VM_Managed_DAFUL_Car_TireTestRigDocument_System_String_"></a> ExportDFG(TireTestRigDocument, string)

Export DFG file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFG(this TireTestRigDocument document, string targetPath)

```

#### Parameters

`document` TireTestRigDocument

The  for exporting DFG file. If null, the active document will be used.

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

The file path to export DFG file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFG_VM_Managed_DAFUL_Car_FourPostTestRigDocument_System_String_"></a> ExportDFG(FourPostTestRigDocument, string)

Export DFG file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFG(this FourPostTestRigDocument document, string targetPath)

```

#### Parameters

`document` FourPostTestRigDocument

The  for exporting DFG file. If null, the active document will be used.

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

The file path to export DFG file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFG_VM_Managed_DAFUL_Car_ShimmyJudderTestRigDocument_System_String_"></a> ExportDFG(ShimmyJudderTestRigDocument, string)

Export DFG file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFG(this ShimmyJudderTestRigDocument document, string targetPath)

```

#### Parameters

`document` ShimmyJudderTestRigDocument

The  for exporting DFG file. If null, the active document will be used.

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

The file path to export DFG file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFS_VM_Managed_DAFUL_Car_TestRigDocument_System_String_"></a> ExportDFS(TestRigDocument, string)

Export DFS file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFS(this TestRigDocument document, string targetPath)

```

#### Parameters

`document` TestRigDocument

The  for exporting DFS file. If null, the active document will be used.

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

The file path to export DFS file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFS_VM_Managed_DAFUL_Car_VehicleTestRigDocument_System_String_"></a> ExportDFS(VehicleTestRigDocument, string)

Export DFS file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFS(this VehicleTestRigDocument document, string targetPath)

```

#### Parameters

`document` VehicleTestRigDocument

The  for exporting DFS file. If null, the active document will be used.

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

The file path to export DFS file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFS_VM_Managed_DAFUL_Car_TireTestRigDocument_System_String_"></a> ExportDFS(TireTestRigDocument, string)

Export DFS file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFS(this TireTestRigDocument document, string targetPath)

```

#### Parameters

`document` TireTestRigDocument

The  for exporting DFS file. If null, the active document will be used.

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

The file path to export DFS file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFS_VM_Managed_DAFUL_Car_FourPostTestRigDocument_System_String_"></a> ExportDFS(FourPostTestRigDocument, string)

Export DFS file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFS(this FourPostTestRigDocument document, string targetPath)

```

#### Parameters

`document` FourPostTestRigDocument

The  for exporting DFS file. If null, the active document will be used.

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

The file path to export DFS file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFS_VM_Managed_DAFUL_Car_ShimmyJudderTestRigDocument_System_String_"></a> ExportDFS(ShimmyJudderTestRigDocument, string)

Export DFS file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFS(this ShimmyJudderTestRigDocument document, string targetPath)

```

#### Parameters

`document` ShimmyJudderTestRigDocument

The  for exporting DFS file. If null, the active document will be used.

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

The file path to export DFS file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFSXML_VM_Managed_DAFUL_Car_TestRigDocument_System_String_"></a> ExportDFSXML(TestRigDocument, string)

Export DFSXML file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFSXML(this TestRigDocument document, string targetPath)

```

#### Parameters

`document` TestRigDocument

The  for exporting DFSXML file. If null, the active document will be used.

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

The file path to export DFSXML file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFSXML_VM_Managed_DAFUL_Car_VehicleTestRigDocument_System_String_"></a> ExportDFSXML(VehicleTestRigDocument, string)

Export DFSXML file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFSXML(this VehicleTestRigDocument document, string targetPath)

```

#### Parameters

`document` VehicleTestRigDocument

The  for exporting DFSXML file. If null, the active document will be used.

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

The file path to export DFSXML file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFSXML_VM_Managed_DAFUL_Car_TireTestRigDocument_System_String_"></a> ExportDFSXML(TireTestRigDocument, string)

Export DFSXML file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFSXML(this TireTestRigDocument document, string targetPath)

```

#### Parameters

`document` TireTestRigDocument

The  for exporting DFSXML file. If null, the active document will be used.

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

The file path to export DFSXML file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFSXML_VM_Managed_DAFUL_Car_FourPostTestRigDocument_System_String_"></a> ExportDFSXML(FourPostTestRigDocument, string)

Export DFSXML file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFSXML(this FourPostTestRigDocument document, string targetPath)

```

#### Parameters

`document` FourPostTestRigDocument

The  for exporting DFSXML file. If null, the active document will be used.

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

The file path to export DFSXML file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_ExportDFSXML_VM_Managed_DAFUL_Car_ShimmyJudderTestRigDocument_System_String_"></a> ExportDFSXML(ShimmyJudderTestRigDocument, string)

Export DFSXML file

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFSXML(this ShimmyJudderTestRigDocument document, string targetPath)

```

#### Parameters

`document` ShimmyJudderTestRigDocument

The  for exporting DFSXML file. If null, the active document will be used.

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

The file path to export DFSXML file exclude file extension.

#### Exceptions

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

Will be thrown if 'document' or 'targetPath' arguments are empty.

### <a id="VM_API_Pre_Car_CarSimulationAPI_RunSimulation_VM_Managed_DAFUL_Car_TestRigDocument_VM_Managed_DAFUL_Operation_SimulationRun_SimulationParameter_"></a> RunSimulation(TestRigDocument, SimulationParameter)

Run simulation.

```csharp
[NotNull(new string[] { "document" })]
public static void RunSimulation(this TestRigDocument document, SimulationRun.SimulationParameter simulationParameter = null)

```

#### Parameters

`document` TestRigDocument

The  for simulate. If null, the active document will be used.

`simulationParameter` SimulationRun.SimulationParameter

The simulation parameter.

#### Exceptions

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

Will be thrown if 'document' argument is empty.

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

Will be thrown if 'document' argument is not assembly.

### <a id="VM_API_Pre_Car_CarSimulationAPI_RunSimulation_VM_Managed_DAFUL_Car_VehicleTestRigDocument_VM_Managed_DAFUL_Operation_SimulationRun_SimulationParameter_"></a> RunSimulation(VehicleTestRigDocument, SimulationParameter)

Run simulation.

```csharp
[NotNull(new string[] { "document" })]
public static void RunSimulation(this VehicleTestRigDocument document, SimulationRun.SimulationParameter simulationParameter = null)

```

#### Parameters

`document` VehicleTestRigDocument

The  for simulate. If null, the active document will be used.

`simulationParameter` SimulationRun.SimulationParameter

The simulation parameter.

#### Exceptions

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

Will be thrown if 'document' argument is empty.

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

Will be thrown if 'document' argument is not assembly.

### <a id="VM_API_Pre_Car_CarSimulationAPI_RunSimulation_VM_Managed_DAFUL_Car_TireTestRigDocument_VM_Managed_DAFUL_Operation_SimulationRun_SimulationParameter_"></a> RunSimulation(TireTestRigDocument, SimulationParameter)

Run simulation.

```csharp
[NotNull(new string[] { "document" })]
public static void RunSimulation(this TireTestRigDocument document, SimulationRun.SimulationParameter simulationParameter = null)

```

#### Parameters

`document` TireTestRigDocument

The  for simulate. If null, the active document will be used.

`simulationParameter` SimulationRun.SimulationParameter

The simulation parameter.

#### Exceptions

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

Will be thrown if 'document' argument is empty.

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

Will be thrown if 'document' argument is not assembly.

### <a id="VM_API_Pre_Car_CarSimulationAPI_RunSimulation_VM_Managed_DAFUL_Car_FourPostTestRigDocument_VM_Managed_DAFUL_Operation_SimulationRun_SimulationParameter_"></a> RunSimulation(FourPostTestRigDocument, SimulationParameter)

Run simulation.

```csharp
[NotNull(new string[] { "document" })]
public static void RunSimulation(this FourPostTestRigDocument document, SimulationRun.SimulationParameter simulationParameter = null)

```

#### Parameters

`document` FourPostTestRigDocument

The  for simulate. If null, the active document will be used.

`simulationParameter` SimulationRun.SimulationParameter

The simulation parameter.

#### Exceptions

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

Will be thrown if 'document' argument is empty.

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

Will be thrown if 'document' argument is not assembly.

### <a id="VM_API_Pre_Car_CarSimulationAPI_RunSimulation_VM_Managed_DAFUL_Car_ShimmyJudderTestRigDocument_VM_Managed_DAFUL_Operation_SimulationRun_SimulationParameter_"></a> RunSimulation(ShimmyJudderTestRigDocument, SimulationParameter)

Run simulation.

```csharp
[NotNull(new string[] { "document" })]
public static void RunSimulation(this ShimmyJudderTestRigDocument document, SimulationRun.SimulationParameter simulationParameter = null)

```

#### Parameters

`document` ShimmyJudderTestRigDocument

The  for simulate. If null, the active document will be used.

`simulationParameter` SimulationRun.SimulationParameter

The simulation parameter.

#### Exceptions

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

Will be thrown if 'document' argument is empty.

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

Will be thrown if 'document' argument is not assembly.