Class FrequencyResponseAPI

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

This class implements APIs for actuator and channel class.

public static class FrequencyResponseAPI

Inheritance

object ← FrequencyResponseAPI

Extension Methods

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

Methods

CreateInputChannel(SubSystemDocument, Obj, Vector, OMatrix, Obj, InputChannelInputType, InputModeType, string)

[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "body", "actuator" })]
public static Obj CreateInputChannel(this SubSystemDocument subSystemDocument, Obj body, Vector position, OMatrix orientation, Obj actuator, InputChannelInputType inputType = InputChannelInputType.Force, InputModeType inputMode = InputModeType.Translational, string name = "")

Parameters

subSystemDocument SubSystemDocument

body Obj

position Vector

orientation OMatrix

actuator Obj

inputType InputChannelInputType

inputMode InputModeType

name string

Returns

Obj

CreateOutputChannel(SubSystemDocument, Obj, Obj?, Obj?, OutputChannelInputType, ChannelDirectionType, string)

Create .

[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "actionMarker" })]
[MatchTypeObj(new object[] { "actionMarker", typeof(IMarker) })]
public static Obj CreateOutputChannel(this SubSystemDocument subSystemDocument, Obj actionMarker, Obj? baseMarker = null, Obj? referenceMarker = null, OutputChannelInputType type = OutputChannelInputType.Displacement, ChannelDirectionType direction = ChannelDirectionType.X, string name = "")

Parameters

subSystemDocument SubSystemDocument

The to create a output channel.

actionMarker Obj

The action marker of a output channel.

baseMarker Obj?

The base marker of a output channel.

referenceMarker Obj?

The reference marker of a output channel.

type OutputChannelInputType

The type of a output channel.

direction ChannelDirectionType

The direction of a output channel.

name string

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

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'subSystemDocument', 'actionMarker' is null.

ArgumentException

Will be thrown if the type of 'baseMarker', 'referenceMarker' is not .

CreateRotatingMassActuatorForForce(SubSystemDocument, ExpressionValueVariable?, ExpressionValueVariable?, string)

Create .

[NotNull(new string[] { "subSystemDocument" })]
public static Obj CreateRotatingMassActuatorForForce(this SubSystemDocument subSystemDocument, ExpressionValueVariable? mass = null, ExpressionValueVariable? radialOffset = null, string name = "")

Parameters

subSystemDocument SubSystemDocument

The to create a rotating mass actuator.

mass ExpressionValueVariable?

The mass of a rotating mass actuator.

radialOffset ExpressionValueVariable?

The radial offset of a rotating mass actuator.

name string

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

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'subSystemDocument' is null.

CreateRotatingMassActuatorForMoment(SubSystemDocument, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, string)

Create .

[NotNull(new string[] { "subSystemDocument" })]
public static Obj CreateRotatingMassActuatorForMoment(this SubSystemDocument subSystemDocument, ExpressionValueVariable? mass = null, ExpressionValueVariable? radialOffset = null, ExpressionValueVariable? offsetNormalToPlane = null, string name = "")

Parameters

subSystemDocument SubSystemDocument

The to create a rotating mass actuator.

mass ExpressionValueVariable?

The mass of a rotating mass actuator.

radialOffset ExpressionValueVariable?

The radial offset of a rotating mass actuator.

offsetNormalToPlane ExpressionValueVariable?

The offset normal to plane of a rotating mass actuator.

name string

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

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'subSystemDocument' is null.

CreateSweptSineActuator(SubSystemDocument, ExpressionValueVariable?, ExpressionValueVariable?, string)

Create .

[NotNull(new string[] { "subSystemDocument" })]
public static Obj CreateSweptSineActuator(this SubSystemDocument subSystemDocument, ExpressionValueVariable? magnitude = null, ExpressionValueVariable? phaseAngle = null, string name = "")

Parameters

subSystemDocument SubSystemDocument

The to create a swept sine actuator.

magnitude ExpressionValueVariable?

The magnitude of a swept sine actuator.

phaseAngle ExpressionValueVariable?

The phase angle of a swept sine actuator.

name string

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

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'subSystemDocument' is null.