Class CarDocumentAPI
Last update: 09.03.2026Namespace: VM.API.Pre.Car
Assembly: VM.API.Pre.Car.dll
This class implements APIs for document.
public static class CarDocumentAPI
Inheritance
object ← CarDocumentAPI
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)
Methods
ChangeGroupDriveline(TestRigDocumentBase, bool, bool)
Change group driveline.
[NotNull(new string[] { "document" })]
public static void ChangeGroupDriveline(this TestRigDocumentBase document, bool activeFront, bool activeRear)
Parameters
document TestRigDocumentBase
The document to be changed group.
activeFront bool
The flag for active front.
activeRear bool
The flag for active rear.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if 'document' argument is not assembly.
ChangeGroupKinematicAndCompliance(TestRigDocumentBase, bool)
Change group kinematic and compliance.
[NotNull(new string[] { "document" })]
public static void ChangeGroupKinematicAndCompliance(this TestRigDocumentBase document, bool kinematic)
Parameters
document TestRigDocumentBase
The document to be changed group.
kinematic bool
The flag for using kinematic.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if 'document' argument is not assembly.
CreateNewAntiRollBarFromTemplateDocument(string, string, MinorRole)
Create
public static AntiRollBarDocument CreateNewAntiRollBarFromTemplateDocument(string newAntiRollBarFromTemplateFilePath, string existedAntiRollBarTemplateFilePath, MinorRole minorRole = MinorRole.Any)
Parameters
newAntiRollBarFromTemplateFilePath string
The file path of new anti-roll bar from template file path.
existedAntiRollBarTemplateFilePath string
The file path of existed anti-roll bar template file path.
minorRole MinorRole
The minor role type. The default value is Any.
Returns
The new
CreateNewAntiRollBarTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static AntiRollBarDocument CreateNewAntiRollBarTemplateDocument(string newAntiRollBarFilePath, string documentName = "AntiRollBar", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newAntiRollBarFilePath string
The file path of new anti-roll bar.
documentName string
The name of document. The default value is AntiRollBar.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newAntiRollBarFilePath' argument is null.
CreateNewBodyFromTemplateDocument(string, string, MinorRole)
Create
public static BodyDocument CreateNewBodyFromTemplateDocument(string newBodyFromTemplateFilePath, string existedBodyTemplateFilePath, MinorRole minorRole = MinorRole.Any)
Parameters
newBodyFromTemplateFilePath string
The file path of new body from template file path.
existedBodyTemplateFilePath string
The file path of existed body template file path.
minorRole MinorRole
The minor role type. The default value is Any.
Returns
The new
CreateNewBodyTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static BodyDocument CreateNewBodyTemplateDocument(string newBodyFilePath, string documentName = "Body", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newBodyFilePath string
The file path of new body.
documentName string
The name of document. The default value is Body.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newBodyFilePath' argument is null.
CreateNewBrakeSystemFromTemplateDocument(string, string, MinorRole)
Create
public static BrakeSystemDocument CreateNewBrakeSystemFromTemplateDocument(string newBrakeSystemFromTemplateFilePath, string existedBrakeSystemTemplateFilePath, MinorRole minorRole = MinorRole.Any)
Parameters
newBrakeSystemFromTemplateFilePath string
The file path of new brake system from template file path.
existedBrakeSystemTemplateFilePath string
The file path of existed brake system template file path.
minorRole MinorRole
The minor role type. The default value is Any.
Returns
The new
CreateNewBrakeSystemTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static BrakeSystemDocument CreateNewBrakeSystemTemplateDocument(string newBrakeSystemFilePath, string documentName = "BrakeSystem", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newBrakeSystemFilePath string
The file path of new brake system.
documentName string
The name of document. The default value is BrakeSystem.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newBrakeSystemFilePath' argument is null.
CreateNewBumpStopPropertyDocument(string, string, Unit, LengthUnitType)
Create
public static PropertyBumpstopDocument CreateNewBumpStopPropertyDocument(string newBumpStopPropertyFilePath, string documentName = "Bumpstop", Unit unit = null, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newBumpStopPropertyFilePath string
The file path of new bump stop property file path.
documentName string
The name of document. The default value is Bumpstop.
unit Unit
The unit information.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
CreateNewBushPropertyDocument(string, string, Unit, LengthUnitType)
Create
public static PropertyBushDocument CreateNewBushPropertyDocument(string newBushPropertyFilePath, string documentName = "Bush", Unit unit = null, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newBushPropertyFilePath string
The file path of new bump stop property file path.
documentName string
The name of document. The default value is Bush.
unit Unit
The unit information.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
CreateNewDamperPropertyDocument(string, string, Unit, LengthUnitType)
Create
public static PropertyDamperDocument CreateNewDamperPropertyDocument(string newDamperPropertyFilePath, string documentName = "Damper", Unit unit = null, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newDamperPropertyFilePath string
The file path of new bump stop property file path.
documentName string
The name of document. The default value is Damper.
unit Unit
The unit information.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
CreateNewDriveLineFromTemplateDocument(string, string, MinorRole)
Create
public static DriveLineDocument CreateNewDriveLineFromTemplateDocument(string newDriveLineFromTemplateFilePath, string existedDriveLineTemplateFilePath, MinorRole minorRole = MinorRole.Any)
Parameters
newDriveLineFromTemplateFilePath string
The file path of new drive line from template file path.
existedDriveLineTemplateFilePath string
The file path of existed drive line template file path.
minorRole MinorRole
The minor role type. The default value is Any.
Returns
The new
CreateNewDriveLineTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static DriveLineDocument CreateNewDriveLineTemplateDocument(string newDriveLineFilePath, string documentName = "DriveLine", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newDriveLineFilePath string
The file path of new drive line.
documentName string
The name of document. The default value is DriveLine.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newDriveLineFilePath' argument is null.
CreateNewFourPostTestRigFromTemplateDocument(string, string, string, string, string, string, string, string, string, string, string[], Vector, Unit, double, LengthUnitType)
Create
[NotNullOrEmpty(new string[] { "newTestRigFromTemplateFilePath" })]
[ExistFile(new string[] { "testRigTemplateFilePath", "frontSuspensionFromTemplateFilePath", "rearSuspensionFromTemplateFilePath", "steeringFromTemplateFilePath", "frontWheelFromTemplateFilePath", "rearWheelFromTemplateFilePath", "bodyFromTemplateFilePath" })]
public static FourPostTestRigDocument CreateNewFourPostTestRigFromTemplateDocument(string newTestRigFromTemplateFilePath, string testRigTemplateFilePath, string frontSuspensionFromTemplateFilePath, string rearSuspensionFromTemplateFilePath, string steeringFromTemplateFilePath, string frontWheelFromTemplateFilePath, string rearWheelFromTemplateFilePath, string bodyFromTemplateFilePath, string breakFromTemplateFilePath = null, string powerTrainFromTemplateFilePath = null, string[] otherFromTemplateFilePath = null, Vector gravity = default, Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFromTemplateFilePath string
The file path of new 4-post test-rig from template file path.
testRigTemplateFilePath string
The file path of test-rig template file path.
frontSuspensionFromTemplateFilePath string
The file path of front suspension template file path.
rearSuspensionFromTemplateFilePath string
The file path of rear suspension template file path.
steeringFromTemplateFilePath string
The file path of steering template file path.
frontWheelFromTemplateFilePath string
The file path of front wheel template file path.
rearWheelFromTemplateFilePath string
The file path of rear wheel template file path.
bodyFromTemplateFilePath string
The file path of body template file path.
breakFromTemplateFilePath string
The file path of break template file path.
powerTrainFromTemplateFilePath string
The file path of power train template file path.
otherFromTemplateFilePath string[]
The file path of other template file path. The default value is null.
gravity Vector
The gravity value.
unit Unit
The unit information.
iconSize double
The size of icon.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFromTemplateFilePath' argument is null.
FileNotFoundException
Will be thrown if 'testRigTemplateFilePath', 'frontSuspensionFromTemplateFilePath', 'rearSuspensionFromTemplateFilePath', 'steeringFromTemplateFilePath', 'frontWheelFromTemplateFilePath', 'rearWheelFromTemplateFilePath', 'bodyFromTemplateFilePath' files are not exist.
CreateNewFourPostTestRigTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static FourPostTestRigDocument CreateNewFourPostTestRigTemplateDocument(string newTestRigFilePath, string documentName = "FourPostTestRig", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFilePath string
The file path of new 4 post test-rig.
documentName string
The name of document. The default value is test rig.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFilePath' argument is null.
CreateNewFullCarTestRigFromTemplateDocument(string, string, string, string, string, string, string, string, string, string, string[], Vector, Unit, double, LengthUnitType)
Create
[NotNullOrEmpty(new string[] { "newTestRigFromTemplateFilePath" })]
[ExistFile(new string[] { "testRigTemplateFilePath", "frontSuspensionFromTemplateFilePath", "rearSuspensionFromTemplateFilePath", "steeringFromTemplateFilePath", "frontWheelFromTemplateFilePath", "rearWheelFromTemplateFilePath", "bodyFromTemplateFilePath" })]
public static VehicleTestRigDocument CreateNewFullCarTestRigFromTemplateDocument(string newTestRigFromTemplateFilePath, string testRigTemplateFilePath, string frontSuspensionFromTemplateFilePath, string rearSuspensionFromTemplateFilePath, string steeringFromTemplateFilePath, string frontWheelFromTemplateFilePath, string rearWheelFromTemplateFilePath, string bodyFromTemplateFilePath, string breakFromTemplateFilePath = null, string powerTrainFromTemplateFilePath = null, string[] otherFromTemplateFilePath = null, Vector gravity = default, Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFromTemplateFilePath string
The file path of new full test-rig from template file path.
testRigTemplateFilePath string
The file path of test-rig template file path.
frontSuspensionFromTemplateFilePath string
The file path of front suspension template file path.
rearSuspensionFromTemplateFilePath string
The file path of rear suspension template file path.
steeringFromTemplateFilePath string
The file path of steering template file path.
frontWheelFromTemplateFilePath string
The file path of front wheel template file path.
rearWheelFromTemplateFilePath string
The file path of rear wheel template file path.
bodyFromTemplateFilePath string
The file path of body template file path.
breakFromTemplateFilePath string
The file path of break template file path.
powerTrainFromTemplateFilePath string
The file path of power train template file path.
otherFromTemplateFilePath string[]
The file path of other template file path. The default value is null.
gravity Vector
The gravity value.
unit Unit
The unit information.
iconSize double
The size of icon.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFromTemplateFilePath' argument is null.
FileNotFoundException
Will be thrown if 'testRigTemplateFilePath', 'frontSuspensionFromTemplateFilePath', 'rearSuspensionFromTemplateFilePath', 'steeringFromTemplateFilePath', 'frontWheelFromTemplateFilePath', 'rearWheelFromTemplateFilePath', 'bodyFromTemplateFilePath' files are not exist.
CreateNewFullCarTestRigTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static VehicleTestRigDocument CreateNewFullCarTestRigTemplateDocument(string newTestRigFilePath, string documentName = "VehicleTestRig", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFilePath string
The file path of new full test-rig.
documentName string
The name of document. The default value is test rig.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFilePath' argument is null.
CreateNewHalfCarTestRigFromTemplateDocument(string, string, string, string, string[], Vector, Unit, double, LengthUnitType)
Create
[NotNullOrEmpty(new string[] { "newTestRigFromTemplateFilePath" })]
[ExistFile(new string[] { "testRigTemplateFilePath", "suspensionFromTemplateFilePath" })]
public static TestRigDocument CreateNewHalfCarTestRigFromTemplateDocument(string newTestRigFromTemplateFilePath, string testRigTemplateFilePath, string suspensionFromTemplateFilePath, string steeringFromTemplateFilePath = null, string[] otherFromTemplateFilePath = null, Vector gravity = default, Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFromTemplateFilePath string
The file path of new half test-rig from template file path.
testRigTemplateFilePath string
The file path of half test-rig template file path.
suspensionFromTemplateFilePath string
The file path of suspension template file path.
steeringFromTemplateFilePath string
The file path of steering template file path. The default value is null.
otherFromTemplateFilePath string[]
The file path of other template file path. The default value is null.
gravity Vector
The gravity value.
unit Unit
The unit information.
iconSize double
The size of icon.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFromTemplateFilePath' argument is null.
FileNotFoundException
Will be thrown if 'testRigTemplateFilePath', 'suspensionFromTemplateFilePath' files are not exist.
CreateNewHalfCarTestRigTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static TestRigDocument CreateNewHalfCarTestRigTemplateDocument(string newTestRigFilePath, string documentName = "Suspension", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFilePath string
The file path of new half test-rig.
documentName string
The name of document. The default value is test rig.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFilePath' argument is null.
CreateNewPowerTrainFromTemplateDocument(string, string, MinorRole)
Create
public static PowerTrainDocument CreateNewPowerTrainFromTemplateDocument(string newPowerTrainFromTemplateFilePath, string existedPowerTrainTemplateFilePath, MinorRole minorRole = MinorRole.Any)
Parameters
newPowerTrainFromTemplateFilePath string
The file path of new power train from template file path.
existedPowerTrainTemplateFilePath string
The file path of existed power train template file path.
minorRole MinorRole
The minor role type. The default value is Any.
Returns
The new
CreateNewPowerTrainTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static PowerTrainDocument CreateNewPowerTrainTemplateDocument(string newPowerTrainFilePath, string documentName = "PowerTrain", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newPowerTrainFilePath string
The file path of new power train.
documentName string
The name of document. The default value is PowerTrain.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newPowerTrainFilePath' argument is null.
CreateNewReboundStopPropertyDocument(string, string, Unit, LengthUnitType)
Create
public static PropertyReboundstopDocument CreateNewReboundStopPropertyDocument(string newReboundStopPropertyFilePath, string documentName = "ReboundStop", Unit unit = null, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newReboundStopPropertyFilePath string
The file path of new bump stop property file path.
documentName string
The name of document. The default value is ReboundStop.
unit Unit
The unit information.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
CreateNewShimmyAndJudderTestRigFromTemplateDocument(string, string, string, string, string, string, string, string, string[], Vector, Unit, double, LengthUnitType)
Create
[NotNullOrEmpty(new string[] { "newTestRigFromTemplateFilePath" })]
[ExistFile(new string[] { "testRigTemplateFilePath", "frontSuspensionFromTemplateFilePath", "rearSuspensionFromTemplateFilePath", "steeringFromTemplateFilePath", "bodyFromTemplateFilePath" })]
public static ShimmyJudderTestRigDocument CreateNewShimmyAndJudderTestRigFromTemplateDocument(string newTestRigFromTemplateFilePath, string testRigTemplateFilePath, string frontSuspensionFromTemplateFilePath, string rearSuspensionFromTemplateFilePath, string steeringFromTemplateFilePath, string bodyFromTemplateFilePath, string breakFromTemplateFilePath = null, string powerTrainFromTemplateFilePath = null, string[] otherFromTemplateFilePath = null, Vector gravity = default, Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFromTemplateFilePath string
The file path of new shimmy and judder test-rig from template file path.
testRigTemplateFilePath string
The file path of test-rig template file path.
frontSuspensionFromTemplateFilePath string
The file path of front suspension template file path.
rearSuspensionFromTemplateFilePath string
The file path of rear suspension template file path.
steeringFromTemplateFilePath string
The file path of steering template file path.
bodyFromTemplateFilePath string
The file path of body template file path.
breakFromTemplateFilePath string
The file path of break template file path.
powerTrainFromTemplateFilePath string
The file path of power train template file path.
otherFromTemplateFilePath string[]
The file path of other template file path. The default value is null.
gravity Vector
The gravity value.
unit Unit
The unit information.
iconSize double
The size of icon.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFromTemplateFilePath' argument is null.
FileNotFoundException
Will be thrown if 'testRigTemplateFilePath', 'frontSuspensionFromTemplateFilePath', 'rearSuspensionFromTemplateFilePath', 'steeringFromTemplateFilePath', 'bodyFromTemplateFilePath' files are not exist.
CreateNewShimmyAndJudderTestRigTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static ShimmyJudderTestRigDocument CreateNewShimmyAndJudderTestRigTemplateDocument(string newTestRigFilePath, string documentName = "ShimmyJudderTestRig", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFilePath string
The file path of new shimmy and judder test-rig.
documentName string
The name of document. The default value is test rig.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFilePath' argument is null.
CreateNewSpringPropertyDocument(string, string, Unit, LengthUnitType)
Create
public static PropertySpringDocument CreateNewSpringPropertyDocument(string newSpringPropertyFilePath, string documentName = "Spring", Unit unit = null, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newSpringPropertyFilePath string
The file path of new bump stop property file path.
documentName string
The name of document. The default value is Spring.
unit Unit
The unit information.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
CreateNewSteeringFromTemplateDocument(string, string, MinorRole)
Create
public static SteeringDocument CreateNewSteeringFromTemplateDocument(string newSteeringFromTemplateFilePath, string existedSteeringTemplateFilePath, MinorRole minorRole = MinorRole.Front)
Parameters
newSteeringFromTemplateFilePath string
The file path of new steering from template file path.
existedSteeringTemplateFilePath string
The file path of existed steering template file path.
minorRole MinorRole
The minor role type. The default value is Front.
Returns
The new
CreateNewSteeringTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static SteeringDocument CreateNewSteeringTemplateDocument(string newSteeringFilePath, string documentName = "Steering", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newSteeringFilePath string
The file path of new steering.
documentName string
The name of document. The default value is Steering.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newSteeringFilePath' argument is null.
CreateNewSuspensionFromTemplateDocument(string, string, MinorRole)
Create
public static SuspensionDocument CreateNewSuspensionFromTemplateDocument(string newSuspensionFromTemplateFilePath, string existedSuspensionTemplateFilePath, MinorRole minorRole = MinorRole.Front)
Parameters
newSuspensionFromTemplateFilePath string
The file path of new suspension from template file path.
existedSuspensionTemplateFilePath string
The file path of existed suspension template file path.
minorRole MinorRole
The minor role type. The default value is Front.
Returns
The new
CreateNewSuspensionTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static SuspensionDocument CreateNewSuspensionTemplateDocument(string newSuspensionFilePath, string documentName = "Suspension", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newSuspensionFilePath string
The file path of new suspension.
documentName string
The name of document. The default value is suspension.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newSuspensionFilePath' argument is null.
CreateNewTireTestRigFromTemplateDocument(string, string, string, Vector, Unit, double, LengthUnitType)
Create
[NotNullOrEmpty(new string[] { "newTestRigFromTemplateFilePath" })]
[ExistFile(new string[] { "testRigTemplateFilePath", "wheelFromTemplateFilePath" })]
public static TireTestRigDocument CreateNewTireTestRigFromTemplateDocument(string newTestRigFromTemplateFilePath, string testRigTemplateFilePath, string wheelFromTemplateFilePath, Vector gravity = default, Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFromTemplateFilePath string
The file path of new tire test-rig from template file path.
testRigTemplateFilePath string
The file path of test-rig template file path.
wheelFromTemplateFilePath string
The file path of wheel template file path.
gravity Vector
The gravity value.
unit Unit
The unit information.
iconSize double
The size of icon.
kernelLengthUnit LengthUnitType
The length unit of kernel.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFromTemplateFilePath' argument is null.
FileNotFoundException
Will be thrown if 'testRigTemplateFilePath', 'wheelFromTemplateFilePath' files are not exist.
CreateNewTireTestRigTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static TireTestRigDocument CreateNewTireTestRigTemplateDocument(string newTestRigFilePath, string documentName = "TireTestRig", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newTestRigFilePath string
The file path of new tire test-rig.
documentName string
The name of document. The default value is test rig.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newTestRigFilePath' argument is null.
CreateNewWheelFromTemplateDocument(string, string, MinorRole)
Create
public static WheelDocument CreateNewWheelFromTemplateDocument(string newWheelFromTemplateFilePath, string existedWheelTemplateFilePath, MinorRole minorRole = MinorRole.Front)
Parameters
newWheelFromTemplateFilePath string
The file path of new wheel from template file path.
existedWheelTemplateFilePath string
The file path of existed wheel template file path.
minorRole MinorRole
The minor role type. The default value is Front.
Returns
The new
CreateNewWheelTemplateDocument(string, string, Unit, double, LengthUnitType)
Create
public static WheelDocument CreateNewWheelTemplateDocument(string newWheelFilePath, string documentName = "Wheel", Unit unit = null, double iconSize = 1, LengthUnitType kernelLengthUnit = LengthUnitType.M)
Parameters
newWheelFilePath string
The file path of new wheel.
documentName string
The name of document. The default value is Wheel.
unit Unit
The unit information.
iconSize double
The size of icon. The default value is 1.
kernelLengthUnit LengthUnitType
The length unit of kernel. The default value is mm.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'newWheelFilePath' argument is null.
FourPostReplaceAssembly(FourPostTestRigDocument, string, string, string, string, string, string, string, string, IEnumerable<string>)
Replace 4-Post assembly.
public static void FourPostReplaceAssembly(this FourPostTestRigDocument document, string frontSuspensionPath = "", string rearSuspensionPath = "", string steeringPath = "", string frontWheelPath = "", string rearWheelPath = "", string bodyPath = "", string brakePath = "", string powerTrainPath = "", IEnumerable<string> otherPaths = null)
Parameters
document FourPostTestRigDocument
The document to be replaced.
frontSuspensionPath string
The front suspension path. The default value is "".
rearSuspensionPath string
The rear suspension path. The default value is "".
steeringPath string
The steering path. The default value is "".
frontWheelPath string
The front wheel path. The default value is "".
rearWheelPath string
The rear wheel path. The default value is "".
bodyPath string
The body path. The default value is "".
brakePath string
The brake path. The default value is "".
powerTrainPath string
The power train path. The default value is "".
otherPaths IEnumerable<string>
The other paths. The default value is "".
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if 'document' argument is not assembly.
FullCarReplaceAssembly(VehicleTestRigDocument, string, string, string, string, string, string, string, string, IEnumerable<string>)
Replace full car assembly.
public static void FullCarReplaceAssembly(this VehicleTestRigDocument document, string frontSuspensionPath = "", string rearSuspensionPath = "", string steeringPath = "", string frontWheelPath = "", string rearWheelPath = "", string bodyPath = "", string brakePath = "", string powerTrainPath = "", IEnumerable<string> otherPaths = null)
Parameters
document VehicleTestRigDocument
The document to be replaced.
frontSuspensionPath string
The front suspension path. The default value is "".
rearSuspensionPath string
The rear suspension path. The default value is "".
steeringPath string
The steering path. The default value is "".
frontWheelPath string
The front wheel path. The default value is "".
rearWheelPath string
The rear wheel path. The default value is "".
bodyPath string
The body path. The default value is "".
brakePath string
The brake path. The default value is "".
powerTrainPath string
The power train path. The default value is "".
otherPaths IEnumerable<string>
The other paths. The default value is "".
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if 'document' argument is not assembly.
ModifyDesignParameter(TestRigDocumentBase, Dictionary<string, List<ParamInfo>>)
Modify design parameter.
[NotNull(new string[] { "document", "dicParam" })]
public static void ModifyDesignParameter(this TestRigDocumentBase document, Dictionary<string, List<UpdateParameterOperation.ParamInfo>> dicParam)
Parameters
document TestRigDocumentBase
The document to be changed group.
dicParam Dictionary<string, List<UpdateParameterOperation.ParamInfo>>
The dictionary to be contained filepath and parameter information.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if 'document' argument is not assembly.
ModifyModelingParameter(TestRigDocumentBase, ObjectBase)
Modify modeling parameter.
[NotNull(new string[] { "document", "target" })]
public static void ModifyModelingParameter(this TestRigDocumentBase document, ObjectBase target)
Parameters
document TestRigDocumentBase
The document to be changed group.
target ObjectBase
The target.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if 'document' argument is not assembly.
ShimmyJudderReplaceAssembly(ShimmyJudderTestRigDocument, string, string, string, string, string, string, IEnumerable<string>)
Replace full car assembly.
public static void ShimmyJudderReplaceAssembly(this ShimmyJudderTestRigDocument document, string frontSuspensionPath = "", string rearSuspensionPath = "", string steeringPath = "", string bodyPath = "", string brakePath = "", string powerTrainPath = "", IEnumerable<string> otherPaths = null)
Parameters
document ShimmyJudderTestRigDocument
The document to be replaced.
frontSuspensionPath string
The front suspension path. The default value is "".
rearSuspensionPath string
The rear suspension path. The default value is "".
steeringPath string
The steering path. The default value is "".
bodyPath string
The body path. The default value is "".
brakePath string
The brake path. The default value is "".
powerTrainPath string
The power train path. The default value is "".
otherPaths IEnumerable<string>
The other paths. The default value is "".
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if 'document' argument is not assembly.
SuspensionReplaceAssembly(TestRigDocument, string, string, IEnumerable<string>)
Replace suspension assembly.
public static void SuspensionReplaceAssembly(this TestRigDocument document, string suspensionPath = "", string steeringPath = "", IEnumerable<string> otherPaths = null)
Parameters
document TestRigDocument
The document to be replaced.
suspensionPath string
The suspension path. The default value is "".
steeringPath string
The steering path. The default value is "".
otherPaths IEnumerable<string>
The other paths. The default value is "".
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if 'document' argument is not assembly.
TireReplaceAssembly(TireTestRigDocument, string)
Replace tire assembly.
public static void TireReplaceAssembly(this TireTestRigDocument document, string wheelPath = "")
Parameters
document TireTestRigDocument
The document to be replaced.
wheelPath string
The wheel path. The default value is "".
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if 'document' argument is not assembly.
