cPropFrameGetRebarColumn Method

Retrieves column rebar data for frame sections.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
int GetRebarColumn(
	string Name,
	ref string MatPropLong,
	ref string MatPropConfine,
	ref int Pattern,
	ref int ConfineType,
	ref double Cover,
	ref int NumberCBars,
	ref int NumberR3Bars,
	ref int NumberR2Bars,
	ref string RebarSize,
	ref string TieSize,
	ref double TieSpacingLongit,
	ref int Number2DirTieBars,
	ref int Number3DirTieBars,
	ref bool ToBeDesigned
)

Parameters

Name
Type: SystemString
The name of an existing frame section property.
MatPropLong
Type: SystemString
The name of the rebar material property for the longitudinal rebar.
MatPropConfine
Type: SystemString
The name of the rebar material property for the confinement rebar.
Pattern
Type: SystemInt32
This is either 1 or 2, indicating the rebar configuration.
ValuePattern
1Rectangular
2Circular

For circular frame section properties this item must be 2; otherwise an error is returned.

ConfineType
Type: SystemInt32
This is either 1 or 2, indicating the confinement bar type.
ValueType
1Ties
2Spiral

This item applies only when Pattern = 2. If Pattern = 1, the confinement bar type is assumed to be ties.

Cover
Type: SystemDouble
The clear cover for the confinement steel (ties). In the special case of circular reinforcement in a rectangular column, this is the minimum clear cover. [L]
NumberCBars
Type: SystemInt32
This item applies to a circular rebar configuration, Pattern = 2. It is the total number of longitudinal reinforcing bars in the column.
NumberR3Bars
Type: SystemInt32
This item applies to a rectangular rebar configuration, Pattern = 1. It is the number of longitudinal bars (including the corner bar) on each face of the column that is parallel to the local 3-axis of the column.
NumberR2Bars
Type: SystemInt32
This item applies to a rectangular rebar configuration, Pattern = 1. It is the number of longitudinal bars (including the corner bar) on each face of the column that is parallel to the local 2-axis of the column.
RebarSize
Type: SystemString
The rebar name for the longitudinal rebar in the column.
TieSize
Type: SystemString
The rebar name for the confinement rebar in the column.
TieSpacingLongit
Type: SystemDouble
The longitudinal spacing of the confinement bars (ties). [L]
Number2DirTieBars
Type: SystemInt32
This item applies to a rectangular reinforcing configuration, Pattern = 1. It is the number of confinement bars (tie legs) running in the local 2-axis direction of the column.
Number3DirTieBars
Type: SystemInt32
This item applies to a rectangular reinforcing configuration, Pattern = 1. It is the number of confinement bars (tie legs) running in the local 3-axis direction of the column.
ToBeDesigned
Type: SystemBoolean
If this item is True, the column longitudinal rebar is to be designed; otherwise it is to be checked.

Return Value

Type: Int32
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
VB
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 Pattern As Integer
       Dim ConfineType As Integer
       Dim Cover As Double
       Dim NumberCBars As Integer
       Dim NumberR3Bars As Integer
       Dim NumberR2Bars As Integer
       Dim RebarSize As String
       Dim TieSize As String
       Dim TieSpacingLongit As Double
       Dim Number2DirTieBars As Integer
       Dim Number3DirTieBars As Integer
       Dim ToBeDesigned As Boolean

   '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, eMatType.Rebar, , , , , eMatTypeRebar.ASTM_A706)

   'set column rebar data
       ret = SapModel.PropFrame.SetRebarColumn("R1", RebarName, RebarName, 2, 2, 2, 10, 0, 0, "#10", "#5", 4, 0, 0, False)

   'get column rebar data
       ret = SapModel.PropFrame.GetRebarColumn("R1", MatPropLong, MatPropConfine, Pattern, ConfineType, Cover, NumberCBars, NumberR3Bars, NumberR2Bars, RebarSize, TieSize, TieSpacingLongit, Number2DirTieBars, Number3DirTieBars, ToBeDesigned)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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