GetLoadDispl

Syntax

SapObject.SapModel.PointObj.GetLoadDispl

VB6 Procedure

Function GetLoadDispl(ByVal Name As String, ByRef NumberItems As Long, ByRef PointName() As String, ByRef LoadCase() As String, ByRef LCStep() As Long, ByRef CSys() As String, ByRef U1() As Double, ByRef U2() As Double, ByRef U3() As Double, ByRef R1() As Double, ByRef R2() As Double, ByRef R3() As Double, Optional ByVal ItemType As eItemType = Object) As Long

Parameters

Name

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

NumberItems

This is the total number of joint ground displacement assignments returned.

PointName

This is an array that includes the name of the point object to which the specified ground displacement assignment applies.

LoadCase

This is an array that includes the name of the load case for the ground displacement load.

LCStep

This is an array that includes the load case step for the ground displacement load. In most cases, this item does not apply and will be returned as 0.

CSys

This is an array that includes the name of the coordinate system for the ground displacement load. This is Local or the name of a defined coordinate system.

This is an array that includes the assigned translational ground displacement in the local 1-axis or coordinate system X-axis direction, depending on the specified CSys. [L]

This is an array that includes the assigned translational ground displacement in the local 2-axis or coordinate system Y-axis direction, depending on the specified CSys. [L]

This is an array that includes the assigned translational ground displacement in the local 3-axis or coordinate system Z-axis direction, depending on the specified CSys. [L]

This is an array that includes the assigned rotational ground displacement about the local 1-axis or coordinate system X-axis, depending on the specified CSys. [rad]

This is an array that includes the assigned rotational ground displacement about the local 2-axis or coordinate system Y-axis, depending on the specified CSys. [rad]

This is an array that includes the assigned rotational ground displacement about the local 3-axis or coordinate system Z-axis, depending on the specified CSys. [rad]

ItemType

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

Object = 0

Group = 1

SelectedObjects = 2

If this item is Object, the load assignments are retrieved for the point object specified by the Name item.

If this item is Group, the assignments are retrieved for all point objects in the group specified by the Name item.

If this item is SelectedObjects, the load assignments are retrieved for all selected point objects, and the Name item is ignored.

Remarks

This function retrieves the ground displacement load assignments to point objects.

The function returns zero if the load assignments are successfully retrieved, otherwise it returns a nonzero value.

VBA Example

Sub GetPointDisplLoad()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim NumberItems As Long
      Dim PointName() As String
      Dim LoadCase() As String
      Dim LCStep() As Long
      Dim CSys() As String
      Dim U1() As Double
      Dim U2() As Double
      Dim U3() As Double
      Dim R1() As Double
      Dim R2() As Double
      Dim R3() As Double
      Dim Value() 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)

   'add ground displacement load
      Redim Value(5)
      Value(0) = 10
      ret = SapModel.PointObj.SetLoadDispl("1", "DEAD", Value)

   'get ground displacement load
      ret = SapModel.PointObj.GetLoadDispl("ALL", NumberItems, PointName, LoadCase, LCStep, CSys, U1, U2, U3, R1, R2, R3, Group)

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

Release Notes

Initial release in version 11.00.