cAnalysisResultsBaseReact Method

Reports the structure total base reactions

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int BaseReact(
	ref int NumberResults,
	ref string[] LoadCase,
	ref string[] StepType,
	ref double[] StepNum,
	ref double[] FX,
	ref double[] FY,
	ref double[] FZ,
	ref double[] MX,
	ref double[] ParamMy,
	ref double[] MZ,
	ref double GX,
	ref double GY,
	ref double GZ
)

Parameters

NumberResults
Type: SystemInt32
The total number of results returned by the program
LoadCase
Type: SystemString
This is an array that includes the name of the analysis case or load combination associated with each result
StepType
Type: SystemString
This is an array that includes the step type, if any, for each result
StepNum
Type: SystemDouble
This is an array that includes the step number, if any, for each result
FX
Type: SystemDouble
This array contains the base reaction force in the global X direction for each result. [F]
FY
Type: SystemDouble
This array contains the base reaction force in the global Y direction for each result. [F]
FZ
Type: SystemDouble
This array contains the base reaction force in the global Z direction for each result. [F]
MX
Type: SystemDouble
This array contains the base reaction moment about the global X axis for each result. [FL]
ParamMy
Type: SystemDouble
This array contains the base reaction moment about the global Y axis for each result. [FL]
MZ
Type: SystemDouble
This array contains the base reaction moment about the global Z axis for each result. [FL]
GX
Type: SystemDouble
The global X coordinate of the point at which the base reactions are reported. [L]
GY
Type: SystemDouble
The global Y coordinate of the point at which the base reactions are reported. [L]
GZ
Type: SystemDouble
The global Z coordinate of the point at which the base reactions are reported. [L]

Return Value

Type: Int32
Returns zero if the reactions are successfully recovered, otherwise it returns a nonzero value
Remarks
Examples
VB
Copy
Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1
       Dim NumberResults As Integer
       Dim LoadCase() As String
       Dim StepType() As String
       Dim StepNum() As Double
       Dim Fx() As Double
       Dim Fy() As Double
       Dim Fz() As Double
       Dim Mx() As Double
       Dim ParamMy() As Double
       Dim Mz() As Double
       Dim gx as Double
       Dim gy as Double
       Dim gz 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 base reactions
       ret = SapModel.Results.BaseReact(NumberResults, LoadCase, StepType, StepNum, Fx, Fy, Fz, Mx, ParamMy, Mz, gx, gy, gz)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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