SetLoadType Method

cLoadPatterns SetLoadType Method

CSi API ETABS 2015

Assigns a load type to a load pattern.

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

Syntax

int SetLoadType(
	string Name,
	eLoadPatternType MyType
)

int SetLoadType(
	string Name,
	eLoadPatternType MyType
)

Function SetLoadType ( _
	Name As String, _
	MyType As eLoadPatternType _
) As Integer

Function SetLoadType ( _
	Name As String, _
	MyType As eLoadPatternType _
) As Integer

int SetLoadType(
	String^ Name, 
	eLoadPatternType MyType
)

int SetLoadType(
	String^ Name, 
	eLoadPatternType MyType
)

Parameters

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

MyType: Type: ETABS2015 eLoadPatternType
This is one of the items in the eLoadPatternType enumeration.

Return Value

Returns zero if the load type is 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 
       Dim MyType As ETABS2013.eLoadPatternType

   '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 load type
       ret = SapModel.LoadPatterns.SetLoadType("DEAD", ETABS2013.eLoadPatternType.SuperDead)

   'get load pattern type
       ret = SapModel.LoadPatterns.GetLoadType("DEAD", MyType)

   '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 MyType As ETABS2013.eLoadPatternType

   '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 load type
       ret = SapModel.LoadPatterns.SetLoadType("DEAD", ETABS2013.eLoadPatternType.SuperDead)

   'get load pattern type
       ret = SapModel.LoadPatterns.GetLoadType("DEAD", MyType)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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