GetSummaryResultsBeam Method

cDesignConcrete GetSummaryResultsBeam Method

CSi API ETABS 2015

Retrieves summary results for concrete design.

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

Syntax

int GetSummaryResultsBeam(
	string Name,
	ref int NumberItems,
	ref string[] FrameName,
	ref double[] Location,
	ref string[] TopCombo,
	ref double[] TopArea,
	ref string[] BotCombo,
	ref double[] BotArea,
	ref string[] VMajorCombo,
	ref double[] VMajorArea,
	ref string[] TLCombo,
	ref double[] TLArea,
	ref string[] TTCombo,
	ref double[] TTArea,
	ref string[] ErrorSummary,
	ref string[] WarningSummary,
	eItemType ItemType = eItemType.Objects
)

int GetSummaryResultsBeam(
	string Name,
	ref int NumberItems,
	ref string[] FrameName,
	ref double[] Location,
	ref string[] TopCombo,
	ref double[] TopArea,
	ref string[] BotCombo,
	ref double[] BotArea,
	ref string[] VMajorCombo,
	ref double[] VMajorArea,
	ref string[] TLCombo,
	ref double[] TLArea,
	ref string[] TTCombo,
	ref double[] TTArea,
	ref string[] ErrorSummary,
	ref string[] WarningSummary,
	eItemType ItemType = eItemType.Objects
)

