Class CycloidalReducerAPI

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

This class implements APIs for class.

public static class CycloidalReducerAPI

Inheritance

object ← CycloidalReducerAPI

Extension Methods

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

Methods

CreateCycloidalReducer(GearTrainDocument, Vector, Vector, Obj, Obj, string)

Create .

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "housing", "outputSharft" })]
[MatchTypeObj(new object[] { "outputSharft", typeof(IShaftSet) })]
public static Obj CreateCycloidalReducer(this GearTrainDocument document, Vector referencePosition, Vector rotateAxis, Obj housing, Obj outputSharft, string name = "")

Parameters

document GearTrainDocument

The to create the RV reducer.

referencePosition Vector

The reference position of the RV reducer.

rotateAxis Vector

The position of the RV reducer.

housing Obj

The base entity of the RV reducer.

outputSharft Obj

The output sharft of the RV reducer.

name string

The name of the RV reducer. If empty, default name starts with 'Cycloidal_Reducer' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'housing', 'outputSharft' argument is empty.

ArgumentException

Will be thrown if the type of 'housing' is not and .