cFrameObjGetLoadDistributed Method

Retrieves the distributed load assignments to frame objects.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetLoadDistributed(
	string Name,
	ref int NumberItems,
	ref string[] FrameName,
	ref string[] LoadPat,
	ref int[] MyType,
	ref string[] CSys,
	ref int[] Dir,
	ref double[] RD1,
	ref double[] RD2,
	ref double[] Dist1,
	ref double[] Dist2,
	ref double[] Val1,
	ref double[] Val2,
	eItemType ItemType = eItemType.Objects
)

Parameters

Name
Type: SystemString
The name of an existing frame object or group, depending on the value of the ItemType item.
NumberItems
Type: SystemInt32
The total number of distributed loads retrieved for the specified frame objects.
FrameName
Type: SystemString
This is an array that includes the name of the frame object associated with each distributed load.
LoadPat
Type: SystemString
This is an array that includes the name of the load pattern associated with each distributed load.
MyType
Type: SystemInt32
This is an array that includes 1 or 2, indicating the type of distributed load.
  1. Force per unit length
  2. Moment per unit length
CSys
Type: SystemString
This is an array that includes the name of the coordinate system in which each distributed load is defined. It may be Local or the name of a defined coordinate system.
Dir
Type: SystemInt32
This is an integer between 1 and 11, indicating the direction of the load.
  1. Local 1 axis (only applies when CSys is Local)
  2. Local 2 axis (only applies when CSys is Local)
  3. Local 3 axis (only applies when CSys is Local)
  4. X direction (does not apply when CSys is Local)
  5. Y direction (does not apply when CSys is Local)
  6. Z direction (does not apply when CSys is Local)
  7. Projected X direction (does not apply when CSys is Local)
  8. Projected Y direction (does not apply when CSys is Local)
  9. Projected Z direction (does not apply when CSys is Local)
  10. Gravity direction (only applies when CSys is Global)
  11. Projected Gravity direction (only applies when CSys is Global)

The positive gravity direction (see Dir = 10 and 11) is in the negative Global Z direction.

RD1
Type: SystemDouble
RD2
Type: SystemDouble
Dist1
Type: SystemDouble
This is an array that includes the actual distance from the I-End of the frame object to the start of the distributed load. [L]
Dist2
Type: SystemDouble
This is an array that includes the actual distance from the I-End of the frame object to the end of the distributed load. [L]
Val1
Type: SystemDouble
This is an array that includes the load value at the start of the distributed load. [F/L] when MyType is 1 and [FL/L] when MyType is 2
Val2
Type: SystemDouble
This is an array that includes the load value at the end of the distributed load. [F/L] when MyType is 1 and [FL/L] when MyType is 2
ItemType (Optional)
Type: ETABS2016eItemType
This is one of the following items in the eItemType enumeration:
  • Object = 0
  • Group = 1
  • SelectedObjects = 2

If this item is Objects, the assignments are retrieved for the frame object specified by the Name item.

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

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

Return Value

Type: Int32
Returns zero if the load assignments are successfully retrieved, otherwise it returns a nonzero value.
Remarks
Examples
VB
Copy
Public Sub Example()
   Dim SapModel As cSapModel
   Dim EtabsObject As cOAPI
   Dim ret As Integer = -1
   Dim NumberItems As Integer
   Dim FrameName() As String
   Dim LoadPat() As String
   Dim MyType() As Integer
   Dim CSys() As String
   Dim Dir() As Integer
   Dim RD1() As Double
   Dim RD2() As Double
   Dim Dist1() As Double
   Dim Dist2() As Double
   Dim Val1() As Double
   Dim Val2() As Double

'create ETABS object
   EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")

'start ETABS application
  ret = EtabsObject.ApplicationStart()

'create SapModel object
   SapModel = EtabsObject.SapModel

'initialize model
   ret = SapModel.InitializeNewModel()

'create steel deck template model
   ret = SapModel.File.NewSteelDeck(4, 12, 12, 4, 4, 24, 24)

'assign frame distributed loads
   ret = SapModel.FrameObj.SetLoadDistributed("14", "DEAD", 1, 10, 0, 1, 0.08, 0.08)
   ret = SapModel.FrameObj.SetLoadDistributed("15", "DEAD", 1, 10, 0, 1, 0.08, 0.08)

'get frame distributed loads
   ret = SapModel.FrameObj.GetLoadDistributed("ALL", NumberItems, FrameName, LoadPat, MyType, CSys, Dir, RD1, RD2, Dist1, Dist2, Val1, Val2, Group)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing

End Sub
See Also