Class GearTrainSimulationAPI

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

This class implements APIs for simulation.

public static class GearTrainSimulationAPI

Inheritance

object ← GearTrainSimulationAPI

Extension Methods

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

Methods

ExportDFG(GearTrainDocument, string)

Export DFS file

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

Parameters

document GearTrainDocument

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(GearTrainDocument, string)

Export DFS file

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

Parameters

document GearTrainDocument

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(GearTrainDocument, string)

Export DFSXML file

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

Parameters

document GearTrainDocument

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(GearTrainDocument, string, bool, bool, bool, bool)

Export motion files.

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

Parameters

document GearTrainDocument

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(GearTrainDocument, SimulationParameter)

Run simulation.

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

Parameters

document GearTrainDocument

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.