## On this page

  

 

 # Class NodalBodyAPI

 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 NodalBodyAPI

```

#### Inheritance

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

### ChangeNodalModal(Obj, BodyAnalysisType)

Change body analysis type.

```csharp
[NotNullObj(new string[] { "nodalBody" })]
[MatchTypeObj(new object[] { "nodalBody", typeof(NodalBody) })]
public static void ChangeNodalModal(this Obj nodalBody, BodyAnalysisType type)

```

#### Parameters

`nodalBody` Obj

The .

`type` BodyAnalysisType

The body analysis type.

#### Exceptions

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

Will be thrown if 'nodalBody' argument is empty.

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

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

### CreateNodalBody(SubSystemDocument, string, MeshDocument, TransformBase)

Create New  class with given  and .

```csharp
[NotNull(new string[] { "meshDocument" })]
public static Obj CreateNodalBody(this SubSystemDocument docToAdd, string strBodyName, MeshDocument meshDocument, TransformBase transformMesh)

```

#### Parameters

`docToAdd` SubSystemDocument

The  to add created .

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

The body name of new .

`meshDocument` MeshDocument

The  to create

`transformMesh` TransformBase

The  for the new .

#### Returns

Obj

The new .

#### Exceptions

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

Will be thrown if 'meshDocument' argument is empty.

### CreateNodalBody(SubSystemDocument, string, string, TransformBase)

Create New  class with given file path of the  and .

```csharp
[NotNull(new string[] { "docToAdd", "transformMesh" })]
[ExistFile(new string[] { "meshFilePath" })]
public static Obj CreateNodalBody(this SubSystemDocument docToAdd, string strBodyName, string meshFilePath, TransformBase transformMesh)

```

#### Parameters

`docToAdd` SubSystemDocument

The  to add created .

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

The body name of new .

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

The path of the  to create

`transformMesh` TransformBase

The  for the new .

#### Returns

Obj

The new .

#### Exceptions

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

Will be thrown if 'docToAdd' or 'transformMesh' arguments are empty.

[Exception](https://learn.microsoft.com/dotnet/api/system.exception)

Will be thrown if meshFilePath file is not exist.

### CreateNodalBody(SubSystemDocument, string, MeshDocument)

Create New  class with given  with identity transformation.

```csharp
[NotNull(new string[] { "meshDocument" })]
public static Obj CreateNodalBody(this SubSystemDocument docToAdd, string strBodyName, MeshDocument meshDocument)

```

#### Parameters

`docToAdd` SubSystemDocument

The  to add created .

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

The body name of new .

`meshDocument` MeshDocument

The  to create

#### Returns

Obj

The new .

#### Exceptions

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

Will be thrown if 'meshDocument' argument is empty.

### CreateNodalBody(SubSystemDocument, string, string)

Create New  class with given file path of the  with identity transformation.

```csharp
public static Obj CreateNodalBody(this SubSystemDocument docToAdd, string strBodyName, string meshFilePath)

```

#### Parameters

`docToAdd` SubSystemDocument

The  to add created .

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

The body name of new .

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

The path of the  to create

#### Returns

Obj

The new .