GetWeightAndMass Method

cPropMaterial GetWeightAndMass Method

CSi API ETABS 2015

Retrieves the weight per unit volume and mass per unit volume of the material.

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

Syntax

int GetWeightAndMass(
	string Name,
	ref double W,
	ref double M,
	double Temp = 0
)

int GetWeightAndMass(
	string Name,
	ref double W,
	ref double M,
	double Temp = 0
)

Function GetWeightAndMass ( _
	Name As String, _
	ByRef W As Double, _
	ByRef M As Double, _
	Optional Temp As Double = 0 _
) As Integer

Function GetWeightAndMass ( _
	Name As String, _
	ByRef W As Double, _
	ByRef M As Double, _
	Optional Temp As Double = 0 _
) As Integer

int GetWeightAndMass(
	String^ Name, 
	double% W, 
	double% M, 
	double Temp = 0
)

int GetWeightAndMass(
	String^ Name, 
	double% W, 
	double% M, 
	double Temp = 0
)

Parameters

Name: Type: System String
The name of an existing material property.

W: Type: System Double

M: Type: System Double

Temp (Optional): Type: System Double
the temperature at which the specified data is to be retrieved.
This item applies only if the specified material has properties that are temperature dependent. That is, it applies only if properties are specified for the material at more than one temperature.

Return Value

Returns zero if the data is successfully retrieved; 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 w As Double 
       Dim m 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)

   'initialize new material property
       ret = SapModel.PropMaterial.SetMaterial("Steel", ETABS2013.eMatType.Steel)

   'assign material property weight per unit volume
       ret = SapModel.PropMaterial.SetWeightAndMass("Steel", 1, 0.00029)

   'get material weight and mass per unit volume
       ret = SapModel.PropMaterial.GetWeightAndMass("Steel", w, m)

   '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 w As Double 
       Dim m 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)

   'initialize new material property
       ret = SapModel.PropMaterial.SetMaterial("Steel", ETABS2013.eMatType.Steel)

   'assign material property weight per unit volume
       ret = SapModel.PropMaterial.SetWeightAndMass("Steel", 1, 0.00029)

   'get material weight and mass per unit volume
       ret = SapModel.PropMaterial.GetWeightAndMass("Steel", w, m)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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