Class BoundaryConditionAPI

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

This class implements APIs for class.

public static class BoundaryConditionAPI

Inheritance

object ← BoundaryConditionAPI

Extension Methods

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

Methods

CreateBoundaryCondition(SubSystemDocument, Obj, string, Obj?, bool, bool, bool, bool, bool, bool)

Create .

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "boundaryConditionComponent" })]
[MatchTypeObj(new object[] { "boundaryConditionComponent", typeof(IGeometricalComponent) })]
public static Obj CreateBoundaryCondition(this SubSystemDocument document, Obj boundaryConditionComponent, string boundaryConditionName = "", Obj? referenceMarker = null, bool translationalX = true, bool translationalY = true, bool translationalZ = true, bool rotationalX = true, bool rotationalY = true, bool rotationalZ = true)

Parameters

document SubSystemDocument

The document to create the boundary condition.

boundaryConditionComponent Obj

The boundary condition component

boundaryConditionName string

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

referenceMarker Obj?

The reference marker.

translationalX bool

The flag whether using translational X.

translationalY bool

The flag whether using translational Y.

translationalZ bool

The flag whether using translational Z.

rotationalX bool

The flag whether using rotational X.

rotationalY bool

The flag whether using rotational Y.

rotationalZ bool

The flag whether using rotational Z.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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