SetCaseList Method

cCombo SetCaseList Method

CSi API ETABS 2015

Adds or modifies one load case or response combination in the list of cases included in the load combination specified by the Name item.

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

Syntax

C++

Copy to Clipboard Print

int SetCaseList(
	string Name,
	ref eCNameType CNameType,
	string CName,
	double SF
)

int SetCaseList(
	string Name,
	ref eCNameType CNameType,
	string CName,
	double SF
)

Function SetCaseList ( _
	Name As String, _
	ByRef CNameType As eCNameType, _
	CName As String, _
	SF As Double _
) As Integer

Function SetCaseList ( _
	Name As String, _
	ByRef CNameType As eCNameType, _
	CName As String, _
	SF As Double _
) As Integer

int SetCaseList(
	String^ Name, 
	eCNameType% CNameType, 
	String^ CName, 
	double SF
)

int SetCaseList(
	String^ Name, 
	eCNameType% CNameType, 
	String^ CName, 
	double SF
)

Parameters

Name: Type: System String
The name of an existing load combination.

CNameType

Type: ETABS2015 eCNameType
This is one of the following items in the eCNameType enumeration:

LoadCase = 0
LoadCombo = 1

This item indicates whether the CName item is an analysis case (LoadCase) or a load combination (LoadCombo).

CName: Type: System String
The name of the load case or load combination to be added to or modified in the combination specified by the Name item. If the load case or combination already exists in the combination specified by the Name item, the scale factor is modified as indicated by the sf item for that load case or combination. If the analysis case or combination does not exist in the combination specified by the Name item, it is added.

SF: Type: System Double

Return Value

Returns zero if the item is successfully added or modified, 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)

   'add combo
       ret = SapModel.RespCombo.Add("COMB1", 0)

   'add load case to combo
       ret = SapModel.RespCombo.SetCaseList("COMB1", LoadCase, "DEAD", 1.4)

   '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)

   'add combo
       ret = SapModel.RespCombo.Add("COMB1", 0)

   'add load case to combo
       ret = SapModel.RespCombo.SetCaseList("COMB1", LoadCase, "DEAD", 1.4)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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