FrameForce Method

cAnalysisResults FrameForce Method

CSi API ETABS 2015

Reports the frame forces for the specified line elements

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

Syntax

int FrameForce(
	string Name,
	eItemTypeElm ItemTypeElm,
	ref int NumberResults,
	ref string[] Obj,
	ref double[] ObjSta,
	ref string[] Elm,
	ref double[] ElmSta,
	ref string[] LoadCase,
	ref string[] StepType,
	ref double[] StepNum,
	ref double[] P,
	ref double[] V2,
	ref double[] V3,
	ref double[] T,
	ref double[] M2,
	ref double[] M3
)

int FrameForce(
	string Name,
	eItemTypeElm ItemTypeElm,
	ref int NumberResults,
	ref string[] Obj,
	ref double[] ObjSta,
	ref string[] Elm,
	ref double[] ElmSta,
	ref string[] LoadCase,
	ref string[] StepType,
	ref double[] StepNum,
	ref double[] P,
	ref double[] V2,
	ref double[] V3,
	ref double[] T,
	ref double[] M2,
	ref double[] M3
)

Function FrameForce ( _
	Name As String, _
	ItemTypeElm As eItemTypeElm, _
	ByRef NumberResults As Integer, _
	ByRef Obj As String(), _
	ByRef ObjSta As Double(), _
	ByRef Elm As String(), _
	ByRef ElmSta As Double(), _
	ByRef LoadCase As String(), _
	ByRef StepType As String(), _
	ByRef StepNum As Double(), _
	ByRef P As Double(), _
	ByRef V2 As Double(), _
	ByRef V3 As Double(), _
	ByRef T As Double(), _
	ByRef M2 As Double(), _
	ByRef M3 As Double() _
) As Integer

Function FrameForce ( _
	Name As String, _
	ItemTypeElm As eItemTypeElm, _
	ByRef NumberResults As Integer, _
	ByRef Obj As String(), _
	ByRef ObjSta As Double(), _
	ByRef Elm As String(), _
	ByRef ElmSta As Double(), _
	ByRef LoadCase As String(), _
	ByRef StepType As String(), _
	ByRef StepNum As Double(), _
	ByRef P As Double(), _
	ByRef V2 As Double(), _
	ByRef V3 As Double(), _
	ByRef T As Double(), _
	ByRef M2 As Double(), _
	ByRef M3 As Double() _
) As Integer

int FrameForce(
	String^ Name, 
	eItemTypeElm ItemTypeElm, 
	int% NumberResults, 
	array<String^>^% Obj, 
	array<double>^% ObjSta, 
	array<String^>^% Elm, 
	array<double>^% ElmSta, 
	array<String^>^% LoadCase, 
	array<String^>^% StepType, 
	array<double>^% StepNum, 
	array<double>^% P, 
	array<double>^% V2, 
	array<double>^% V3, 
	array<double>^% T, 
	array<double>^% M2, 
	array<double>^% M3
)

int FrameForce(
	String^ Name, 
	eItemTypeElm ItemTypeElm, 
	int% NumberResults, 
	array<String^>^% Obj, 
	array<double>^% ObjSta, 
	array<String^>^% Elm, 
	array<double>^% ElmSta, 
	array<String^>^% LoadCase, 
	array<String^>^% StepType, 
	array<double>^% StepNum, 
	array<double>^% P, 
	array<double>^% V2, 
	array<double>^% V3, 
	array<double>^% T, 
	array<double>^% M2, 
	array<double>^% M3
)

Parameters

Name: Type: System String
The name of an existing line object, line element or group of objects, depending on the value of the ItemTypeElm item.

ItemTypeElm: Type: ETABS2015 eItemTypeElm
This is one of the following items in the eItemTypeElm enumeration.
If this item is ObjectElm, the result request is for the line elements corresponding to the line object specified by the Name item.
If this item is Element, the result request is for the line element specified by the Name item.
If this item is GroupElm, the result request is for the line elements corresponding to all line objects included in the group specified by the Name item.
If this item is SelectionElm, the result request is for line elements corresponding to all selected line objects and the Name item is ignored.

NumberResults: Type: System Int32
The total number of results returned by the program

Obj: Type: System String
This is an array that includes the line object name associated with each result, if any

ObjSta: Type: System Double
This is an array that includes the distance measured from the I-end of the line object to the result location

Elm: Type: System String
This is an array that includes the line element name associated with each result

ElmSta: Type: System Double
This is an array that includes the distance measured from the I-end of the line element to the result location

LoadCase: Type: System String
This is an array that includes the name of the analysis case or load combination associated with each result

StepType: Type: System String
This is an array that includes the step type, if any, for each result

StepNum: Type: System Double
This is an array that includes the step number, if any, for each result

P: Type: System Double
This is a one dimensional array of the axial force for each result. [F]

V2: Type: System Double
This is a one dimensional array of the shear force in the local 2 direction for each result. [F]

V3: Type: System Double
This is a one dimensional array of the shear force in the local 3 direction for each result. [F]

T: Type: System Double
This is a one dimensional array of the torsion for each result. [FL]

M2: Type: System Double
This is a one dimensional array of the moment about the local 2-axis for each result. [FL]

M3: Type: System Double
This is a one dimensional array of the moment about the local 3-axis for each result. [FL]

Return Value

Returns zero if the forces are successfully recovered, 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 NumberResults As Integer 
       Dim Obj() As String 
       Dim ObjSta() As Double 
       Dim Elm() As String 
       Dim ElmSta() As Double 
       Dim LoadCase() As String 
       Dim StepType() As String 
       Dim StepNum() As Double 
       Dim P() As Double 
       Dim V2() As Double 
       Dim V3() As Double 
       Dim T() As Double 
       Dim M2() As Double 
       Dim M3() 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)

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

   'deselect all cases and combos
       ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput

   'set case selected for output
       ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")

   'get frame forces
       ret = mySapModel.Results.FrameForce("1", ETABS2015.eItemTypeElm.ObjectElm, NumberResults, Obj, ObjSta, Elm, ElmSta, LoadCase, StepType, StepNum, P, V2, V3, T, M2, M3)

   '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 NumberResults As Integer 
       Dim Obj() As String 
       Dim ObjSta() As Double 
       Dim Elm() As String 
       Dim ElmSta() As Double 
       Dim LoadCase() As String 
       Dim StepType() As String 
       Dim StepNum() As Double 
       Dim P() As Double 
       Dim V2() As Double 
       Dim V3() As Double 
       Dim T() As Double 
       Dim M2() As Double 
       Dim M3() 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)

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

   'deselect all cases and combos
       ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput

   'set case selected for output
       ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")

   'get frame forces
       ret = mySapModel.Results.FrameForce("1", ETABS2015.eItemTypeElm.ObjectElm, NumberResults, Obj, ObjSta, Elm, ElmSta, LoadCase, StepType, StepNum, P, V2, V3, T, M2, M3)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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