JointDispl



Your Ad Here

Syntax

SapObject.SapModel.Results.JointDispl

VB6 Procedure

Function JointDispl(ByVal Name As String, ByVal ItemTypeElm As eItemTypeElm, ByRef NumberResults As Long, ByRef Obj() As String, ByRef Elm() As String, ByRef ACase() As String, ByRef StepType() As String, ByRef StepNum() As Double, ByRef U1() As Double, ByRef U2() As Double, ByRef U3() As Double, ByRef R1() As Double, ByRef R2() As Double, ByRef R3() As Double) As Long

Parameters

Name

The name of an existing point object, point element, or group of objects depending on the value of the ItemTypeElm item.

ItemTypeElm

This is one of the following items in the eItemTypeElm enumeration:

ObjectElm = 0

Element = 1

GroupElm = 2

SelectionElm = 3

 

If this item is ObjectElm, the result request is for the point element corresponding to the point object specified by the Name item.

If this item is Element, the result request is for the point element specified by the Name item.

If this item is GroupElm, the result request is for all point elements directly or indirectly specified in the group specified by the Name item.

If this item is SelectionElm, the result request is for all point elements directly or indirectly selected and the Name item is ignored.

See Item Type for Elements for more information.

NumberResults

The total number of results returned by the program.

Obj

This is an array that includes the point object name associated with each result, if any. Some results will have no point object associated with them. For these cases this item will be blank.

Elm

This is an array that includes the point element name associated with each result.

ACase

This is an array that includes the name of the analysis case or response combination associated with each result.

StepType

This is an array that includes the step type, if any, for each result.

StepNum

This is an array that includes the step number, if any, for each result.

U1, U2, U3

These are one dimensional arrays that include the displacement in the point element local 1, 2 and 3 axes directions, respectively, for each result. [L]

R1, R2, R3

These are one dimensional arrays that include the rotation about the point element local 1, 2 and 3 axes, respectively, for each result. [rad]

Remarks

This function reports the joint displacements for the specified point elements. The displacements reported by this function are relative displacements.

The function returns zero if the displacements are successfully recovered, otherwise it returns a nonzero value.

See Analysis Results Remarks for more information.

VBA Example

Sub GetJointDisplacements()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim NumberResults As Long
      Dim Obj() As String
      Dim Elm() As String
      Dim ACase() As String
      Dim StepType() As String
      Dim StepNum() As Double
      Dim U1() As Double
      Dim U2() As Double
      Dim U3() As Double
      Dim R1() As Double
      Dim R2() As Double
      Dim R3() As Double

   'create Sap2000 object
      Set SapObject = New SAP2000.SapObject

   'start Sap2000 application
      SapObject.ApplicationStart

   'create SapModel object
      Set SapModel = SapObject.SapModel

   'initialize model
      ret = SapModel.InitializeNewModel

   'create model from template
      ret = SapModel.File.New2DFrame(PortalFrame, 3, 124, 3, 200)

   'run analysis
      ret = SapModel.File.Save("C:\SapAPI\x.sdb")
      ret = SapModel.Analyze.RunAnalysis

   'clear all case and combo output selections
      ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput

   'set case and combo output selections
      ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")

   'get point displacements
      ret = SapModel.Results.JointDispl("ALL", GroupElm, NumberResults, Obj, Elm, ACase, StepType, StepNum, U1, U2, U3, R1, R2, R3)

   'close Sap2000
      SapObject.ApplicationExit False
      Set SapModel = Nothing
      Set SapObject = Nothing
End Sub

Release Notes

Initial release in version 11.00.

See Also

JointDisplAbs

JointVel

JointVelAbs

JointAcc

JointAccAbs

GeneralizedDispl

 

 

Return to SAP2000 Index


Your Ad Here