cPropMaterialGetMassSource_1 Method

Retrieves the mass source for the model.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetMassSource_1(
	ref bool IncludeElements,
	ref bool IncludeAddedMass,
	ref bool IncludeLoads,
	ref int NumberLoads,
	ref string[] LoadPat,
	ref double[] sf
)

Parameters

IncludeElements
Type: SystemBoolean
Include element self mass
IncludeAddedMass
Type: SystemBoolean
Include additional masses
IncludeLoads
Type: SystemBoolean
Include specified loads
NumberLoads
Type: SystemInt32
The number of load patterns from which mass is obtained. This item applies only when IncludeLoads is True.
LoadPat
Type: SystemString
This is an array of the names of the load patterns from which mass is obtained. This item applies only when IncludeLoads is True.
sf
Type: SystemDouble
This is an array of load patterns multipliers used to calculate the mass. This item applies only when IncludeLoads is True.

Return Value

Type: Int32
Returns zero if the mass source is successfully retrieved; 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
       Dim MyLoadPat() As String
       Dim MySF() As Double
       Dim MyOption As Integer
       Dim NumberLoads As Integer
       Dim LoadPat() As String
       Dim sf() As Double    

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

   'set mass source
       ReDim MyLoadPat(1)
       ReDim MySF(1)
       MyLoadPat(0) = "DEAD"
       MyLoadPat(1) = "LIVE"
       MySF(0) = 1
       MySF(1) = 0.2
       ret = SapModel.PropMaterial.SetMassSource(3, 2, MyLoadPat, MySF)

   'get mass source
       ret = SapModel.PropMaterial.GetMassSource(MyOption, NumberLoads, LoadPat, sf)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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