Class ConcentratedLoadAPI

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

This class implements APIs for class.

public static class ConcentratedLoadAPI

Inheritance

object ← ConcentratedLoadAPI

Extension Methods

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

Methods

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

Create with functions.

[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

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

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

ArgumentException

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

ArgumentException

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

ArgumentException

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

ArgumentException

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

ArgumentException

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

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.

[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

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

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

ArgumentException

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