GetLoadDistributed Method

cFrameObj GetLoadDistributed Method

CSi API ETABS 2015

Retrieves the distributed load assignments to frame objects.

Namespace: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)

Syntax

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
)

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
)

Function GetLoadDistributed ( _
	Name As String, _
	ByRef NumberItems As Integer, _
	ByRef FrameName As String(), _
	ByRef LoadPat As String(), _
	ByRef MyType As Integer(), _
	ByRef CSys As String(), _
	ByRef Dir As Integer(), _
	ByRef RD1 As Double(), _
	ByRef RD2 As Double(), _
	ByRef Dist1 As Double(), _
	ByRef Dist2 As Double(), _
	ByRef Val1 As Double(), _
	ByRef Val2 As Double(), _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

Function GetLoadDistributed ( _
	Name As String, _
	ByRef NumberItems As Integer, _
	ByRef FrameName As String(), _
	ByRef LoadPat As String(), _
	ByRef MyType As Integer(), _
	ByRef CSys As String(), _
	ByRef Dir As Integer(), _
	ByRef RD1 As Double(), _
	ByRef RD2 As Double(), _
	ByRef Dist1 As Double(), _
	ByRef Dist2 As Double(), _
	ByRef Val1 As Double(), _
	ByRef Val2 As Double(), _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

int GetLoadDistributed(
	String^ Name, 
	int% NumberItems, 
	array<String^>^% FrameName, 
	array<String^>^% LoadPat, 
	array<int>^% MyType, 
	array<String^>^% CSys, 
	array<int>^% Dir, 
	array<double>^% RD1, 
	array<double>^% RD2, 
	array<double>^% Dist1, 
	array<double>^% Dist2, 
	array<double>^% Val1, 
	array<double>^% Val2, 
	eItemType ItemType = eItemType::Objects
)

int GetLoadDistributed(
	String^ Name, 
	int% NumberItems, 
	array<String^>^% FrameName, 
	array<String^>^% LoadPat, 
	array<int>^% MyType, 
	array<String^>^% CSys, 
	array<int>^% Dir, 
	array<double>^% RD1, 
	array<double>^% RD2, 
	array<double>^% Dist1, 
	array<double>^% Dist2, 
	array<double>^% Val1, 
	array<double>^% Val2, 
	eItemType ItemType = eItemType::Objects
)

Parameters

Name: Type: System String
The name of an existing frame object or group, depending on the value of the ItemType item.

NumberItems: Type: System Int32
The total number of distributed loads retrieved for the specified frame objects.

FrameName: Type: System String
This is an array that includes the name of the frame object associated with each distributed load.

LoadPat: Type: System String
This is an array that includes the name of the load pattern associated with each distributed load.

MyType

Type:

System Int32
This is an array that includes 1 or 2, indicating the type of distributed load.

Force per unit length
Moment per unit length

CSys: Type: System String
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: System Int32

RD1: Type: System Double

RD2: Type: System Double

Dist1: Type: System Double
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: System Double
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: System Double
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: System Double
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: ETABS2015 eItemType
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

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

Remarks

Examples

C++

Copy to Clipboard Print

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

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