Class CarSimulationAPI

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

This class implements APIs for simulation in car.

public static class CarSimulationAPI

Inheritance

object ← CarSimulationAPI

Extension Methods

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

Methods

ExportDFG(TestRigDocument, string)

Export DFG file

[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

The file path to export DFG file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFG(VehicleTestRigDocument, string)

Export DFG file

[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

The file path to export DFG file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFG(TireTestRigDocument, string)

Export DFG file

[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

The file path to export DFG file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFG(FourPostTestRigDocument, string)

Export DFG file

[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

The file path to export DFG file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFG(ShimmyJudderTestRigDocument, string)

Export DFG file

[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

The file path to export DFG file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFS(TestRigDocument, string)

Export DFS file

[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

The file path to export DFS file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFS(VehicleTestRigDocument, string)

Export DFS file

[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

The file path to export DFS file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFS(TireTestRigDocument, string)

Export DFS file

[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

The file path to export DFS file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFS(FourPostTestRigDocument, string)

Export DFS file

[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

The file path to export DFS file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFS(ShimmyJudderTestRigDocument, string)

Export DFS file

[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

The file path to export DFS file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFSXML(TestRigDocument, string)

Export DFSXML file

[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

The file path to export DFSXML file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFSXML(VehicleTestRigDocument, string)

Export DFSXML file

[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

The file path to export DFSXML file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFSXML(TireTestRigDocument, string)

Export DFSXML file

[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

The file path to export DFSXML file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFSXML(FourPostTestRigDocument, string)

Export DFSXML file

[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

The file path to export DFSXML file exclude file extension.

Exceptions

ArgumentNullException

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

ExportDFSXML(ShimmyJudderTestRigDocument, string)

Export DFSXML file

[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

The file path to export DFSXML file exclude file extension.

Exceptions

ArgumentNullException

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

ExportMotionFiles(TestRigDocument, string, bool, bool, bool, bool)

Export motion files.

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportMotionFiles(this TestRigDocument document, string targetPath, bool writeDFS, bool writeXML, bool writeDFG, bool includeReferenceFiles)

Parameters

document TestRigDocument

The for exporting motion files. If null, the active document will be used.

targetPath string

The file path to export motion files exclude file extension.

writeDFS bool

The flag for whether to write on dfs or not.

writeXML bool

The flag for whether to write on dfsxml or not.

writeDFG bool

The flag for whether to write on dfg or not.

includeReferenceFiles bool

The flag for whether to include reference files or not.

Exceptions

ArgumentNullException

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

ExportMotionFiles(VehicleTestRigDocument, string, bool, bool, bool, bool)

Export motion files.

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportMotionFiles(this VehicleTestRigDocument document, string targetPath, bool writeDFS, bool writeXML, bool writeDFG, bool includeReferenceFiles)

Parameters

document VehicleTestRigDocument

The for exporting motion files. If null, the active document will be used.

targetPath string

The file path to export motion files exclude file extension.

writeDFS bool

The flag for whether to write on dfs or not.

writeXML bool

The flag for whether to write on dfsxml or not.

writeDFG bool

The flag for whether to write on dfg or not.

includeReferenceFiles bool

The flag for whether to include reference files or not.

Exceptions

ArgumentNullException

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

ExportMotionFiles(TireTestRigDocument, string, bool, bool, bool, bool)

Export motion files.

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportMotionFiles(this TireTestRigDocument document, string targetPath, bool writeDFS, bool writeXML, bool writeDFG, bool includeReferenceFiles)

Parameters

document TireTestRigDocument

The for exporting motion files. If null, the active document will be used.

targetPath string

The file path to export motion files exclude file extension.

writeDFS bool

The flag for whether to write on dfs or not.

writeXML bool

The flag for whether to write on dfsxml or not.

writeDFG bool

The flag for whether to write on dfg or not.

includeReferenceFiles bool

The flag for whether to include reference files or not.

Exceptions

ArgumentNullException

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

ExportMotionFiles(FourPostTestRigDocument, string, bool, bool, bool, bool)

Export motion files.

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportMotionFiles(this FourPostTestRigDocument document, string targetPath, bool writeDFS, bool writeXML, bool writeDFG, bool includeReferenceFiles)

Parameters

document FourPostTestRigDocument

The for exporting motion files. If null, the active document will be used.

targetPath string

The file path to export motion files exclude file extension.

writeDFS bool

The flag for whether to write on dfs or not.

writeXML bool

The flag for whether to write on dfsxml or not.

writeDFG bool

The flag for whether to write on dfg or not.

includeReferenceFiles bool

The flag for whether to include reference files or not.

Exceptions

ArgumentNullException

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

ExportMotionFiles(ShimmyJudderTestRigDocument, string, bool, bool, bool, bool)

Export motion files.

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportMotionFiles(this ShimmyJudderTestRigDocument document, string targetPath, bool writeDFS, bool writeXML, bool writeDFG, bool includeReferenceFiles)

Parameters

document ShimmyJudderTestRigDocument

The for exporting motion files. If null, the active document will be used.

targetPath string

The file path to export motion files exclude file extension.

writeDFS bool

The flag for whether to write on dfs or not.

writeXML bool

The flag for whether to write on dfsxml or not.

writeDFG bool

The flag for whether to write on dfg or not.

includeReferenceFiles bool

The flag for whether to include reference files or not.

Exceptions

ArgumentNullException

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

RunSimulation(TestRigDocument, SimulationParameter)

Run simulation.

[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

Will be thrown if 'document' argument is empty.

ArgumentException

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

RunSimulation(VehicleTestRigDocument, SimulationParameter)

Run simulation.

[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

Will be thrown if 'document' argument is empty.

ArgumentException

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

RunSimulation(TireTestRigDocument, SimulationParameter)

Run simulation.

[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

Will be thrown if 'document' argument is empty.

ArgumentException

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

RunSimulation(FourPostTestRigDocument, SimulationParameter)

Run simulation.

[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

Will be thrown if 'document' argument is empty.

ArgumentException

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

RunSimulation(ShimmyJudderTestRigDocument, SimulationParameter)

Run simulation.

[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

Will be thrown if 'document' argument is empty.

ArgumentException

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