Function GetSummaryResultsBeam ( _
	Name As String, _
	ByRef NumberItems As Integer, _
	ByRef FrameName As String(), _
	ByRef Location As Double(), _
	ByRef TopCombo As String(), _
	ByRef TopArea As Double(), _
	ByRef BotCombo As String(), _
	ByRef BotArea As Double(), _
	ByRef VMajorCombo As String(), _
	ByRef VMajorArea As Double(), _
	ByRef TLCombo As String(), _
	ByRef TLArea As Double(), _
	ByRef TTCombo As String(), _
	ByRef TTArea As Double(), _
	ByRef ErrorSummary As String(), _
	ByRef WarningSummary As String(), _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

Function GetSummaryResultsBeam ( _
	Name As String, _
	ByRef NumberItems As Integer, _
	ByRef FrameName As String(), _
	ByRef Location As Double(), _
	ByRef TopCombo As String(), _
	ByRef TopArea As Double(), _
	ByRef BotCombo As String(), _
	ByRef BotArea As Double(), _
	ByRef VMajorCombo As String(), _
	ByRef VMajorArea As Double(), _
	ByRef TLCombo As String(), _
	ByRef TLArea As Double(), _
	ByRef TTCombo As String(), _
	ByRef TTArea As Double(), _
	ByRef ErrorSummary As String(), _
	ByRef WarningSummary As String(), _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

int GetSummaryResultsBeam(
	String^ Name, 
	int% NumberItems, 
	array<String^>^% FrameName, 
	array<double>^% Location, 
	array<String^>^% TopCombo, 
	array<double>^% TopArea, 
	array<String^>^% BotCombo, 
	array<double>^% BotArea, 
	array<String^>^% VMajorCombo, 
	array<double>^% VMajorArea, 
	array<String^>^% TLCombo, 
	array<double>^% TLArea, 
	array<String^>^% TTCombo, 
	array<double>^% TTArea, 
	array<String^>^% ErrorSummary, 
	array<String^>^% WarningSummary, 
	eItemType ItemType = eItemType::Objects
)

int GetSummaryResultsBeam(
	String^ Name, 
	int% NumberItems, 
	array<String^>^% FrameName, 
	array<double>^% Location, 
	array<String^>^% TopCombo, 
	array<double>^% TopArea, 
	array<String^>^% BotCombo, 
	array<double>^% BotArea, 
	array<String^>^% VMajorCombo, 
	array<double>^% VMajorArea, 
	array<String^>^% TLCombo, 
	array<double>^% TLArea, 
	array<String^>^% TTCombo, 
	array<double>^% TTArea, 
	array<String^>^% ErrorSummary, 
	array<String^>^% WarningSummary, 
	eItemType ItemType = eItemType::Objects
)

Parameters

Name: Type: System String
The name of an existing frame object or group, depending on the value of the ItemType item.

NumberItems: Type: System Int32
The number of frame objects for which results are obtained.

FrameName: Type: System String
This is an array that includes each frame object name for which results are obtained.

Location: Type: System Double
This is an array that includes the distance from the I-end of the frame object to the location where the results are reported. [L]

TopCombo: Type: System String
This is an array that includes the name of the design combination for which the controlling top longitudinal rebar area for flexure occurs. A combination name followed by (Sp) indicates that the design loads were obtained by applying special, code-specific multipliers to all or part of the specified design load combination, or that the design was based on the capacity of other objects (or other design locations for the same object).

TopArea: Type: System Double
This is an array that includes the total top longitudinal rebar area required for the flexure at the specified location. It does not include the area of steel required for torsion. [L2]

BotCombo: Type: System String
This is an array that includes the name of the design combination for which the controlling bottom longitudinal rebar area for flexure occurs. A combination name followed by (Sp) indicates that the design loads were obtained by applying special, code-specific, multipliers to all or part of the specified design load combination, or that the design was based on the capacity of other objects (or other design locations for the same object).

BotArea: Type: System Double
This is an array that includes the total bottom longitudinal rebar area required for the flexure at the specified location. It does not include the area of steel required for torsion. [L2]

VMajorCombo: Type: System String

VMajorArea: Type: System Double

TLCombo: Type: System String
This is an array that includes the name of the design combination for which the controlling longitudinal rebar area for torsion occurs. A combination name followed by (Sp) indicates that the design loads were obtained by applying special, code-specific, multipliers to all or part of the specified design load combination, or that the design was based on the capacity of other objects (or other design locations for the same object).

TLArea: Type: System Double
This is an array that includes the total longitudinal rebar area required for torsion. [L2]

TTCombo: Type: System String
This is an array that includes the name of the design combination for which the controlling transverse reinforcing for torsion occurs. A combination name followed by (Sp) indicates that the design loads were obtained by applying special, code-specific, multipliers to all or part of the specified design load combination, or that the design was based on the capacity of other objects (or other design locations for the same object).

TTArea: Type: System Double
This is an array that includes the required area of transverse torsional shear reinforcing per unit length along the frame object for torsion at the specified location. [L2/L]

ErrorSummary: Type: System String
This is an array that includes the design error messages for the frame object, if any.

WarningSummary: Type: System String
This is an array that includes the design warning messages for the frame object, if any.

ItemType (Optional)

Type: ETABS2015 eItemType
This is one of the following items in the eItemType enumeration:

Object = 0
Group = 1
SelectedObjects = 2

If this item is Objects, the design results are retrieved for the frame object specified by the Name item.

If this item is Group, the design results are retrieved for all frame objects in the group specified by the Name item.

If this item is SelectedObjects, the design results are retrieved for all selected frame objects, and the Name item is ignored.

Return Value

Returns zero if the results are successfully retrieved; otherwise it returns a nonzero value.

Remarks

Note that torsional design is only included for some codes.

Examples

C++

Copy to Clipboard Print

Public Sub Example()
   Dim SapModel As cSapModel
   Dim EtabsObject As cOAPI
   Dim ret As Integer = -1 
   Dim Name As String 
   Dim NumberItems As Long 
   Dim FrameName() As String 
   Dim Location() As Double 
   Dim TopCombo() As String 
   Dim TopArea() As Double 
   Dim BotCombo() As String 
   Dim BotArea() As Double 
   Dim VmajorCombo() As String 
   Dim VmajorArea() As Double 
   Dim TLCombo() As String 
   Dim TLArea() As Double 
   Dim TTCombo() As String 
   Dim TTArea() As Double 
   Dim ErrorSummary() As String 
   Dim WarningSummary() As String 

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

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

'create new concrete frame section properties
   ret = SapModel.PropFrame.SetRectangle("COL", "4000Psi", 20, 20)
   ret = SapModel.PropFrame.SetRectangle("BEAM", "4000Psi", 20, 12)
   ret = SapModel.PropFrame.SetRebarBeam("BEAM", Name, Name, 2, 2, 2, 2, 2, 2)

'create steel deck template model
   ret = SapModel.File.NewSteelDeck(4, 12, 12, 4, 4, 24, 24)

'run analysis
   System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
   ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
   ret = SapModel.Analyze.RunAnalysis

'start concrete design
   ret = SapModel.DesignConcrete.StartDesign

'get summary result data
   ret = SapModel.DesignConcrete.GetSummaryResultsBeam("8", NumberItems, FrameName, Location, TopCombo, TopArea, BotCombo, BotArea, VmajorCombo, VmajorArea, TLCombo, TLArea, TTCombo, TTArea, ErrorSummary, WarningSummary)

'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 Name As String 
   Dim NumberItems As Long 
   Dim FrameName() As String 
   Dim Location() As Double 
   Dim TopCombo() As String 
   Dim TopArea() As Double 
   Dim BotCombo() As String 
   Dim BotArea() As Double 
   Dim VmajorCombo() As String 
   Dim VmajorArea() As Double 
   Dim TLCombo() As String 
   Dim TLArea() As Double 
   Dim TTCombo() As String 
   Dim TTArea() As Double 
   Dim ErrorSummary() As String 
   Dim WarningSummary() As String 

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

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

'create new concrete frame section properties
   ret = SapModel.PropFrame.SetRectangle("COL", "4000Psi", 20, 20)
   ret = SapModel.PropFrame.SetRectangle("BEAM", "4000Psi", 20, 12)
   ret = SapModel.PropFrame.SetRebarBeam("BEAM", Name, Name, 2, 2, 2, 2, 2, 2)

'create steel deck template model
   ret = SapModel.File.NewSteelDeck(4, 12, 12, 4, 4, 24, 24)

'run analysis
   System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
   ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
   ret = SapModel.Analyze.RunAnalysis

'start concrete design
   ret = SapModel.DesignConcrete.StartDesign

'get summary result data
   ret = SapModel.DesignConcrete.GetSummaryResultsBeam("8", NumberItems, FrameName, Location, TopCombo, TopArea, BotCombo, BotArea, VmajorCombo, VmajorArea, TLCombo, TLArea, TTCombo, TTArea, ErrorSummary, WarningSummary)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing 

End Sub