Class AssemblyManagerAPI

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

This class implements APIs for class.

public static class AssemblyManagerAPI

Inheritance

object ← AssemblyManagerAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)

Methods

ApplyAssemblyBearing(GearTrainDocument, Obj, IEnumerable, IEnumerable)

Apply assembly bearing.

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "referenceBody" })]
[MatchTypeObj(new object[] { "referenceBody", typeof(IConnectable) })]
public static void ApplyAssemblyBearing(this GearTrainDocument document, Obj referenceBody, IEnumerable<bearinginformationinassemblymanager> bearingInfo = null, IEnumerable<cycloidpininformationinassemblymanager> cycloidPinInfo = null)

Parameters

document GearTrainDocument

The for assembly bearing apply. If null, the active document will be used.

referenceBody Obj

The reference body. The type is .

bearingInfo IEnumerableBearingInformationInAssemblyManager>

The bearing information. If it is not given, default values will be used..

cycloidPinInfo IEnumerableCycloidPinInformationInAssemblyManager>

The cycloid information. If it is not given, default values will be used..

Exceptions

ArgumentNullException

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

ArgumentNullException

Will be thrown if type of 'referenceBody' is not .

ApplyAssemblyIOShaft(GearTrainDocument, Obj, Vector, IEnumerable, IEnumerable)

Apply assembly IO shaft.

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "referenceBody" })]
[NotZeroMagnitude(new string[] { "referenceVector" })]
[MatchTypeObj(new object[] { "referenceBody", typeof(IConnectable) })]
public static void ApplyAssemblyIOShaft(this GearTrainDocument document, Obj referenceBody, Vector referenceVector, IEnumerable<shaftinformationinassemblymanager> inputInfo = null, IEnumerable<shaftinformationinassemblymanager> outputInfo = null)

Parameters

document GearTrainDocument

The for assembly IO shaft apply. If null, the active document will be used.

referenceBody Obj

The reference body. The type is .

referenceVector Vector

The reference vector.

inputInfo IEnumerableShaftInformationInAssemblyManager>

The input information. If it is not given, default values will be used.

outputInfo IEnumerableShaftInformationInAssemblyManager>

The output information. If it is not given, default values will be used.

Exceptions

ArgumentNullException

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

ArgumentException

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

ArgumentException

Will be thrown if type of 'referenceBody' is not .

ArgumentException

Will be thrown if type of 'inputInfo' is not (, ).

ArgumentException

Will be thrown if type of 'outputInfo' is not (, ).

ApplyPowerFlow(GearTrainDocument, PowerFlowParameters?)

Apply power flow.

[NotNull(new string[] { "document" })]
public static void ApplyPowerFlow(this GearTrainDocument document, PowerFlowParameters? powerFlowParameters = null)

Parameters

document GearTrainDocument

The for power apply. If null, the active document will be used.

powerFlowParameters PowerFlowParameters?

The power flow parameters. If it is not given, default values will be used.

Exceptions

ArgumentNullException

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

ApplyRequest(GearTrainDocument, IEnumerable, RequestParameters?)

Apply request.

[NotNull(new string[] { "document" })]
public static void ApplyRequest(this GearTrainDocument document, IEnumerable<bool> gearsetForceDisplay, RequestParameters? requestParameters = null)

Parameters

document GearTrainDocument

The for request apply. If null, the active document will be used.

gearsetForceDisplay IEnumerablebool>

The flags whether using force display of gearset.

requestParameters RequestParameters?

The request parameters. If it is not given, default values will be used.

Exceptions

ArgumentNullException

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

SimulateInAssemblyManager(GearTrainDocument)

Simulate in assembly manager.

[NotNull(new string[] { "doc" })]
public static void SimulateInAssemblyManager(this GearTrainDocument doc)

Parameters

doc GearTrainDocument

The for simulate. If null, the active document will be used.

UpdateAssemblyManager(GearTrainDocument)

Update assembly manager.

[NotNull(new string[] { "doc" })]
public static void UpdateAssemblyManager(this GearTrainDocument doc)

Parameters

doc GearTrainDocument

The for assembly manager update. If null, the active document will be used.