Class RequestAPI

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

This class implements APIs for request class.

public static class RequestAPI

Inheritance

object ← RequestAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)

Methods

CreateConnectedEntityRequest(SubSystemDocument, Obj, string)

[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "actionEntity" })]
[MatchTypeObj(new object[] { "actionEntity", typeof(IBodyAnalysisType) })]
public static Obj CreateConnectedEntityRequest(this SubSystemDocument subSystemDocument, Obj actionEntity, string name)

Parameters

subSystemDocument SubSystemDocument

actionEntity Obj

name string

Returns

Obj

CreateEntitiesRequest(SubSystemDocument, Obj[], string)

[NotNull(new string[] { "subSystemDocument" })]
public static void CreateEntitiesRequest(this SubSystemDocument subSystemDocument, Obj[] actionEntities, string name)

Parameters

subSystemDocument SubSystemDocument

actionEntities Obj[]

name string

CreateEntityRequest(SubSystemDocument, Obj, string)

[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "actionEntity" })]
[MatchTypeObj(new object[] { "actionEntity", typeof(IReportable) })]
public static Obj CreateEntityRequest(this SubSystemDocument subSystemDocument, Obj actionEntity, string name)

Parameters

subSystemDocument SubSystemDocument

actionEntity Obj

name string

Returns

Obj

CreateKinematicRequest(SubSystemDocument, Obj, string, Obj?, Obj?, OutputType?)

[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "actionEntity" })]
public static Obj CreateKinematicRequest(this SubSystemDocument subSystemDocument, Obj actionEntity, string name, Obj? baseEntity = null, Obj? referenceMarker = null, RequestKinematic.OutputType? outputType = null)

Parameters

subSystemDocument SubSystemDocument

actionEntity Obj

name string

baseEntity Obj?

referenceMarker Obj?

outputType RequestKinematic.OutputType?

Returns

Obj

CreateStructuralRequest(SubSystemDocument, Obj, string, SideFilter, OutputType?)

[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "actionEntity" })]
public static Obj CreateStructuralRequest(this SubSystemDocument subSystemDocument, Obj actionEntity, string name, RequestStructure.SideFilter sideFilter = SideFilter.Maximum, RequestStructure.OutputType? outputType = null)

Parameters

subSystemDocument SubSystemDocument

actionEntity Obj

name string

sideFilter RequestStructure.SideFilter

outputType RequestStructure.OutputType?

Returns

Obj