cLoadPatternsAdd Method

Adds a new load pattern.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int Add(
	string Name,
	eLoadPatternType MyType,
	double SelfWTMultiplier = 0,
	bool AddAnalysisCase = true
)

Parameters

Name
Type: SystemString
The name for the new load pattern.
MyType
Type: ETABS2016eLoadPatternType
This is one of the items in the eLoadPatternType enumeration.
SelfWTMultiplier (Optional)
Type: SystemDouble
The self weight multiplier for the new load pattern.
AddAnalysisCase (Optional)
Type: SystemBoolean
If this item is True, a linear static load case corresponding to the new load pattern is added.

Return Value

Type: Int32
Returns 0 if the load pattern is successfully added; otherwise it returns nonzero.
Remarks
An error is returned if the Name item is already used for an existing load pattern.
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)

   'add new load pattern
       ret = SapModel.LoadPatterns.Add("LIVE1A", eLoadPatternType.Live)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing
   End Sub
See Also