cFrameObjSetLoadPoint Method

Assigns point loads to frame objects.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
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
)

Parameters

Name
Type: SystemString
The name of an existing frame object or group, depending on the value of the ItemType item.
LoadPat
Type: SystemString
The name of a defined load pattern.
MyType
Type: SystemInt32
This is 1 or 2, indicating the type of point load.
  1. Force
  2. Moment
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.

Dist
Type: SystemDouble
Val
Type: SystemDouble
CSys (Optional)
Type: SystemString
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: SystemBoolean
If this item is True, the specified dist item is a relative distance, otherwise it is an actual distance.
Replace (Optional)
Type: SystemBoolean
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: ETABS2016eItemType
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

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

'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
See Also