## On this page

  

 

 # Class FrequencyResponseAPI

 Last update: 16.07.2025 

Namespace: [VM.API.Pre](VM.API.Pre.md)  
Assembly: VM.API.Pre.dll

This class implements APIs for actuator and channel class.

```csharp
public static class FrequencyResponseAPI

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [FrequencyResponseAPI](VM.API.Pre.FrequencyResponseAPI.md)

#### Extension Methods

[LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

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

```csharp
[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](VM.API.Pre.Obj.md)

`position` Vector

`orientation` OMatrix

`actuator` [Obj](VM.API.Pre.Obj.md)

`inputType` [InputChannelInputType](VM.API.Pre.InputChannelInputType.md)

`inputMode` InputModeType

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

#### Returns

[Obj](VM.API.Pre.Obj.md)

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

Create .

```csharp
[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](VM.API.Pre.Obj.md)

The action marker of a output channel.

`baseMarker` [Obj](VM.API.Pre.Obj.md)?

The base marker of a output channel.

`referenceMarker` [Obj](VM.API.Pre.Obj.md)?

The reference marker of a output channel.

`type` [OutputChannelInputType](VM.API.Pre.OutputChannelInputType.md)

The type of a output channel.

`direction` [ChannelDirectionType](VM.API.Pre.ChannelDirectionType.md)

The direction of a output channel.

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

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

#### Returns

[Obj](VM.API.Pre.Obj.md)

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

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

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

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

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

Create .

```csharp
[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](https://learn.microsoft.com/dotnet/api/system.string)

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

#### Returns

[Obj](VM.API.Pre.Obj.md)

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'subSystemDocument' is null.

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

Create .

```csharp
[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](https://learn.microsoft.com/dotnet/api/system.string)

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

#### Returns

[Obj](VM.API.Pre.Obj.md)

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'subSystemDocument' is null.

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

Create .

```csharp
[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](https://learn.microsoft.com/dotnet/api/system.string)

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

#### Returns

[Obj](VM.API.Pre.Obj.md)

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'subSystemDocument' is null.