SetLoadPoint Method

cFrameObj SetLoadPoint Method

CSi API ETABS 2015

Assigns point loads to frame objects.

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

Syntax

int SetLoadPoint(
	string Name,
	string LoadPat,
	int MyType,
	int Dir,
	double Dist,
	double Val,
	string CSys = "Global",
	bool RelDist = true,
	bool Replace = true,
	eItemType ItemType = eItemType.Objects
)

int SetLoadPoint(
	string Name,
	string LoadPat,
	int MyType,
	int Dir,
	double Dist,
	double Val,
	string CSys = "Global",
	bool RelDist = true,
	bool Replace = true,
	eItemType ItemType = eItemType.Objects
)

Function SetLoadPoint ( _
	Name As String, _
	LoadPat As String, _
	MyType As Integer, _
	Dir As Integer, _
	Dist As Double, _
	Val As Double, _
	Optional CSys As String = "Global", _
	Optional RelDist As Boolean = True, _
	Optional Replace As Boolean = True, _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

Function SetLoadPoint ( _
	Name As String, _
	LoadPat As String, _
	MyType As Integer, _
	Dir As Integer, _
	Dist As Double, _
	Val As Double, _
	Optional CSys As String = "Global", _
	Optional RelDist As Boolean = True, _
	Optional Replace As Boolean = True, _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

int SetLoadPoint(
	String^ Name, 
	String^ LoadPat, 
	int MyType, 
	int Dir, 
	double Dist, 
	double Val, 
	String^ CSys = L"Global", 
	bool RelDist = true, 
	bool Replace = true, 
	eItemType ItemType = eItemType::Objects
)

int SetLoadPoint(
	String^ Name, 
	String^ LoadPat, 
	int MyType, 
	int Dir, 
	double Dist, 
	double Val, 
	String^ CSys = L"Global", 
	bool RelDist = true, 
	bool Replace = true, 
	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.

LoadPat: Type: System String
The name of a defined load pattern.

MyType

Type:

System Int32
This is 1 or 2, indicating the type of point load.

Force
Moment

Dir: Type: System Int32

Dist: Type: System Double

Val: Type: System Double

CSys (Optional): Type: System String
This is Local or the name of a defined coordinate system. It is the coordinate system in which the loads are specified.

RelDist (Optional): Type: System Boolean
If this item is True, the specified dist item is a relative distance, otherwise it is an actual distance.

Replace (Optional): Type: System Boolean
If this item is True, all previous loads, if any, assigned to the specified frame object(s), in the specified load pattern, are deleted before making the new assignment.

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 assignment is made to the frame object specified by the Name item.

If this item is Group, the assignment is made to all frame objects in the group specified by the Name item.

If this item is SelectedObjects, the assignment is made to all selected frame objects and the Name item is ignored.

Return Value

Returns zero if the loads are successfully assigned, 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 

'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 point loads
   ret = SapModel.FrameObj.SetLoadPoint("15", "DEAD", 1, 10, .5, 20)

'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 

'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 point loads
   ret = SapModel.FrameObj.SetLoadPoint("15", "DEAD", 1, 10, .5, 20)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing 

End Sub