Class MotorDesignAPI

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

This class implements APIs for drivetrain class.

public static class MotorDesignAPI

Inheritance

object ← MotorDesignAPI

Extension Methods

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

Methods

CreateMotorDesigner(GearTrainDocument, Vector, Vector, HousingType, StatorMountingType, string)

Create .

[NotNull(new string[] { "document" })]
[NotZeroMagnitude(new string[] { "rotateAxis" })]
public static Obj CreateMotorDesigner(this GearTrainDocument document, Vector position, Vector rotateAxis, MotorDesigner.HousingType housingType = HousingType.Integrated, MotorDesigner.StatorMountingType statorMountingType = StatorMountingType.PressFit, string name = "")

Parameters

document GearTrainDocument

The document to create the ..

position Vector

The position of the motor designer.

rotateAxis Vector

The rotate axis of the motor designer.

housingType MotorDesigner.HousingType

The housing type of the motor designer.

statorMountingType MotorDesigner.StatorMountingType

The stator mounting type of the motor designer.

name string

The name of the motor designer.

Returns

Obj

the new object created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document' argument is empty.

ArgumentException

Will be thrown if the magnitude of 'rotateAxis' is 0.