GetRebarBeam Method

cPropFrame GetRebarBeam Method

CSi API ETABS 2015

Retrieves beam rebar data for frame sections.

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

Syntax

int GetRebarBeam(
	string Name,
	ref string MatPropLong,
	ref string MatPropConfine,
	ref double CoverTop,
	ref double CoverBot,
	ref double TopLeftArea,
	ref double TopRightArea,
	ref double BotLeftArea,
	ref double BotRightArea
)

int GetRebarBeam(
	string Name,
	ref string MatPropLong,
	ref string MatPropConfine,
	ref double CoverTop,
	ref double CoverBot,
	ref double TopLeftArea,
	ref double TopRightArea,
	ref double BotLeftArea,
	ref double BotRightArea
)

Function GetRebarBeam ( _
	Name As String, _
	ByRef MatPropLong As String, _
	ByRef MatPropConfine As String, _
	ByRef CoverTop As Double, _
	ByRef CoverBot As Double, _
	ByRef TopLeftArea As Double, _
	ByRef TopRightArea As Double, _
	ByRef BotLeftArea As Double, _
	ByRef BotRightArea As Double _
) As Integer

Function GetRebarBeam ( _
	Name As String, _
	ByRef MatPropLong As String, _
	ByRef MatPropConfine As String, _
	ByRef CoverTop As Double, _
	ByRef CoverBot As Double, _
	ByRef TopLeftArea As Double, _
	ByRef TopRightArea As Double, _
	ByRef BotLeftArea As Double, _
	ByRef BotRightArea As Double _
) As Integer

int GetRebarBeam(
	String^ Name, 
	String^% MatPropLong, 
	String^% MatPropConfine, 
	double% CoverTop, 
	double% CoverBot, 
	double% TopLeftArea, 
	double% TopRightArea, 
	double% BotLeftArea, 
	double% BotRightArea
)

int GetRebarBeam(
	String^ Name, 
	String^% MatPropLong, 
	String^% MatPropConfine, 
	double% CoverTop, 
	double% CoverBot, 
	double% TopLeftArea, 
	double% TopRightArea, 
	double% BotLeftArea, 
	double% BotRightArea
)

Parameters

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

MatPropLong: Type: System String
The name of the rebar material property for the longitudinal rebar.

MatPropConfine: Type: System String
The name of the rebar material property for the confinement rebar.

CoverTop: Type: System Double
The distance from the top of the beam to the centroid of the top longitudinal reinforcement. [L]

CoverBot: Type: System Double
The distance from the bottom of the beam to the centroid of the bottom longitudinal reinforcement. [L]

TopLeftArea: Type: System Double
The total area of longitudinal reinforcement at the top left end of the beam. [L2]

TopRightArea: Type: System Double
The total area of longitudinal reinforcement at the top right end of the beam. [L2]

BotLeftArea: Type: System Double
The total area of longitudinal reinforcement at the bottom left end of the beam. [L2]

BotRightArea: Type: System Double
The total area of longitudinal reinforcement at the bottom right end of the beam. [L2]

Return Value

Returns zero if the rebar data is successfully retrieved; otherwise it returns a nonzero value.

Remarks

This function applies only to the following section types. Calling this function for any other type of frame section property returns an error.

The material assigned to the specified frame section property must be concrete or this function returns an error.

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim RebarName As String 
       Dim MatPropLong As String 
       Dim MatPropConfine As String 
       Dim CoverTop As Double 
       Dim CoverBot As Double 
       Dim TopLeftArea As Double 
       Dim TopRightArea As Double 
       Dim BotLeftArea As Double 
       Dim BotRightArea 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 new frame section property
       ret = SapModel.PropFrame.SetRectangle("R1", "4000Psi", 20, 12)

   'add ASTM A706 rebar material
       ret = SapModel.PropMaterial.AddQuick(RebarName, ETABS2013.eMatType.Rebar, , , , , ETABS2013.eMatTypeRebar.ASTM_A706)

   'set beam rebar data
       ret = SapModel.PropFrame.SetRebarBeam("R1", RebarName, RebarName, 3.5, 3, 4.1, 4.2, 4.3, 4.4)

   'get beam rebar data
       ret = SapModel.PropFrame.GetRebarBeam("R1", MatPropLong, MatPropConfine, CoverTop, CoverBot, TopLeftArea, TopRightArea, BotLeftArea, BotRightArea)

   '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 RebarName As String 
       Dim MatPropLong As String 
       Dim MatPropConfine As String 
       Dim CoverTop As Double 
       Dim CoverBot As Double 
       Dim TopLeftArea As Double 
       Dim TopRightArea As Double 
       Dim BotLeftArea As Double 
       Dim BotRightArea 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 new frame section property
       ret = SapModel.PropFrame.SetRectangle("R1", "4000Psi", 20, 12)

   'add ASTM A706 rebar material
       ret = SapModel.PropMaterial.AddQuick(RebarName, ETABS2013.eMatType.Rebar, , , , , ETABS2013.eMatTypeRebar.ASTM_A706)

   'set beam rebar data
       ret = SapModel.PropFrame.SetRebarBeam("R1", RebarName, RebarName, 3.5, 3, 4.1, 4.2, 4.3, 4.4)

   'get beam rebar data
       ret = SapModel.PropFrame.GetRebarBeam("R1", MatPropLong, MatPropConfine, CoverTop, CoverBot, TopLeftArea, TopRightArea, BotLeftArea, BotRightArea)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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