## On this page

  

 

 # Class ConcentratedLoadAPI

 Last update: 16.07.2025 

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

This class implements APIs for  class.

```csharp
public static class ConcentratedLoadAPI

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [ConcentratedLoadAPI](VM.API.Pre.FE.ConcentratedLoadAPI.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

### CreateConcentratedLoad(SubSystemDocument, Obj, string, DirectionType, Obj?, Obj?, Obj?, Obj?, Obj?, Obj?)

Create  with functions.

```csharp
[MatchTypeObj(new object[] { "functionFX", typeof(Function), "functionFY", typeof(Function), "functionFZ", typeof(Function), "functionTX", typeof(Function), "functionTY", typeof(Function), "functionTZ", typeof(Function) })]
public static Obj CreateConcentratedLoad(this SubSystemDocument document, Obj concentratedLoadComponent, string concentratedLoadName = "", CLoadStandard.DirectionType directionType = DirectionType.RECTANGULAR, Obj? functionFX = null, Obj? functionFY = null, Obj? functionFZ = null, Obj? functionTX = null, Obj? functionTY = null, Obj? functionTZ = null)

```

#### Parameters

`document` SubSystemDocument

The document to create the concentrated load.

`concentratedLoadComponent` Obj

The concentrated load component

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

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

`directionType` CLoadStandard.DirectionType

The direction type.

`functionFX` Obj?

The name of the fx function.

`functionFY` Obj?

The name of the fy function.

`functionFZ` Obj?

The name of the fz function.

`functionTX` Obj?

The name of the tx function.

`functionTY` Obj?

The name of the ty function.

`functionTZ` Obj?

The name of the tz function.

#### Returns

Obj

The new  object that is created by this API.

#### Exceptions

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

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

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

Will be thrown if 'functionFX' argument is not empty and type of 'functionFX' is not .

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

Will be thrown if 'functionFY' argument is not empty and type of 'functionFY' is not .

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

Will be thrown if 'functionFZ' argument is not empty and type of 'functionFZ' is not .

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

Will be thrown if 'functionTX' argument is not empty and type of 'functionTX' is not .

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

Will be thrown if 'functionTY' argument is not empty and type of 'functionTY' is not .

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

Will be thrown if 'functionTZ' argument is not empty and type of 'functionTZ' is not .

### CreateConcentratedLoad(SubSystemDocument, Obj, Obj, string)

Create  with user-subrooutine.

```csharp
[NotNullObj(new string[] { "usub" })]
[MatchTypeObj(new object[] { "usub", typeof(UserSubroutine) })]
public static Obj CreateConcentratedLoad(this SubSystemDocument document, Obj concentratedLoadComponent, Obj usub, string concentratedLoadName = "")

```

#### Parameters

`document` SubSystemDocument

The document to create the concentrated load.

`concentratedLoadComponent` Obj

The concentrated load component

`usub` Obj

The name of the user-subrooutine.

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

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

#### Returns

Obj

The new  object that is created by this API.

#### Exceptions

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

Will be thrown if 'document' or 'concentratedLoadComponent' or 'usub' arguments are empty.

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

Will be thrown if 'usub' argument is not empty and type of 'usub' is not .