GetRebarColumn Method

cPropFrame GetRebarColumn Method

CSi API ETABS 2015

Retrieves column rebar data for frame sections.

Namespace: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.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
)

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
)

Function GetRebarColumn ( _
	Name As String, _
	ByRef MatPropLong As String, _
	ByRef MatPropConfine As String, _
	ByRef Pattern As Integer, _
	ByRef ConfineType As Integer, _
	ByRef Cover As Double, _
	ByRef NumberCBars As Integer, _
	ByRef NumberR3Bars As Integer, _
	ByRef NumberR2Bars As Integer, _
	ByRef RebarSize As String, _
	ByRef TieSize As String, _
	ByRef TieSpacingLongit As Double, _
	ByRef Number2DirTieBars As Integer, _
	ByRef Number3DirTieBars As Integer, _
	ByRef ToBeDesigned As Boolean _
) As Integer

Function GetRebarColumn ( _
	Name As String, _
	ByRef MatPropLong As String, _
	ByRef MatPropConfine As String, _
	ByRef Pattern As Integer, _
	ByRef ConfineType As Integer, _
	ByRef Cover As Double, _
	ByRef NumberCBars As Integer, _
	ByRef NumberR3Bars As Integer, _
	ByRef NumberR2Bars As Integer, _
	ByRef RebarSize As String, _
	ByRef TieSize As String, _
	ByRef TieSpacingLongit As Double, _
	ByRef Number2DirTieBars As Integer, _
	ByRef Number3DirTieBars As Integer, _
	ByRef ToBeDesigned As Boolean _
) As Integer

int GetRebarColumn(
	String^ Name, 
	String^% MatPropLong, 
	String^% MatPropConfine, 
	int% Pattern, 
	int% ConfineType, 
	double% Cover, 
	int% NumberCBars, 
	int% NumberR3Bars, 
	int% NumberR2Bars, 
	String^% RebarSize, 
	String^% TieSize, 
	double% TieSpacingLongit, 
	int% Number2DirTieBars, 
	int% Number3DirTieBars, 
	bool% ToBeDesigned
)

int GetRebarColumn(
	String^ Name, 
	String^% MatPropLong, 
	String^% MatPropConfine, 
	int% Pattern, 
	int% ConfineType, 
	double% Cover, 
	int% NumberCBars, 
	int% NumberR3Bars, 
	int% NumberR2Bars, 
	String^% RebarSize, 
	String^% TieSize, 
	double% TieSpacingLongit, 
	int% Number2DirTieBars, 
	int% Number3DirTieBars, 
	bool% ToBeDesigned
)

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.

Pattern

Type:

System Int32
This is either 1 or 2, indicating the rebar configuration.

Value	Pattern
1	Rectangular
2	Circular

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

ConfineType

Type:

System Int32
This is either 1 or 2, indicating the confinement bar type.

Value	Type
1	Ties
2	Spiral

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

Cover: Type: System Double
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: System Int32
This item applies to a circular rebar configuration, Pattern = 2. It is the total number of longitudinal reinforcing bars in the column.

NumberR3Bars: Type: System Int32
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: System Int32
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: System String
The rebar name for the longitudinal rebar in the column.

TieSize: Type: System String
The rebar name for the confinement rebar in the column.

TieSpacingLongit: Type: System Double
The longitudinal spacing of the confinement bars (ties). [L]

Number2DirTieBars: Type: System Int32
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: System Int32
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: System Boolean
If this item is True, the column longitudinal rebar is to be designed; otherwise it is to be checked.

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 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, ETABS2013.eMatType.Rebar, , , , , ETABS2013.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

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, ETABS2013.eMatType.Rebar, , , , , ETABS2013.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